Akeneo Connector for Salesforce Commerce Cloud

22.2.1
Developed by Akeneo
Akeneo PIM compatibility
Enterprise Edition (SaaS) Supported
Enterprise Edition (PaaS)
Growth Edition Not supported
Community Edition Not supported
Salesforce Commerce Cloud
compatibility
Versions
SFRA compliance
SFCC Compatibility Mode 19.10
Extension type
Connector
More info
Extension version
22.2.1
Price: Quote based

Description

The easiest way to spread your catalog to Salesforce Commerce Cloud

Utilize Akeneo’s open source PIM solution to easily consolidate, enrich, manage, and export product information to Salesforce Commerce Cloud. This connector leverages the latest API technology to provide seamless integration between Akeneo PIM and Commerce Cloud.

Akeneo connector for Salesforce Commerce Cloud

SFCC

How it works

Once the architecture of your catalog is complete in Akeneo PIM, and your collections ready for export, you can spread your product content to Salesforce Commerce Cloud in just a few steps from the Business Manager of Salesforce Commerce:

 

  • Upload the .zip archive that contains the connector
  • Fill in the API credentials to bind your Akeneo instance with your SFCC account
  • Set a handful of custom preferences to ease synchronization between Akeneo catalog and Salesforce Commerce Cloud architecture as per your own needs
  • Use the Job schedules feature to run pre-set jobs that will call relevant API endpoints to fetch the whole catalog inside Salesforce Commerce Cloud

See how it works in details with a full demonstration of our extension here:

 

Video

Features

The integration enables the merchant to set up pre-defined jobs in Salesforce Commerce Business Manager to retrieve product data, product with variants, categories, attributes, media, assets, associations and price books from Akeneo PIM.

Imports can be made either manually or automatically through CRON jobs as part of the native Jobs feature of Salesforce Commerce Cloud.

A set of custom preferences also enables the merchant to map Akeneo PIM attributes to existing Salesforce Commerce taxonomy.

Contact

Get in touch with Akeneo to know more about the perks and the support model of Akeneo Connector for Salesforce Commerce Cloud.

  • Tel. (France): +33 (0)2 55 59 00 00
  • Tel. (Germany): +49 211 2339 6655
  • Tel. (U.S.A.): +1 (833) PIM-4ALL
  • E-Mail: demandware@akeneo.com
Salesforce link Salesforce

Feature list

Latest update: August 19, 2022

Akeneo PIM data/properties

Product structure: attribute types

  • Identifier More info
    Available
  • Price More info
    Available
  • Text More info
    Available
  • Text area More info
    Available
  • Number More info
    Available
  • Yes-No More info
    Available
  • Date More info
    Available
  • Measurement More info
    Available
  • Simple select More info
    Available
  • Multi select More info
    Available
  • Image More info
    Available
  • File More info
    Not available
  • Table More info
    Available
  • Asset collection More info
    Available
  • Reference entity single link More info
    Available
  • Reference entity multiple links More info
    Available

Product structure: attribute properties

  • Localizable attribute (value per locale) More info
    Available
  • Scopable attribute (value per channel) More info
    Available

Product structure: Families

  • Family More info
    Not available
  • Family variant More info
    Available

Categories

Products

  • Simple product (with no variation) More info
    Available

Products status

  • Enabled/Disabled More info
    Available

Product model

  • Product with 1 level of variation More info
    Available
  • Product with 2 levels of variation More info
    Available

Attribute type as variation axis

Product association

  • Cross sell More info
    Available
  • Upsell More info
    Available
  • Pack More info
    Available
  • Substitution More info
    Available
  • Custom association More info
    Available
  • Association with quantities More info
    Available

Association level

  • Association at product level More info
    Available
  • Association at product model level More info
    Available

Assets

Asset structure: attribute type

  • Media file More info
    Available
  • Media link More info
    Available
  • Prefix and Suffix media link property More info
    Available
  • Text More info
    Available

Asset structure: attribute properties

  • Localizable attribute (value per locale) More info
    Available
  • Scopable attribute (value per channel) More info
    Available

Asset level

  • Assets at product level More info
    Available
  • Assets at product model level More info
    Available

Reference entities

  • Reference entity properties More info
    Available

Reference entity structure: attribute type

Reference entity record structure: attribute properties

  • Localizable attribute (value per locale) More info
    Available
  • Scopable attribute (value per channel) More info
    Available

Reference entity level

  • Reference entity at product level More info
    Available
  • Reference entity at product model level More info
    Available

Published products

Connector/App capabilities

