In this article
| Table of Contents | ||||
|---|---|---|---|---|
|
...
Use this Snap to retrieve multiple data objects in one HTTP request from SAP S/4HANA applications. The Snap returns a multipart binary stream document in its output. Depending on your requirement, it might be necessary to use a Multipart Reader Snap next to this Snap.
Prerequisites
A valid account with appropriate access permissions to connect to the SAP S/4HANA On-Premise instance. See SAP S/4HANA Accounts.
Support for Ultra Pipelines
...
- SAP S/4HANA On-Premise does not support server-side pagination. As a result, the $skiptoken used for server-side pagination is not supported.
Snap Input and Output
| Input/Output | Type of View | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|---|---|---|---|
| Input | Document |
|
| A JSON document containing input data of the batch request and can be used to filter entities that need to be retrieved in SAP S/4HANA Server. |
| Output | Binary Document (default) |
|
| A document that contains the data retrieved from an SAP S/4HANA entity. The output document can be a multipart binary stream or a document stream.
|
...
| Parameter Name | Data Type | Description | Default Value | Example | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Label | String | Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline. | N/A | SAP S/4HANA Batch Read | ||||||||||
API object | String | Required. Select the API that you want to access in SAP S/4HANA On-Premise instance by clicking the | N/A | ZCRM_BUPA_ODATA_0001 (Odata Services for Business Partner) | ||||||||||
| Entities | Required. Use this field set to specify the different entities that you want to access.
You must specify each entity in a separate row. Click This field set comprises of the following fields:
| |||||||||||||
Entity | String | Required. Select a business object (the Entity or Endpoint) for the API object chosen above, by clicking the | N/A | AccountCollection | ||||||||||
Output entry limit | Integer | The maximum number of entries that you want to retrieve from SAP S/4 HANA On-Premise for the entity.
| N/A | 10 | ||||||||||
Output entry offset | Integer | The starting index, that can also be used with an Output entry limit, for the output.
| N/A | 10 | ||||||||||
Is an active entity | String | Specify the value for the IsActiveEntity field in the HTTP request. There are many SAP S/4HANA entities that require the field IsActiveEntity to be set to true or false and included in the HTTP request. The Snap displays the 'Draft 2.0 object <SERVICE~ENTITY> requires selection condition on IsActiveEntity', error if this field is not included for those entities. Available options are:
| not available | true | ||||||||||
| Count | Check box | Select this check box to return only the total number of records retrieved in the API response.
| Not selected | Selected | ||||||||||
Connection details | Use this field set to specify the connectivity parameters: timeout, retry count, and retry interval. This field set comprises the following fields:
| |||||||||||||
TimeOut | Integer | Required. Specify the connection timeout duration in seconds, in this field. | 300 | 480 | ||||||||||
Maximum request attempts | Integer | Required. Specify the maximum number of re-connections in case of connection failure or timeout. | 3 | 5 | ||||||||||
RetryInterval | Integer | Required. Specify the time interval in seconds to be maintained between two reconnections. | 1 | 5 | ||||||||||
Snap Execution | String | Specifies the execution type:
| Validate & Execute | Execute only | ||||||||||
...
- GET operation to read multiple data objects from the SAP S/4HANA server.
- OData querying operations: $filter (FilterRecords), $select (OutputFieldSelection), $orderby (OrderBy), $top (Output entry limit), and $skip (Output entry offset). FilterRecords, OutputFieldSelection, and OrderBy will be shown in the input schema for this Snap.
- OData operation $count (Count check box).
- Connection-failed-retry mechanism.
- Client-side pagination through $top (Output entry limit) and $skip (Output entry offset) mechanisms.
- Customized HTTP Headers. For more information, see Using Customized Headers.
- Dynamic loading of API metadata with a Parent-child dependency structure. This means that you can
- Select an API object from the API object field to view only entities that are related to the API object and support GET queries (read operations).
...
| Parameter Name | Data Type | Description | ||
|---|---|---|---|---|
CustomizedHeader | Use this property schema to add customized HTTP request headers for implementing specific HTTP requests other than the ones listed under Using Customized Headers section. | |||
name | String | The field name of the customized HTTP request header. | ||
value | String | The field value for the above field in the customized HTTP request header. | ||
FilterRecords | This property schema enables you to define how the response result be filtered based on the specified parameters. | |||
name | String | Specify the name of the system parameter $filter fields to be included in the output. | ||
operator | String | Specify the comparison operator for the system parameter $filter. | ||
value | Any | The values of specified input $filter fields. The data type of this field depends on what Field name you selected or entered which can be String, Integer, Boolean, etc. | ||
condition | String | Specify the logical operator for the system parameter $filter. | ||
| KeyParameter | This property schema enables you to specify the key parameters for a specific entity. Providing values for all key parameters represented in the schema list enables SAP S/4HANA to identify a unique record.
| |||
OrderBy | With this property schema, it is possible to order the resulting records based on the specified element. The order types to be selected are either ascending or descending. | |||
name | String | Specify the field that will be used for sorting by descending or ascending order. | ||
value | String | Specify the Order Type (Ascending or Descending order). | ||
| OutputFieldSelection | With this property schema, it is possible to select fields to be included in the output. If not selected, all fields of the selected entity will be returned. | |||
| name | String | The name of the entered field to be included in the output. | ||
...
| Info |
|---|
The HTTP headers listed above are internally handled by the Snap and need NOT be defined again in CustomizedHeader section. |
Accessing Related Entities from Snap Outputs for an Entity
Records in SAP S/4HANA Batch Read Snap output may contain navigation properties, typically uri fields, pertaining to some entities related to the entity specified in Snap Settings.
...
| Note |
|---|
The example assumes that you have configured and authorized a valid SAP S/4HANA Account (see Configuring SAP S/4HANA Accounts). |
Mapper Snap
The Mapper Snap is configured to map the schema from its input JSON (coming from the upstream JSON Generator Snap) with the schema propagated backward by the SAP S/4HANA Read Batch Snap. It also outputs the Target Schema as the Input Schema for the SAP S/4HANA Batch Read Snap.
...
The File Writer Snap is connected to the SAP S/4HANA Batch Read Snap to save/write the JSON-formatted data into a file.
Output
To view the output JSON file, you must SSH to the target directory and open the newly-created JSON file. The preview of the output JSON file containing the batch response data can be seen below:
Downloads
| Note | ||
|---|---|---|
| ||
|
...