Back to Top

Magento 2 Akeneo Bulk Synchronization

Updated 10 October 2023

Introduction

This blog is all about the features and functionality of the Magento 2 Akeneo Bulk Synchronization.

With this amazing Webkul module, Admin can quickly and easily export bulk product and product model data from Akeneo to Magento 2 Store. This module takes only a few hours to complete this process.

Note

  • This module is compatible with 5.0.x and 6.0.x versions.
  • This Module is an add-on to the Magento 2 Akeneo Connector. In order to use this module, you must install the Magento 2 Akeneo Connector.
  • Rabbit MQ will be required to queue imported data in Magento 2.

Basic Requirments

  • You must be using Magento 2.4.x
  • This module works with Akeneo 5.0.x. and 6.0.x Download Akeneo from here.
  • Node and Yarn Packages to be installed.
  • This module is compatible with the Akeneo community and Enterprise (Flexibility) editions.
  • 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.
  • Rabbit MQ configuration with Magento 2.

Check the functionality of the module in the below mentioned video to understand the workflow:

kyXdPJHlBCs

Feature

  • Export bulk product data in Akeneo to Magento 2.
  • Export bulk Product model in Akeneo to Magento 2.
  • Credentials must be selected on the basis of the Magento Version.
  • Works with simple and configurable Products.

Magento (Adobe Commerce) API Integration

For creating API in Magento, login to your admin panel then go to ‘System > Integrations > Add New Integration’.

In the ‘Name’ field, add any unique name for identification and enter the admin panel password in ‘Your Password’.

Searching for an experienced
Akeneo Company ?
Find out More

NOTE:- Please leave the rest of the field blank, then proceed to the next step.

Magento-API-

Select APIs for Integration After you have entered the integration information, go to the API section and select the following resources and click Save.

Catalog-1

After that, once the API is created, you will see the integration in the list.

Akeneo-Demo-bulk

Now click on the Reauthorize button. Then the following window will appear.

Reauthorize

The API credentials will be generated as follows. After that, you need to copy Access Tokens and then paste them into the Akeneo configuration.

Actiivated-Demo-link-

Now click on the Done Button.

Installation Process

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

  • Composer Installation
  • Manual Installation

Installation using Composer Installation

Read This Blog on How to install the Webkul Akeneo connector via Composer Before starting the installation via composer.

Step 1: Get the Access Key [Raise a Ticket]

For Akeneo 6.0.x.

Step 2: Add our repository and installation script in your Akeneo composer.json

{
  "scripts": {
        "post-update-cmd": [
           "vendor/webkul/magento2bulkapibundle/src/Webkul/Magento2BulkApiBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
        ],
        "post-install-cmd": [
           "vendor/webkul/magento2bulkapibundle/src/Webkul/Magento2BulkApiBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
        ],
        "post-create-project-cmd": [
          "vendor/webkul/magento2bulkapibundle/src/Webkul/Magento2BulkApiBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
       ]
   },
  "repositories": [{
    "type": "composer",
    "url": "https://akeneorepo.webkul.com/"
  }]
}

Step 3: Install the extension using composer.

composer require webkul/magento2bulkapibundle

For Akeneo 5.0.x.

Step 2: Add our repository and installation script to your Akeneo composer.json

{
  "scripts": {
        "post-update-cmd": [
           "vendor/webkul/magento2bulkapibundle/composer_install.sh"
        ],
        "post-install-cmd": [
           "vendor/webkul/magento2bulkapibundle/composer_install.sh"
        ],
        "post-create-project-cmd": [
          "vendor/webkul/magento2bulkapibundle/composer_install.sh"
       ]
   },
  "repositories": [{
    "type": "composer",
    "url": "https://akeneorepo.webkul.com/"
  }]
}

3- Install the extension using composer.

composer require webkul/magento2bulkapibundle:1.0.0

4- Fill in the authentication.

5- Success Message

6-Clear the Browser cache.

Please follow these steps for installing the Magento 2 Akeneo bulk synchronization module in your Akeneo PIM platform.

Manual Installation Akeneo Version 6.0.x

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

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

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

Run the below command over the DOCKER Instance from the PIM directory

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

For Akeneo Version 5.0.x

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

screenshot___2023_02_07t172706.060

Goto config/Bundles.php and add line:

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

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

Non-Docker instances:

 rm -rf var/cache/ && php bin/console magento2:setup:install

Docker instance:

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;

Uninstall Module

For Akeneo 6.0.x

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

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

Run the below command over the DOCKER Instance from the PIM directory.

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

Documentation

To export simple and configurable products. First you need to install RabbitMQ and configure it with Magento 2.

