Visual Experience Platform
Help CenterRelease NotesBlogWebsite
  • VXP - Visual Experience Platform
    • The VXP
      • Token
    • Settings
      • My Account
        • Profile
        • Support
      • Organisation
        • General Organisation Settings
        • Billing
          • Payment
          • Invoices
          • Plan
        • Users
          • Users
          • Roles
        • Teams
      • Project
        • Branding
        • Subscription
        • Analytics
          • Standard Dashboards
            • Multi tenants
            • User Dashboard
            • DAM Storage
            • Workflows Monitoring
            • Traffic Origin
            • Caching (Volumetry)
            • CDN performance
          • Custom Dashboard
        • Access
          • API keys
          • Security templates
          • OAuth2
  • Digital Asset Management (DAM)
    • Library
      • Assets
        • Asset Details window
          • Asset actions
            • Regional settings
            • Context menu ("..." button)
            • Add to My favorites (heart icon)
            • Edit media (image, video, etc)
              • Edit image
              • Edit video (coming soon)
              • Edit design template (coming soon)
            • Share
          • Asset information tabs
            • General
            • Metadata
            • Variations
            • Comments
            • Approvals
            • History
      • Folders
      • Collections
      • Labels
      • Products
      • My favorites
      • Help
      • Sharebox
      • Airbox
      • Search and Filters
        • Faceted Search
    • Plugins & Connectors
      • Plugins
        • Adobe Creative Cloud
        • Adobe Commerce (Magento)
        • Canva
        • Contentful
        • Contentstack
        • Directus
        • Drupal
        • Opencart
          • Opencart (v4)
        • Prestashop
        • Shopware
        • Storyblok
        • Strapi (v4)
        • Sylius
        • Uniform CMS
        • Wordpress
      • Connectors
        • Akeneo PIM App
        • Canva App
        • CI-Hub
        • Commercetools FaaS App
        • Hygraph app
        • Kontent.ai
        • OneTeg
        • Pabbly Connect
        • Prismic
        • Shopify / Shopify plus app
        • Zapier automation
    • Settings
      • Library
        • Featured components
        • Interface customization
      • Metadata
        • Metadata Configuration
        • Assets
      • Tags
        • Configuration
        • Dictionary
      • Notifications
      • Automations
        • Post processing
        • Webhooks
        • Workflows
      • Storage
        • Providers
        • Upload
        • Video
        • Listing
        • Download
        • Custom routing
  • Visual AI
    • Welcome
    • Visual AI
      • Images
        • Classification models
          • Auto-tagging
          • Brand detect
          • Dominant color extraction
          • Faces
            • Face analysis
            • Face clustering
          • Image quality
          • OCR
          • Number Plate recognition
          • Product type
          • Property classification
          • Scene Classification
          • Sport Classification
        • Generative AI models
          • Image-to-text
          • Plate blurring
          • Quality improvement (remove artifacts)
          • Remove background
          • Text-to-Image
        • Moderation models
          • Face count
          • NSFW - Not Safe For Work
          • Real estate authenticity
          • Watermark detection
      • Videos
        • Face detection
      • Search & find assets
        • Text Search
        • Similar Assets
  • Portals
    • Welcome
    • Creating a Portal
    • Editing a Portal
      • Pages
      • Sections
      • Design
      • Fonts
    • Managing a Portal
      • Settings
      • Access
      • Users
      • Labeling, Cloning, Archiving
    • Publishing a Portal
  • Dynamic Media Optimization (DMO)
    • Welcome
      • Responsive libraries
      • Native plugins
      • 360° view builder
      • Service status
    • Insights
      • Delivery
      • Optimization
      • Alerts
      • Logs
    • Transformations
      • Image optimization
        • Operations
          • Width and height
          • Prevent enlargement
          • Crop
            • Automatic Gravity Crop
            • Positionable Crop
            • Focal point Crop
            • Face Crop
            • Face hide
            • Aspect ratio crop
          • Fit
          • Cropfit
          • Bound
          • Boundmin
          • Cover
          • Device pixel ratio
          • Flip
          • Rotate
          • Trim
          • Rounded corners
        • Filters
          • Adjustment
            • Brightness
            • Contrast
            • Saturate
          • Color manipulation
            • Color overlay
            • Grayscale
            • Duotone
          • Blur
          • Pixelate
          • Sharpen
        • Watermarking
          • Static watermark
          • Dynamic watermark
          • Text watermark
        • Image compression
          • Image formats
          • Optipress
      • Video optimization
        • Video API
          • Editing
            • Chapters
            • Combine
            • Trim
          • Optimizing
            • Convert
            • Compress
            • Transcode
        • On-the-fly-video optimization
      • Static content optimization
        • PDF to image
        • JS/CSS optimization
    • Invalidation
    • Settings
      • Asset Origin
        • AWS S3 or any other S3-compatible storage provider
        • Google Cloud storage (GCP)
        • Azure Blob storage
        • Own HTTP-based Storage
      • Images
        • Compression
        • Optimization
        • Watermark
      • Static content
      • Delivery
        • CNAME
        • URL format
        • Rules
        • Security
        • Caching
        • Default behaviors
  • Developers / Headless
    • Headless DAM
      • DAM APIs
        • API Authentication
        • API Reference
      • Command Line Interface (CLI)
      • Media Asset Widget(MAW)
        • Overview
        • Developer reference
        • V2 End-of-life
Powered by GitBook
LogoLogo

Quick links

  • Go to website
  • Legal Center

©2024 Scaleflex SAS

On this page
  • Introduction
  • Installation & Activation
  • Prerequisites
  • Activation
  • Configurations
  • General Setting
  • Sync Setting
  • Synchronization
  • Metadata version
  • UI version
Export as PDF
  1. Digital Asset Management (DAM)
  2. Plugins & Connectors
  3. Connectors

Akeneo PIM App

Scaleflex VXP Akeneo App

PreviousConnectorsNextCanva App

Last updated 7 days ago

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

Currently, these two version only support Akeneo EE.

Feature
Field Type Support
Metadata
UI
Scope/Channel
Locale

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)

Attribute type
Support
Field condition(Chanel/Locale)

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

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

  • Your Akeneo plan needs to be Enterprise Edition.

Activation

  • 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.

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

Setting in DAM
Akeneo attribute

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:

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.

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.

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

You can have 2 main attributes for one Family, each Family can have only one main attribute.

Synchronization

Metadata version

  • Go to any asset, at Metadata section click Edit

  • Enter family and code metadata which same in setting page

  • 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

Product Code must exist in Akeneo, for Asset and Entity it does not required, if not exist it will create a new one.

Go to Setting / Automation / Integrations or use this link:

Go to Access to get an API Key: , please select All

To sync from DAM to PIM by Metadata you have to copy and add to new Webhook Setting at:

Register for a demo
https://hub.scaleflex.com/settings/dam/automations/integrations
https://hub.scaleflex.com/settings/project/access/api-keys
https://hub.scaleflex.com/settings/dam/automations/webhooks
Scaleflex App
Select one Token to use with Akeneo
Sync setting
Sync family options
Enable Product
Main sync attribute
Edit Asset Metadata