Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.
Extra information
System documentation:
Connector package documentation
Table of Contents
1 Setting up HTTP Client SAP S/4 Hana Odata.
1.1 Steps. 2
2 Subscribing to Entities from SAP S/4 Hana Odata.
2.1 Steps. 3
2.2 General Concept.
3 Publishing Entity to SAP S/4 Hana Odata.
3.1 Steps.
3.2 General Concept.
Setting up HTTP Client SAP S/4 Hana Odata
Steps
- In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select SAP S/4 Hana Odata HTTP Client as the prototype of the HTTP Client.
- Fill in the Base URI, and Api Key.
- On the top right, press Save & Continue, after you received the key.|
Subscribing to Entities from SAP S/4 Hana Odata
Steps
- Go to Connections → Incoming and create a new incoming configuration and select SAP S/4 Hana Odata Subscriber as the subscriber.
- Select the entity you want to subscribe from SAP S/4 Hana Odata.
- Add any request parameters needed to subscribe to the entity (optional).
- You can optionally add a transformer to transform the request parameters into something you need.
- Select the SAP S/4 Hana Odata HTTP Client to use
General Concept
We follow SAP S/4 Hana Odata documentation on building this connector so you can easily use the connector based on SAP S/4 Hana Odata API Reference.
Entity
It’s the entity you want to subscribe from SAP S/4 Hana Odata. Please refer to the entities in Management APIs from SAP S/4 Hana Odata API Reference page.
Request Parameters
These are the parameters you can provide to get the needed entity based on SAP S/4 Hana Odata API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing Read Bank by Details
That’s why we need to define the BankCountry, and BankInternalID property inside the odata property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. The properties inside path parameters will be parsed as path parameters. The properties inside payload parameters will be parsed as payload. Here is the final URL that will be called when using such Request Parameters field.
/odata/sap/API_BANKDETAIL_SRV/A_BankDetail(BankCountry=‘US’,BankInternalID=‘444444’)
Input Transformer
Any transformers set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity.
HTTP Client
It’s the HTTP Client configuration or prototype you will use to access SAP S/4 Hana Odata.
Publishing Entity to SAP S/4 Hana Odata
Steps
- Go to Connections → Outgoing, create a new outgoing configuration, and select SAP S/4 Hana Odata Publisher as the publisher.
- Select the action that you want the publisher to do with the data.
- Select the SAP S/4 Hana Odata entity you want the data to be published.
- Select the HTTP Client to use.
General Concept
Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration).
Action
Currently, we support Create (HTTP POST method), Patch (HTTP Patch method), and Delete (HTTP DELETE method).
Entity
We support publishing to most SAP S/4 Hana Odata. Please refer to the entities in Management APIs from SAP S/4 Hana Odata API Reference page. Based on the documentation, some endpoints may need one or more odata parameters.
For endpoints that require an object as the request payload, please look at the example below. For example, we want to Add new entity to related to_BatchPlant. Please select “Create” as the action and “Add new entity to related to_BatchPlant” as the entity of the publisher.
You can put the payload you want to send to SAP S/4 Hana Odata into the payload property in the data. Here is an example of the Possible Response after Creation.
Alumio will send an API request to SAP S/4 Hana Odata with URL
odata/sap/API_BATCH_SRV/Batch(Material=%27Polyester%27,BatchIdentifyingPlant=%27Arsenal%27,Batch=%270234567%27)/to_BatchText
HTTP Client
It’s the HTTP Client configuration or prototype you will use to access SAP S/4 Hana Odata.