# Akeneo PIM

## 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="/files/VZ6F6PL5mFZdLa5xbmjB" 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="/files/ZQrL2sjoCCtV8YA1451L" alt=""><figcaption></figcaption></figure>

* Fill in your data to complete the configuration connector

<figure><img src="/files/ZmJfEjp0MhFL8WZBJeCT" alt=""><figcaption></figcaption></figure>

### Set up Your Integration

Follow the steps to complete the integration

<figure><img src="/files/oH46c1okSELJkWzE7pQ5" 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="/files/Du5o2PxQlCbuJljRIUgB" alt=""><figcaption></figcaption></figure>

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

Example:

<figure><img src="/files/IM7iLHpgk567ukX82ECR" 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="/files/5nwmxakawC2VJUKAxIWy" 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="/files/GzTlI4mOW3SmfowlvvAW" 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="/files/QU7GPzxxP8FERXMhxDpM" 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="/files/NY7NiYqnSfqLQOSNCm9i" 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="/files/Snt78dFwwl4byAhbeBmd" alt=""><figcaption></figcaption></figure>

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

<figure><img src="/files/WMmpvnBSHahgWJQNEbN3" alt=""><figcaption></figcaption></figure>

3. **Presets**

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

<figure><img src="/files/CcCApow24nHS1hO673PA" 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="/files/4mibrCzuDOA9mV6CqqeE" 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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.scaleflex.com/digital-asset-management-dam/plugins-and-connectors/connectors/akeneo-pim.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.