Description
Advanced CSV Connector is an extension of classic Akeneo CSV Connector. It allows to customize columns mapping with custom entity in your PIM project:
Lot of mapping parameters are available:
- Transformation: Use LUA scripts created in your PIM project to update values dynamically
- Only on creation: To set value only for product creation (avoid erasing contributions)
- Default value: To set a value when column is empty
- Etc.
Installation
Download the Bundle
composer require "clickandmortar/advanced-csv-connector-bundle":"<version-wanted>.*"
Example for last version:
composer require "clickandmortar/advanced-csv-connector-bundle":"1.8.*"
Enable the Bundle
Enable the bundle by adding it to the list of registered bundles
in the config/bundles.php file of your project:
<?php return [ // ... Pim\Bundle\CustomEntityBundle\PimCustomEntityBundle::class => ['all' => true], ClickAndMortar\AdvancedCsvConnectorBundle\ClickAndMortarAdvancedCsvConnectorBundle::class => ['all' => true] ];
Update your config/routes/routes.yml file to enable custom entities:
pim_customentity:
prefix: /reference-data
resource: "@PimCustomEntityBundle/Resources/config/routing.yml"
candm_advanced_csv_connector:
prefix: /candm-advanced-csv-connector
resource: "@ClickAndMortarAdvancedCsvConnectorBundle/Resources/config/routing.yml"
And finally clear cache and update database:
rm -rf var/cache/*
php bin/console --env=prod pim:installer:assets --symlink --clean
yarn run webpack
php bin/console doctrine:schema:update --force
Documentation
Import
To create a new import mapping, go to Référenciel / Mappings d'import and click on Create top right button. You can add as many mapping lines as you want by clicking on Ajouter une ligne.
Some explanations for table columns:
Attribut(mandatory): Attribute code in your Akeneo project (you can use suffixes like-fr_FRor-EURfor locales, channels, currencies, ...)Nom de la colonne(mandatory): Column name in your file to importTransformation: LUA script name to update value after mapping. Example: Uppercase, lowercase, ... (you can create a new LUA script underRéférenciel / Scripts LUA)Valeur par défaut: Default value for attribute if empty data in fileIdentifiant(mandatory): Used to defined main identifier attribute of productUniquement à la création: Set attribute value only if product is new (checked withidentifierattribute)Effacer si null: Remove key from item mapping if value is nullSupprimer: Click on this cell to delete mapping line
Once mapping is saved, go to Imports part and create a new job with type Import des produits avancé (CSV). After job creation, go to edition mode and update Mapping parameter in global parameters tab.
Export
To create a new export mapping, go to Référenciel / Mappings d'export and click on Create top right button. You can add as many mapping lines as you want by clicking on Ajouter une ligne.
Some explanations for table columns:
Attribut(mandatory): Attribute code in your Akeneo project (you can use suffixes like-fr_FRor-EURfor locales, channels, currencies, ...)Nom de la colonne(mandatory): Column name in your file to exportValeur forcée: Force a value (erase given attribute value from Akeneo)Transformation: LUA script name to update value after mapping. Example: Uppercase, lowercase, ... (you can create a new LUA script underRéférenciel / Scripts LUA)Utiliser le libellé: Boolean to get the label associated to the code given (for attribute options or custom entities)Langue: Select a specific locale for the label to export (linked toUtiliser le libellécolumn)Longueur max.: Integer use to shorten attribute value if necessaryValeur par défaut: Default value for column if empty attribute valueSupprimer: Click on this cell to delete mapping line
Once mapping is saved, go to Exports part and create a new job with type Export des produits avancé (CSV). After job creation, go to edition mode and update Mapping parameter in global parameters tab.