A Complete User Guide for Akeneo PIM Cache

PIM Cache for Akeneo will dedicate a cache library for Akeneo API calls and help to boost and make it more stable, making it a great way to connect your PIM.

Akeneo API Cache can drastically improve the performance of getting data by using the saved data of the cache.

It is a complete cache solution for all resources of the catalog structure that need to be defined when creating or updating a product or product model in Akeneo.

• This module works with Akeneo 3.0.x, 3.1.x,4.0.x, 5.0.x. and 6.0.x.
• This module is compatible with the Akeneo community and Enterprise(Flexibility) edition.
• If you want to use this extension on Akeneo EE Serenity mode, please contact us.
• For the Akeneo installation, your Akeneo server should meet these system requirements.

• Drastically improved performances compared to naive API calls.
• API Booster can drastically improve the performance of getting data.
• API Booster performs the request for – categories, attributes, attribute options, attribute groups, association types, locales, channels, currencies, measurement families, media files, assets, reference entities.

Read This Blog

Before beginning the composer installation

1: Get the ACCESS KEYS [Create a support ticket]
2: In Akeneo composer.json, add our repository as well as the installation script.

For Akeneo 6.x 

{	
  "scripts": {	
        "post-update-cmd": [	
           "vendor/webkul/apicachebundle/src/Webkul/ApiBoosterBundle/install/config.sh COMPOSER=true NO_DOCKER=true"	
        ],	
        "post-install-cmd": [	
           "vendor/webkul/apicachebundle/src/Webkul/ApiBoosterBundle/install/config.sh COMPOSER=true NO_DOCKER=true"	
        ],	
        "post-create-project-cmd": [	
          "vendor/webkul/apicachebundle/src/Webkul/ApiBoosterBundle/install/config.sh COMPOSER=true NO_DOCKER=true"	
       ]	
   },	
  "repositories": [{	
    "type": "composer",	
    "url": "https://akeneorepo.webkul.com/"	
  }]	
}	

For Akeneo <=5.x 

{
  "scripts": {
        "post-update-cmd": [
           
"vendor/webkul/apicachebundle/composer_install.sh"
        ],
        "post-install-cmd": [
           
"vendor/webkul/apicachebundle/composer_install.sh"
        ],
        "post-create-project-cmd": [
         
"vendor/webkul/apicachebundle/composer_install.sh"
       ]
   },
  "repositories": [{
    "type": "composer",
    "url": "https://akeneorepo.webkul.com/"
  }]
}

3: Use composer to install the extension.

         composer require webkul/apicachebundle

4: Complete the authentication form.
5: Send a Message of Success
6: Delete your browser’s cache.

Installing Module for Version 6.0.x

•  After unzipping the appropriate extension zip, merge the “src” folder into the akeneo project.
• From the PIM directory, run the following command over the NO-DOCKER Instance.

./src/Webkul/ApiBoosterBundle/install/config.sh COMPOSER=false NO_DOCKER=true

•  Run the command below over the PIM directory’s DOCKER instance.

./src/Webkul/ApiBoosterBundle/install/config.sh COMPOSER=false NO_DOCKER=false

Please follow these steps for installing the Akeneo API Booster module in your Akeneo PIM platform.

1 – Unzip the respective extension zip then merge the “src” folder into the akeneo project root directory.

2 – Goto config/Bundles.php then add line:

Webkul\ApiBoosterBundle\ApiBoosterBundle::class => ['all' => true],

in the return array.

3 – Copy the “config” folder into the akeneo project root directory for routing.

4 – Run this command after ssh to your akeneo server by the terminal

rm -rf ./var/cache/** && php bin/console wk-api-booster:setup:install

5. If you are using php-fpm. Then you need to restart the php-fpm services and apache web server.

For Akeneo 5

sudo service php-fpm7.4 restart

For Akeneo 4

sudo service php-fpm7.3 restart

Docker Installation Command :

For Akeneo 5

alias docker_php='docker-compose run -u www-data --rm php php';
alias docker_yarn='docker-compose run -u node --rm node yarn';
docker_php bin/console cache:clear --env=prod;
docker_php bin/console pim:installer:assets --symlink --clean --env=prod;
docker_php bin/console d:s:u --force;
docker_yarn run webpack;
docker_yarn run update-extensions;
docker_yarn run less;

For Akeneo 4

alias docker_php='docker-compose run -u www-data --rm php php';
alias docker_yarn='docker-compose run -u node --rm node yarn';
docker_php bin/console cache:clear --env=prod;
docker_php bin/console pim:installer:assets --symlink --clean --env=prod;
docker_php bin/console d:s:u --force;
docker_yarn run webpack;
docker_yarn run less;

Please follow these steps for installing the Akeneo API Booster module in your Akeneo PIM platform.

1 – Unzip the respective extension zip then merge the “src” folder into the akeneo project root directory.

2 – Goto app/AppKernel.php then add the line.

new Webkul\ApiBoosterBundle\ApiBoosterBundle(),

3 – Goto app/config/routing.yml then add these lines at top of the file.

wk_api_booster:
      resource: "@ApiBoosterBundle/Resources/config/routing.yml"
      prefix:   /

4 – Run this command after ssh to your akeneo server by the terminal

rm -rf ./var/cache/** && php bin/console wk-api-booster:setup:install

5. If you are using php-fpm. Then you need to restart the php-fpm services and apache web server.

sudo service php-fpm7.2 restart

Common Issues After Installation

It might happen that even after proper installation, upon opening your Akeneo admin dashboard, you see a loading screen. In that case, do check for the following solution:

• Webpack Installation: If you get the below error

It means that web pack is not installed in your system. Run the following command.

npm install --save-prod webpack
npm install

• Module routing.yml is not configured properly. Re-check the routing.yml file as mentioned in the 3rd step of Module Installation
• Clear your browser cache.

• From the PIM directory, run the command below over the NO-DOCKER Instance.

./src/Webkul/ApiBoosterBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=true

• Run the command below over the PIM directory’s DOCKER instance.

./src/Webkul/ApiBoosterBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=false

After successful installation of the module PIM Cache for Akeneo, you will see the Webkul API Booster icon on the left side of the dashboard as shown below:

In this module all resources of the catalog structure that need to be defined when creating or updating a product or a product model :

• Attribute
• Attribute option
• Category
• Attribute group
• Association type
• Locale
• Channel
• Currency
• Reference entity record
• Asset

While adding or updating data to a product, As the Akeneo API is really strict, you need to format that data correctly. Some of the examples are in the below image.

Now to set up the booster navigate to Webkul API Booster>>Connection Setup. After that, you have to select the title.

The two most known cache solutions are probably Memcached and Redis. They both work well for our use case and both have their pros and cons

After entering the Title you need to enter the DNS String for the connection after that click on the Save button.

So, that was much about the User Guide of Akeneo API Booster for any queries or doubts reach out to us at [email protected]. You can also raise a ticket at our HelpDesk System.

Please explore our Akeneo Development Services and Quality Akeneo Extensions.