ballerinax/sap.s4hana.api_material_document_srv Ballerina library

Overview

SAP S/4HANA is a robust enterprise resource planning (ERP) solution, designed for large-scale enterprises by SAP SE. It covers core business processes such as finance, procurement, sales, and materials management, including inventory and warehouse operations.

WSO2 SAP S/4HANA Material Document provides a way to interact with the Material Document - Read, Create API. The service allows to retrieve and create material documents, for example, to post a goods receipt for a purchase order or to document the transfer of materials between two storage locations, and to cancel existing material documents or single items.

Key Features

• Post goods movements such as goods receipts, goods issues and transfer postings as material documents
• Read material document headers and items with OData query options
• Cancel complete material documents or individual items

Setup guide

This connector uses Basic Authentication with an SAP S/4HANA Cloud communication user. Each S/4HANA API is exposed through a communication scenario, so the user must be assigned to a communication arrangement for the Material Document Integration (SAP_COM_0108) scenario before the connector can call it.

All the apps used below are in the Communication Management group of the SAP Fiori launchpad.

Step 1: Create a communication user

1. Sign in to your SAP S/4HANA Cloud system as an administrator.
2. Open the Maintain Communication Users app and choose New.
3. Enter a user name and a description, set a password, and choose Create.

Note the user name and password. These are the credentials the connector uses.

Step 2: Create a communication system

1. Open the Communication Systems app and choose New.

2. Enter a system ID and a system name, and choose Create.

   

3. Under General > Technical Data, enter a host name and a Logical System (an uppercase ID of up to 10 characters, for example, INTEGRATOR). Some scenarios refuse to activate when the logical system is empty.

4. Under Users for Inbound Communication, add the communication user from Step 1 with the User Name and Password authentication method.

   

5. Choose Save.

Step 3: Create a communication arrangement

1. Open the Communication Arrangements app and choose New.

2. In the Scenario value help, search for Material Document Integration and select SAP_COM_0108. This is the scenario that exposes API_MATERIAL_DOCUMENT_SRV, the service this connector calls.

   

3. Enter a unique name for the arrangement and choose Create.

   

4. Select the communication system from Step 2. The communication user from Step 1 is filled in as the inbound user. If the scenario lists outbound services that the integration does not need, clear their Active check boxes so that no outbound user is required.

   

5. Choose Save.

Step 4: Note the hostname

Open the saved arrangement. The API-URL next to Own SAP Cloud System shows the hostname (<unique id>-api.s4hana.cloud.sap).

You now have everything the connector needs:

• hostname - the API hostname, for example, my123456-api.s4hana.cloud.sap
• username - the communication user name
• password - the communication user password

Quickstart

To use the sap.s4hana.api_material_document_srv connector in your Ballerina application, modify the .bal file as follows:

Step 1: Import the module

Import the sap.s4hana.api_material_document_srv module.

import ballerinax/sap.s4hana.api_material_document_srv as materialdocument;

Step 2: Instantiate a new connector

Use the hostname and credentials to initiate a client.

configurable string hostname = ?;
configurable string username = ?;
configurable string password = ?;

materialdocument:Client materialDocumentClient = check new (
    {
      auth: {
        username,
        password
      }
    },
    hostname
);

Step 3: Invoke the connector operation

Now, utilize the available connector operations.

materialdocument:CollectionOfA_MaterialDocumentItemWrapper listAMaterialDocumentItems = check materialDocumentClient->listA_MaterialDocumentItems();

Step 4: Run the Ballerina application

bal run

Examples

The SAP S/4HANA Inventory Ballerina connectors provide practical examples illustrating usage in various scenarios. Explore these examples, covering use cases like point-of-sale stock reservations and warehouse document automation.

1. POS Integration with S/4HANA - Check real-time material stock and create reservation documents in S/4HANA from point-of-sale orders.

2. Warehouse Automation through S/4HANA Integration - Digitize paper delivery notes with OCR and create material documents in S/4HANA from the extracted data.