User Guide for Akeneo Configurable Product Importer

The Akeneo Configurable Product Importer module enables the admin to copy any configurable product’s variants to another configurable product in the same family.

The admin can choose the product and variants that need to be imported, as well as run the import job for the configurable product variants that need to be copied.

Check the overview of the plugin –

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

Features

• Duplicate any configurable product’s variants.
• Users will have the ability to import an infinite number of variants.
• The users can make a copy of a product variants that belongs to the same family.
• The users can select the configurable product and variants to be copied.
• This module is compatible with the latest Akeneo version 7.0.x

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

3: Use composer to install the extension.

 composer require webkul/akeneoconfigurablebundle

4: Fill out the authentication.

5: Success Message.

5: Clear your browser’s cache.

Manual Installation For Akeneo 6 and 7

• Unzip the respective extension zip and then merge “src” folder into akeneo project
• Run the below command over the NO-DOCKER Instance from the PIM directory.

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

• Run the below command over the docker Instance from the PIM directory

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

Installing Module For Version 4.0.x to 5.0.x

Please follow these steps for installing the Akeneo Configurable Product Importer 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\AkeneoConfigurableBundle\AkeneoConfigurableBundle::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

php bin/console ca:cl --env=prod;php bin/console wk-configurable:setup:install  --env=prod;

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;

Installing Module for Version 2.x to 3.x

Please follow these steps for installing the Akeneo Configurable Product Importer 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\AkeneoConfigurableBundle\AkeneoConfigurableBundle(),

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

wk_configurable_product:
	    resource: "@AkeneoConfigurableBundle/Resources/config/routing.yml"
	    prefix:   /

4. You have to navigate first to Akeneo installation directory (Ex: cd /opt/bitnami/apps/akeneo/htdocs). After SSH, you have to run the command to your Akeneo server by the terminal.

php bin/console ca:cl --env=prod;php bin/console wk-configurable:setup:install  --env=prod;

5 – You have to restart your web server like Apache, Nginx. Run the command for the Apache webserver.

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.

Uninstall Module: For Akeneo 6 and 7

• Run the below command over the NO-DOCKER Instance from the PIM directory

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

• Run the below command over the docker Instance from the PIM directory

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

Create a Product Model

To create a variant product in Akeneo, the admin needs to navigate through Products -> Create Product as seen in the screenshot given below.

After clicking on the CREATE button, the admin must select the product model as seen in the screenshot given below.

The admin must enter details such as code, family, and variant after selecting the product model.

Afterward, the admin needs to click on the SAVE button and can set the information for common and variant products as seen in the screenshot given below.

Configurable Product Mapping

The Akeneo Configurable Product Importer symbol appears in the Akeneo dashboard when the connector is installed as seen in the screenshot given below.

Mapping Feilds in Akeneo Configurable Product Importer

To set up Akeneo configurable product importer admin needs to click on the Akeneo Configurable Product Importer icon.

In this, the admin maps their product model with the variant products they want to import.

To add a new mapping the admin needs to first select the product click on ADD NEW MAPPING button.

Afterward, the admin needs to map the variants that need to be imported into a new product.

After selecting the variants the admin needs to click on the SAVE button as seen in the screenshot given below.

Create Import profile

To import the configurable product, the admin needs to create an import profile and then run it.

To begin, the admin needs to navigate through Imports > Create Import Profile, then enter a unique code, a label, and a job profile.

After that, the admin must select the Job profile and then click the Save button to view the export profile.

Afterward, the admin needs to select the Job profile and click on the Save button and see the export profile.

Here, the admin can check properties and history, then click the SAVE button and proceed to the next step to run this profile.

Product Import

The admin needs to click on Import Now button to start the execution process to import the product.

After clicking on Import Now button wait for the execution process to complete.

After the completion of the import job, the variant products will appear in the product as seen in the screenshot given below.

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.

Support

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