Scope/Channel

  • Capability to manage one eCommerce PIM Channel More info
    Available
  • Capability to manage multiple PIM Channel More info
    Available

Multiple eCommerce organizations/websites

  • Capability to manage multiple eCommerce websites/storefront More info
    Available
  • Capability to manage multiple organizations More info
    Available

Measurement mapping

  • Capability to map the value More info
    Not available
  • Capability to map the value and the unit More info
    Available

Attribute mapping

  • Capability to map PIM attribute with eCommerce default attribute More info
    Available
  • Capability to map PIM attribute with eCommerce custom attribute More info
    Available

Family filtering

  • Capability to choose which PIM families to import More info
    Available

Product/Product model filtering

  • Simple filter based on product completness, status, modification date More info
    Available
  • Advanced filter based on attribute values or other product properties More info
    Available

Category filtering

  • Capability to define which category trees to import More info
    Available
  • Capability to define which sub-category trees to import More info
    Not available

Reference entity mapping

  • Capability to import only reference entity record label More info
    Not available
  • Capability to import all the reference entity record data structure with labels and images More info
    Available

Media/Asset mapping

  • Capability to choose between PIM media attribute (image/file) and/or assets More info
    Available
  • Asset: capability to manage asset media file (media uploaded in the PIM) More info
    Available
  • Asset: capability to manage asset media link (media from a CDN/DAM) More info
    Available
  • Asset: capability to manage multiple image sizes More info
    Available

Data synchronization

Trigger

  • Capability to trigger automatically the data synchronization (with a scheduling system) More info
    Available
  • Capability to trigger the data synchronization manually (on demand) More info
    Available

Synchronization strategy

  • Capability to manage PIM data differential (to import only updated data) More info
    Available
  • Retrying synchronization after failure More info
    Not available

Scalability and performance

  • Capability to manage large PIM data volume/complexity (or known limits) More info
    Available
  • Capability to manage PIM data synchronization time in an optimized way (Time-to-market oriented) More info
    Available

Release notes

About Akeneo Connector for Salesforce Commerce Cloud

The Akeneo Connector has been certified under version 21.0.0 of Salesforce Commerce Cloud.

Salesforce Commerce Cloud integration is a certified plug-in for the Salesforce Commerce Cloud platform. Leveraging Akeneo API technology, this extension is designed to work with the following versions of Akeneo PIM, Enterprise editions.

Akeneo Connector is also compatible with the latest StoreFront Reference Architecture of Salesforce Commerce Cloud as well as the Model View Controller.

Release notes

22.2.1

  • Split job 2 into separate job pricebook and assets
  • Merge jobs 3 in 3-0-Akeneo-FULL-Import-Initialization
  • Rename jobs uppercase FULL and DIFFERENTIAL
  • Add RuntimeObjectID to pricebook job
  • Add Reference entities differential import
  • Rename job 6

22.2.0

Functional enhancements: 

  • Improve import table attribute setting by adding the new API paramater: with_table_select_options

UI enhancements:

  • Change the Naming of Import fields in General section
  • Move Write PIMCategories (akeneoWriteCategories) above Akeneo Category Online
  • Add information for the following helpers:
  • Akeneo Service General URL
  • Akeneo Main (Catalog) Categories
  • Akeneo Main Catalogs becomes Akeneo Main Category to clarify the usage

21.1.1

  • New feature: add the possibility to import attribute table. (5.0)
    Note: in case of update of the cartridge, don’t forget to import new metadata file.
  • New feature: Execute job with Replace ImportMode (5.0; 4.0)
  • Enhancement: Optimize the categories process by using API filter IN CHILDREN (5.0; 4.0)

21.1.0

Enhancement

  • The cartridge now uses the Akeneo API Category filters when requesting products, based on the configuration field "topLevelCategoryID"

21.0.0

  • Certified version, this involves some modifications:
    • The cartridge has been renamed in 'bm_akeneo` for the Salesforce Commerce Cloud certified connector. Please note that: 

Steps for Akeneo connector cartridge renaming : 
- upload the new cartridge version on the target plateform
- edit the Site configuration so that it now uses the bm_akeneo cartridge : 
  Manage Sites => "SiteName" => Settings and in the Cartridges field, rename bc_akeneo to bm_akeneo
- delete the old "x-Akeneo-...' jobs
- import the new metadatas (Administration > Site Import & Export)
To make sure the jobs are pointing to the correct cartridge, go to Administration > Jobs > Open any of the "x-Akeneo-..." job, go to the "Job Steps" tab. The "ExecuteScriptModule.Module" field should point to a path starting with "bm_akeneo".

  • The code compatibility mode switched from 18.10 to 19.10

