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. 

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

• 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

N/A

AccountCollection

Subentity

String/Expression/Suggestion

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

N/A

MainContact

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

true

Count

Check box

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

Deselected

Selected

Disable datatype conversion

Checkbox/Expression

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

Deselected

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

• 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

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.

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.