Akeneo PIM App
Scaleflex VXP Akeneo App
Introduction
There are 2 versions(sync way) in Akeneo App:
Metadata version: Which is new support sync assets and product by metadata.
UI version: Setting and Support sync by UI
Akeneo version support:
Enterprise version: Support by App Activation
Community version: Support by Data Source
Asset Manager
Media Type
Product
Image Field(Binary)
Text
Entity Reference
Image(Binary)
Text
Metadata version support Bi-Direction Sync(DAM to PIM, PIM to DAM)
Text / Textarea
No Chanel / No Locale
Locale support(Use Variant in DAM)
Attribute code and Metadata Key MUST MATCH in both system
Single Select
No Chanel / No Locale
Attribute code and Metadata Key MUST MATCH in both system
Options value must be the same in both system
Multiple Select
No Chanel / No Locale
Attribute code and Metadata Key MUST MATCH in both system
Options value must be the same in both system
Installation & Activation
Prerequisites
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)"
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
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
When activation done, you will be redrect to DAM Hub. You can choose go to Setting Page, or discover the DAM Hub.
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
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
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
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:
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
No Scope + No Locale
Value per locale: False
Value per channel: False
Scope + No Locale
Value per locale: False
Value per channel: True
No Scope + Locale
Value per locale: True
Value per channel: False
Scope + Locale
Value per locale: True
Value per channel: True
Image resize technique: Fit or Crop
Size: Must follow format: width x height, example: 300x400
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.
Copy API Key and paste into Api key
Enable the Toggle button
Save changes
Metadata setting
Please follow these configurations:
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.
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.
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.
Select one
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
Asset / Family
Asset family attributes must be synchronized between DAM and PIM, using a select-one field with identical predefined options in both systems.
Select one
Asset / Asset Code
Asset code metadata identifies the specific products to be updated during the synchronization process. Use a text field. To get all options family from PIM you can use Sync family option feature, read bellow.
Text
Sync family options
You have to provide a valid API Key in PIM to DAM section to enable this feature.
Main attribute setting(Same for Product and Asset)
To see these tabs, you have to enable feature on Metadata section
This mapping determines which asset attributes will be synchronized based on the product family.
Select Family
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
Last updated
