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. The mapping of source and target data structure is to be done on the customer side, since each company has its own business constraints and logic. There are also search rules that need to be maintained by customers.
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
Configuration frequency
PIM Create Subscriber to Event
This iFlow is designed to create a unique Subscriber ID, which is the essential first step for an application to register and receive events from a specific PIM. By establishing this subscriber, you declare your application's intent to listen to and consume events published by the PIM's event platform.
Once - starting point
PIM Create subscription To Event
Filter the event you need to receive
Once - starting point
PIM Event Listener
Receive event in queues and send the event
Once
PIM Event consumer
Map the data
As much as the business logic requires
Overall process
The entry point is the event configuration: the integrator configure and subscribe to the needed event using the “PIM Create Subscriber to Event” and “PIM Create subscription To Event” iFlows. To complete this steps, API providers needs to be set up in the integration suite as a pre-requisite.
Once set up, the PIMevent listener collects the messages coming from the event platform and send it in queue.
Data mapping and transformation need to be conducted before synchronization. As the data mapping is very specific to each customer it is expected that customers do this configuration in the “MM_PIM_to_SAP” in the PIM Event Consumer iFlow.
Configuration guide
1/Create the API providers and Proxi
First, you need to set up the API Provider in the SAP Integration Suite. This creates a public URL, that will be the entry point for receiving event messages. Next, you must configure a proxy to route these events to a specific endpoint within the Integration Suite, listed as API_ENDPOINT in the configuration table below, ensuring they are properly received.
Once the API providers and proxies are in place, the accelerator's “PIM Event Listener” will begin monitoring the designated endpoint. It listens for incoming messages and adds them to a queue. The “PIMEventConsumer” then reads from this queue, performs the necessary data mapping and synchronization, and transfers the data to S/4HANA. This asynchronous, reliable mechanism is mandatory for handling these events.
2/ Security materials creation
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
Akeneo API Token/Login | User & Password
AKENEO_CLIENT_SECRET
Akeneo OAuth2 client | Client ID & Client Secret
API_ENDPOINT
Endpoint to listen to Event Platform messages
Once created, those security materials will need to be called in the accelerator, commonly named at SAP package. To do so, change the security materials in the necessary iFlows.
Good to know
The iFlow parameters are related, once an item is registered, it is replicated on the other tabs of the same iFlow. Fill in first the “all parameters” tab for ease. We still advise of checking all tabs to make sure those are up to dates.
3/ Create a subscriberID Thanks to “PIM Create subscriber to event” iFlow
A subscriber is a necessary first step to declare itself to the Akeneo Event Platform. The objective of this iFlow is to generate a SubscriberID so you can subscribe to events in the “PIM Create subscription to event” iFlow.
This iFlow needs to be configured once and deployed once. The subscriber generated need to be copy/paste by hand in the “PIM Create subscription to event” parameters.
First, update the content in content modifier, in “configure” “more”, or for better readiness, step by step as follow:
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 AKENEO_CLIENT_SECRET
R_PIM
HTPP
HTTPaddress: Address of your PIM
Fill in the PIM URL and credentials listed above as AKENEO_CLIENT_SECRET
R_Event
HTTP
Address of the event platform
No action required
In more
More
Parameter
Action
All parameters
EVENT_Subcriber_Email
Fill in the mail to receive event information
All parameters
EVENT_Subcriber_Name
No action required
All parameters
Address of the PIM
Check/Fill in the PIM URL
All parameters
PIM_Credential_Name_Basic
Fill in the security material with user name and password listed as AKENEO_BASIC_AUTH above
All parameters
PIM_Credential_Name_OAuth2
Check/Fill in the security material with client ID and secret name and password listed as AKENEO_CLIENT_SECRET
Check the results in the externalized parameters of the iFlow.
iFlow visual helper
Example through a temporary PIM
Then deploy the iFlow. Go into the log, in monitor → Integration and APIs. On the iFlow log, click on "attachments → Subscriber. Retrieve the subscriber ID to paste it in the PIM create subscription to event iFlow.
iFlow subscriberID
4/ Subcribe to events with the “PIM Create subscription to event ” iFlow
The objective of this iFlow is to subscribe to the event you need to receive from Akeneo Event Platform. To do so, fill in the parameters, starting by the configure → more tab:
In more
More
Parameter
Action
All parameters
Address of the PIM
Check/Fill in the PIM URL
All parameters
PIM_CallBackUrl
URL
All parameters
PIM_Credential_Name_Basic
Fill in the security material with user name and password listed as AKENEO_BASIC_AUTH above
All parameters
PIM_Credential_Name_OAuth2
Check/Fill in the security material with client ID and secret name and password listed as AKENEO_CLIENT_SECRET
Fill in the subscriber ID generated by the previous iFlow
Subscription list
List the subscriptions in “PIM_SubscribedEvent” parameter
5/ Configure the PIM Event listener to receive events
Click on the HTTPS arrow, fill in the connection address with the API_ENDPOINT you created in step 1 to receive events. No other parameters need to be fulfilled.
API
6/ Configure the PIM Event consumer.
A/ Configure the iFlow
In sender
Sender
Adapter type
Parameter
Action
S_Queue
JMS
Queue Name
No action required
In receiver
Receiver
Adapter type
Parameter
Action
R_PIM
HTTP
PIM_HTTP_address: Address of your PIM Credentialname: Security material with Credential name
Fill in the PIM URL and credentials listed above as AKENEO_CLIENT_SECRET
R_PIM
HTTP
PIM_HTTP_address: Address of the PIM
Fill in the PIM URL
R_S4HANA
HCIOData
SAP_Address: Address of the SAP S/4HANA receiving the data
Fill in the SAP S/4HANA URL
R_S4HANA
HCIOData
Credential Name
Fill in the credentials of SAP S/4HANA listed above as S4HANA_CONNECTIVITY
In more
More
Adapter type
Parameter
Action
All parameters
HTTP
PIM_CredentiaName_Basic
Fill in the username and password credentials listed above as AKENEO_BASIC_AUTH
B/ Conduct the 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 left-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.
C/Deploy the iFlow
Upon successful connectivity and mapping, the flow will create and update mapped attributes.
Want to find out more? Take a look at these related articles