Menu Close
    Searching for an experienced Akeneo Development Company ?

    Akeneo Custom CSV Export

    Introduction

    Akeneo Custom CSV Export: With this connector, you can extract your product data into a customized CSV 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 CSV fields (columns) for creating CSV files.

    Basic Requirements:

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

    Features

    • Export products from Akeneo into CSV file
    • Product export variations from Akeneo into CSV file
    • Export multiple images of a product from Akeneo to CSV as a link
    • Use a fixed value for some fields when exporting data.
    • Mapping of Akeneo fields with CSV 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
    • Support concatenate, multiple and simple fields
    • Export CSV products using quick export.
    • Variant product mapping is also available
    • This module is compatible with the latest Akeneo version 5.0.x
    • Filter Data to be exported based on Category, Family, Completeness, Time conditions, Identifier (SKU), Language, and Currency.

    Installing Module for Version 4.0.x to 5.0.x

    Please follow these steps for installing the Akeneo Custom CSV Export module in your Akeneo PIM platform.

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

    csv-src

    2 – Goto config/Bundles.php then add line:

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

    in return array.

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

    csv-conf

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

    php bin/console cache:clear--env=prod;
    php bin/console csv: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

    For Akeneo 4

    sudo service php-fpm7.3 restart

    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

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

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

    Docker Installation Command :

    For Akeneo 5

    For Akeneo 4

    Installing Module for Version 2.x to 3.x

    Please follow these steps for installing the Akeneo Custom CSV Export module in your Akeneo PIM platform.

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

    csv-src

    2 – Goto app/AppKernel.php then add the line

    new Webkul\WebkulCsvBundle\WebkulCsvBundle(),
    

    AppKernel.php file in Akeneo3 – Goto app/config/routing.yml then add these lines at top of the file

     webkul_csv:
        resource: "@WebkulCsvBundle/Resources/config/routing.yml"
        prefix:    /
    

    routing.yml file in Akeneo4 -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.

    php bin/console cache:clear--env=prod;
    php bin/console csv:setup:install

    5 – You have to restart your web server like Apache, Nginx. Run the command for 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 Webpack 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.

    Akeneo CSV Mapping

    After installing the connector in Akeneo, You can see the Webkul CSV connector icon at the Akeneo dashboard.

    Webkul CSV connector

    CSV Connector Product Mapping Fields

    You can click on the Webkul CSV connector icon to set up a CSV connector. In this you can create map multiple template.

    To create new template  click on create template.

    create-template

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

    fillname

    Then click to Save button.

    Now to map the attributes in that template click to 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.

    csv-mapping

    Akeneo Fields – 

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

    dropdown-csv

    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.

    default-value-1

    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.

    variant-mapping

    Add Mapping CSV Fields

    If you want to map the more CSV fields with the Akeneo fields then 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. Example: You have a variant name “color” and value “Red” then you can mention the variant code and value in Variant Export Mapping fields name.

    add-mapping-csv

    Here you can select the three fields:

    Simple Field – Here, you can map a single attribute with CSV attribute fields.

    Multiple Selection Field – With this option, you can select and map multiple product attributes.

    Concatenate Filed – With this option, you can concatenate multiple products attributes in Akeneo fields.

    three-mapping-1

    If you have selected the Yes/No then there will be two more options in which you can select their value format.

    yesno-formate

    After clicking on the Add field, you can see the attribute code in the CSV mapping.

    Other Mapping:

    • Multiple Value Separator – You can add multiple value separator ex- (,) food, clothes, accessories.
    • Export unit with metric attributes – In this you can export metric attribute.
    • Csv Family Field – In this you can add Akeneo product family.
    • Export select option as label – If you want to export simple/multi select attribute option lable.

    other-Mapping-csv

    Create Export Profile

    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 – as 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 variationSelect the product 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.

    Create product in AkeneoAdd Product Details

    Now you need to provide information about the product. First, select the Channel and Locale then enter the price, name, and description.

    webkul-magento2-akeneo-add-product

    Export Profile

    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.Create Export Profile

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

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

    Global Settings:

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

    global-setting

    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.

    content-csv-1

    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.

    Export profile Product CSV Export

    Filter The Products

    Now you need to decide which products to export in CSV file.Filter the product in Akeneo

    Family

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

    Filter with family

    Status

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

    Filter with status

    • 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:Filter with completeness

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

    Filter with 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.

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

    Categories selection

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

    Setup Store Template:

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

    seletct-template

    Product Export

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

    Export option 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 CSV file.

    Export Execution details

    Products In CSV

    After the click on the Download Generated files, you can download the CSV files.

    Products in CSV FilesYou can upload this CSV file on eCommerce channels to import the product.

    Upload CSV in E-commerce

    After generating the CSV files, you can upload this CSV file in the eCommerce Channel. For example, you have generated the CSV file for the Shopify store.

    Now, you have to log in to your Shopify store admin panel. After that, you have to navigate the Products -> All Products. Then you have to click on the Import.

    Choose a CSV file for the Product upload

    After the successful import, you can see the products in the Shopify product list.

    Product in All products list

    Support

    For any issues related to this module, please create a support ticket at- https://webkul.uvdesk.com/en/customer/create-ticket Also, for any pre-sales queries or customization discussion, please drop an email to [email protected]

    Please explore our Akeneo Development Services and Quality Akeneo Extensions.

    Current Product Version - 3.0.0

    Supported Framework Version - Akeneo 2.2.x, 2.3.x, 3.0.x, 3.1.x, 3.2.x, 4.0.x and 5.0.x

    Blog Version - Akeneo 2.2.x, 2.3.x, 3.0.x, 3.1.x, 3.2.x, 4.0.x and 5.0.x
    • Version Akeneo 2.2.x, 2.3.x, and 3.0.x
    • Version Akeneo 2.2.x, 2.3.x, 3.0.x, and 3.1.x
    • Version Akeneo 2.2.x, 2.3.x, 3.0.x, 3.1.x, 3.2.x, 4.0.x and 5.0.x
    • Version Akeneo 2.2.x, 2.3.x, 3.0.x, 3.1.x, 3.2.x and 4.0.x
    • Version Akeneo 2.2.x, 2.3.x, 3.0.x, 3.1.x and 3.2.x
    . . .
    Discuss on Helpdesk

    Leave a Comment

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


    2 comments

  • Shiv Kumar Singh
    Can we make any modification to the values imported in the webkul, like replacing any space or special characters with underscore (“_”) for any field ?
    • Adarsh Shukla (Moderator)

      Hello Shiv,

      Greetings of the day!!!

      Can we make any modification to the values imported in the webkul, like replacing any space or special characters with underscore (“_”) for any field?

      —> No, currently, there is no feature available to replace any space or special characters with underscore (“_”) for any field. If you want this feature then please send us an email to [email protected]

      Thanks & Regards,

      Webkul Team

  • Back to Top

    Table of Content

    Hide Index