Consume OData Service
You can use the Consume OData Service activity to invoke the SAP S/4HANA Cloud OData service.
General Tab
The following table lists the configurations on the General tab of the Consume OData activity:
| Field | Visual Diff | Module Property | Description |
|---|---|---|---|
| Name | Yes | No | Specify the name to be displayed as the label for the activity in the process. |
| SAP S/4HANA Cloud Conn. | Yes | Yes | Click
 to select an SAP S/4HANA Cloud Connection shared resource. The SAP S/4HANA Cloud Connection shared resource establishes connections between the plug-in and the SAP S/4HANA Cloud system or On-Premise / Private Cloud system.
If no matching SAP S/4HANA Cloud Connection shared resources are found, click Create Shared Resource to create one. For more details, see Creating and Configuring an SAP S/4HANA Cloud Connection. |
| SAP S/4HANA API | Yes | No | Click Fetch API to select a SAP S/4HANA Cloud API. |
| Service | Yes | No | Select the service. |
| Operation | Yes | No | Select the operation. |
| Batch Size | Yes | Yes |
Multiple requests for the same operation can be sent on the same call to SAP S/4 Hana, when using a batch size greater than 1. Minimum value is 1 and maximum value is 128. Note:
This field is disabled when Operation is set as |
Description
On the Description tab, you can enter a short description for the Consume OData Service activity.
Input
The input is generated based on the SAP S/4HANA Cloud API Service and Operation selected by the user.
The Input tab displays the input schema of the activity as a tree structure. The information in the schema varies based on the fields selected on the General tab. Enter information as required for any mandatory fields.
Output
The Output tab shows the response of the invoked service.
The Output displays the output schema of the activity as a tree structure. The output is read-only. The information in the schema varies based on the fields selected on the General tab.
| Output Item | Data Type | Description |
|---|---|---|
| ResultCount | Integer | This ResultCount output counts how many records are returned after the Consume OData Service activity is invoked. |
| BatchError -> ErrorCount | Integer | This element shows error count in the batch. |
| BatchError -> ErrorDetails | String | This element shows a short error description in the batch. |
Fault
The Fault tab displays the exceptions of this activity.
There are two types of exceptions of the ConsumeODataService activity:
-
S4HanaSystemFault: Generated when the error originates from the SAP S/4Hana system.
-
S4HanaPluginFault: Generated when the error originates from the plug-in.
Error Schema Element Data Type Description msg String The error message returned by the plug-in. msgcode String The error code returned by the plug-in.
If-Match header at runtime for PATCH and DELETE operations. To enable this functionality when running from TIBCO BusinessWorks (BW) Studio, add the required property to your VM arguments as shown below: com.tibco.bw.palette.s4hana.IfMatchHeader Example:
-Dcom.tibco.bw.palette.s4hana.IfMatchHeader=* If-Match input header for PATCH operations when using ODATA V4 APIs. This applies to existing projects configured with OData V4 APIs. To enable this feature refresh the API by downloading it from SAPS/4HANACloudConnection.