Multi Akeneo Syndication

Multi Akeneo Syndication help of this connector, you can export/import product data from one Akeneo to multiple Akeneo.

This connector helps the admin to easily export/import product data categories, attributes, family, attribute options products, and product models from Akeneo to Akeneo.

Admin can do integration between Akeneo to Akeneo using the API key and export/import data locale-wise. Using this module admin can filter data to be exported based on Category, family, Completeness, etc, and export them to multiple Akeneo.

Check a brief overview of the plugin –

Please Note –

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

• Export/Import Categories from Akeneo to Akeneo
• Export/Import Attribute and options from Akeneo to Akeneo
• Import/Export Family and Variants from Akeneo to Akeneo
• Filter data to be Exported based on Category, family, Completeness, Time conditions, Identifier(SKU), Language, and Currency for Product Export.
• Export/Import Product and Product Models from Akeneo to Akeneo
• Export Product and Product Model Images

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

Two different types of module installation processes are available for the module.

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

3: Use composer to install the extension.

         composer require webkul/multiakeneosyndicationbundle

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

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

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

Please follow these steps for installing Multi Akeneo Syndication 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\MultiAkeneoSyndicationBundle\MultiAkeneoSyndicationBundle::class => ['all' => true],

in return array.

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

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

php -d memory_limit=4G /usr/local/bin/composer require akeneo/api-php-client php-http/guzzle6-adapter:^2.0 http-interop/http-factory-guzzle:^1.0 --no-scripts

To run the Quick export in Akeneo 5.0.x, you need to run the below command.

Install composer dependency

php -d memory_limit=4G /usr/local/bin/composer --prefer-dist --no-scripts require navneetbhardwaj/akeneo-quickexport-configurator;

After that, register bundle in config/bundles.php

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

Define routing to create a file in the config/routes/wk_quick_export.yml

wk_quick_expoort:
    resource: "@QuickExportConfiguratorBundle/Resources/config/routing.yml"
    prefix: /

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

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

6– 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 Multi Akeneo Syndication 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\MultiAkeneoSyndicationBundle\MultiAkeneoSyndicationBundle(),

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

akeneotoakeneo:
   resource: "@MultiAkeneoSyndicationBundle/Resources/config/routing.yml"
   prefix:  /

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

php -d memory_limit=4G /usr/local/bin/composer require akeneo/api-php-client php-http/guzzle6-adapter:^2.0 http-interop/http-factory-guzzle:^1.0 --no-scripts

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

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

6 – 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 the 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/MultiAkeneoSyndicationBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=true

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

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

The admin can easily generate API keys. For this, the admin will navigate to your Store terminal and then run this command in your store terminal as per the below image.

php bin/console multiakeneosyndication:create:apicredential

Copy the client id and client secret in Multi Syndication Connection Credentials Section. 

To Create API Key in Another Akeneo you have to navigate to Connect>>Connection settings>>Create connections.

After clicking on create button fill in the details like the label, code, and flow type.

Now after filling in the details click to save button. After that add these details to another Akeneo to setup credentials

After installing the module in Akeneo, you need to set up the other Akeneo API keys. For this, log into Akeneo then navigate to Multi Akeneo Syndication Connector>Create.

• Credentials – In this you need to add your Akeneo instance URL.
• Client Id – In this, you need to copy the Client Id from another Akeneo in Which you want to export the data.
• Client Secret Key – In this, you need to copy the Secret key from another Akeneo in Which you want to export the data.
• Username – In this, you need to copy the Username from another Akeneo in Which you want to export the data.
• Password – In this, you need to copy the password from your other Akeneo in Which you want to export the data.
• Akeneo Version – Here you need to select the Akeneo version from the Dropdown.

After that click on to Save button.

You can also create a product in Akeneo. Therefore, navigate to Products. Then click the  Create button.

Now, you need to choose your action – as Product or Product Model as per the below image. You can select-

• Product – if you want to create simple products.

Enter the SKU, choose a family, then click the Save button as per the below image.

Product Family – This is a set of attributes that will be the same for all products belonging to a family.

The product family represents product type, imposes product information structure, and defines the list of attributes for a product that it belongs to.

