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.

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.

Field name

Default Value: N/A
Example: accountID

String

Specify the reference parameter in this field.

Field value

Default Value: N/A
Example: TEST_001

String

Specify the value for the reference parameter in this field.

Customized query

Default Value: N/A
Example: $filter=accountID eq 'Test_123' and name1 eq 'testname'&$select=accountID,name1,name2&
orderby=name1 desc

String

This field enables you to enter your OData query.

Raw response

Default Value: Deselected

Checkbox/Expression

Select the checkbox to write the raw response to the output as a single document. If this checkbox is deselected, the results are written as individual documents.

Has next

Default Value: N/A
Example: $entity['has-more']

String/Expression

Enter the expression that must be evaluated to true or false indicating if the Snap should fetch the next page or not.

Next URL

Default Value: N/A
Example: $entity['has-more']

String/Expression

Enter an expression that must be evaluated to a URL that the Snap should use to proceed to the next page.

Disable datatype conversion

Default Value: Deselected
Example: Selected

Checkbox/Expression

Select the checkbox to disable the datatype conversion for values of key parameters and filters.

Count

Default Value: Deselected
Example: Selected

Checkbox/Expression

Select this checkbox to return the total number of records retrieved in the API response.

Allow empty result

Default Value: Selected
Example: Deselected

Checkbox/Expression

Select this checkbox to define whether output views can show empty result. If this checkbox is not selected, an error will be thrown when the output has no records.

Connection details

Use this field set to specify the connectivity parameters: timeout, retry count, and retry interval.

TimeOut*

Default Value: 300
Example:120

Integer

Enter, in seconds, the duration for which the Snap must try to establish connection with SAP S/4HANA On-Premise instance. If the connection cannot be established within this duration, the Snap times out, writes the event to the log, and waits until the specified RetryInterval before attempting to reconnect.

Maximum request attempts*

Default Value: 3
Example: 5

Integer

Specify an integer value to set the maximum number of reconnection attempts that the Snap must perform, in case of connection failure or timeout.

RetryInterval*

Default Value: 1
Example: 10

Integer

Enter, in seconds, the duration for which the Snap must wait between two reconnection attempts, until the number of retries is reached.

Snap Execution

Default Value: Validate & Execute
Example: Execute only

Dropdown list

Indicates how the Snap must be executed. Available options are:

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

You have an empty value in the Field name field for the Key parameter.

The Field name field must not be empty for the Key parameter.

Enter a valid Field name for the Key parameter.

You have an empty field in the Field name/value field for the Customized header.

The Field name/value field must not be empty for the Customized header.

Enter a valid Field name/value for the Customized header.

ResponseCode: 500; ErrorCode: SY/530;Draft 2.0 object <Service~Entity> requires selection condition on IsActiveEntity.

Draft 2.0 object <Service~Entity> requires selection condition on IsActiveEntity For backend administrators: run transaction /IWFND/ERROR_LOG on SAP Gateway hub system and search for entries with the timestamp above for more details See SAP Note 1797736 for error analysis (https://service.sap.com/sap/support/notes/1797736)

Add the following query into the Customized query field: $filter=IsActiveEntity eq true or $filter=IsActiveEntity eq false. 

Empty result found.

There is no data coming back from the API call. Possible reasons:

• No relevant data available in the API database

• Filter setting is restrictive

• URL parameter setting is restrictive

Select the Allow empty result check box.

API object does not exist.

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

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

Entity does not exist.

The entered Entity is not found in the server.

Locate and select the Entity from the drop-down list.

Output entry limit: 100

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

Output entry offset: 50

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

Output entry offset: 100, and 
Output entry limit: 100

• Skips the first 100 records and collects the 200 - 300 records in the API response from the server.