Custom XLSX Connector for Akeneo

Custom Xlsx Connector for Akeneo With this connector, you can extract your product and product model data into a customized Xlsx file and use it for uploading product information to third-party platforms, suppliers, or other applications. The extension enables you to map Akeneo fields with the Xlsx fields (columns) for creating Xlsx files.

Check a brief 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.

• Export/Import products from Akeneo into Xlsx file
• Product export variations from Akeneo into Xlsx file
• Export multiple images of a product from Akeneo to Xlsx is a link
• Use a fixed value for some fields when exporting data.
• Mapping of Akeneo fields withXlsx field code
• Create multiple stores
• Create dynamic custom fields for every store
• Select types that the custom field support at the time of creating
• Support option to the export category, attribute, and select type attribute option label
• Export category and family with a product
• Variant product mapping is also available
• This module is compatible with the latest Akeneo version 7.0.x
• Filter Data to be exported based on Category, Family, Completeness, Time conditions, Identifier (SKU), Language, and Currency.

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

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

3: Use composer to install the extension.

         composer require webkul/webkulcustomxlsxbundle

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

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

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

Please follow these steps for installing the Custom Xlsx Connector for the Akeneo 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 config/Bundles.php then add line:

Webkul\WebkulCustomXlsxBundle\WebkulCustomXlsxBundle::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

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

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;

Please follow these steps for installing the Custom XLSX Connector for Akeneo 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\WebkulCustomXlsxBundle\WebkulCustomXlsxBundle(),

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

webkul_xlsx:
    resource: "@WebkulCustomXlsxBundle/Resources/config/routing.yml"
    prefix:    /

4 -You have to navigate to Akeneo Installation Directory(Ex. cd /opt/bitnami/apps/akeneo/htdocs ). Run this command after ssh to your akeneo server by the terminal.

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

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

sudo service php-fpm7.2 restart

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.

• From the PIM directory, run the command below over the NO-DOCKER Instance.

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

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

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

Akeneo Xlsx Mapping

After installing the connector in Akeneo, You can see the Webkul Custom Xlsx Connector connector icon at the Akeneo dashboard.

XLSX Connector Product Mapping Fields

You can click on the Webkul Xlsx connector icon to set up an Xlsx connector. In this, you can create map multiple templates.

To create a new template click on create the template.

After that, it will redirect you to the new page in which you have to enter the name of the template.

Then click on to Save button.

Now to map the attributes in that template click on the template.

After that, you can see the other fields like Akeneo fields. With these fields, you can do the correct mapping of the product attributes for your Akeneo and eCommerce products fields.

Akeneo Fields – 

In the Akeneo fields, you can map the Akeneo attributes fields with the eCommerce store Xlsx fields that you want to export. You can select the attributes in the dropdown as you have created and want to map.

Default Value – 

In the default value fields, you can fix the default value of the attributes. Example: If you have a product quantity attribute then you can fix the size of the quantity.

Variant Product Mapping –

In this mapping, you can export the variant product information along with the parent product information.

Example: If you have a variant product with a variant like color – Red, White. Then, you can send the product information like the price for the variant product.

Add Mapping Xlsx Fields

If you want to map the more Xlsx fields with the Akeneo fields, you can create a new mapping with the Map more fields option.

In the variant export mapping fields, you can mention the attribute for the variant product name. For example, You have a variant name “color” and value “Red” then you can mention the variant code and value in the Variant Export Mapping fields name.

Other Mapping:

• Xlsx Category Field – In this section you have to enter the category header name as entered in the XLSX file.
• Multiple Value Separator – You can add multiple value separator ex- (,) food, clothes, accessories.
• Seperate product family code from dash(-) – If you want to separate attribute name and attribute value with a separator like (-)
• Xlsx Family Field – In this section you have to enter the family header name as entered in the XLSX file.
• Xlsx Product Parent Field – you can save the Akeneo product parent field in this which you want to export.
• Export unit with metric attributes – Enable this option if you want to export metric attributes.
• Xlsx Family Variant Field – In this section you have to enter the family variant header name as entered in the XLSX file.
• Xlsx Product Enabled Field – In this section, you have to enter the status of the header name as entered in the XLSX file. If you want to export an enabled product then in the XLSX file value must be 1 and if want to disable then the value should be 0.

After that, map the attributes which you want to import in Akeneo. With these fields, you can do the correct mapping of the product attributes to your Akeneo and eCommerce products fields.

