SAP S/4HANA Batch Read

In this article

Overview

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

See Snap Support for Ultra Pipelines.

Limitations and Known Issues

  • 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/OutputType of ViewNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input 

Document

  • Min:0
  • Max:1
  • Mapper Snap
  • XML Parser
  • Binary to 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)

  • Min:1
  • Max:1
  • Multipart Reader
  • File Writer
  • JSON Formatter
  • JSON Splitter

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.

  • The binary stream contains the header and the original API batch-request response.
  • The document stream contains the JSON structured API batch-request response split from the original API batch-request response. 

Snap Settings

Parameter NameData TypeDescriptionDefault ValueExample 

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

RequiredSelect the API that you want to access in SAP S/4HANA On-Premise instance by clicking the button. This drop-down list contains APIs available for the S/4HANA account configured in the Snap, each with a short description.

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. 

Client-side pagination is supported through the use of the $top (Output entry limit), and $skip (Output entry offset)
Odata operations. 
$skiptoken is not supported for this release.

You must specify each entity in a separate row.  Click  to add a new row in this table and define the values accordingly. 

This field set comprises of the following fields:

  • Entity
  • Output entry limit
  • Output entry offset
  • Is an active entity
  • Count

Entity

String

Required. Select a business object (the Entity or Endpoint) for the API object chosen above, by clicking the button.

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.

Example

When Output entry limit is 100, the Snap:

  • Retrieves the first 100 API response records from the server (if more than 100 records are present in API response).
  • Retrieves all the available API response records from the server (if 100 or less records are present in API response).
N/A10

Output entry    offset

Integer

The starting index, that can also be used with an Output entry limit, for the output.

Example 1

When Output entry offset is 50, the Snap:

  • Retrieves API response records starting from index 51 from the server (if more than 50 records are present in API response).
  • Retrieves all available records starting from index 51 (up to the last index/record).
  • Returns empty result (if 50 or less records are present in API response).

Example 2

When Output entry offset is 100, and Output entry limit is 100, the Snap skips the first 100 records and collects the 200 - 300 records in the API response from the server.

N/A10

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: if the entity does not need IsActiveEntity field specified in the HTTP request.
  • true: to set this field in the HTTP request to true and get all records with field IsActiveEntity = true in the returned response.
  • false: to set this field in the HTTP request to false and get all records with field IsActiveEntity = false in the returned response.
not availabletrue
CountCheck box

Select this check box to return only the total number of records retrieved in the API response.

No records retrieved

For all entities specified with this check box selected, the Snap returns ONLY the count of records matching the the respective entity criteria and DOES NOT return any records from the SAP S/4HANA instance (for those entities). If this check box is not selected for one or more entities, records matching each entity's criteria are returned.

Not selectedSelected

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
  • Maximum request attempts
  • RetryInterval

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: Performs limited execution of the Snap (up to 50 records) during Pipeline validation; performs full execution of the Snap (unlimited records) during Pipeline execution.

  • Execute only: Performs full execution of the Snap during Pipeline execution; does not execute the Snap during Pipeline validation.

  • Disabled: Disables the Snap and, by extension, its downstream Snaps.

Validate & Execute

Execute only

Troubleshooting

ErrorReasonResolution

The entered FilterRecords operator is not allowed for the batch input with Batch ID: <EntityName>_<BatchNumber>

The operator selected for FilterRecords is not allowed.

Select an operator field from the list: Equals, Not equals, Less than, Greater than, Less than or equal, Greater than or equal, Starts with, Ends with.

The entered FilterRecords condition is not allowed for the batch input with Batch ID: <EntityName>_<BatchNumber>

The FilterRecords condition selected is not allowed.

Select one of the following values in the Condition field: And, Or, None.

The entered OrderBy value is not allowed for the batch input with Batch ID: <EntityName>_<BatchNumber>

The OrderBy value entered is not allowed.

Enter one of the following values in the OrderBy field: Ascending, Descending.

Entity is not existing. Batch Number: <BatchNumber>.

The entered entity is not found for the selected API object in the server.

Locate and select an appropriate entity from the drop-down list.

API object is not existing.

Allowed API object format is <API ID>(Description).

Locate and select an appropriate API object from the drop-down list.

Additional Information

Here is some information to assist you while using the SAP S/4HANA Batch Read Snap.

Snap General Behavior

The SAP S/4HANA Batch Read Snap supports the following:

  • 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).

Sending Batch Request

The SAP S/4HANA supports the OData 2.0 protocol. SAP S/4HANA APIs that support OData 2.0 can send batch requests with specific requirements and for specific operations. See the documentation at OData 2.0 batch request, for more details.

Batch Input Schema

The Input Schema (the Target Schema of the preceding Mapper Snap) enables you to define the input data for the Batch requests. For SAP S/4HANA Batch Read Snap, the $filter (FilterRecords),  $select (OutputFieldSelection), $orderby (OrderBy), KeyParameter and CustomizedHeader can be defined using the Input Schema. 

Schema settings 

Parameter Name Data TypeDescription

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

StringThe 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

StringSpecify the name of the system parameter $filter fields to be included in the output.

operator

StringSpecify the comparison operator for the system parameter $filter.

value

AnyThe 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

StringSpecify 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.

Key parameters are NOT the same as filters which can return multiple records. Use key parameters only to retrieve specific records. To use a filter like normal select, use the parameters at the Filter records section instead.

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

