Integration apps main factors

Akeneo prioritizes several key factors, that are common expectations for integration solutions, as primary drivers for enhancements:

Salesforce Commerce Cloud B2C connector main information

The SFCC Akeneo Connector bridges Akeneo PIM (core version) and Salesforce B2C Commerce Cloud (core version). Designed to be agnostic, this connector ensures compatibility regardless of specific customer configurations. Our primary goal is to provide a robust technical foundation for integrating Akeneo PIM with an SFCC instance. For any customizations, your IT team or integration partner can easily extend the connector to meet your specific needs.

• Overview: Akeneo Connector for SFCC is an add-on for Salesforce B2C Commerce Cloud. This add-on named "cartridge" is installed on the SFCC side and communicates with Akeneo PIM via its API. The connector is an unidirectional system: it imports PIM data to SFCC B2C. No SFCC Commerce data is sent back to the PIM. The PIM is considered as the master tool for product data, it should not be handled in SFCC B2C Commerce. Check the compatibility and pre-requisite article to ensure the connector is compatible with your specific needs.
• Connector main jobs: The SFCC B2C Connector handles all the main expectations of an integration solution stated in the paragraph above: filtering, mapping, synchronizing, and compliancy with features of both systems. Please read the documentation for more information.  The mapping in our connectors is based on the unique association. That means that a PIM value can be mapped on only one SFCC value.
• Installation:  Please note the installation and configuration is a technical process. The access to the connector is given by your CSM. Once you get access to the core code,  please follow the installation instructions in the dedicated installation section. 
• Maintenance: Developed by Akeneo, the SFCC B2C Commerce Connector is installed and maintained on the customer's eCommerce platform. It facilitates the exchange of data and streamlines operations between Akeneo and the customer's eCommerce system. Maintenance of the connector is the responsibility of the integrator, primarily performed on the eCommerce platform. Akeneo supports the standard, unaltered (vanilla) version of the connector. Refer to the support section for more information.
• Customization: The SFCC B2C Connector provides the flexibility for customization to align with your unique requirements. For guidance on adapting the connector to your specific needs, please consult the customization advice section.   
  It's important to note that while customization is available, the quality and impact of these customizations are beyond our control. To ensure the reliability of the connector, our support team rigorously tests it against a standard, unaltered (vanilla) version. If a bug is replicated in this vanilla version, the issue is within the core code of the connector. However, if the bug does not reoccur, it is likely associated with the customization or customer-specific settings. Please be aware that Akeneo does not provide support for customization itself, but we are committed to offering guidance and assistance to our customers to the best of our abilities. Refer to the support article for more information.
• Data Transfer: Data transfer is facilitated through the use of an API to XML format, ensuring seamless communication between systems. It means this connector will call these APIs to import the following data, build a valid XML feed, and then import it into Salesforce Commerce Cloud:
  • Products (Master, variation and simple products)
  • Product images
  • Product attributes (Extends of « Product » System Object)
  • Categories
  • Category Assignments
  • Price books  
  • Reference Entities
  • Reference Entity Records
  • Media Assets
    Performance and scalability are crucial for integrations. Different factors can impact those: catalog volume, complexity, and systems limitations. There are several ways to optimize performance: partial import, filters, asset media link, direct mapping… For more insight on how to run differential import please refer to the synchronizing data section for more information. For filtering and mapping, please refer to the setup section.  
     

Known issues and limitations

Known issues are:

1. Custom Cache Requirement for Job Execution: attempting to run certain jobs with an empty custom cache may result in a failure accompanied by an error message. To prevent this issue, verify that the custom cache is not empty before job execution.
2. Cache Size Issue Due to JavaScript String Length Limit: there may be an issue with products that have extensive information or master products with a large number of variations, as this can lead to exceeding the api.jsStringLength limit. This limit defines the maximum allowed length of a JavaScript string, and when reading files and appending chunks to a string variable in the code, it's possible to surpass this threshold. Careful management of product data size and variation count is recommended to stay within the JavaScript string length constraints and prevent cache-related problems.
3. Issue with Catalog Job Dependency: If the catalog job is executed without running the attributes job beforehand, it is likely that the desired outcomes will not be achieved. It is recommended to ensure that the attributes job is completed prior to initiating the catalog job to avoid any discrepancies.

Limitations:

1. Due to a limitation of the Salesforce B2C platform custom attributes of type Enum that correspond to a PIM type of Select can not be used as variation attributes.
   In case the PIM attribute for variation axis is of type select there is a need to create SFCC B2C custom attribute of type string and map PIM variation axis attribute to the new SFCC B2C attribute using the “Akeneo Custom Attributes Mapping” site preference.
2. Localized attributes originating from the PIM will only map their values to the configured languages leaving the default locale unpopulated on SFCC B2C, conversely non localized attributes originating from the PIM will only map the default locale regardless of the localization nature of the target SFCC B2C attribute.
3. When selecting the "Both" option from the “Akeneo Image Import Type” no asset images of type media link will be added to the SFCC B2C Product image view types.Asset image attributes of type media file will be added alongside the product product image attributes, the information about asset media link images will be saved in product custom attributes. 

Ensuring the success of my integration

You should test the Connector as early as possible in the integration process. By doing so, you will challenge the data model and ensure the efficiency of the mapping.

To begin, complete this checklist:

1. Are Akeneo PIM and/or the eCommerce platform customized in any way? If so, this should signal the need to assess any additional customizations required for the core integration.
2. Are all project stakeholders aware of their responsibilities? If there is any uncertainty, ensure everyone attends the Akeneo Akademy Training.
3. Does the system integrator (or IT team responsible for the integration) know that:
   • Customizations mean that associated support (levels 1 to 3) and maintenance are the responsibility of the integrator who developed them.
   • The integrator is responsible for updating and upgrading the connector to address bugs and incorporate new features.
4. The larger the catalog, the sooner the Connector must be tested, particularly regarding performance and data synchronization policies.
5. The more complex the catalog, the earlier integration mapping must be addressed. Delaying this until the end of the project can lead to significant time loss and potential delays in the go-live date, causing frustration.
6. Be proactive and open to trying new approaches. Use this opportunity to challenge your existing data model and eliminate complexity inherited from legacy systems. Our advice is to slightly modify the existing data model on the eCommerce side to efficiently map and smoothly import your data, rather than recreating legacy complexity in the PIM.
7. An Akeneo integration is designed to seamlessly connect any standard PIM to a standard version of SFCC B2C, ensuring top performance and scalability for all users. If Akeneo Connector tests do not meet your performance standards, you have two options:

• Develop your own integration from scratch (and we fully support this choice).
• Create customizations to enhance performance according to your standards.

#SFCC Connector configuration panels

Configuration panel

Once the connector is installed in your SFCC instance, find the principal configuration panels:

1. First select a site in SFCC, click on Merchant Tools
2. Then click on Site preferences : Custom preferences

Jobs panel

Find the job panel:

1. Click on the Administration menu
2. Then go to Operations : Jobs