Integration app main jobs
Akeneo prioritizes several key factors, that are common expectations for integration solutions, as primary drivers for enhancements:
Category |
Content |
---|---|
Connector main jobs: ensuring data transfer | Filtering, mapping, transformation when needed, synchronization (Load and monitor) |
Feature compliancy | PIM Features compatibility, SAP Commerce compatibility |
Technical expectations | Performance and scalability, security, flexibility (customization possibilities for SAP integration) |
Integration main information
The SAP Commerce integration, developed by Akeneo, is installed and maintained on the customer's Integration Suite platform. This iflow serves as a bridge between Akeneo and the customer's eCommerce system, facilitating the exchange of data and streamlining operation.
- Overview: Akeneo integration for SAP Commerce is an iflow for SAP Commerce Cloud. The integration is therefore installed on the Integration Suite (iPASS of SAP) and communicates with Akeneo PIM via its GraphQL API. The integration is an unidirectional system: it imports PIM data to SAP Commerce Cloud. No SAP Commerce Cloud data is sent back to the PIM. The PIM is considered as the master tool for product data, it should not be handled in SAP Commerce Cloud.
- Connector main jobs: Akeneo iflow for SAP Commerce handles all the main expectations of an integration app stated in the paragraph above. Please read the documentation for more information.
- Integration Suite: The integration package that is provided is solely based on the Integration Suite of the SAP BTP. The integration package is comprised of several artifacts that describe the logic and execute it, to achieve the needed functional requirements. The dominating approach to development in the Integration Suite is “low-code”.
- Installation: SAP Commerce integration is compatible with both SAP Commerce Cloud and last onPrem version. Check the compatibility and pre-requisite article. You can find detailed installation instructions in the dedicated installation section. Please note the installation and configuration is a technical process.
- Maintenance: The maintenance of the integration is the responsibility of the integrator, primarily performed on the Integration Suite. Akeneo covers the bugs happening on the vanilla integration without customizations as described below. Refer to the setting up section for additional insights on the maintenance and integration app lifecycle for insight on support coverage and evolution.
-
Customization: The SAP Commerce integration provides the flexibility for customization to align with your unique requirements.
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 section for more information. - Data Transfer: Data transfer is facilitated through the use of an API to API format, ensuring seamless communication between systems. 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 preserve and optimize performance and scalability please follow the advices of the How to Set up and use the integration section.
Package organization
In the github package, you will be able to retrieve:
- the Integration Suite (CPI/CI) integration archive which contains the integration.
- the SAP CC Extension. An extension to install in SAP CC so the integration works properly. Refer to the dedicated installation section..
- a Readme.md
The integration is an iFlow in SAP Integration suite. It is a visual representation of the data integration between systems, which allows developers to easily manage and automate data movement using a drag-and-drop interface. Each iFlow is composed of building blocks that will either concern the sender (source system), the receiver (target system), contain a message processing (step to modify or process the data), and adapters (allowing the connection to different systems). Please refer to SAP CI documentation for more information
The Akeneo integration for SAP Commerce is a package regrouping several artifacts. The integration does not only transfer one type of data like the attributes but rather enables a full synchronization of both systems. To simplify the integration onboarding, the package has been sub-divided into several sections:
Artifact |
|
---|---|
0 | Main configuration parameters: Global configuration and filtering (0.0) , Global artifact (0.1), Global Family artifact (0.2) |
1 | Synchronization process: Full (1.1), Delta or differential import (1.2), Structural data import on family (1.3) |
2 | Mapping: attributes (2.1) and product type mapping (2.2) |
3 | Advanced configuration available for customization (3.1 product variation, 3.2 Product Model variation axis mapping) |
4 | Data Transformation Mapping: Product (4.1) and Product Variant transformation (4.2) |
5 | Script |
Find more details in the Using the integration section.
Ensuring the success of my integration
It is advised to test the integration as early as possible in the integration process. By doing so, you will challenge the data model and ensure the efficiency of the mapping.
Please be aware that determining whether the core connector version meets your requirements is the responsibility of your technical team or integrator. Therefore, the sooner you begin testing, the sooner you can be confident in the connector's compatibility and suitability for adoption.
To begin, complete this checklist:
- Are Akeneo PIM and/or the eCommerce platform customized in any way? If so, this should raise a flag. Customization estimation should be detailled.
- Are all project stakeholders aware of their responsibilities and equipped with the necessary competencies? By evaluating the team's knowledge of Akeneo, SAP Commerce, the Integration Suite, and the Akeneo integration, you can significantly increase the chances of project success.
- 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. Support is handled on the non-customized integration.
- The integrator is responsible for updating and upgrading the connector to address bugs and incorporate new features.
- The larger the catalog, the sooner the Connector must be tested, particularly regarding performance and data synchronization policies.
- 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.
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.
An Akeneo integration is designed to seamlessly connect any standard PIM to a standard version of SAP Commerce, 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.