Akeneo XML Connector

• This module works with Akeneo 2.0.x, 2.1.x, 2.2.x, 2.3.x, 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
• Also 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 attribute and attribute option.
• Import attribute and attribute option.
• Export Categories from Akeneo to XML File.
• Import Categories from XML File to Akeneo.
• Export Products and product model from Akeneo to XML File.
• Import Products and product model from XML File to Akeneo.
• Admin can do multiple XML mapping
• Import an XML file using a public URL and authenticate with a username and password.
• Using the module, you can import and export product models and variants.
• Import an image with a public image URL (jpg, jpeg).
• Import file (PDF) with public URL

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

3: Use composer to install the extension.

composer require webkul/xmlconnectorbundle

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

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

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

Please follow these steps for installing the Akeneo XML Connector module in your Akeneo PIM platform.

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

2 – After that goto config/Bundles.php and add the line:

Webkul\XmlConnectorBundle\XmlConnectorBundle::class => ['all' => true]

in the return array.

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

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

php bin/console xml:setup:install

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

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 Akeneo XML Connector module in your Akeneo PIM platform.

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

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

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

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

After successfully installing the connector in Akeneo, then you can see the XML Akeneo Connector icon at the Akeneo dashboard.

Then to create multiple templates, you have to navigate XML Akeneo Connector>>Create Templates.

After that, it will redirect to a new page and fill in the details to create a new template.

Fill in the following details:

Template Name: In this, you have to name the template.

Upload sample XML files for mapping – In this, you have to upload the XML file for the mapping of the header.

XML Multiproduct Tagname – In this, you have to add the header of the catalog which want to export in Akeneo.

XML product Tagname – In this, you have to add the header of the product that you want to export in Akeneo.

Sample template

 <CATALOG>
  <PRODUCT>
   <groups></groups>
   <Categories>master_accessories_bags,print_accessories,supplier_zaro</Categories>
   <Status>1</Status>
   <family>accessories</family>
   <Standard_Mapping>
    <SKU>1111111171</SKU>
    <Name>Bag</Name>
    <Price>10</Price>
    <Description>Add your own product description</Description>
    <Short_description>XML product short description</Short_description>
    <Release_Date>10/02/2022</Release_Date>
    <Collection>This is a multi-select attribute the added option should be mach to this attribute option.</Collection>
   </Standard_Mapping>
   <ERP>
    <EAN>1234567890183</EAN>
    <ERP_Name>Akeneo Webkul</ERP_Name>
    <Supplier>This is the simple select attribute, the given attribute option should be matched.</Supplier>
    <Brand>This is the simple select attribute, the given attribute option should be matched.</Brand>
   </ERP>
   <Technical>
    <Weight>500 GRAM</Weight>
    <Display_Dignonal>10</Display_Dignonal>
   </Technical>
   <Media>
    <Picture>Add image </Picture>
    <Model_Picture>http://vikas.akeneo6.com/media/cache/preview/0/2/5/a/025a3e1ad6ca565f0d4499933158156bab74e352_1e050b5d3ef20462eda8e812a103037804f1bedc_9de4eed38975f579860446c5b5d4e78c24736943_88a94c420b5f0.jpg</Model_Picture>
    <Variant_Picture></Variant_Picture>
    <Notice>add file</Notice>
   </Media>
   <SEO>
    <Meta_Title>add meta title</Meta_Title>
    <Meta_Description>Add meta Description</Meta_Description>
    <Meta_Keywords>Add meta keyword</Meta_Keywords>
   </SEO>
   <Other>
    <Size>Add bag size eg. m, l, s</Size>
    <Colour>This is the simple select attribute, the given attribute option should be matched. eg. red</Colour>
    <Material>This is the simple select attribute, the given attribute option should be matched. eg. lether</Material>
    <Type>Add product type</Type>
    <test1>Add product type</test1>
    <test2>Add product type</test2>
    <Shoes_SIZE>This is the simple select attribute, the given attribute option should be matched. e.g. 6</Shoes_SIZE>
    <Auto_Exposure>This is the boolean attribte, the value should be 0 or 1.</Auto_Exposure>
    <Auto_Focus>This is a number attribute the value should be intiger e.g. 123456</Auto_Focus>
   </Other>
  </PRODUCT>
</CATALOG>

Then click on to Save button.

After that, click on the template that you have created and then map all the attributes.

Note: The XML headers that you have added to the XML file will be visible in the mapping template

XML Header Fields

The header field is used while exporting the product to add more XML headers that need to fill:

• XML header field name
• XML header field value

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

Then to create a product in Akeneo, go 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 the product 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.

Export Profile

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

In XML connector there are 4 export jobs:

• Product and Product Model Export
• Category Export
• Attribute Option Export
• Attribute Export

Then to create an export profile navigate to Exports>Create Export Profile. After that, enter a unique code, the label then selects a job profile.

Attribute export-

Attributes that are duplicated are not exported. A check attribute label is required to be exported. All attributes are exported in accordance with the Channel and locale settings.

Attribute Option Export–

In this export jobyou can easily export all the attribute option.

Category Export-

Name of the category (Locale as selected, for example, en US, fr FR..) Exporting multi-category trees (Exported as per the specified tree).

If the category tree already exists, make sure not to generate a duplicate when exporting for the first time.

Export product and product model –

After that, you have to select the Job profile. Then to create an export profile, you must click the Save button.

Now you can see the export profile then go to the Global Settings. 

In the Global Settings, you will get three options File path, Date Format, and Export files and Images.

Select Template – In this you have to select the template created

File Path – In this you have to enter the file path in which the XML file will be exported.

Date Format – In this you have to select the date format.

Export files and Images – With this option, you can export Files and Images from Akeneo to XML

file.

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

Filter the Data:

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 – Also you have to select 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.

Filter The Products

Now you need to decide which products to export in the XML file.

Family:

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

Status:

Also, you can filter on the status of your products, three options are available:

• All – to export all products whatever their status is
• Enabled (default option) – only to export enabled products
• Disabled – only disabled products will be exported.

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:

However, 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 the 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:

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

Identifier:

Then you can make a selection of identifiers to export by adding them to the SKU field.

Also, can copy and paste a list of identifiers, and separate them by using comma, space or line breaks.

After that, click the Save button. Then click on the Export Now button.

Now, after clicking on the Save button, wait for the execution process to complete, then check the errors.

Note: 2 separate files are generated on the product export job one is for the product and another is for the product model

After that, you can download your product in an XML file that has been exported.

After completing the export job, the products will appear in the XML file.

This was all about the Akeneo XML 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 doesn’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.