20.5.0

New feature

  • The connector manages association with quantity feature in a bundle association type

Enhancement

  • Changes to configuration interface's labels and documentation

Bug fixes

  • Remove category assignment duplicates on variants

20.4.0

New feature

  • Add support for prefix/suffix parameter for media URL

Enhancement

  • Changes to configuration interface's labels and documentation

Bug fixes

  • Remove category assignment duplicates on variants

20.3.10

Bug fixes

  • Leave AkeneoCatalogRunTime as it is and only updates it if the job succeeds (with the date of the beginning of the job execution)

20.3.9

Enhancement

  • The both way product association (A <==> B) and simple way (A ==> B) have been implemented.

Bug fixes

  • Null check on storefront catalog header (SDS-17263)

20.3.8

Enhancement

  • Now consider the "Start time" of the last successful import job for differential imports.

Bug Fix

  • Missing NULL check on writeImagesXML.js is not creating an error anyway

  • A proper Error message is logged when image view type setting is empty

  • Code checking for image view type settings when image import is not enabled

20.3.7

Bug Fix

  • Bug Fix: Null Pointer Exception in generateImagesXML.js

20.3.6

Enhancement

  • Introduced new configuration for mapping Media Assets Attributes to SFCC Image Viewtypes

20.3.5

Bug Fix

  • Bug Fix: Can't get labels from attributes when using mappings

20.3.4

Bug Fix

  • Storefront Import does not throw warning anymore when running an import without Categories

20.3.3

New feature

  • You can decide to not copy the PIM categories into SFCC. More detail online

20.3.2

Enhancement

  • Asset and Media jobs are more resilient to errors, which means if an error occurs in the asset import process, then the import job status will be in orange with the WARNING label. Details of the error are explicitly written down in the import log file.

Bug fix

  • Multi-select Bug Fix

20.3.1

Enhancement:

  • in order to have a direct visualization of the variant medias, we have created thumbnails in the image grid.

20.3.0

