The accelerator is not plug-and-play and works with pre-existing structures on both sides. It proposes a basis to accelerate the overall connectivity. SAP data filtering is not included for instance. The mapping of source and target data structure is to be done on the customer side in the package (step 3), since each company has its own business constraints and logic. There are also search rules that need to be maintained by customers.The package is available in batch and in unitary mode.
Additionally to the core package, an OPEN API generator package is also available so you can easily retrieve your PIM structure and ease the message mapping part.
iFlow Overview
Below is a high-level summary of the iFlows implemented for Material Master data synchronization. Each iFlow corresponds to a logical data area or process step.
iFlow Name
Purpose
Import in Batch Data from SAP S4HANA to Akeneo PIM
The entry point iFlow, here data collection logic must be implemented and pushed to Orchestration iFlow
Message mapping S4HANA to Akeneo PIM
Map your source fields to your target fields. Step where source payload is transformed to target structure.
Orchestrate Data in Batch
Call this IFlow with the IFlow that will collect data from customer's source. This iFlow will manage the remaining steps ( PIM Token, Mapping, Search, PIM API)
Overall process
The entry point is the data collect iFlow “Import in Batch Data from SAP S4HANA to Akeneo PIM” where the integrator will adapt the IFlow to meet the customer logic intended and get the products master data to synchronize to Akeneo PIM.
Then, the data mapping and transformation need to be conducted. As the data mapping is very specific to each customer it is expected that customers do this configuration in the “Message mapping S/4Hana to Akeneo PIM”.
Once data is collected and mapped, it needs to be communicated to the orchestration iFlow “Orchestrate Data in Batch”; here the iFlow manages the logic of Product(s) synchronization as a process. For example, the PIM’s token management part check if it is a creation or update and finally calls PIM’s API to push product master data. This iFlow call the Search and mapping steps.
Configuration guide
1/ Security material and main configuration set up
To connect both systems, make sure to generate connection settings in the monitor folder of the Integration Suite. We recommend creating:
Credential needed
Content
S4HANA_CONNECTIVITY
Connect to SAP OData service | User & Password
AKENEO_BASIC_AUTH
User & Password
AKENEO_CLIENT_SECRET
Client ID & Client Secret
Once created, those security materials will need to be called in the package. To do so, change the SAP security materials in the iFlow_Step_DataCollect. Then change the PIM security materials calls in the configuration of the iFlow_Step_Orchestration of the package.
Informations
The iFlow parameters are related, once an item is registered, it is replicated on the other. However, we advise of checking all of parameters to make sure those are up to dates.
Configure the Import in Batch Data from SAP S4HANA to Akeneo PIM iFlow
In receiver:
Receiver
Adapter type
Parameter
Action
R_S4HANA
HCIOData
SAP_Address Credential Name
Fill in the URL of the SAP ERP and the security material of SAP ERP listed above as S4HANA_CONNECTIVITY
iFlow visual helper
In this example, the security material was called “S4_BasicAuth”, S4_Address is the website of S/4Hana
Configure the “Orchestrate Data in Batch” iFlow.
In Sender tab:
Sender
Adapter type
Parameter
Action
SND
Process Direct
/pim/synchronization
No action required
SND
JMS
Akeneo retry interval definition
Retry can be adjusted to fit your business need
SND
HTTPS
/pim/synchronization
No action required
iFlow visual helper - retry
Example of configuration
In Receiver tab:
Receiver
Adapter type
Parameter
Action
R_PIM
HTTP
HTTPaddress: Address of your PIM Credentialname: Security material with Credential name
Fill in the PIM URL and credentials listed above as S4HANA_CONNECTIVITY
R_PIM
HTPP
HTTPaddress: Address of your PIM
Fill in the PIM URL and credentials listed above as AKENEO_CLIENT_SECRET
R_CPI
Process Direct
Mapping file address
No action required
R_CPI
JMS
AkeneoRetry
Retry retention and expiration can be adjusted to fit your business need
iFlow visual helper
Example of configuration
Fill in the PIM address - here a temporary PIM address was filled in for example
The PIM credentials listed as AKENEO_CLIENT_SECRET above should be stored in this field. Here, the cliend ID and secret were stored in the Integration Suite as AKN_OTTERS_OAUTH2, the url of the PIM was a temporary test PIM.
The retry retention and expiration can be changed
In More:
Type
Parameters
Action
All parameters
PIM_CREDENTIAL_NAME
Add the name of the security material for Akeneo PIM credential AKENEO_CLIENT_SECRET
Content Modifier
Name [ID] CM_SetPIM_Credential_Name_Basic[…]
In source value, add the name of the security material for Akeneo PIM credential listed AKENEO_BASIC_AUTH
iFlow visual helper
Example of configuration
Filled in the PIM credential listed as AKENEO_BASIC_AUTH in the table above (User and password). In the example,the Integration Suite here was called AKN_OTTERS_BASIC.
3/ Mapping between SAP ERP and Akeneo PIM structure
To conduct the mapping, the SAP S/4Hana structure and Akeneo PIM structure need to be present in the message mapping step of the iFlow IFlow Message mapping S4HANA to Akeneo PIM. To generate Akeneo PIM structure file, generate it by using the Akeneo OPEN API package and then download it in the message mapping of package.
Generate the structure OPEN API files
The steps are
Download and Save: The output will be a JSON or XML file representing your Akeneo structure. Download this file and save it locally.
Load into Mapping iFlow: Go to the S4HANA_to_AkeneoPIM iFlow.
Open Message Mapping: Click on the MM_SAPS/4_TO_AKENEOPIM block.
Import Target Structure: On the right-hand side, import the Akeneo structure file you just saved.
The integrator will also need to manually obtain or generate the SAP S/4HANA structure to use as the source file in the mapping step.
Configure the OPEN API Generator package: step by step
The Akeneo PIM Open API generator package generates the structure of the PIM based on filters on family OR attribute group.
To generate the PIM Open API, configure the package:
Receiver
Adapter type
Parameter
Action
R_PIM
HTTP
Address Query
no change
R_PIM
HTTP
PIM_HTTP_Address Credential name
Fill in the address of the targeted PIM and the client ID and secret labelled as AKENEO_CLIENT_SECRET in the table above
R_PIM
HTTP
PIM_HTTP_Query
Enter the family code or attribute group you need to create the OPEN API on Add several families and attribute groups filtered by a coma
R_PIM
HTTP (second in row)
PIM_HTTP_Address PIM_HTTP_Query PIM_HTTP_Query
Fill in the information coming from the desired PIM
Example for the filters to configure: here on families.
More
Action
All Parameters
PIM Credential Name
Enter the credential material name for the PIM with client ID and secret, listed above as
Content modifier
Name [ID] CM_SetPIM_Credential_Name_Basic[…]
In source value, add the name of the security material for Akeneo PIM credential username and password, listed above as AKENEO_BASIC_AUTH
Once the credentials and the family or attribute groups filters are registered, deploy the package. You will retrieve a JSON file.
Visual helper for mapping update
Conduct the mapping
The flow is all set! You can manually do the mapping and transformation between the two systems.
Deploy the orchestration iFlow
Upon successful connectivity and mapping, the flow will create and update mapped attributes.
The package also exists in unitary mode and follows the same logic
Unitary package specificity on pre-existing
When pushing products, the accelerator needs to check if the product already exists in the PIM system or not. To do so, a common attribute needs to exist between both systems. By default, the accelerator checks SKU for pre-existing products. It is possible to modify the attribute according to your business needs.
Go to the IFlow_Step_PIM_SearchProduct
Modify the message body
iFlow visual helper
Want to find out more? Take a look at these related articles