Steps to follow

  • Go to the Magento 2 directory path.
  • Edit the .env file to the path /app/etc.
  • Add the below code
        'queue' => [
            'consumers_wait_for_messages' => 1,
            'amqp' => [
                'host' => 'localhost',
                'port' => '5672',
                'user' => 'username',
                'password' => 'password',
                'virtualhost' => '/'
            ]
        ]
  • Need to update the code from magento2 end(directory path: vendor/magento/framework-amqp/Config.php at line no. 171)
        Search line - $this->channel = $this->connection->channel();
            Add - $this->channel->basic_qos(null, 1, null);
            in the below line.
  • After configure the rabbitMQ you need to run the below commands from the magento2 directory path
        php bin/magento setup:upgrade
        php bin/magento setup:di:compile
        php bin/magento setup:static-content:deploy -f
        php bin/magento cache:clean
        php bin/magento indexer:reindex
        php bin/magento cache:flush
  • To sync the products run the below command from the Magento 2 directory path to sync the products run the below command from the magento2 directory path
        php bin/magento queue:consumers:start async.operations.all

RabbitMQ Configuration

Now we added the product to Que

rabbitmq-1

Track Magento 2 Akeneo Bulk Synchronization

You can track this module once you work on the Job Profile Section. To view this module export job you have to navigate Export > Create Export Profile > Job

Magento-2-Supported-Jobs-

Setup Credentials in Akeneo

After successfully installing Magento 2 Akeneo Connector in Akeneo, you should configure the Magento API credentials in Akeneo.

Please log in to Akeneo then follow Magento 2 Connector > Setup Credentials.

Credentials

In Hostname, you should enter your website URL and then enter the Magento API integration tokens as created.

  • Host name
  • Access Token

Set up Attribute Mapping –

After you configure the credentials, you will need to map the credentials field between Magento to Akeneo. For the mapping section please have a look at Magento 2 Akeneo connector.

Mapping-

Create products in Akeneo

To create products in Akeneo, first go to the products and click on the Create button.

Then there is the option to choose the type of product.

Product-Create

Product – To create the Simple Product we need to select the product option then choose SKU and family for the product and then Save it.

Product-Details-

Add Product Details

Now, provide the product information and enter details such as color, size, name and brand and upload the product.

Akeneo-6-product-

Supported Attribute Type

To add product details, choose the attribute options you need. In addition, you can create new options for the attribute.

The following Akeneo attributes are supported for exportation:

  • Text
  • Text-Area
  • Number
  • Date
  • Boolean
  • Select
  • Price
  • Matric
  • Image

Multi-locale Information

Once you are done with the attributes Section, then it will redirect you to a new option (add information) for other languages and store views.

Akeeno-6-Locale-

Select Categories

After entering all the product information. Now you can also select categories for the created product.

Select-categories-Akeneo-6

Creating Variants Product in Akeneo

For the creation of Variants types of products, you can check the Magento2 Akeneo Connector.

Magento 2 Akeneo Bulk Synchronization function flow

Important Note –

Before exporting the Magento 2 Akeneo Bulk Synchronization Job we have to export attributes, attribute options, Categories and Families.

Magento2 Akeneo Bulk Synchronization supported Export Job

  • Simple product bulk export job
  • Configurable and variant product bulk export job

Simple Product Bulk Export Job

In order to export the simple product in bulk from Akeneo we have to go to the export section and create an export profile for the simple product.

Simple-Product-Export-Job-Select-

Now click on the save button to run this job. Now you can check the process from the edit button.

Properties Option – From here you can check your code, label and export category according to your mapping.

Simple-Properties

Content Option – From here you can filter the data according to channel, locales, families and Categories.

Content-Simple

Once you fill up all the details and save it. Then you have the option to run the export job.

Simple-product-Job-Run

Configurable and variant product bulk export job

In order to export the configurable and variant product in bulk from Akeneo to Magento 2. We have to go to the export section and create an export profile for the configurable and variant product.

Configurable-product-export

Once you serve it, you have an edit option to select and filter the data.

Properties Section – You can code, label and export categories according to your mapping for configurable products.

Configurable-Properties

Content Section – From here you can filter the data according to channel, locales, families and Categories.

Content-COnfigurable-

Once you fill up all the details and save it. Then you have the option to run the export job.

Configurable-

Bulk Log Option

Check all the options in the bulk log.

bulk_log-1

Magento 2 Product View Section –

Now finally you can see all the export Bulk products in your Magento product catalog.

Magento2-Product-View-

Support

So, that is much about the user guide of Magento 2 Akeneo Bulk Synchronization.

For any queries or doubts reach out to us at [email protected].

You can raise a ticket through our helpdesk system.

Please explore our Akeneo development services and quality extensions.

Current Product Version - 2.0.0

Supported Framework Version - Akeneo - 5.x.x and 6.x.x || Magento 2.4.x

Blog Version - Akeneo - 5.x.x and 6.x.x || Magento 2.4.x
  • Version Akeneo - 5.x.x and 6.x.x || Magento 2.4.x
  • Version 5.x.x and 6.x.x
. . .

Leave a Comment

Your email address will not be published. Required fields are marked*


Be the first to comment.

Back to Top

Message Sent!

If you have more details or questions, you can reply to the received confirmation email.

Back to Home

Table of Content