> 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-1/akeneo-enterprise-pim-app.md).

# Akeneo Enterprise PIM 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 *Enterprise Edition*.

### 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)"

<figure><img src="/files/MwZYsmtGi16tpEfIiclV" alt=""><figcaption><p>Scaleflex App</p></figcaption></figure>

* Click *Connect*: You will be redirected to the Asset Hub where to select which token you want to use for your Akeneo instance
  * Each token can be used for only one Akeneo Instance
  * Multiple Akeneo instances can use the same token

<figure><img src="/files/zlMqKeGGM5q7AQKuSj65" alt=""><figcaption><p>Select one Token to use with Akeneo</p></figcaption></figure>

* After selecting your token and clicking Active, you will be redirected back to Akeneo, **please grant all permission to Akeneo app**
  * **Check on EVENT PLATFORM**

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

* When activation done, you will be redrect to DAM Hub. You can choose go to Setting Page, or discover the DAM Hub.

## Configurations

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

There are 2 sections:

### General Setting

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

#### Default Configuration

* Enable / Disable: If disabled, you cannot use the Akeneo sync feature on DAM
* Default size: Default image size will be used if there are no configs related to each asset
* Image resize technique:
  * Crop: Cut image part to resize
  * Fit: Keep all content in image, and make image fit the size
* Addition subfix URL: append a suffix to asset URLs to enable transformations,  read more here: [Transformations](/dynamic-media-optimization-dmo/transformations/image-optimization/operations.md)
* Please click "Save changes" to update the configuration

#### Image resize setting

**How does it work?**

* Can be duplicated
* Priority: Bottom to top, and it will apply the first one match the setting, check example bellow.

*Example:*&#x20;

An Asset with these information:

* Scope: commerce / Locale: en\_US / Family: filerobotmedia
* Will try to match setting following the steps below:
  * First try: Type: Asset / Family: filerobotmedia / Scope: commerce / Locale: en\_US
  * Second try: Type: Asset / Family: All Items / Scope: commerce / Locale: en\_US
  * Third try: Type: Global / Scope: commerce / Locale: en\_US
  * Use size and image resize technique from Default configuration above

**Flow guide**

* Select type, there are 4 types:
  * Global: Affects all assets including entity and asset
  * Asset: Asset Family
  * Entity: Entity Reference
  * Product
* Choose family, we can choose **"All items"**, this will be affected all Families in selected type
* Scope and locale

<table><thead><tr><th width="225.3828125">Setting in DAM</th><th>Akeneo attribute</th></tr></thead><tbody><tr><td>No Scope + No Locale</td><td><ul><li>Value per locale: False </li><li>Value per channel: False</li></ul></td></tr><tr><td>Scope + No Locale</td><td><ul><li>Value per locale: False </li><li>Value per channel: True</li></ul></td></tr><tr><td>No Scope + Locale</td><td><ul><li>Value per locale: True </li><li>Value per channel: False</li></ul></td></tr><tr><td>Scope + Locale</td><td><ul><li>Value per locale: True </li><li>Value per channel: True</li></ul></td></tr></tbody></table>

* Image resize technique: Fit or Crop
* Size: Must follow format: width x  height, example: **300x400**
* **Addition subfix URL:** append a suffix to asset URLs to enable transformations,

### Sync Setting

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

#### PIM to DAM

To enable PIM to DAM sync: When we update some attribute(check supported field type above) in a PIM record(Asset, Product), it will update the mapped metadata in DAM.

* Go to Access to get an API Key: <https://hub.scaleflex.com/settings/project/access/api-keys>, please select All

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

* Copy API Key and paste into Api key
* Enable the Toggle button
* Save changes

#### Metadata setting

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

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

Please follow these configurations:

<figure><img src="/files/8LpxoOI2ibbZgBLEzk8i" alt=""><figcaption></figcaption></figure>

