Akeneo Community PIM Connector

Installation & Activation

Prerequisites

• You need an active DAM account. Register for a demo if you don't already have one;

• Akeneo instance

Activation by Data source(CE Version)

Prepare crendentials by go to Akeneo instance go to Connect / Connection settings

• Create

  • Label: any

  • Code: any

  • Flow type: Data source

• Then you will be redirect to this page, please add a Role and Group to this Data source

  
• Save these information to use in next step

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

• Click on Enable Akeneo community

• Enter credentials from Akeneo, then Validate and Save Change

• After validated, you can change your credentials in Credentials Tab

Configurations

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

There are 2 sections:

General Setting

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

• Please click "Save" 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:

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

• 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

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

• 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

Please follow these configurations:

Metadata

Description

Type in DAM

Scope

Asset metadata scope/channel attributes must be synchronized between DAM and PIM, using a multi-select field with identical predefined options in both systems. You can use "Sync scope options" to add all scopes/channels from PIM to DAM Metadata field options

Multiple select

Locale

Asset metadata locale attributes must be synchronized between DAM and PIM, using a multi-select field with identical predefined options in both systems. You can use "Sync locale options" to add all locale from PIM to DAM Metadata field options

Multiple select

Product /Family

Product family attributes must be synchronized between DAM and PIM, using a select-one field with identical predefined options in both systems. To get all options family from PIM you can use Sync family option feature, read bellow. You can use "Sync family options" to add all families from PIM to DAM Metadata field options.

Select one

Product/Default PIM Product Attribute

This is the default attribute to which assets will sync if no specific setting is defined in the Product Attribute Mapping.

N/A

Product / Product Code

Product code metadata identifies the specific products to be updated during the synchronization process. Use a text field. If you use Product reference instead Metadata. Please first Enable Product in DAM / Library / Feature Components

Text

Product / Product model code

Product model code metadata identifies the specific products to be updated during the synchronization process. Use a text field.

Text

Sync family options

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

Main attribute setting

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

Synchronization

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

  

• Click save

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

• 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