In this article
Overview
Use this Snap to read and retrieve data objects from the SAP S/4HANA On-Premise instance.
Prerequisites
A valid account that supports SAP S/4HANA On-Premise instance, with the appropriate access permissions. See Configuring SAP S/4HANA Accounts.
Support for Ultra Pipelines
- Works in Ultra Pipelines.
See Snap Support for Ultra Pipelines.
Limitations and Known Issues
- SAP S/4HANA On-Premise instance does not support server-side pagination. As a result, the $skiptoken is not supported.
- The Snap does not support OData navigation link.
Snap Input and Output
Input/Output | Type of View | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| A document with data that indicates the entities to be filtered and retrieved from SAP S/4HANA On-Premise instance. |
Output | Document |
|
| A document containing the entity data retrieved from a SAP S/4HANA On-Premise instance. |
Snap Settings
Parameter Name | Data Type | Description | Default Value | Example |
---|---|---|---|---|
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 Read |
API object | String | Required. 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. | N/A | ZCRM_BUPA_OData_0001 (OData Services for Business Partner) |
Entity | String | Required. Select a business object (the Entity or Endpoint) for the API Object chosen above. | N/A | AccountCollection |
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 this page. Only one customized header can be specified in each row. Click to add a new row in this table and specify the values accordingly. This field set comprises the following fields:
| |||
Field name | String | The field name of the customized HTTP request header. | N/A | If-Match |
Field value | String | The field value for the above field in the customized HTTP request header. | N/A | W/"'82F636DC08F14D22260CE67E505C231D0D2ACD95'" |
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. 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. Only one key parameter can be specified in each row. Click to add a new row in this table and define the values accordingly. This field set comprises the following fields:
| |||
Field name | String | Specify the reference parameter in this field. | N/A | accountID |
Field value | String | Specify the value for the reference parameter in this field. The data type—String, Integer, Boolean or any other—depends on the Field name you specified for the parameter. | N/A | TEST_001 |
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. Click to add a new row in this table and define the values accordingly. Multiple filters, if defined in this table, will be applied for generating the final output, in the order they are defined. This field set comprises the following fields:
| |||
Field name | String | Specify the system parameter—$filter field—to be used for filtering the records in the output. | N/A | accountID |
Operation | String | Specify the comparison operator for the $filter field specified above from this drop-down list. Available options are:
| Equals | Equals |
Field value | 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. | N/A | TEST-AC-01 |
Condition | 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 | None |
Output field selection | This field set enables you to select the fields to be included in the output. Only one output field can be specified in each row. Click to add a new row in this table. To return all available fields in the output, do not specify any output field. | |||
N/A | String | Specify the fields from the result dataset to be populated in the output. | N/A | accountID, name1, name2 |
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. Click to add a new row in this table and define the sort order criteria accordingly. Multiple Order by criteria will be applied in the same sequence as they are defined. This field set comprises the following fields:
| |||
Element | String | Specify the field in the expected output by which the records in the output must be ordered. | N/A | name1 |
Order by type | String | Depending on the field selected above, define whether the rows must be sorted in the ascending order or descending order. Available options are:
| Descending | 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. Available options are:
| |||
Output entry limit | Integer | Specify the maximum number of entries that SAP S/4 HANA On-Premise instance must return in the output. | 500 | 10 |
Output entry offset | 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. | N/A | 10 |
Is an active entity | String | Use this Snap property to 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. If this field is not included for these entities, the error 'Draft 2.0 object <SERVICE~ENTITY> requires selection condition on IsActiveEntity', is returned. Select one of the following from this drop-down list:
| not available | true |
Count | Check box | Select this check box to return the total number of records retrieved in the API response. | Deselected | Selected |
Allow empty result | Check box | Use this property 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. | Selected | Deselected |
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 | Integer | Required. 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. | 300 | 120 |
Maximum request attempts | Integer | Required. Specify an integer value to set the maximum number of reconnection attempts that the Snap must perform, in case of connection failure or timeout. | 3 | 5 |
RetryInterval | Integer | Required. Enter, in seconds, the duration for which the Snap must wait between two reconnection attempts, until the number of retries is reached. | 1 | 10 |
Snap Execution | String | Indicates how the Snap must be executed. Available options are:
| Validate & Execute | Execute only |
Troubleshooting
Error | Reason | Resolution |
---|---|---|
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:
| 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. |
Additional Information
Here is some information to assist you while using the SAP S/4HANA Read Snap.
Snap General Behavior
The SAP S/4HANA Read Snap supports the following:
- GET operation to read data from the SAP S/4HANA server.
- OData querying operations: $filter (Filter records), $select (Output field selection), $orderby (Order by), $top (Output entry limit), and $skip (Output entry offset).
- OData operation $count (Count check box).
- Connection-failed-retry mechanism.
- Client-side pagination through $top (Output entry limit) and $skip (Output entry offset) mechanisms. For more information, see Pagination.
- 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).
- And then, select an entity to view and specify values for only read-compatible parameters related to this entity in Key parameter, Filter records, Output field selection, and Order by fields.
Pagination
Client-side pagination is supported through the use of the $top (Output entry limit), and $skip (Output entry offset) OData operations.
Examples
Snap Output Setting | Pagination result |
---|---|
Output entry limit: 100 |
|
Output entry offset: 100 |
|
Output entry offset: 100, and Output entry limit: 100 |
|
Using Customized Headers
SAP S/4HANA On-Premise instance 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 Customized header section. Below is an example of a custom HTTP header defined:
Accessing Related Entities from Snap Outputs for an Entity
Records in SAP S/4HANA 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 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 Customer Material Data from SAP S/4HANA On-Premise instance
This Pipeline example demonstrates using a SAP S/4HANA Read Snap to retrieve customer material data from SAP S/4HANA On-Premise instance and write it into a JSON file.
The example assumes that you have configured and authorized a valid SAP S/4HANA Account (see Configuring SAP S/4HANA Accounts).
Downloads
Important Steps to Successfully Reuse Pipelines
- Download and import the Pipeline into SnapLogic.
- Configure Snap accounts as applicable.
- Provide Pipeline parameters as applicable.