Features:

  • The cartridge is now compatible with the new 4.0 Asset Manager and allow you to manage:

    • IMAGES (URL or Upladed images in the PIM)

    • VIDEO (Youtube & Vimeo links only)

    • FILES - PDF or Other (URL or Uploaded media in the PIM

Enhancement:

  • To overcome the SharedLibrary limitation we have decided to change slightly the way to store the media information as a product attribute. Please check the related online documetation

20.2.3

Enhancement:

  • Performance issues fix.

20.2.2

Features:

  • Possibility for the user to synchronize the PIM enable/Disable status with the SalesForce onlineFlag property.

Enhancement:

  • You now have the possibility to link PIM attributes to 32 standards SF attribute (instead of 8 before):

["EAN", "UPC", "unit", "minOrderQuantity", "stepQuantity", "name", "shortDescription", "longDescription", "onlineFlag", "onlineFrom", "onlineTo", "searchable", "searchableIfUnavailable", "template", "taxClassID", "brand", "manufacturerName", "manufacturerSKU", "searchPlacement", "searchRank", "siteMapIncluded", "siteMapChangeFrequency", "siteMapPriority", "pageTitle", "pageDescription", "pageKeywords", "pageUrl", "pinterestEnabled", "facebookEnabled", "storeReceiptName", "storeForcePriceEnabled", "storeNonInventoryEnabled", "storeNonRevenueEnabled", "storeNonDiscountableEnabled"]

note: those one are not mappable:

["ID", "UUID", "lastModified", "creationDate"] => reserved to the SF system auto generation

["available", "image", "thumbnail", "storeTaxClass"] => deprecated by SF

20.2.1

Bug fix:

  • Bad product attribute grouping (due to a PIM API evolution).

20.2.0

New features:

  • Compliance with New Asset Manager, image-based assets only (Documentation)
  • Improve Product model mapping (compliance for variant axes attribute types). It is now possible to create a product variation axis of those kinds (Documentation):
    • Simple select
    • Reference entity single link (EE only)
    • Measurement (ex metric)
    • Boolean (Yes/No)

Enhancements:

  • Be able to have more than 1 attribute on the first variation axis to spread images in the created variations in SFCC (as a gift, the attributes for variation are now automatically gathered)
  • To avoid the contributed refinement to disappear at every import, a new job has to be created on the SF side to copy those refinements in a cache.

Bug fix:

  • Wrong catalog import and out of memory error, fixed
  • The recommendation issues (not working anymore), fixed
  • Be able to select the assets by picking the scope/channel under consideration, fixed

20.1.2

  • Bug fix: If simple/multi-select attribute is deselected in PIM, it will now reflect the change in SFCC.

20.1.1

  • Salesforce certified version
  • In SFCC Marketplace this version is available as 20.1.0 as per SFCC's version number standards
  • We release the same certified version as version number 20.1.1 because we already released a version with number 20.1.0 earlier this year in our GitHub before getting certification from SFCC for this year

20.1.0

  • Introduced custom cache
  • Certification fixes

19.10.1

  • Clearing impex directories before executing each job

19.10.0

  • Full sync optimization
  • Removed usage of custom objects in model-variation import

19.9.0

19.8.0

19.7.1

  • Documentation corrected/updated

19.7.0

  • New feature added: Support mutliple organizations and storefronts (Documentation)

19.6.1

  • Multiple bug fixes

19.6.0

  • New feature added: Import Model-Model-Variations into Model-Variation Group-Variations (Documentation)

19.5.3

  • Filter attribute meta import

19.5.1

  • Updated feature: Advanced Filter Builder

19.5.0

  • New feature - Import association as Product Sets (Documentation)

19.4.1

  • New feature - Import association as Product Links (OR Recommendations) (Documentation)

19.3.3

  • Bug fix: Empty attribute for product variation

19.3.2

  • Bug fixes on API Token refresh

19.3.1

  • Upgraded to Script Module version
  • Find the steps to migrate from existing Pipeline version to Script Module version in our documentation

19.2.3

  • Bug fix on asset update

Note: Re-import of custom-objecttype-definitions is recommended

19.2.2

  • Bug fixes: Asset update
  • Bug fixes: Adding variation to already imported Master

Note: Expecting a one time full import just after applying these bug fixes

19.2.1

  • Bug fix: importing multiple types of Table attributes

19.2.0

Certified version

Akeneo Connector for Salesforce Commerce Cloud (Akeneo PIM v.2.3)

  • Jobs are configured to trigger pipelines
  • Imports Master-Variation products
  • Imports product associations

Documentation

Akeneo Connector for Salesforce Commerce Cloud Documentation

 

Have a look at our Help Center to go through the installation process, and get a handful of tips to configure the settings of your Akeneo Connector properly.

Help Center

How to install Akeneo Connector for Salesforce Commerce Cloud

Cartridge Upload

Upload the bc_akeneo cartridge into the Salesforce Commerce Cloud Studio Workspace:

1.    Open Salesforce Commerce Cloud Studio.
2.    Click File -> Import -> General -> Existing Projects into Workspace.
3.    Browse to the directory where you have saved the bc_akeneo cartridge.
4.    Click Finish.
5.    Click OK when prompted to link the cartridge to the sandbox.

Metadata Import

For the Akeneo integration to work, the following object structures (metadata) needs to be imported and configured in the Business manager. Follow the below steps:

1.    In the cartridge bundle find metadata/ simple-akeneo-workflow_site-import and compress it to generate simple-akeneo-workflow_site-import.zip file.
2.    Go to Business Manager Menu > Administration > Site Development > Site Import & Export
3.    Under Import : Upload Archive : Ensure that the radio button with label Local is enabled (Else click on the radio button to enable it)
4.    Click on Choose File input field, select the simple-akeneo-workflow_site-import.zip file from open dialog box and click on upload button
5.    After finishing the upload, from the Archives list click the radio button corresponding to simple-akeneo-workflow_site-import.zip and click on Import button
6.    Click on OK button of the confirmation box asking “Are you sure that you want to import the selected archive?”

Cartridge Path

1.    Go to Business Manager Menu > Administration -> Sites -> Manage Sites.
2.    Select the desired site.
3.    Click on the Settings tab.
4.    Append ":bc_akeneo" to the "Cartridges" field.
5.    Click on Apply button.
6.   Repeat steps d and e for all sites including Business Manager site.

Configuration

For using Akeneo’s jobs, here the requirements:
- have at least one site activated for associate job to site scope.
- have at least one storefront catalog associate to your current site.
(The master catalog which contain all akeneo product will be automatically created)

Once all previous requirements are valid, you have to configure Custom Site Preferences.

Go to Business Manager Menu > Merchant Tools > Site Preferences > Custom Preferences
 

Schedule jobs as needed, and start synchronization with Akeneo PIM instance.

Please refer to our documentation to get more details about the jobs and Custom Preferences configuration.