What is the Akeneo PIM Data Model Generator package?

The Akeneo PIM Data Model Generator package is a technical utility designed to automate the retrieval of the OpenAPI contract (data schema) directly from Akeneo PIM.

In an integration project, Akeneo's flexibility allows for the creation of unique data models, such as custom attributes or specific families.

This package simplifies the integrator's work by generating a precise "blueprint" in the form of an OpenAPI JSON Schema that serves as a reference for SAP mappings. This schema can be generated for one or more product families, or for one or more attribute groups, including all associated technical attributes.

Quick Overview of the iFlow

The Data Model Generator Integration Flow is a single artifact that manages:

• OAuth2 authentication (Password Grant) via Akeneo
• Dynamic requests to the specialized Akeneo contract generation endpoint
• Archiving the JSON result in the SAP platform logs

Prerequisites

Before configuring the Integration Flow, ensure the following conditions are met:

• PIM Configuration: A connection must be active in Akeneo to provide the OAuth2 credentials
• Network Security: SAP CPI must have outbound access to the Akeneo PIM instance

Supported Attribute Types

The following table details the availability of PIM attribute types within the generated contract:

Configurable Parameters

Before deploying the Integration Flow, ensure the following parameters are correctly filled in your SAP CPI configuration.

Receiver

For the R_PIM Receiver and the first HTTP adapter

Parameters	Description
PIM_HTTP_Adress	Base URL of your Akeneo PIM instance
PIM_Credential_Name_OAuth2	Security alias for the Akeneo OAuth Client ID / Secret

---

For the second HTTP adapter

Parameters	Description
PIM_HTTP_Adress	Base URL of your Akeneo PIM instance
PIM_HTTP_QueryParamName	Type of entity to retrieve (Possible values: families or attribute-groups)
PIM_HTTP_QueryParamValue	Technical code of the entity (e.g., shoes). Supports multiple values separated by commas

 

 

More

In the All Parameters tab

Parameters	Description
PIM Credential Name	Security alias for the Akeneo OAuth Client ID / Secret

---

In the Content Modify tab

Parameters	Description
Name [ID] CM_SetPIM_Credential_Name_Basic[…]	In Source Value, security alias for the Akeneo OAuth Client ID / Secret

 

 

Technical Workflow

The Data Model Generator Integration Flow automates the extraction of your data structure through the following steps:

1. Authentication: The flow connects to Akeneo via the LP_PIM_GetToken local process to establish a secure session and extract the access token.
2. Dynamic Requesting: It builds a GET request including your filtering parameters and injects a specific User-Agent (sap-erp-akeneo-app) for identification with Akeneo support
3. Contract Generation: The flow queries the dedicated Akeneo endpoint (/api/rest/v1/apps/sap-erp/generate-openapi) to retrieve the technical structure
4. Logging & Archiving: Once received, the attachContractToLog script adds the JSON body as an attachment to the message processing log (MPL)

How to retrieve the generated contract?

The iFlow can be triggered manually via the "Run Now" button (Timer) or by an external HTTPS call.

Retrieval Steps

Once the iFlow has executed successfully

1. Access the Monitoring section of SAP Cloud Integration
2. Open the Message Processing Log
3. In the Attachments tab, open the file named Contrat
4. Download or copy the JSON content to configure your Message Mappings (.mmap files)