Akeneo History Management

Akeneo History Management allows the user to restore the older version of your product along with its old values. Whenever any changes are made to the product information then it will reflect on its Manage History tab. This module adds the Manage History tab which helps users to view all the changes as per the versions of that product. Users can even click on the “Restore Old Data” button to restore the previous version values of that product.

Check the plugin overview –

Basic Requirements:

• This module works with Akeneo 3.0.x, 3.1.x, 3.2.x, 4.0.x,5.0.x, 6.0.x and 7.0.x. Download Akeneo from here
• Node and Yarn packages need to be installed.
• This module is compatible with the Akeneo community 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.

• Restore the previous values of the product.
• The user can view all the changed values of any product under the Manage History tab.
• Can give permission to different users for data restoration.
• Can restore the media files as well as docs of any product.
• This module is compatible with Akeneo latest version 7.0.x

For the module, there are two different installation processes available.

1. Composer Installation
2. Manual Installation

Installation using Composer Installation

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 and 7.x

{
  "scripts": {
        "post-update-cmd": [
           "vendor/webkul/akeneohistorymanagementbundle/src/Webkul/AkeneoHistoryManagementBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
        ],
        "post-install-cmd": [
           "vendor/webkul/akeneohistorymanagementbundle/src/Webkul/AkeneoHistoryManagementBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
        ],
        "post-create-project-cmd": [
          "vendor/webkul/akeneohistorymanagementbundle/src/Webkul/AkeneoHistoryManagementBundle/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/akeneohistorymanagementbundle/composer_install.sh"
        ],
        "post-install-cmd": [
           
"vendor/webkul/akeneohistorymanagementbundle/composer_install.sh"
        ],
        "post-create-project-cmd": [
         
"vendor/webkul/akeneohistorymanagementbundle/composer_install.sh"
       ]
   },
  "repositories": [{
    "type": "composer",
    "url": "https://akeneorepo.webkul.com/"
  }]
}

3: Use composer to install the extension.

         composer require webkul/akeneohistorymanagementbundle

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

•  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/AkeneoHistoryManagementBundle/install/config.sh COMPOSER=false NO_DOCKER=true

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

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

Please follow the below steps for installing the Akeneo History Management module in your Akeneo PIM platform.

• Unzip the respective extension zip then merge the “src” folder into the Akeneo project root directory.

• Goto config/Bundles.php then add line:

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

in return array.

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

• Run this command after ssh to your akeneo server by terminal and navigating to Akeneo installation directory (ex. cd /opt/bitnami/apps/akeneo/htdocs).

php bin/console ca:cl --env=prod && php bin/console akeneohistorymanagement:setup:install

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

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

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

new Webkul\AkeneoHistoryManagementBundle\AkeneoHistoryManagementBundle(),

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

wk_akeneo_history_management:
   resource: "@AkeneoHistoryManagementBundle/Resources/config/routing.yml"
   prefix: /

4 –Run this command after ssh to your akeneo server by terminal and navigating to Akeneo installation directory (ex. cd /opt/bitnami/apps/akeneo/htdocs).

php bin/console ca:cl --env=prod && php bin/console akeneohistorymanagement:setup:install

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.

Uninstall Module: For Akeneo 6 and 7

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

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

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

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

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 found all the product lists created by you or exported from any channel.

After that click on product then on Manage History menu entry.

If the product is new there is no modification in the product then in Manage History the button Restore will not be visible.

Once you will modified any information in the product then in Manage History “Restore Old Data” button will be visible.

Ro restore the old value click on restore data then it will redirect to new page for the confirmation.

After that click on ok. then you can check the previous value and updated value in the product.

It’s totally possible with the restore old data feature. You can browse through the whole history of a product to find a version that is good according to your point of view and then, restores it.

Image Restore

In product image when you will restore the data then in old and new value image path will be visible.

Associations Restore

In this module you can restore the associate product.

To provide the permission to Akeneo History Management. You need to give permission to the users.

For that you need to navigate to System>>Roles. Then create new role and the allow the permission.

After that navigate to System>>Users then select the user to allow the permission.

Click on the check box to add Akeneo History Managment Conmector.

Note – If you want to export and store product data on Oracle and use it on other software with the help of API then you can use the Oracle Akeneo Connector extension.

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