> For the complete documentation index, see [llms.txt](https://docs.scaleflex.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.scaleflex.com/digital-asset-management-dam/plugins-and-connectors/connectors/akeneo-pim.md).

# Akeneo PIM

Scaleflex DAM (VXP) Akeneo App

## Installation & Activation

### Prerequisites <a href="#od_117c69a2" id="od_117c69a2"></a>

* You need an active DAM account. [Register for a demo](https://www.scaleflex.com/en/request-a-demo) if you don't already have one.
* Your Akeneo plan needs to be the *Enterprise Edition*.

### Activation

1. &#x20;**Activation by App (EE Version)**

* Log in to your Akeneo instance
* Go to **Connect - App store**, search by name: "Scaleflex", App name: "Scaleflex DAM (Visual Experience Platform)"

1. **Activation by Data source(CE Version)**

Prepare credentials by going to the Akeneo instance, and go to Connect / Connection settings&#x20;

* Create
  * Label: any
  * Code: any
  * Flow type: Data source
* Then you will be redirected to this page. <mark style="color:red;">**Please add a Role and Group to this Data source**</mark>

<figure><img src="https://2536208400-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fqsq2dR7Fjagf5eTifWZx%2Fuploads%2FuT99NLra9ytk5YztmstV%2Fimage.png?alt=media&amp;token=dcc3163a-c049-4741-9f32-67b66415bef2" alt=""><figcaption><p>Data Source setting</p></figcaption></figure>

* Save this information to use in the next step

Go to Settings / Automation / Integrations or use this link: <https://hub.scaleflex.com/settings/dam/automations/integrations>

* Click on "Add Connetor" and select "Akeneo PIM"

<figure><img src="https://2536208400-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fqsq2dR7Fjagf5eTifWZx%2Fuploads%2FBZBkthg8xGN2aXFCiSpd%2Fimage.png?alt=media&amp;token=32354343-d8c2-4eac-818a-66cd915f6eb2" alt=""><figcaption></figcaption></figure>

* Fill in your data to complete the configuration connector

<figure><img src="https://2536208400-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fqsq2dR7Fjagf5eTifWZx%2Fuploads%2FIkzqnNRnhFmYKJrRWWMM%2Fimage.png?alt=media&amp;token=ee868b61-95cf-45b6-a5b9-07580bc5838a" alt=""><figcaption></figcaption></figure>

### Set up Your Integration

Follow the steps to complete the integration

<figure><img src="https://2536208400-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fqsq2dR7Fjagf5eTifWZx%2Fuploads%2FjTa4YeXF61gavgoj2IYX%2Fimage.png?alt=media&amp;token=5e792401-164b-47d7-8070-5cb60a552ec7" alt=""><figcaption></figcaption></figure>

* **HUB API Key:** In Hub, go to Settings > Access > API Keys to get one.  (<https://hub.scaleflex.com/settings/project/access/api-keys>)
* **Field Mappings:**

  <figure><img src="https://2536208400-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fqsq2dR7Fjagf5eTifWZx%2Fuploads%2FrOtkTIedhMNPqqGskJXm%2Fimage.png?alt=media&amp;token=f66da624-d249-4b1e-8887-3ea990a6c5c5" alt=""><figcaption></figcaption></figure>

**Recommend:** Go to the Hub and create the default metadata to use for Akeneo Mapping.

Example:

<figure><img src="https://2536208400-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fqsq2dR7Fjagf5eTifWZx%2Fuploads%2FkeKS8JXGrteT6zBLsgcI%2Fimage.png?alt=media&amp;token=135078bf-014b-4b14-8144-e6f884198456" alt=""><figcaption></figcaption></figure>

With the option "Separate Product & Asset settings" enabled. You need to select the metadata used for Product and Asset

<figure><img src="https://2536208400-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fqsq2dR7Fjagf5eTifWZx%2Fuploads%2FyuFiP05duL24ZgiJuio6%2Fimage.png?alt=media&amp;token=da4e4214-2f04-4479-b01b-501b79679831" alt=""><figcaption></figcaption></figure>

Lastly, regarding the option "Use product.ref for Product SKU". To use it, please verify that the Product setting is enabled in HUB. In Hub, go to Settings > Interface > Enable "Products" (<https://hub.scaleflex.com/settings/dam/library/featured-components>)

### Webhook Configuration

To sync from DAM to PIM by Metadata, you have to copy and add to the new Webhook Setting at: <https://hub.scaleflex.com/settings/dam/automations/webhooks>

Please follow these configurations:

<figure><img src="https://2536208400-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fqsq2dR7Fjagf5eTifWZx%2Fuploads%2Fulr8rLzJJPHUpLgj357H%2Fimage.png?alt=media&amp;token=994e9e0c-917e-4d56-bb33-e44be1402e23" alt=""><figcaption></figcaption></figure>

### Sync Configuration&#x20;

1. **Asset**

Go to Settings > On tab "Attribute Sync"

On this screen, you can select the attribute you want to sync the asset from DAM to PIM

<figure><img src="https://2536208400-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fqsq2dR7Fjagf5eTifWZx%2Fuploads%2FZ7QCKy3wFN1qllTdpspC%2Fimage.png?alt=media&amp;token=7030184f-522e-4876-be99-d631bd77ad8b" alt=""><figcaption></figcaption></figure>

2. **Mapping Metadata**

* **DAM Field:** Select the metadata field on DAM to map with PIM
* **Target Type:** Choose mapping target Product/Asset
* **PIM Attribute:** Select the metadata field on PIM to map with DAM
* **Direction:** Choose the way you want to sync
  * DAM to PIM
  * PIM to DAM (Support only for EE version)
  * Bidirectional (Support only for EE version)

<figure><img src="https://2536208400-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fqsq2dR7Fjagf5eTifWZx%2Fuploads%2FCirFiBzHHweBQQSmKyGi%2Fimage.png?alt=media&amp;token=6e6d6f67-3b05-43db-b570-1327dfa3afc1" alt=""><figcaption></figcaption></figure>

**Requirement:** You need to create a new variant for Akeneo at <https://hub.scaleflex.com/settings/dam/metadata/configuration>. And follow the instructions in **Settings** > **Metadata** > **DAM Variants** to set up the option and value for your variant.

<figure><img src="https://2536208400-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fqsq2dR7Fjagf5eTifWZx%2Fuploads%2F4td3eWaDStfrExyT32CU%2Fimage.png?alt=media&amp;token=b46d42df-b430-42a8-9b9e-db1852480168" alt=""><figcaption></figcaption></figure>

Copy the value of **Name** for **Label** and **API Key** for **API Key**

<figure><img src="https://2536208400-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fqsq2dR7Fjagf5eTifWZx%2Fuploads%2FJJyzsL5c9JKESS266oEO%2Fimage.png?alt=media&amp;token=d7864c4f-b4f6-4d27-b3e1-0f9a8f5146c2" alt=""><figcaption></figcaption></figure>

3. **Presets**

To use **Presets,** you need to select the field metadata on the tab **General.**

<figure><img src="https://2536208400-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fqsq2dR7Fjagf5eTifWZx%2Fuploads%2FEIxoekFwu3FuQX09Czgu%2Fimage.png?alt=media&amp;token=ed61020d-ae60-4455-b967-aedc56af005d" alt=""><figcaption></figcaption></figure>

3. **PIM to DAM (Event Platform)**

Please be aware that this feature is supported only for the Akneo EE version.

And make sure you have already permitted the Event Platform

<figure><img src="https://2536208400-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fqsq2dR7Fjagf5eTifWZx%2Fuploads%2FLGxympOHd0Xu5YC1dXn9%2Fimage.png?alt=media&amp;token=bf19562a-220f-44b2-9160-446ab4a6fc02" alt=""><figcaption></figcaption></figure>

With this option enabled, when you change the field already mapped in PIM, it will sync the data change back to DAM