A Complete Guide to Akeneo Revision History

Akeneo Revision History: This module allows the admin to export the user’s product history in CSV and XLSX format for a single or many products.

It also allows the admin to export product data for a certain use as well as data for a specific product and product model.

After exporting the user’s product history, the administrator can view all details, including recent activity, time and date, version, author, and product.

Check the workflow of the plugin –

• Export the product history data into the CSV & XLSX format.
• Export product data for the specific user.
• This module is compatible with Akeneo 4 and 5.
• Export data for the particular product & product model.
• Export product data with the date condition.

1- Composer Installation

Read This Blog

Run the composer install command:

composer require webkul/versionhistoryexport

2- Manual Installation

Please follow these steps for installing the Akeneo Revision History module in your Akeneo PIM platform.

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

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

Webkul\VersionHistoryExportBundle\VersionHistoryExportBundle::class => ['all' => true]

in return array.

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

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

rm -rf var/cache && php bin/console versionhistoryexport: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;

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.

Create Product In Akeneo

To create a product in Akeneo, go to navigate to Products then click the Create button. Now, you need to choose the product type – as Product or Product Model.

Product – Select this type for creating simple and virtual products.

Product Model – Select this type for creating a configurable product with variations.

Now enter the required SKU, choose a family, then click the Save button.

Product Family – A family is a set of attributes that will be the same for all products belonging to a family. The product family represents products type, imposes product information structure and defines the list of attributes for a product that it belongs.

Product List

After creating the product in Akeneo you can check the product list. You will find all the product lists created by you or exported from any channel.

If you wish to change or update a product, simply click on it and make the necessary changes or updates.

You may view the modification history in the history tab after you’ve made any changes to the product.

After clicking the History tab, you’ll be able to see a list of users who have changed or updated the product’s data.

Then, by clicking on the user, you can view the user’s history, which has been updated with the previous value and the new value for the product.

Create Export Job Profile

Create a new export job to export product history data.

Go to Exports>Create Export Profile to make a new export job profile.

To create a new job profile, add a code, a label, and a job type.

This module allows you to create two types of export profiles.

•  CSV Version History 
• XLSX Version History

The export profile appears once you click the save button.

Global Settings:

You must fill in and enable the details shown in the image below.

• File Path – In this, you must include the file path where the generated file will be written to the file system.
• With Header – If you want to print the column names, such as entity, attribute fields or author, then enable this option.
• Export Product Model First – If you want to export product models before products, enable this option.

Go to the Content section now and choose from the following options:

• Locales – Depending on your needs, choose one Locales.
• Select User – If you want to export the product version history of a certain user, you must choose that user in this section.

• Family – If you want to export items from certain families, go to the drop-down menu and select the families you wish to include in the field.
• Time condition – You can now export your product on a specific time condition.
• Category –The categories of the channel tree that you want to export can be configured.
• Identifier – By adding them to the SKU field, you can construct a list of identifiers to export. A list of identifiers can be copied and pasted, with commas, spaces, and line breaks used to separate them.

In Akeneo, you’ll see the Export Now button after you’ve created and filtered data in the Export profile.

Now, wait for the execution process to complete before checking for errors after hitting the Save button.

The products will appear in the CSV file after the export job is completed.

Products History In CSV

You can download the CSV files after clicking the Download Generated files button.

You must create an XLSX export job in the same way as you performed a CSV export job.

You’ll see the Export Now button after you’ve created and filtered data in the Export profile.

Now, wait for the execution process to complete before checking for errors after hitting the Save button.

The products will appear in the XLSX file after the export job is completed.

Products History In Xlsx

You can download the XLSX files after clicking the Download Generated files button.

Support

So, that was much about the User Guide of Akeneo Revision History Extension 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.