How to configure catalogs for Apps?


What's a catalog?

With catalogs, you can configure which products you want to share with an app thanks to a product selection composed of one or several criteria that allow you to filter products.

When an app uses catalogs to retrieve product data, it automatically enables the Catalogs tab and creates catalogs for this app in your PIM. To configure your catalogs: 

  1. Go to Connect, then Connected Apps
  2. Click Manage app, and then click Catalogs.

Here you access the list of all the catalogs the app can manage with a label and a status.

Click on the catalog you want to set up to access the configuration interface.

When you access a catalog, you will see two tabs:

  • Product selection: where you will configure criteria to filter your product selection,
  • Filter the values: when a catalog is not compatible with mapping, we display this tab to allow you to choose which values to send to the app based on filters,
  • Product mapping: where you can map your PIM attributes with the app expected targets.


If you can't click on Manage apps, please read our paragraph Who can connect apps?



Configure your catalog product selection

In the Product selection tab, you can define selection criteria. They are the attributes or system fields you can use to filter your products. Altogether, the criteria will create your Product selection.

When there are no criteria, your whole PIM catalog is selected.



You will find the system fields at the top of the list, and below are all the attributes gathered by attribute groups. There is a search bar to help you find the attributes.

Each time you add a criterion, its color turns purple to inform you that it is already used.  
A new line appears in the product selection.

Let's see how a line is organized.

  1. You will find the system fields or attribute you chose in purple on the left.
  2. Then, you have to choose an operator. Depending on the filter, the operator list changes.

The following fields vary depending on your filter. There can be up to 3 types of fields.

  • You can have the value field. For example, if your filter is a multi-select attribute type, you can choose which options you want to filter on.
  • If your filter has a value per channel and/or per locale, the channel and locale fields appear to let you choose which locale/channel you want to filter on.

If you want to remove a condition, click on the cross at the end of the line.


Available conditions

To select your products, you can use the following system fields and attribute types of the PIM as conditions:

  • Status
  • Category
  • Completeness
  • Family
  • Simple select attribute
  • Text attribute
  • Measurement attribute
  • Yes/No attribute
  • Multi-select attribute
  • Number attribute
  • Text area attribute
  • Date attribute
  • Identifier
  • Measurement


Configure the product data mapping

After configuring your product selection, you must configure your product data mapping. To do so, let's switch to the Mapping tab. 

You will see 2 columns in this tab: the target list and the Sources. The left panel displays all the app's targets to synchronize your product data, and you can configure the sources to map with the target in the right panel. 

Please note that target names are not translated as we display the value sent by the app. 



Apps can require different types of targets: 

  • String with no specified format, 
  • String with the date-time format,
  • String with the link (URI) format,
  • Number, 
  • Boolean, 
  • Array of strings, 
  • Array of strings with the link (URI) format. 

Using the type information, the source panel suggests all PIM attributes or properties that match the expected target type or could match the target type after applying transformation functions. 

The source panel suggests as PIM sources the following attribute types:

  • identifier,
  • parent code,
  • family (code or label),
  • categories (code or label),
  • groups,
  • product status (enabled),
  • text,
  • textarea,
  • date,
  • number,
  • measurement,
  • price,
  • simple select (code or label),
  • multi-select (code or label),
  • yes/no,
  • image,
  • single reference entity link:
    • code, 
    • text, 
    • number, 
    • simple select attributes,
    • multi-select attributes,
    • image,
  • multiple reference entity link:
    • code, 
    • text, 
    • simple select attributes,
    • image,
  • asset collection: 
    • code,
    • text,
    • media file,
    • media link,


Please note that we only send the first asset value when you map an asset collection attribute with a string target. 



Select source

To select a source:

  1. Go to the Mapping tab, 
  2. Select a target in the left panel, 
  3. Then, click Add source and select the property or attribute you want to map.



For some sources, you may have to configure additional information. 

  • When an attribute has value per locale, select the locale to use for exporting the data. 
  • When an attribute has value per channel, select the channel to use for exporting the data. 



Source parameters

Depending on the selected attribute type in the Sources panel, you may have to set up additional configurations. 

  • For select attribute types, simple and multi, you must select a language in which the value should be sent. When the app synchronizes the product data, it will get the option translation you set up in your PIM settings instead of the option code. 
  • You must select a currency for price attributes so the PIM can send the related amount to the app when it gets product data. 
  • You must select a unit for measurement attributes so the PIM can send the related value to the app when it gets product data. Note that if the unit you select is not the unit used in the product, the PIM converts the value before sending it to the app. 


Default values 

When the source value is empty

In the source settings, when possible, we display a Default value when is empty field. If you fill in this field, the PIM will send this value when the product's source attribute value is empty. 

When you have no target to map

For string, number, and boolean targets, you can select a Default value when you have no source to map. In this case, the PIM will send the default value you set up as the target value for all your products.


Replace values

When you map one of the following source types, you can choose to replace your PIM values with new ones. 

  • families,
  • categories,
  • simple select attributes,
  • multi-select attributes,
  • single reference entity link: code, label, single option, and multiple options attributes
  • multiple reference entity link: code, label, and single option attributes

To do so, click Replace values in the Sources section. It displays a new screen where you can manage your replacement values. 

For example, in your PIM, you manage different blue colors: denim, dark blue, light blue, etc. But the marketplace you want to connect only manages the blue color. You might want to replace all your blues with the “Blue” value.

Once you are done, click Confirm. It closes the Option replacement screen and brings you back to the mapping.



Sometimes, you might need to transform your PIM data to match specific channel requirements. To do so, you can use the Transformation section. 

In this section, you can find the list of the sources you selected in the section above, a preview using 3 products' values, and the transformation field. 


Please read the Akeneo function list page to learn more about transformation functions.



Configure value filters

In the Filter the values tab, you can configure data filters to send only the data your app needs.


Available filters

To filter product values, you can use the following filters:

  • Channels: when an attribute has value per channel, the PIM sends only product values for the selected channels
  • Locales: when an attribute has value per locale, the PIM sends only product values for the selected locales
  • Currencies: the PIM sends only prices for the selected currencies



You connect your e-commerce app with your PIM and want to send only data related to your e-commerce channel.

In the Filter the values tab, we advise you to filter the values on your e-commerce channel as in the following screenshot.


Enable/disable a catalog

Once you finish configuring your catalog, update the Enable status value to Yes in the catalog header.

As soon as you enable a catalog, the app will be able to retrieve your product selection data.

On the contrary, if you want to stop the catalog synchronization between Akeneo PIM and the app, update the Enable status value to No in the catalog header.

All new catalogs are disabled by default when you connect an app. It's up to you to enable them when your configuration is ready.