Akeneo App

1. Prerequisite

• You must have an active Filerobot account, you can request one here: Contact Scaleflex

• Your Akeneo must be Enterprise Edition

2. Features

• One Filerobot token can only support one Akeneo EE Instance, but one Akeneo EE Instance can use multiples Filerobot Token

  • Beware: Metadata sync locales and code of metadata must be matched

• Support Asset Manager

  • Medialink Type only: Link Sync

• Support Akeneo Entity Reference

  • Image Type: Binary sync
  • Text type: Link sync

• Size setting

  • Support at family level(Asset Manager), Entity level(Entity Reference) for specific Scope and Locale

• Metadata sync to Attribute

  • Support Global
  • Support value per locale

3. Authentification & Activation

• Must login to Filerobot Hub first

• After login to Akeneo, go to Connect / App Store to Find the Filerobot by Scaleflex App

• Then click Connect: You will redirected to the Filerobot Asset Hub and will be able choose which token you want to use for your Akeneo EE instance

  • Each Token can be used for only one Akeneo EE Instance
  • Multiple Akeneo instance can use the same Token

• After selecting your token and clicking Active, you will redirected back to Akeneo

• Then please Confirm that you give App access to the Akeneo EE instance

After confirmation, you will be redirected back to Filerobot

• Choose to go to Setting

• View the Asset Library

4. User guide

4.1 Setting

4.1.1 General Setting

• (1) Go to More / Developers / Automations / Akeneo PIM to open the Setting page

• (2) General setting

  • Enable / Disable: If disabled you can not use Akeneo Sync feature on Filerobot
  • Default size: Default image size will be used if there are no config related to each asset
  • Default function: Crop or Fit
  • Please click Apply change to update configuration

  After change please reload / refresh the Filerobot browser's page

• (3) Size setting(Please read 4.1.2 for more details)

4.1.2 Size Setting

How does it work?

• Can be duplicated

• Priority: Bottom to Top, and it will apply the first matching setting only

• Example: An Asset with these information:

  • Scope: commerce / Locale: en_US / Family: filerobotmedia

  • Will try to match setting following the steps bellow:

    • 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 default setting

4.1.2.1 Add new

• (1) To add new size setting Click Add new size on the top right

Explanation

• (1) Type, currently The app support 3 types

  • Global: Affect all asset include entity and asset
  • Asset: Asset Family
  • Entity: Entity Reference

• (2) If we choose Asset or Entity, we can also choose which attribute family(asset manager) or entity(entity reference) will be applied this setting

  • We can also choose All Items to apply to all Family / Entity

• (3) / (4) Scope and Locale

  • To choose locale you muse choose a scope first / can choose No Scope
  • There are 4 cases can happen:

• (5) / (6) Function and Size

  • Function: Crop and Fit
  • Size of asset to be resized
  • Must follow format: widthxheight, example: 300x400

4.2.2.2 Edit / Delete

• (1) Click on Edit on each setting

• Same as Add new

• (2) You can Delete by click Delete button on opened Modal

4.2 Sync asset

4.2.1 Sync Media

• (1) On each Asset / Click Detail

• (2) You can choose which type to sync

  • Entity: Entity reference
  • Asset: Asset Manager

  

• (3) On Sync Asset Tab

  • Choose Family or Entity
  • Choose attribute(For entity support two types: Text(Link sync) and Image(Binary Sync)

  • There are 4 cases 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
  • Entity Code(Entity Ref): Code -> You can search for old code, or create new one.

• (4) To check sync history, Click Sync Logs

  • (5) You can see which locales and scopes were synced by click View on Each item

4.2.2 Sync metadata

• Only support attribute with following settings:

  • Value per locale: true / Value per channel: false
  • Value per locale: false / value per channel: false

• Configuration step:

• (1) Go to store config

• (2) In Regional variants, Add new group

• (3) Option setting

  • (3.1) Name of Group - Can be anything you want
  • (3.2) / (3.3) Code of Locale / Must match the setting in Akeneo / See picture bellow

• Metadata setting

  • (1) In store config, Metadata tab, you can add new Group then Add new field
  • (2.1) API Value must match (3.1) Attribute code(in Entity / Asset Manager Family)
  • If (3.2) is uncheck then (2.2) is None else (2.2) must specific a Regional variants group as we did above with Same setting as Akeneo locales

• How to sync

  • After configuration, everything is automatic for the mapping between two systems
  • On each Asset detail(1) you can see Metadata tab(2), You can change value by locale or value only(if value per locale is false)(3) , then click Done(4) to save the value
  • You must close the asset popup and open again to make new metadata available to sync(5)