Akeneo Icecat Connector

Akeneo Icecat Connector allows you to supplement Akeneo PIM product data with the extensive Icecat catalog.

It works with an open Icecat free catalog.

This connector can only accommodate simple products.

The Akeneo Icecat App also helps in the import of Icecat catalogue content from Icecat to the Akeneo app.

Check a brief overview of the plugin –

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

• EAN attribute and product code will be used to match Icecat products via their web API.
• Only simple products are supported by Akeneo Icecat Connector.
• You can modify the icecat attribute type during attribute import under the Icecat attribute type mapping tab.
• In this Akeneo PIM attributes must also be mapped to Icecat features.
• Akeneo products will enrich via running a product enrich job.
• In this, you can map Icecat common attributes like Ean, Product code, Vendor (Brand), Name, Description, Short description, Summary description, Short summary description, and Pictures with Akeneo attribute through UI.
• Icecat Akeneo Connector is compatible with the latest Akeneo version 7.0.x
• In this, you can also do other Icecat feature mapping to map other Icecat feature attributes with the Akeneo attribute.
• You can also map the Icecat locale with the Akeneo locale.

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

3: Use composer to install the extension.

         composer require webkul/icecatconnectorbundle

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

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

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

Before installing the module you must require the connector dependencies.

php -d memory_limit=4G /usr/local/bin/composer --prefer-dist --no-scripts require guzzlehttp/guzzle 6.*;
php -d memory_limit=4G /usr/local/bin/composer --prefer-dist --no-scripts require prewk/xml-string-streamer 0.9.*;

Please follow the below steps for installing the Akeneo Icecat Connector 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\IcecatConnectorBundle\IcecatConnectorBundle::class => ['all' => true],

in return array.

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

• 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 icecat:setup:install

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;

Before installing the module you must require the connector dependencies.

php -d memory_limit=4G /usr/local/bin/composer --prefer-dist --no-scripts require guzzlehttp/guzzle 6.*;
php -d memory_limit=4G /usr/local/bin/composer --prefer-dist --no-scripts require prewk/xml-string-streamer 0.9.*;

Please follow the below steps for installing the Akeneo Icecat Connector module in your Akeneo PIM platform.

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

• Goto app/AppKernel.php then add the following line in function registerProjectBundles().

new Webkul\IcecatConnectorBundle\IcecatConnectorBundle(),

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

webkul_icecat_connector:
    resource: "@IcecatConnectorBundle/Resources/config/routing.yml"
    prefix: /

• 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 icecat:setup:install

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 a 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/IcecatConnectorBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=true

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

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

After you’ve successfully installed the module in Akeneo, you’ll notice an Icecat connector icon in the bottom left corner, as shown below.

Setup Credential

Note: You must first create a profile on Icecat’s end, where you must provide all of your information, including your username, password, and email address.

To set up a credential you have to click on the icon on the Icecat Connector.

After that, it will take you to a new page where you must fill in the information you entered in Icecat, such as:

• Icecat username
• Icecat password

After that, you have to click on Save to save the credentials.

Icecat Common Attributes Mapping

In this, you have to map your Akeneo attributes with the Icecat attribute so that they can syn properly and while importing data from Icecat to Akeneo there will be no error.

You have to map the following attributes:

• EAN attribute
• Product code
• Vendor (Brand)
• Name
• Title
• Description attribute
• Short description attribute
• Short summary description attribute
• Pictures attribute
• Summary description attribute

Icecat Other Attribute Mapping

Important :

Prior to the Icecat property being added, You must first perform the features mapping job before adding the Icecat attribute.

Feature Mapping Job

To do so, go to Import>>Create Import Profile and follow the steps. Then fill in the necessary information, such as the code, label, and job type(Features Mapping).

After that, click the Save button. Then, to start the execution process, click Import Now.

After completing the job, you’ll be able to see the imported Icecat attributes in a drop-down menu and select the attribute that best suits your needs.

Then you have to map the Icecat attributes with Akeneo attributes in which the value will be imported.

Icecat attribute type mapping

In this you can add a new Icecat attribute that is imported from Icecat then you can map that attribute with the Akeneo attribute type.

If you map the attribute type, the attribute from Icecat will be imported in the chosen attribute type to Akeneo.

If you don’t map the attribute type, the attribute will be imported according to the Icecat attribute type.

After you’ve mapped an attribute, you’ll need to create an import attribute job in Akeneo to import the attribute you’ve mapped.

Then click on the Icecat attribute to the import tab and select the attribute which you have mapped to import the attribute in Akeneo.

Click the Save button after you’ve picked the attribute.

Then, to start the work of importing attributes, click the import button.

You can see the attributes in the Akeneo attribute once the import procedure is complete.

Locale Mapping

In this section, you can map Akeneo local with Icecat local.

Then click on the Save button.

If you’ve entered an Icecat EAN number as an SKU in Akeneo, you’ll need to map product code to EAN in attribute mapping, as illustrated in the figure below.

In this Icecat Akeneo Connector, there are three types of import jobs.

• Features Mapping
• Import Attribute
• Enrich Product

Now to import and enrich Akeneo PIM product data with the rich Icecat catalog you have to create an import job for that navigate to Import>>Create Import Profile.

Then after clicking on create Import Profile it will redirect you to the new page in which you have to fill in details like:

• Code
• Label
• Job
  

After that click on Save then go to the Content section and select your channel & locales.

Then you can use various filters for deciding which products to import.

Therefore you can even import some specific products using their SKU values using commas for more than one SKU.

After that, click on Global setting in this you can do two things:

• Enable/Disable Download Image
• Fallback locale

Then click Save to save your changes, then Import, and wait for the product execution process to finish.

Once the import process is finished, you can see the product data filled.

This was all about the Akeneo Icecat Connector. I hope you must have the got the idea of our module. Thanks for taking the time in reading this blog.

And also, please don’t forget to share your feedback and suggestions under the comment box given below.

Moreover, If you have any queries or suggestions, then feel free to add a ticket at our HelpDesk system or reach out to us at [email protected].

Please explore our Akeneo Development Services and Quality Akeneo Extensions.