<table><thead><tr><th>Metadata</th><th width="392.11328125">Description</th><th>Type in DAM</th></tr></thead><tbody><tr><td>Scope</td><td>Asset metadata scope/channel attributes must be synchronized between DAM and PIM, using a multi-select field with identical predefined options in both systems.<br><br>You can use "Sync scope options" to add all scopes/channels from PIM to DAM Metadata field options</td><td>Multiple select</td></tr><tr><td>Locale</td><td>Asset metadata locale attributes must be synchronized between DAM and PIM, using a multi-select field with identical predefined options in both systems.<br><br>You can use "Sync locale options" to add all locale from PIM to DAM Metadata field options</td><td>Multiple select</td></tr><tr><td>Product /Family</td><td>Product family attributes must be synchronized between DAM and PIM, using a select-one field with identical predefined options in both systems.<br><br>To get all options family from PIM you can use Sync family option feature, read bellow.<br><br>You can use "Sync family options" to add all families from PIM to DAM Metadata field options.</td><td>Select one</td></tr><tr><td>Product/Default PIM Product Attribute</td><td>This is the default attribute to which assets will sync if no specific setting is defined in the Product Attribute Mapping.</td><td>N/A </td></tr><tr><td>Product / Product Code</td><td><p>Product code metadata identifies the specific products to be updated during the synchronization process. Use a text field.<br><br>If you use Product reference instead Metadata. Please first Enable Product in DAM / Library / Feature Components</p><p></p><div><figure><img src="/files/N6lOK18omxEovfG1szM8" alt=""><figcaption></figcaption></figure></div></td><td>Text</td></tr><tr><td>Product / Product model code</td><td>Product model code metadata identifies the specific products to be updated during the synchronization process. Use a text field.</td><td>Text</td></tr><tr><td>Asset / Family</td><td><p>Asset family attributes must be synchronized between DAM and PIM, using a select-one field with identical predefined options in both systems.</p><p><br>You can use "Sync family options" to add all families from PIM to DAM Metadata field options.</p></td><td>Select one</td></tr><tr><td>Asset/Default PIM Asset Attribute</td><td>This is the default attribute to which assets will sync if no specific setting is defined in the Asset Attribute Mapping.</td><td>N/A</td></tr><tr><td>Asset / Asset Code</td><td>Asset code metadata identifies the specific products to be updated during the synchronization process. Use a text field.<br><br>To get all options family from PIM you can use Sync family option feature, read bellow.</td><td>Text</td></tr></tbody></table>

**Sync family options**

You have to provide a valid API Key in PIM to DAM section to enable this feature.

<figure><img src="/files/nlJ4eMcMYLvqIIIdW93Y" alt=""><figcaption><p>Sync family options</p></figcaption></figure>

#### Main attribute setting(Same for Product and Asset)

To see these tabs, you have to enable feature on Metadata section

<figure><img src="/files/2AZ2iv1rwI4F6IZykpmP" alt=""><figcaption><p>Enable Product</p></figcaption></figure>

This mapping determines which asset attributes will be synchronized based on the product family.

* Select Family
* You can set Default attribute options in case all family have the same field. If you don't declare mapping for specific family, this attribute will be use by default.
* Select attribute belong to Family
* You can Edit and Delete

{% hint style="info" %}
You can have 2 main attributes for one Family, each Family can have only one main attribute.
{% endhint %}

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

## Synchronization&#x20;

### Metadata version

* Go to any asset, at Metadata section click Edit

* Enter family and code metadata which same in setting page

  * If you use Product Reference Component, Enter code on Product Section on top of Metadata tab

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

* Click save

<figure><img src="/files/9nfUwH8yZb0QZtLZy8yZ" alt=""><figcaption><p>Edit Asset Metadata</p></figcaption></figure>

If PIM to DAM enabled, any update attribute(supported types) in Akeneo will update in DAM

* It only update asset metadata when change attribute value in PIM if that asset is synced to an Asset or Product in PIM.
* If one asset synced to multiple assets, products, the last one win.

### UI version

* Right click on any asset / More action / Sync to Akeneo

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

* Choose Family or Entity, Product
* Choose attribute
* There are 4 cases that can happen:
  * Value per channel and value per locale are both false: Can sync without choose scopes or locales
  * Value per locale is true, value per channel is false: Must choose at least one locale
  * Value per locale is false, value per channel is true: Must choose at least one scope
  * Value per channel and value per locale are both true: Must choose at least one scope and locale

{% hint style="info" %}
Product Code must exist in Akeneo, for Asset and Entity it does not required, if not exist it will create a new one.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.