Here you can find some information to configure the connector.
Contents
Bynder to Akeneo Mapping Parameters
Attributes in the conditions
In Bynder you can split the meta-properties in 2 types :
- Native metaproperties (isPublic, Type, …)
- Specific meta-properties : your meta-properties, defined with your Bynder integration team.
For the native attributes, the name is the same in the condition and in Bynder
"field": "isPublic",
For the specific meta-properties, you must add the “property_” information in the condition. If we take the example of “Document_Type” as the name of your specific meta-property, in the condition, you must put :
"field": "property_Document_Type",
Operators for the conditions
For the conditions, you can use different operators :
- IN
- Works for “Simple Select” and “Multi Select” meta-properties
This operator is used for the Select or List attributes. Thanks to this, you can retrieve the assets that match with at least one value of the values.
Example on how to filter the asset which the type is image or picture
{
"field": "type",
"operator": "IN",
"value": [
"image",
"picture"
]
}
- EQUALS
- Works for “Simple Select” and “Boolean” meta-properties
This operator is used for the Select or List attributes. Thanks to this, you can retrieve the assets that match specifically to one value.
Example on how to filter the asset which the isPublic is true
{
"field": "isPublic",
"operator": "EQUAL",
"value": 1
}
- NOT_EMPTY
- Works for “Text“, “Simple Select” and “Boolean” meta-properties
Example on how to filter the asset which the sku is not empty
{
"field": "property_sku",
"operator": "NOT_EMPTY"
}
- CONTAINS
- Works for “Text” meta-properties
Example on how to filter the asset which the name contains “ONLY THESE”
{
"field": "name",
"operator": "CONTAINS",
"value": "ONLY THESE"
}
- DOES_NOT_CONTAIN
- Works for “Text” meta-properties
Example on how to filter the asset which the name does not contain “NOT THESE”
{
"field": "name",
"operator": "DOES_NOT_CONTAIN",
"value": "NOT THESE"
}
More operators will be released soon to be used in the configuration
Features for “metadata”
In the mapping, you can just want to send some meta-properties to Akeneo
- On the left, you put the Bynder meta property
- On the right, you put the Akeneo asset attribute code
"metadata": {
"BYNDER_SKU": "sku",
"id": "asset_id",
...
}
But sometimes you have to specify the scope or the local to fit to your Akeneo asset attribute configuration
"metadata": {
"name": [
{
"attribute": "label",
"locale": "de_DE"
},...
}
We also added a “concatenation” feature, so you can merge many Bynder meta-properties into one Akeneo asset attribute value. In that case you must use a patern in which you will specify
- the property_type : “pattern”
- the source : pattern you will use (with the Bynder meta properties)
- the target : Akeneo asset attribute
"metadata":{
"pattern_metadata": {
"property_type": "pattern",
"pattern": "%%bynder-sku%%#%%bynder-variant-sku%%-%%tags%%: id=%%id%%.",
"attribute": "skus_pattern"
},...
}
Link assets to many products
The standard is
"akeneo_asset_multi_products": {
"CODE_FOR_YOUR_RULE": {
"asset_family": "AKENEO ASSET FAMILLY CODE",
"identifiers": "{{ASSET FAMILLY ATTRIBUTE}}",
"locale": null,
"channel": null,
"product_attribute": "AKENEO PRODUCT ATTRIBUTE",
"separator": "|"
}
Example 1
In this example, we will have a rule name “rule_one” which will take the assets from the asset family “MyFabulousAssetFamilyCode”.
In this family, the attribute “myLinkedProducts” will contain the SKU to be linked to the asset. As the value is dynamic, we have to put the attribute between {{ }}
The asset collection Product attribute “MyAssetCollection” is not scopable and is not localisable, so we leave the value as null. In our case, the SKU in the “myLinkedProducts” are separated with a comma.
"akeneo_asset_multi_products": {
"rule_one": {
"asset_family": "MyFabulousAssetFamilyCode",
"identifiers": "{{myLinkedProducts}}",
"locale": null,
"channel": null,
"product_attribute": "MyAssetCollection",
"separator": ","
}
Example 2
In this example, we will have a rule name “rule_two” which will take the assets from the asset family “MySecondFabulousAssetFamilyCode”.
In this family, the attribute “myLinkedProducts” will contain the SKU to be linked to the asset. As the value is dynamic, we have to put the attribute between {{ }}
The asset collection Product attribute “MyAssetCollection” is not scopable but is localisable, so we leave the Scope value as null and we want to put the assets in the “French” locale. We put a specific value for the locale “fr_FR”. The locale must be activated in the PIM.
In our case, the SKU in the “myLinkedProducts” are separated with a comma.
"akeneo_asset_multi_products": {
"rule_one": {
"asset_family": "MySecondFabulousAssetFamilyCode",
"identifiers": "{{myLinkedProducts}}",
"locale": "fr_FR",
"channel": null,
"product_attribute": "MyAssetCollection",
"separator": ","
}
Example 3
In this example, we will have a rule name “rule_three” which will take the assets from the asset family “MySecondFabulousAssetFamilyCode”.
In this family, the attribute “myLinkedProducts” will contain the SKU to be linked to the asset. As the value is dynamic, we have to put the attribute between {{ }}
The asset collection Product attribute “MyAssetCollection” is not scopable but is localisable, so we leave the Scope value as null and we want to take the value of the asset attribute “localisation” for the locale. We put a “dynamic” value for the locale “{{localisation}}”. The locale must be activated in the PIM.
In our case, the SKU in the “myLinkedProducts” are separated with a comma.
"akeneo_asset_multi_products": {
"rule_three": {
"asset_family": "MySecondFabulousAssetFamilyCode",
"identifiers": "{{myLinkedProducts}}",
"locale": "{{localisation}}",
"channel": null,
"product_attribute": "MyAssetCollection",
"separator": ","
}