StringSpecify the field that will be used for sorting by descending or ascending order.

value

StringSpecify the Order Type (Ascending or Descending order).
OutputFieldSelectionWith 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.
nameStringThe name of the entered field to be included in the output.

Using Customized Headers

SAP S/4HANA On-Premise contains a large number of API objects and entities. It also allows you to create and use customized API objects and entities as needed.

  • Some entities may require specific/customized HTTP headers like, If-Match, Etag.
  • SAP S/4HANA Snap Pack supports definition and usage of such customized HTTP headers.
  • This Snap Pack currently contains the following common HTTP headers pre-defined and ready to use. You can however add any custom or specific HTTP headers to fulfill your requirement.
    • Content-type
    • Cache-Control
    • Authorization
    • Accept
    • X-CSRF-Token, and
    • Cookie

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.

For example, the SAP S/4HANA Batch Read Snap output for the ZCRM_BUPA_ODATA_0001 (Odata Services for Business Partner) API object and the AccountCollection entity contains navigation properties (of entities) like Contacts, Addresses, Logo, Attachments.

  • The navigation properties can be used to access specific details of these related entities.
  • In the API response, the navigation property values are displayed as URLs.

You can use one of the following methods to retrieve the details of each related entity returned in the output.

  • Pass the value (URL) from the Snap output as input to any of the three SAP S/4HANA Read Snaps to navigate to or access details of these related entities. OR
  • Parse the value (URL) from the Snap output and use it as input to Service URL field of a REST Get Snap.

Both of these methods return the properties of the corresponding related entity.

Example: Accessing related entities

While querying for AccountCollection entity in the API object ZCRM_BUPA_ODATA_0001 (Odata Services for Business Partner), you can navigate to the Contacts property by connecting any one of the three Read Snaps from this Snap Pack in the downstream to call the ContactCollection entity in the API object ZCRM_BUPA_ODATA_0001 (Odata Services for Business Partner) and filter with a specific accountId.

  • If using the SAP S/4HANA Read Custom Query Snap in the downstream, enhance the customized query by adding $expand=Contacts,Addresses to display the contents of these two properties in the API response of the entity AccountCollection.

Examples

Retrieve multiple Account and Contact records from SAP S/4HANA server

This Pipeline example demonstrates using a SAP S/4HANA Batch Read Snap to query and retrieve multiple records from customer material data in SAP S/4HANA On-Premise and write it into a JSON file. The Snap queries the AccountCollection and ContactCollection entities via API object ZCRM_BUPA_ODATA_0001 (Odata Services for Business Partner).

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.

SAP S/4HANA Read Batch Snap

The following settings are defined for the SAP S/4HANA Batch Read Snap to retrieve Accounts and Contact data from the SAP S/4HANA On-Premise instance. The Snap is configured to send three HTTP API requests (one on AccountCollection and two on ContactCollection) in a single call to the SAP S/4HANA server.

  • API objectZCRM_BUPA_ODATA_0001 (Odata Services for Business Partner) 
  • EntitiesAccountCollection and ContactCollection

A successful validation or execution of the Snap gives the following output preview.

The Binary output view: 

JSON Document output view:

File Writer

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:

Download this Pipeline.

Downloads

Important Steps to Successfully Reuse Pipelines

  1. Download and import the Pipeline into SnapLogic.
  2. Configure Snap accounts as applicable.
  3. Provide Pipeline parameters as applicable.

  File Modified

File SAP_S4HANA_ZCRM_BUPA_ODATA_0001_Multi_Entity_Read_Batch_Demo.slp

Aug 28, 2020 by Anand Vedam

Snap Pack History

 Click here to expand...
Release Snap Pack VersionDateType  Updates
4.27main95 Latest
  • Enhanced the SAP S/4 HANA Snaps to support sub-entities and pagination support.

  • Removed unnecessary datatype conversions.

  • Reduced metadata request volume.

  • Fixed issues in concurrency exception and potential Snap crashes.

4.27main93 StableUpgraded with the latest SnapLogic Platform release.
4.26main88 StableUpgraded with the latest SnapLogic Platform release.
4.25main73
 
StableUpgraded with the latest SnapLogic Platform release.
4.24main73
StableUpgraded with the latest SnapLogic Platform release.
4.23main7430
 
Stable

Enhances the Snap Pack to handle batch and custom query operations:

  • Introduces the SAP S/4HANA Batch Read Snap that enables retrieving batches of records from an SAP S/4HANA On-Premise instance.
  • Introduces the SAP S/4HANA Batch Write Snap that enables writing batches of records to an SAP S/4HANA On-Premise instance.
  • Introduces the SAP S/4HANA Read Custom Query Snap that enables retrieving multiple records from an SAP S/4HANA On-Premise instance, based on custom queries.
  • Introduces the SAP S/4HANA SSL Auth Account type to enable SSL-based authentication on an SAP S/4HANA On-Premise instance.
  • Adds the Count field to the SAP S/4HANA Read Snap to allow returning the total number of records retrieved.
4.22 Patch 422patches6973 Latest

Enhances the SAP S/4HANA Snap Pack with the following additions:

4.22main6403
 
StableUpgraded with the latest SnapLogic Platform release.
4.21snapsmrc542

 

StableInitial release.


See Also