App Settings & Advanced Configuration

Summary

 

So, you've just installed an AppExchange package, and you're wondering what to do next. There are a few key configurations required to ensure the app transfers the right data. 

After installing the AppExchange package, configuring your Custom Metadata Records is a critical step to define how the app transfers, processes, and stores your PIM data. The details you enter here directly determine the mapping options and storage architecture available inside the app.

To complete your configuration, you will need to set up three main components:

  1. App Settings: Define global preferences (locales, category roots, log behaviors) and choose your target storage mode (Custom Objects or Standard Objects) for each data domain
  2. Product Asset Mappings: Structure your digital media collections to enable the transfer of product assets and images
  3. Variation Axes Mappings: Prepare how your multi-variant product attributes map into Salesforce

 

App Settings

Before starting your first data transfer, you must adjust your app settings to define your global preferences and select your desired storage architecture (Custom vs. Standard Objects) for each data domain.

 

How to access App Settings

You can access the configuration interface using either of the following methods:

  1. Open the Akeneo PIM App from the App Launcher
  2. On the homepage view, review your current setup parameters
  3. Click the Edit Configuration Details button to open the modification panel

Method 2: Via Salesforce Setup (Technical Path)

  1. Go to the Salesforce Setup section
  2. In the Quick Find box, search for and select Custom Metadata Types
  3. Click on Manage Records for the Akeneo Connector Configuration
  4. Click Edit next to the Akeneo record


Configuration Options

Configure the parameters within the edit panel according to your business logic.

Configuration Option Value Details
Default Locale en_US This value will be the locale ISO code to be used to retrieve and build the categories and related category tree
Secondary Locale fr_CA,de_DE These settings determine the alternative locales to be used when transferring localised product data beyond the default locale. Separate each locale code with a comma and no whitespace (e.g., fr-CA,de-DE,es-ES). Be sure to check that the mapped locales are enabled in the PIM.
Root Category Code master The exact code of the category tree you wish to transfer from Akeneo PIM to Salesforce 
Category Attribute Name Category The label of your mapping target for Categories inside the Akeneo Catalog interface 
Minimal Transfer Logs TRUE / FALSE Determines logging behavior. If TRUE, the system only saves log entries for errors. If FALSE, a log entry is saved for every single successful product transfer.
Category Target Mode Akeneo Custom Objects / Standard Select Standard to sync your categories directly to Salesforce Commerce standard objects. Requires specific Salesforce prerequisites (See our Standard Categories Setup Guide for step-by-step instructions)
Translation Target Mode Akeneo Custom Objects / Standard Select Standard to sync your translations directly to Salesforce Commerce standard objects. Requires specific Salesforce prerequisites (See our Standard Translations Setup Guide for step-by-step instructions)
Variation Axes Target Mode Akeneo Custom Objects / Standard Select Standard to sync your variation axes directly to Salesforce Commerce standard objects. Requires specific Salesforce prerequisites (See our Standard Variation Axes Setup Guide for step-by-step instructions)
Assets Target Mode Akeneo Custom Objects / Standard Select Standard to sync your assets directly to Salesforce Commerce standard objects. Requires specific Salesforce prerequisites (See our Standard Assets Setup Guide for step-by-step instructions)
CMS Workspace Id Your Salesforce Workspace ID The unique 18-character Salesforce ID of your Enhanced CMS Workspace. This field is mandatory if Assets Target Mode is set to Standard.
Pre-existing Identifier Field ProductCode or an External ID API Name The target Salesforce field used by the app to identify and link to your pre-existing products during the initial sync or migration process

 

Target Modes: Custom Objects vs. Standard Objects

By default, the connector synchronizes Akeneo PIM data into dedicated custom tables within Salesforce. However, if you are leveraging Salesforce Commerce Cloud native capabilities, you can switch the data routing to Standard Mode.

Before altering these settings, we highly recommend reading the Akeneo Fundamentals: Custom Objects vs. Standard Objects Concept Guide to understand how data mapping adapts to your architecture.

Each feature module can be toggled independently and requires specific prerequisites:

 

Configure Product Asset Mappings

If you want to transfer product assets (such as images, logos, or user manuals) from Akeneo PIM to Salesforce, you must define your asset collection structures. The configurations you create here will automatically become available as mapping targets within the Akeneo Catalog interface.

You can define as many asset mapping types as your business requirements dictate. Common examples of Asset Collection Categories include:

  • PDP (Product Detail Page images)
  • PLP (Product Listing Page / Category images)
  • Attachment
  • Generic
  • Service
  • Manuals

Architectural Note

If your global architecture routes media directly into Salesforce core CMS rather than custom tables, please consult our dedicated guide: Configuring Assets with Salesforce CMS.

 

 

How to access Product Asset Mappings

You can view and manage your asset mappings using either of the following methods:

  1. Open the Akeneo PIM App from the App Launcher
  2. Locate the Product Asset Mapping section on the homepage
  3. Click the Edit Configuration Details button to manage your records

Method 2: Via Salesforce Setup (Technical Path)

  1. Go to the Salesforce Setup section.
  2. In the Quick Find box, search for and select Custom Metadata Types
  3. Click Manage Records next to the custom metadata type called Akeneo Product Asset Mapping

 

