Enhanced Enrichment Engine (e3) for Akeneo PIM

Enhanced Enrichment Engine is a tool to manipulate product data in the Akeneo PIM using its REST API.

It is similar and compatible with Akeneo Enrichment Rules but is more powerful. See how it is different from Akeneo Rules.

When to use e3

⭐ Data cleansing e.g.

• trim attribute values
• remove html tags
• remove artefacts from text attributes

⭐ Improve data e.g.

• lowercase or uppercase attribute values
• generate slugs

⭐ Attribute type changes e.g.

• copy values of a non-localisable attribute to a localisable one
• copy number data to a metric attribute

⭐ Data model changes e.g.

• add an attribute to families

⭐ Migration e.g.

• copy a product range from UAT to production

How to use e3

Step 0. Install the Akeneo e3 command line script.

Step 1. Create a connection in Akeneo or use one of existing connections.

Step 2. Create a connection profile.

Create a file connection.yaml and configure it using your connection credentials.

host: '{{ Your Akeneo server url }}'
clientId: '{{ Client ID}}'
clientSecret: '{{ Secret }}'
userName: ' {{ Username }}'
userPassword: '{{ Password }}'

Step 3. Define your rules.

Create a file rules.yaml, e.g. this configuration allows you to trim values of the name attribute for the en_GB locale:

actions:
    -
        type: set
        field: name
        locale: en_GB
        scope: null
        expression: 'trim(value("name", null, "en_GB"))'

See also

• examples of rules
• supported actions
• supported expression functions

Step 4. Run the script:

php akeneo-e3.phar transform --resource-type=product --connection=connection.yaml --profile=rules.yaml