Input 

Document

• Min: 0

• Max: 1

• Mapper Snap

• Copy Snap

• JSON Parser

A document with data that indicates the entities to be filtered and retrieved from SAP S/4HANA On-Premise instance. 

Output

Document

• Min: 1

• Max: 1

• Mapper Snap

• Copy Snap

• XML Formatter

• JSON Formatter

A document containing the entity data retrieved from a SAP S/4HANA On-Premise instance.

Label*

Default Value: N/A
Example: SAP S/4HANA Read

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 enable the Snap to perform a specific action.

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. 

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

Filter records

This field set enables you to define how the response result be filtered based on the specified parameters (filter criteria). Only one filter can be specified in each row. Multiple filters, if defined in this table, will be applied for generating the final output, in the order they are defined.

Field name

Default Value: N/A
Example: accountID

String

Specify the system parameter—$filter field—to be used for filtering the records in the output.

Operation

Default Value: Equals
Example: Equals

String

Specify the comparison operator for the $filter field specified above from this drop-down list. Available options are: 

• Equals

• Not Equals

• Greater than or Equal

• Greater than

• Less than or Equal

• Less than

• Starts with

• Ends with

Field value

Default Value: N/A
Example: TEST-AC-01

String

Specify the value with which the above $filter field must be compared. The data type—String, Integer, Boolean, or any other—depends on the $filter field you specified for the filter criterion.

Condition

Default Value: Or
Example: None

String

Select a value from this drop-down list to set the correlation between this filter criterion (row) and the next one (row), if being defined at all, to apply the filters for generating the final output. Available options are: 

• Or: To retrieve records that match either the current criterion or the next criterion.

• And: To retrieve only records that match both the current criterion and the next criterion.

• None: To specify that the current and the next criteria can be evaluated independent of each other in retrieving the records.

Output field selection

This field set enables you to select the fields to be included in the output. 

Element

Default Value: N/A
Example: accountID, name1, name2

String/Expression

Specify the fields from the result dataset to be populated in the output.

Order By

This field set enables you to define the sort order for the records in the output. Only one column name can be specified in each row for the sort order. Multiple Order by criteria will be applied in the same sequence as they are defined

Element

Default Value: N/A
Example: name1

String

Specify the field in the expected output by which the records in the output must be ordered.

Order by type

Default Value: Descending
Example: Descending

String

Depending on the field selected above, define whether the rows must be sorted in the ascending order or descending order. Available options are:

• Ascending

• Descending

Output fields advanced options

Use this section of Snap Settings to customize the output set: the number of output entries and the index of the starting entry

Output entry limit

Default Value: N/A
Example: 10

Integer

Specify the maximum number of entries that SAP S/4 HANA On-Premise instance must return in the output.

Output entry offset

Default Value: N/A
Example: 10

Integer

Specify the record index starting from which SAP S/4 HANA On-Premise instance must return records in the output.
Use this property along with the Output entry limit to retrieve a specific set of entries in the output.

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.

Is an active entity

Default Value: not available
Example: true

Dropdown list

Choose the value for this field. Available options are: 

• true: get all records with field IsActiveEntity = truein the returned response.

• false: get all records with field IsActiveEntity = false in the returned response.

• not available: Do not require this field.

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 check box 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: 1

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 Output field selection table.

The Output field selection table has an empty field.

Provide a valid entry for the selected output field.

You have an empty value in the Order by table.

The Order by table has an empty field.

Enter a valid value to define sort order.

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.

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: 100

• Retrieves API response records starting from index 101 from the server (if more than 100 records are present in API response).

• Returns empty result (if 100 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.