How to Create or Edit an Asset Mapping

To register a new asset collection target:

  1. From the asset mapping list view, click the New button (or click Edit next to an existing record).
  2. Populate the parameters based on the following fields:

Label Value Details
Label Original Image The user-friendly name that will appear inside the app layout
Akeneo Product Asset Mapping Name original_image The unique API name for this metadata record (automatically populated based on the Label)
Media Type PDP Categorizes the asset destination or purpose (e.g., PDP, PLP, Manual)
Target Type String / Object / Array of Objects Defines the structural format used by the app to store and output the asset data
Product Card Image TRUE / FALSE A switch used by the catalog app. Setting this boolean to TRUE tells the app to use this specific media asset type when rendering product previews inside the app interface

 

Choosing the Right Target Type for Assets

The Target Type parameter determines the data structure the app will use to store and present your PIM assets inside Salesforce. Your choice must align with your global Assets Target Mode setting:

  • How it works: The app extracts only the raw, single asset URL from Akeneo and writes it directly as text
  • Best used for: Akeneo Custom Objects mode. If you store your assets in the custom object package (Akeneo_Product_Asset__c), a simple string URL is perfect for basic integrations or custom image display components.

2. When to use Object or Array of Objects (Required for Standard Mode)

  • How it works: Instead of a simple URL, the app fetches a structured JSON object containing all the rich metadata fields of the Akeneo asset
  • Best used for: Salesforce Standard Objects mode (Salesforce CMS)

Because standard Salesforce CMS records and storefront ProductMedia require multiple native properties to function properly, you must use Object (for a single asset mapping) or Array of Objects (to group multiple assets). This rich format allows the app to properly map and populate the following native Salesforce CMS attributes:

  • Asset Name ➔ CMS Content Name / Title: Used to name the media record within your CMS Workspace. Keep names clear and human-readable
  • Asset URL ➔ CMS Image Source URL: Must be a durable, publicly renderable URL (and not an authenticated Akeneo REST API media-file URL) so Salesforce CMS can render it on the storefront
  • Alt Text ➔ CMS Image Alt Text: Automatically mapped to ensure accessibility compliance and storefront quality
  • Media Type ➔ Product Media Usage: Maps your Akeneo Media Type (e.g., PDP, PLP, Attachment) directly to standard Salesforce storefront usage

Important CMS Note

Salesforce enforces strict per-product media limits. Any assets transferred beyond these limits will be skipped to prevent synchronization errors.

 

 

Configure Variation Axes Mappings

Prerequisite Note

You only need to configure Variation Axis Mappings if you have set your global Variation Axes Target Mode to Standard. If you keep this domain on Akeneo Custom Objects (the default path), this configuration is not required.

 

When transferring multi-variant products in Standard Mode, you must define how Akeneo's variation axes match your Salesforce standard target fields. The records you create here establish the relationship between Akeneo attribute codes and your custom Salesforce ProductAttribute picklist fields.

Architectural Guide

For the full overview of standard variation prerequisites and validation methods, please check our dedicated guide: Configuring Variation Axes with ProductAttribute.

 

 

How to Access Variation Axes Mappings

You can view and manage your variation mappings using either of the following methods:

  1. Open the Akeneo Connector Application from the App Launcher
  2. Locate the Akeneo Variation Axis Mappings component on the homepage
  3. Click Edit Configuration Details to adjust them

Method 2: Via Salesforce Setup (Technical Path)

  1. Go to the Salesforce Setup section
  2. In the Quick Find box, search for and select Custom Metadata Types
  3. Click Manage Records next to the custom metadata type called Akeneo Variation Axis Mapping

 

How to Create or Edit a Variation Axis Mapping

To map a variation axis for your Standard Mode setup:

  1. From the variation axis mapping list view, click the New button (or click Edit next to an existing record)
  2. Populate the fields based on the following parameters

Label Value Details
Label Color Picklist The display label used for this mapping record within Salesforce Setup
Akeneo Variation Axis Mapping Name Color_Picklist The unique API name for this metadata record (automatically populated based on the Label)
Akeneo Axis Code color The exact Attribute Code of the variation axis as defined in your Akeneo PIM instance (e.g., color, size, shirt_size)
ProductAttribute Field API Color__c The API name of the distinct target picklist field you manually created inside the standard Salesforce ProductAttribute object

 

Requirements for Standard Variation Axes

When this mapping is active in Standard Mode, ensure the following Salesforce setup is completed:

  • Distinct Fields: You must create a distinct ProductAttribute picklist field for each required Akeneo axis (e.g., Color__c and Size__c)
  • Metadata Sync (Salesforce Self): If you need the connector to automatically create or update the picklist values (options) inside Salesforce when they change in Akeneo, you must configure Salesforce Self Client Credentials. If Salesforce Self is skipped, new picklist options must be managed manually in Salesforce Setup
  • Data Limitation: Existing simple Product2 records cannot be converted into Variation Parent records by the connector. Remediate or recreate any incorrect product type data manually before running the sync