Bynder Connector app

Tasks

Create a new task

There are 4 Task Types in the Bynder App:

Click on the + Create button on the right side. In the modal you can enter your task code and select the type for your new task:

1. bynder_v2_import_assets_from_bynder: This task is used to import digital assets from Bynder. The task allows you to retrieve assets from Bynder and store them in Akeneo

2. bynder_v2_enrich_bynder_asset_properties: This task will update the asset type, product codes, product model codes and all mapped meta properties of the asset in Bynder.

3. bynder_v2_full_bynder_sync: This task will run the 2 tasks above in sequence.

4. bynder_v2_unlink_assets_from_bynder: This task will look at all the assets in Bynder and validate if it must be unlinked in Akeneo.

Bynder configuration

We will start off by doing the preparations on the Bynder instance. A few things need to be set up here.

Permanent token

You can create a permanent token by navigating to ‘Advanced settings’ > ‘Portal settings’ > ‘Permanent tokens’ using the cog in the upper right hand side of the application, provided you have the necessary rights to do so.

Clicking ‘Add new’ prompts a form with a Bynder user selection. This would preferably be linked to a dedicated user, since the history/actions will be linked to the selected one. The user should have the following permission active:

Next up you select the access scopes of the token:

After selecting the user, scopes and confirming, a permanent token should be generated (store it somewhere on temporary location as leaving the page will obscure the token) which we can use to add to the credentials in Akeneo.

Metaproperties

A few metaproperties need to be defined/existent to link to a product’s (or model’s) identifier and the related attribute within that product in Akeneo.

First of all, we want a product identifier with the advised configuration as follows:

Then we define the same type of metaproperty, but for product model codes:

We want to make sure there is a metaproperty that contains/links to the attribute name that reflects the image attribute name of the product in Akeneo. The following setup would be advised:

There is an optional possibility to map 1 metaproperty option to multiple image attributes, provided they have the same name affixed with a dash and count. (f.e. ‘application’ in bynder => ‘application_1’, ‘application_2’ in Akeneo CE) In that case, an order field needs to be added in Bynder to define the order of the assets that get linked.

The metaproperty configurations above are according to us the most optimal configurations in terms of usability and added value. As long as the metaproperty is available through the Bynder API (ApiField) and the value reflects/maps with the corresponding values in Akeneo, the asset will get linked.

Mapping index

Each task needs to have the json mapping. Below is a list of mappings used in our application.

1. Derivative to Use

2. Asset Unlink After Archiving

3. Export bynder url to akeneo attribute

4. Property mappings

5. Asset Type MetaProperty Options Mappings

6. Enrichment MetaProperty Mappings

7. Localizable Asset Type MetaProperty Mappings

8. Scopable Asset Type MetaProperty Mappings

9. Sortable Asset Type MetaProperty Mappings

10. Enrichment MetaProperty Options Mappings

11. Enrichment MetaProperty Locale Mappings

12. Enrichment MetaProperty Scope Mappings

13. Enrichment of MetaProperties: measurement configuration

14. Update Metaproperty on Empty Only Mappings

15. Asset Enrichment MetaProperty Mappings

16. Asset Family Mappings

17. Media Link Attribute Code

18. Attributes with No Physical File Mappings

19. Domain Mappings

20. Derivative Mappings

21. New Asset Version on Update Mappings

Click on the mapping title to view more details about each mapping.

If you need further assistance, please do not hesitate to ask.

CE Example

{

  "domain_mappings": {

    "acc": "https://induxx.demo.cloud.akeneo.com"

  },

  "property_mappings": {

    "asset_type": "asset_type",

    "sort_order": "akeneo_order",

    "domain_code": "domain",

    "product_code": "product_codes",

    "applicable_scopes": "applicable_scopes",

    "applicable_locales": "applicable_locales",

    "product_model_code": "product_model_codes"

  },

  "derivative_mappings": {

    "urls": {

      "product_image": {

        "ecommerce": "product_image_ecommerce_url"

      }

    }

  },

  "new_asset_version_on_update_mappings": [

    "main_image"

  ],

  "enrichment_metaproperty_mappings": {

    "family": "family",

    "brand_name": "Brand"

  },

  "enrichment_metaproperty_locale_mappings": [

    "family"

  ],

  "asset_type_metaproperty_options_mappings": {

    "basis": "basis",

    "picture": "picture",

    "main_image": "main_image",

    "product_image": "product_image_bynder",

    "scopable_image": "scopable_image",

    "application_image": "application",

    "localizable_image": "localizable_image"

  },

  "enrichment_metaproperty_options_mappings": {

    "color": {

      "red": "red_bynder",

      "blue": "blue_bynder",

      "green": "green_bynder"

    },

    "category": {

      "electronics": "electronics_bynder",

      "clothing": "clothing_bynder",

      "accessories": "accessories_bynder"

    }

  },

  "attributes_with_no_physical_file_mappings": [

    "product_image"

  ],

  "scopable_asset_type_metaproperty_mappings": [

    "scopable_image"

  ],

  "sortable_asset_type_metaproperty_mappings": [

    "application_image"

  ],

  "update_metaproperty_on_empty_only_mappings": [

    "color"

  ],

  "localizable_asset_type_metaproperty_mappings": [

    "localizable_image"

  ]

}

EE Example

{

  "domain_mappings": {

    "acc": "https://induxx.demo.cloud.akeneo.com"

  },

  "property_mappings": {

    "domain_code": "domain",

    "applicable_scopes": "applicable_scopes",

    "asset_family_code": "akeneo_asset_family_code",

    "applicable_locales": "applicable_locales"

  },

  "asset_family_mappings": {

    "bynder_assets": "bynder_assets"

  },

  "media_link_attribute_code": "bynderurl"

}

Reference entity Example

{

  "property_mappings": {

    "domain_code": "domain",

    "applicable_scopes": "applicable_scopes",

    "applicable_locales": "applicable_locales",

  "reference_entity_code": "reference_entity_code",

  "reference_entity_record_code": "reference_entity_record_code",

  },

  "reference_entity_media_attribute_code": "image",

"derivative_mappings": {

    "urls": {

      "image": {

        "ecommerce": "image_ecommerce_url"

      }

    }

  },

}

Categories Example

{

  "property_mappings": {

    "domain_code": "domain",

    "applicable_scopes": "applicable_scopes",

    "applicable_locales": "applicable_locales",

  "category_code": "category_code",

  },

  "category_media_attribute_code": "media",

"derivative_mappings": {

    "urls": {

      "media": {

        "ecommerce": "media_ecommerce_url"

      }

    }

  },

}