SAP S/4HANA Cloud Create

Overview

The SAP S/4HANA Cloud Create Snap creates data objects in an SAP S/4HANA Cloud instance.

Supported Accounts

This is a Write-type Snap.
Works in Ultra Tasks

Prerequisites

A valid account that supports SAP S/4HANA Cloud instance, with the appropriate access permissions. See SAP S/4HANA Cloud Accounts.

Known issues

The Snap does not support OData navigation link.

Snap views


Type	Description	Examples of upstream and downstream Snaps
Input	This Snap has exactly one document input view. Each input document contains data that must be created and written into the SAP S/4HANA Cloud instance.	Mapper Copy JSON Parser
Output	This Snap has at most one document output view. Each document contains the response of the creation of new records in the SAP S/4HANA Cloud instance.	Mapper Copy XML Formatter JSON Formatter
Learn more about Error handling.

Snap settings

Note: Learn about the common controls in the Snap settings dialog.


Field/Field set	Description
Label* `String`	Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline. Default value: SAP S/4Hana Cloud Create Example: `SAP S/4Hana Cloud_Create`
API object* `String/Expression/ 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. Default value: N/A Example: `API_BUSINESS_PARTNER_0001 (Remote API for Business Partner)`
Entity* `String`	Select a business object (the Entity or Endpoint) for the API Object chosen above. Default value: N/A Example: `A_Supplier`
Customized Header	Use this field set to add customized HTTP request headers for implementing specific HTTP requests other than the ones listed in the Usage of Customized Header section of this page. Note: The Snap provides the Customized Header in the input schema to help you to 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 `String`	Specify the field name of the customized HTTP request header. Default value: None Example: `If-Match`
Field Value `String`	Specify the field value for the above field of the customized HTTP request header. Default value: None Example: '`82F636DC08F14D22260CE67E505C231D0D2ACD95'`
Connection Details	Use this field set to specify the connectivity parameters.
Connection Timeout `Integer`	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 RetryInterval before attempting to reconnect. Default value: 300 Example: `500`
Maximum Request Attempts `Integer`	Specify the maximum number of attempts the Snap should make to perform the selected operation in case of connection failure or timeout. Default value: 0 Example: `2`
Retry Interval `Integer`	Specify the time interval in seconds between the two successive retry requests. A retry happens only when the previous attempt resulted in an exception. Default value: 0 Example: `2`
Snap execution `Dropdown list`	Choose one of the three modes in which the Snap executes. Available options are: `Validate & Execute`: Performs limited execution of the Snap and generates a data preview during pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during pipeline runtime. `Execute only`: Performs full execution of the Snap during pipeline execution without generating preview data. `Disabled`: Disables the Snap and all Snaps that are downstream from it. Default value: Validate & Execute Example: `Execute only`

General behavior of SAP S/4HANA Cloud Create Snap

Supports POST operation to create new data to the SAP S/4HANA Cloud instance.

Supports customized HTTP Header. For details, see the Usage of Customized Header section.
Supports the input schema by which it is allowed to display the Create supported input parameter set from the upstream input snap.
Supports dynamic metadata loading, by which it is allowed to load the API metadata with a Parent-child dependency structure. Select an API object from the API Object field and only this selected API-object related and Create supported (POST operation supported) entities will be displayed. After selecting an entity, only this selected entity related and Create supported (POST operation supported) parameters will be shown in the input schema.

Input Schema

The input schema for SAP S/4HANA Create Snap is divided into two parts, CustomizedHeader and Payload as shown below.

The CustomizedHeader schema helps you define the customized headers to the UI using the expression function. Alternatively, you can 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 do not link to the UI using the expression, the names or values you have entered are not delivered to the API.

The Payload schema helps you define the input payload for the API call via Create Snap. It loads all the parameters that you need for the data object creation. If there is a Mapper Snap or a Snap that displays the entire input schema, then use payload schema to define the input payload. Otherwise, in the input JSON object, always include "Payload" text as a key in the parent of the input.

SAP S/4HANA Cloud Create Snap input schema

Schema Settings


Field/Field set	Type	Description
CustomizedHeader	Array	Add a customized HTTP request header to implement specific HTTP requests.
name	String	The field name of the customized HTTP request header. Example: If-Match
value	String	The field value of the customized HTTP request header. Example: W/"'82F636DC08F14D22260CE67E505C231D0D2ACD95'"
Payload	Object	Specify the input data parameters for the selected entities.

Usage of Customized Header

For this Snap Pack, setting customized HTTP headers is allowed. SAP S/4HANA Cloud contains a large number of API objects and entities. It is also possible to create customized API objects and entities in SAP S/4 HANA. For some entities, specific HTTP headers might be required. Example: If-Match and Etag. In the current release, only a few commonly used HTTP headers are pre-defined in the Snap. You can however add any custom or specific HTTP headers to fulfill your requirement. The following headers are already defined in Snap: Content-type, Cache-Control, Authorization, Accept, X-CSRF-Token, and Cookie.

Note: Since the header parameters Content-type, Cache-Control, Authorization, Accept, X-CSRF-Token, and Cookie are already internally handled by the Snap, please do not provide them in these fields.

See below for an example of a defined custom header.

Troubleshooting


Field/Field set	Type	Description
`There is 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.
`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.