Other Mapping:

• Xlsx Category Field –  In this section you have to enter the category header name as entered in the XLSX file.
• Family Field – In this section you have to enter the family header name as entered in the XLSX file.
• Xlsx Product Parent Field – You can save the Akeneo product parent field in this which you want to import.
• Multiple Value Separator – You can add multiple value separators ex- (,) food, clothes, and accessories.
• Xlsx Family Variant Field – In this section you have to enter the family variant header name as entered in the XLSX file.
• Xlsx Product Enabled Field – In this section, you have to enter the status of the header name as entered in the XLSX file. If you want to import an enabled product then in the XLSX file value must be 1 and if want to disable then the value should be 0.

Note: Parent header is required for the import of variants, while family variant header is required for the import of product models.

For creating the product in Akeneo, you can follow our user guide. Create Product and Product Variant in Akeneo 

To create a product in Akeneo, go to navigate to Products then click the Create button. Now, you need to choose the product type – Product or Product Model.

Product – Select this type for creating simple and virtual products.

Product Model – Select this type for creating a configurable product with variation

Now to enter the required SKU, choose a family, then click the Save button.

SKU– Fill in the product’s unique code.

Product Family – A family 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. First, select the Channel and Locale then enter the price, name, and description.

Now to export your product data you need to create a job profile then execute it.

First, go to Exports>Create Export Profile after that enter a unique code, the label then select a job profile.

After that, you have to select the Job profile. For creating an export profile, you have to click on the Save button.

After clicking on the save button, you can see the export profile.

Properties:

In this, you have to select the storage type and enter the file path.

Global Settings:

In this, you have to fill in the details given below in the image like decimal separator, data formate, etc.

Setup Store Template:

In this, you can select the template, and after that click the Save button and follow the next step to execute this profile.

Now go to the Content section then select the following options:

Channel – Each export job can only be linked to one channel, please select the relevant channel of products to export.

Locales – Select one or more Locales depending on your requirements.

Currency – You have to select here one currency.

Attributes – You can select which product attributes you want to export all or a few of them. Click the Edit button to select the attributes.

Edit Attributes

To make your own attribute selection, click on the left side to select a specific attribute group (or All groups to display all attributes). The selected attributes will be displayed as columns in your export file.

Filter The Products

Now you need to decide which products to export an Xlsx file.

Family

After that one or more product families to export in the Xlsx file. 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.

Status

You can also filter on the status of your products, three options available:

• All – to export all products whatever their status is
• Enabled (default option) – only to export enabled products
• Disabled – to only export enabled products

Completeness

This enables you to filter on the completeness of selected locales. Four options on completeness are proposed:

• No condition on completeness – all products will be exported whatever their completeness is.
• Complete on at least one selected locale (default option) – products must be complete on at least one locale
• Not complete on all selected locales – In these products must not be complete on all locales (if you have selected more than one locale).
• Complete on all selected locales – products must be complete on all locales (if you have selected more than one locale).

Time Condition

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

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

Category

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

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

Identifier

You can make a selection of identifiers to export by adding them to the SKU field. You can copy and paste a list of identifiers, separated them by using comma, space, or line breaks.

Product Export

After creating and filtering data in the Export profile, you can see the Export Now button in Akeneo.

Now after clicking on the Save button, Wait for the execution process to complete and check the errors. After the completion of the export job, the products will appear in the Xlsx file.

Now to export your product data you need to create a job profile and then execute it.

First, go to Imports>Create Import profile.

After that enter a unique code, the label then select the Job profile. For creating an import profile, you have to click on the Save button.

After clicking on the save button, you can see the import profile.

Properties:

In this, you have to select the storage type and enter the file path.

Global Settings:

In this, you have to fill in the details given below in the image like decimal separator, and data formate.

Setup Store Template:

In this, you can select the template, and after that click the Save button and follow the next step to execute this profile.

Product Import

After creating and adding data to the Export profile, you can see the Import Now button in Akeneo.

Add File path for import.

As well as you can add upload files for import.

Now after clicking on the Save button, Wait for the execution process to complete and check the errors. After the completion of the import job, the products will appear in the Akeneo.

That was all about the  Custom Xlsx Connector for Akeneo. Moreover, if you have any doubts or queries regarding the extension get back to us at [email protected] or create a ticket at our HelpDesk system.

Please explore our Akeneo Development Services and Quality Akeneo Extensions.