SAP S/4HANA Read Custom Query

In this article

Overview

Use this Snap to retrieve multiple data objects from an entity in SAP S/4HANA applications using custom OData queries.

Rest custom query (1).png

 

Prerequisites

A valid account that supports SAP S/4HANA, with appropriate access permissions. See Configuring SAP S/4HANA Accounts.

Support for Ultra Pipelines

Works in 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 Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min:0

  • Max:1

  • Mapper Snap

  • CSV Parser

  • JSON Parser

A document containing data that can be used to filter entities that need to be retrieved in SAP S/4HANA server. 

Output

Document

  • Min:1

  • Max:1

  • Mapper Snap

  • Copy Snap

  • XML Formatter

  • JSON Formatter

A document containing the data retrieved from an SAP S/4HANA entity.

Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the pipeline by choosing one of the following options from the When errors occur list under the Views tab:

  • Stop Pipeline Execution: Stops the current Pipeline execution if the Snap encounters an error.

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

  • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap Settings

Field Name

Field Type

Description

Field Name

Field Type

Description

Label*

Default Value: SAP S/4HANA Read Custom Query
Example: SAP S/4HANA Read Custom Query

String

Specify a 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.

API object*

 

Default Value: N/A
Example: ZCRM_BUPA_OData_0001 (OData Services for Business Partner)

String

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

Entity*

 

Default Value: N/A
Example: AccountCollection

String/Expression/Suggestion

Select a business object (the Entity or Endpoint) for the API Object chosen above. 

Subentity

 

Default Value: N/A
Example: MainContact

String/Expression/Suggestion

Specify or select a subentity corresponding to the entity chosen above.

Customized header

 

 

Use this field set to add customized HTTP request headers for implementing specific HTTP requests other than the ones listed in the Using Customized Headers section of SAP S/4HANA Read Snap. Only one customized header can be specified in each row.

Field name

 

Default Value: N/A
Example: If-Match

String

The field name of the customized HTTP request header.

Field value

 

Default Value:  N/A
Example: W/"'82F636DC08F14D22260CE67E505C231D0D2ACD95'"

String

The field value for the above field in the customized HTTP request header. 

Key parameter

 

 

 

This field set enables you to specify the key parameters for a specific entity. Providing values for all key parameters in the drop-down list enables SAP S/4HANA to identify a unique record. Click + to add a new row in this table and define the values accordingly.

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

Field name

 

Default Value: N/A
Example: accountID

String

Specify the reference parameter in this field.

Field value

 

Default Value: N/A