Magento 2 Akeneo Bulk Synchronization

Magento 2 Akeneo Bulk Synchronizations enable the bulk export of products and product models from Akeneo to Magento 2.

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.

• This module is compatible with 5.0.x, 6.0.x and 7.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.

• You must be using Magento 2.4.x
• This module works with Akeneo 5.0.x, 6.0.x and 7.0.x Download Akeneo.
• 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:

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

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

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

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

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

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

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

Now click on the Done Button.

For the new version of module:

Admin need to allow permission to the user for that, navigate to Admin -> System -> User Roles -> Edit your User -> Role Resources.

Select the below mentioned roles for the users:

• Catalog, Inventory, Products, Categories, Admin Seller Management API, Marketplace Management, Customers
• Stores, Settings, Currency, Attributes, Other Settings

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

• Composer Installation
• Manual 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 and 7.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.

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.

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;

For Akeneo 6.0.x and 7.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

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

Now we added the product to Que

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

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.

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

• Host name(URL of Magento store)
• Username
• Password

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.

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 – To create the Simple Product we need to select the product option then choose SKU and family for the product and then Save it.

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

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

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.

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

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

Important Note –

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

• Simple product bulk export job
• Configurable and variant 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.

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.

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

Note: When you select the credential in the export or import job, only the selected channel and locale in the store view mapping will be listed in the export job.
For example, if you have selected mobile and e-commerce channels in store view mapping,.

Then only mobile and e-commerce channels will be visible in the export profile after selecting the credential.

Once you fill up all the details and save it. Then you have the option to run the 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.

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.

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

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

Check all the options in the bulk log.

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

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.