Add Product Details

Now you need to provide information about the product.

Enter the details like name, collection, description, etc.

Select Attribute

For adding product information, select the attribute options you require. Therefore, you can also create new options for the attribute.

The following Attributes from Akeneo are supported for export:

• Text
• Text Area
• Number
• Date
• Yes/No
• Select
• Price
• Metric
• Image

You can also add product details like price, design, weight, color, etc.

Upload Image

Click the upload picture section or use the drag and drop feature to add a product image.

Select Category

After entering all the product information. Then you can also select Categories for the created product.

To export the products, first of all, you need to create the Export Profile. Therefore, navigate to Exports -> Create Export Profile as per the below image.

This will redirect you to the Export Profile page. Therefore, you will enter a unique code, label then select a job profile.

Then click Save.

Filter The Data

You can export the filtered data. Therefore, navigate to the Content section as per the below image.

You can filter the data as per-

• Channel – This selects the relevant channel of products to export.
• Locales – Depending as per your choice multiple locals can be selected.
• Attributes – select the product attributes that you want to export. You can either select all attributes else click the edit button to select the attributes.

You will be navigated to the “Attribute” page when clicking the edit button as per the below image.

Here, click on the left side to select a specific attribute group. Then select the displayed attributes as per the choice.

Filter The Products.

Akeneo enables you to decide which products to export.

Family

Select one or more product families to export to Akeneo. If you want to export products belonging to specific families, click on the drop-down list then click on the families to add in the field like clothing, shoes, t-shirts

Time Condition

You can now export your product on a specific time condition.

• No date condition (default option) – Products are not filtered using time conditions.
• Updated products over the last n days (e.g. 6) – This filter the products that were updated during the last six days, enter 6 value.
• Updated products since this date – To filter the products that were updated during a specific date, select a date.
• Products updated since last export –The products that were updated during the last update will be filtered.

Category

You can configure the categories of the channel tree you want to export. For example, you want to export clothing products to update.

By default, all categories are exported. To select a category, then click the Edit button the categories of the channel tree are displayed.

Identifier

You can select product identifiers to export the product. Therefore, you can select multiple product identifiers that should be separated by comma, space, or line breaks.

Credentials

You have to select a credential in which the product will be exported.

After that click the  Save button.

Export Now

After creating the export profile, click on the Export button as per the below image.

Note: Before exporting the product you have to export category, family attribute option and attributes.

Execution Process

After the execution of the export process, you can check the process summary and errors if present.

After the completion of the export process, you can check the products on the other Akeneo product page.

The admin can view the products so if there will be any changes in the product edit form of Akeneo as per the below image.

Admin can also create a variant product in Akeneo, for this click on the product option then click to create

Then select the product model.

• Product Model –  If you want to create a variant product with variations.

Select Product Family:

This is a set of attributes that will be the same for all products belonging to a family in which variants are added.

Enter the code, choose a family, then click the Save button as per the below image.

Add Product Details

Now you need to provide information about the product. Similarly to the simple product.

Then add variant:

Click on the selected variants as per the below image.

Fill in the variant and code:

Select the variant which is available and give them some specific code.

Select the variant then click to Save.

Then export the product to another Akeneo.

Important Note:

Before exporting the product model admin needs to export the variant and product for that you need to run the two jobs Webkul Multi Akeneo Syndication Family And Variant Export and Webkul Multi Akeneo Syndication Product Export job.

After that create an export product model and run the job.

After the completion of the export process, you can check the product model on the other Akeneo product page.

The admin can view the products so if there will be any changes in the product edit form of Akeneo as per the below image.

To import the products, first of all, you need to create the Import Profile. Therefore, navigate to Imports -> Create Import Profile as per the below image.

After creating a job click on the Content section, then you can select the channel and locales for import product data.

Setup Credentials – In case you are managing multiple Akeneo, you can select the Akeneo credential from which you want to import the data.

Once everything is set up correctly, you just need to click the Import Now button then the import execution process will start.

From the following screenshot, you can see the number of categories, attribute groups, attributes, etc are being imported.

This was all about the Multi Akeneo Syndication. I hope you must have 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.

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.