Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Field Name

Type

Description

Label*

Default ValueSAP S/4Hana Cloud Update
ExampleSAP S/4Hana Cloud_Update

String

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

API Object*

Default Value: None
ExampleAPI_BUSINESS_PARTNER_0001 (Remote API for Business Partner)

String/Suggestion

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

Entity*

Default Value: None
ExampleA_Supplier

String/Suggestion

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

Subentity

Default Value: None
Example: to to_SupplierCompany

String/Suggestion

Add a subentity for the entity choosen.

Customized Header

Use this field set to add customized HTTP request headers for implementing specific HTTP requests other than the ones listed in the Additional Information - Usage of Customized header section of this page. 

The Snap provides the CustomizedHeader in the input schema to help you define the customized headers to the UI using the expression function. You can also manually enter the customized header names with values on the UI Customized header fieldset. If you provide only the customized header names or values using schema, but not link to the UI using the expression, the names or values you have entered will not be delivered to the API.

Field Name

Default Value: None
ExampleIf-Match

String/Expression

Specify the field name of the customized HTTP request header.

Field Value

Default Value: None
Example'82F636DC08F14D22260CE67E505C231D0D2ACD95'

String/Expression

Specify the field value for the above field of the customized HTTP request header. 

Key Parameter

Use this field set to specify the key parameters for a specific entity. Providing values for all key parameters in the dropdown list allows 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 plus to add a new row in this table and define the values accordingly. 

Field Name

Default Value: None
Example: userId

String/Expression

Specify the reference parameter in this field.

Field Value

Default Value: None
Example: TestUser

String/Expression

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.

Updating method

Dropdown list

Specify if the Replace or the Merge method should be implemented for updates.

  • By Replace, it is able to replace an entire old record to new.

  • By Merge, it is able to overwrite a new update to old records and merge them together.

Connection Details

Use this field set to specify the connectivity parameters.

Connection Timeout

Default Value300
Example: 500

Integer/Expression

Specify the duration in seconds for which the Snap must try to establish a connection with SAP S/4HANA Cloud. If the connection cannot be established within this duration, the Snap times out writes the event to the log and waits until the specified Retry Interval before attempting to reconnect.

Maximum Retry Attempts

Default Value0
Example: 3

Integer/Expression

Specify the maximum number of attempts the Snap should make to perform the selected operation in case of connection failure or timeout.

Retry Interval

Default Value0
Example: 2

Integer/Expression

Speify the time interval in seconds between the two successive retry requests. A retry happens only when the previous attempt resulted in an exception.

Snap Execution

Default ValueValidate & 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.

...

Multiexcerpt include macro
nameSAP S/4HANA 4 HANA Cloud SPHSP
pageSAP S/4HANA Cloud Snap Pack

...