The Akeneo PIM Event Platform integration with SAP ERP package enables real-time synchronization of product data between Akeneo PIM and SAP ERP (S/4HANA) via the Akeneo Event Platform.
Unlike bulk flows (Full Load) optimized for mass data handling, this architecture allows for an instantaneous reaction to every modification (creation or update) performed in the PIM. This triggers immediate synchronization of the SAP repository without delay, ensuring perfect data consistency across your ecosystem. The accelerator is designed to provide a solid baseline to speed up connectivity. However, because every enterprise has unique business constraints and logic, the underlying field mapping must be adapted on the customer side
Additionally to the core package, an Akeneo PIM Data Model Generator package is also available so you can easily retrieve your PIM structure and ease the message mapping part.
Quick Overview of the iFlow
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 |
|---|---|
| Create Subscriber To Akeneo Event Platform | A one-time initialization flow. It registers the SAP CPI instance as an authorized recipient with Akeneo |
| Create Subscription To Event Platform | A configuration flow. It specifically defines which PIM events trigger data transfers and secures the link via HMAC |
| Receive Events from Akeneo Event Platform | An HTTPS entry point (Webhook) whose sole role is to receive messages and immediately persist them in a JMS queue to guarantee performance |
| Send Akeneo PIM Event To SAP | An asynchronous business consumer. It de-queues events, retrieves full data via the Akeneo PIM REST API, transforms the format, and performs the final update in SAP S/4HANA |
Overall process
- The entry point is the event configuration: the integrator configures and subscribes to the needed events using the Create Subscriber To Akeneo Event Platform
-
Once set up, the Receive Events from Akeneo Event Platform
iFlow collects the incoming messages from the event platform and securely routes them into a JMS queue . -
Data mapping and transformation need to be conducted before synchronization
. As the data mapping is highly specific to each customer, integrators are expected to perform this configuration inside the “MM_PIM_to_SAP” block within the Send Akeneo PIM Event To SAP consumer iFlow.
Prerequisites
- PIM Configuration: A connection must be created in Akeneo to obtain the Client ID and Secret credentials
- API Provider & Network Setup: An API Provider and API Proxy must be provisioned within the SAP Integration Suite to establish a public URL (PIM_callBackUrl) capable of safely receiving external event messages. Whitelist Akeneo's source IP addresses on your infrastructure to allow calls to this reception endpoint.
- Keystore Requirements: Import Akeneo's root certificate into the CPI Keystore to secure all outgoing HTTPS calls
Authorization Requirements
Before deploying artifacts, you must authorize your API Connection to interact with the Event Platform within the Akeneo PIM settings.
- In Akeneo, navigate to Connect > Connections.
- Select the connection used for your SAP integration
- Ensure the "Event Platform" capability (checkbox) is enabled
If this box is not checked, the connection will not have the necessary permissions.
For detailed steps on how to assign these permissions, please refer to the official Akeneo API documentation.
Exposing the Public Endpoint (API Provider & Proxy)
Before registering your system with Akeneo, you must expose a public entry point within the SAP Integration Suite to receive real-time notifications:
- Set up the API Provider: Create and configure the API Provider in the SAP Integration Suite. This generates the secure, public-facing URL required to listen to external events.
- Configure the API Proxy: Set up an API Proxy to securely route incoming events from this public entry point directly to the internal endpoint within your Integration Suite (listed as API_ENDPOINT in the configuration table below).
Configure Security Policies
We recommend adding the following "PreFlow" policies to protect your system:
- Spike Arrest: Prevents your system from being overwhelmed by too many requests at once
- IP Whitelisting: Only allow requests coming from official Akeneo IP addresses (available on the Akeneo website)
- Quota & XML Protection: Ensures the volume of data remains within expected limits and protects against malicious payloads
Once the API Provider and Proxy are deployed, the architecture operates as an asynchronous, reliable, decoupled mechanism:
- Ingestion: The Receive Events from Akeneo Event Platform iFlow monitors this designated endpoint, immediately listening for incoming event messages and safely pushing them into a central JMS storage queue.
- Processing & Sync: The Send Akeneo PIM Event To SAP consumer iFlow asynchronously reads from this queue, executes the custom data mapping, and securely transfers the synchronized product updates to your S/4HANA backend.
Security material and main configuration setup
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 package. To do so, change the SAP security materials in the various iFlows of the package.
The iFlow parameters are related; once an item is registered, it is replicated on the other tabs of the same iFlow. Fill in the "all parameters" tab first for ease. We still advise of checking all tabs to make sure those are up to date.
Create Subscriber To Akeneo Event Platform
Think of the Subscriber as your SAP system’s "ID Card" within Akeneo’s Event Platform.
Once created, this object holds:
- A Unique subscriberId: The most important piece of information, required to set up any future subscriptions.
- Connection Details: It tells Akeneo which security credentials to use when sending data to your SAP environment.
Important: You only need to run this iFlow once during your initial setup to generate your ID
Configurable Parameters for the subscriber
Before deploying the iFlow, ensure the following parameters are correctly filled in your SAP CPI configuration
Receiver
For the R_PIM Receiver
| Parameter | Description |
|---|---|
| PIM_Address | Base URL of the Akeneo PIM instance |
| Credential Name (PIM_Credential_Name_OAuth2) | Security alias for the Akeneo OAuth Client ID / Secret (Fill in the security material listed as AKENEO_CLIENT_SECRET above) |
For the R_Event Receiver
| Parameter | Description |
|---|---|
| HTTP_Address | Akeneo Event Platform URL (No action required) |
More
In the All Parameters tab
| Parameter | Description |
|---|---|
| EVENT_Subcriber_Email |
Email address representing the subscriber |
| EVENT_Subcriber_Name | Name identifying the subscriber |
| Address of the PIM | Base URL of the Akeneo PIM instance |
| PIM_Credential_Name_Basic |
Secure store alias for Basic OAuth token credentials (Fill in the security material listed as AKENEO_BASIC_AUTH above) |
| PIM_Credential_Name_OAuth2 |
Security alias for the Akeneo OAuth Client ID / Secret (Fill in the security material listed as AKENEO_CLIENT_SECRET above) |
How to Retrieve the subscriberId
After deploying and running the iFlow, you must manually retrieve the generated ID to use it in the next step.
- Navigate to the CPI Monitor
- Go to the Message Processing Log and locate your execution
- Open the Logs and look for the Attachments tab
- Open the attachment named Subscriber
- Locate and copy the value for "subscriberId": “xxxx”
Success! You now have your Subscriber ID.
Keep it handy; you will need to paste it into the configuration of the next iFlow: Create Subscription To Event Platform
Technical Workflow for the subscriber creation
The iFlow handles the initial registration of your SAP system within the Akeneo ecosystem through these steps:
- Authentication: The iFlow connects to Akeneo using OAuth2 Client Credentials to establish a secure session
- Payload Building: It automatically formats your configuration (Subscriber Name and Email) into a valid JSON request
- Identity Creation: It sends a POST request to the Akeneo /api/v1/subscribers endpoint to register your SAP instance
- ID Generation & Logging: Akeneo generates a unique subscriberId. The iFlow captures this ID and stores it in the execution logs (attachments) so you can use it for the next step.
Create Subscription To Event Platform
If the Subscriber is your "ID Card," the Subscription is your "Delivery Order."
It defines two critical elements:
- The Topics: Which specific events should trigger a notification (e.g., product_updated)
- The Destination (Callback URL): The specific digital address where Akeneo will "push" the information
Configurable Parameters for the subscription
Before deploying the iFlow, ensure the following parameters are correctly filled in your SAP CPI configuration
Receiver
For the R_PIM Receiver
| Parameter | Description |
|---|---|
| PIM_Address | Base URL of the Akeneo PIM instance |
| Credential Name (PIM_Credential_Name_OAuth2) | Security alias for the Akeneo OAuth Client ID / Secret (Fill in the security material listed as AKENEO_CLIENT_SECRET above) |
For the R_Event Receiver
| Parameter | Description |
|---|---|
| HTTP_Address | Akeneo Event Platform URL (No action required) |
More
In the All Parameters tab
| Parameter | Description |
|---|---|
| PIM_Address | Base URL of the Akeneo PIM instance |
| PIM_CallBackUrl | The callback endpoint (your receiver) that the Event Platform will call when events occur |
| PIM_Credential_Name_Basic |
Secure store alias for Basic OAuth token credentials (Fill in the security material listed as AKENEO_BASIC_AUTH above) |
| PIM_Credential_Name_OAuth2 |
Security alias for the Akeneo OAuth Client ID / Secret (Fill in the security material listed as AKENEO_CLIENT_SECRET above) |
| PIM_SubscribedEvent |
One or more event topic names from the Event Platform that the system should subscribe to (Fill in the event you need to subscribe to based on Event Platform events) |
| PIM_SubscribedID | Unique identifier of the subscriber (your system/app id) (Fill in the subscriber ID generated by the previous iFlow) |
The Callback URL: Your System’s "Front Door"
The Callback URL is one of the most important settings in your integration. It is the public HTTP endpoint on your SAP environment that "listens" for Akeneo.
Why is it critical?
- Real-time Delivery: When a change happens in Akeneo, it immediately sends a "POST" request to this URL
- Verification: When you create a subscription, Akeneo pings this URL to ensure the connection is live and secure
- Enterprise Security: For production environments, we recommend exposing this URL through SAP API Management (APIM) to add an extra layer of protection between the public internet and your CPI
Technical Workflow for the subscription creation
The iFlow automates your subscription management with the Akeneo API through these key steps:
- Authentication & Handshake: The iFlow connects to Akeneo using your secure OAuth2 credentials to obtain a valid access token
- Callback Validation: Akeneo performs a real-time check to ensure your destination URL (the G.3 Listener) is active and reachable
- Subscription Activation: Once validated, Akeneo activates the subscription for the specific event types you selected (e.g., product deletions)
- Logging & Confirmation: The iFlow logs the resulting subscriptionId in the SAP CPI message logs. You will need this ID if you wish to update or delete the subscription later.
Receive Events from Akeneo Event Platform
The Receive Events from Akeneo Event Platform is the specialized HTTPS endpoint (webhook) that sits on your SAP environment.
Its sole purpose is to "listen" for incoming notifications from Akeneo. Think of it as a high-speed reception desk: it receives the package, signs for it immediately so the delivery driver (Akeneo) can leave, and places the package in a secure locker (JMS Queue) for processing.
Configurable Parameters for the listener
Directly in the iFlow, click the HTTPS arrow. In the connection address field, enter the API_ENDPOINT created when the proxy was set up. No other parameters are required.
Technical Workflow for the listener
The iFlow follows a streamlined "Receive and Delegate" logic to ensure your PIM remains fast while guaranteeing data delivery:
- HTTP Receiver: The iFlow acts as a dedicated webhook endpoint, waiting for Akeneo to "push" event notifications.
- JMS Dispatch: The received payload is instantly forwarded to a secure JMS queue (akeneoEvent). This ensures the message is saved even if the rest of the system is busy.
- Fast Acknowledgment: The iFlow immediately returns an HTTP 200 (OK) to Akeneo. This confirms successful reception and stops Akeneo from retrying the delivery, keeping the communication loop short and efficient.
Send Akeneo PIM Event To SAP
The Send Akeneo PIM Event To SAP iFlow is the specialized "worker" of the Event Platform. While the Listener is responsible for receiving the data, the Consumer is responsible for acting on it. It retrieves messages from the secure JMS queue, verifies they are authentic, and executes the modification of entities within SAP Commerce Cloud.
Configurable Parameters for the consumer
Before deploying the iFlow, ensure the following parameters are correctly filled in your SAP CPI configuration
Sender
For the S_Queue Sender
| Parameter | Description |
|---|---|
| Queue Name (PIM_JMS_EVENT_QNAME) | Name of the source JMS queue to consume (No action required) |
Receiver
For the R_PIM Receiver and the first HTTP adapter
| Parameter | Description |
|---|---|
| PIM_HTTP_Adress | Base URL of the Akeneo PIM instance |
| Credential Name (PIM_Credential_Name_OAuth2) | Security alias for the Akeneo OAuth Client ID / Secret (Fill in the security material listed as AKENEO_CLIENT_SECRET above) |
For the R_PIM Receiver and the second HTTP adapter
| Parameter | Description |
|---|---|
| PIM_HTTP_Adress | Base URL of the Akeneo PIM instance |
For the R_S4HANA Receiver
| Parameter | Description |
|---|---|
| SAP_Address | URL of the SAP S/4HANA instance (OData API) |
| Credential Name (SAP_CredentialName) | Security alias for SAP access (Basic Auth) (Fill in the credentials of SAP S/4HANA listed above as S4HANA_CONNECTIVITY) |
More
In the All Parameters tab
| Parameter | Description |
|---|---|
| PIM_CredentiaName_Basic | Secure store alias for Basic OAuth token credentials (Fill in the username and password credentials listed above as AKENEO_BASIC_AUTH) |
Mapping between Akeneo PIM structure and SAP ERP
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 Send Akeneo PIM Event To SAP. To generate the Akeneo PIM structure file, generate it by using the Akeneo PIM Data Model Generator package and then download it in the message mapping of the package.
Generate the OpenAPI structure files
The steps are
- Generate Akeneo Structure: In the Akeneo PIM Data Model Generator package, configure the R_PIM HTTP receiver to use the appropriate PIM_HTTP_Query (e.g., family=t-shirts). Run the iFlow.
- 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 Send Akeneo PIM Event To SAP iFlow
- Open Message Mapping: Click on the MM_PIM_to_SAP 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.
Conduct the mapping
The flow is all set! You can manually do the mapping and transformation between the two systems.
Deploy the iFlow
Upon successful connectivity and mapping, the flow will create and update mapped attributes.
Technical Workflow for the consumer
The iFlow acts as the final "executioner" of the events by following these precise steps:
- JMS Consumption: The Integration Flow retrieves the stored event message from the secure JMS queue, ensuring no notification is missed.
- Signature Verification: A built-in script validates the HMAC signature against your secret key to guarantee the message truly originated from your Akeneo PIM.
- Event Parsing & Routing: The iFlow interprets the payload to identify the Entity Type and Action. It only routes the message forward if the action is a "deleted" status.
- OData Execution: Once validated, the iFlow sends the final command via OData to SAP Commerce Cloud, modifying the specific product from your storefront in real time.