SAP S/4HANA Cloud Delete

Overview

The SAP S/4HANA Cloud Delete Snap deletes data objects in the SAP S/4HANA Cloud.

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. Learn more: SAP S/4HANA Cloud Accounts.

Known issues

The Snap does not support the 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 the key of the selected entity that must be deleted from 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 deletion 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 Delete Example: `SAP S/4Hana Cloud_Delete`
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/Expression/ Suggestion`	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 Additional Information - Usage of Customized header section of this page.
Field name `String/Expression`	Specify the field name of the customized HTTP request header. Default value: N/A Example: `if-match`
Field value `String/Expression`	Specify the field value for the above field of the customized HTTP request header. Default value: If-Match Example: `82F636DC08F14D22260CE67E505C231D0D2ACD95`
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 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.
Field name `String/Expression`	Specify the reference parameter in this field. Default value: N/A Example: `userId`
Field value `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. Default value: N/A Example: `TestUser`
Connection details	Use this field set to specify the connectivity parameters.
Timeout `Integer/Expression`	Required. Specify the duration in seconds for which the Snap must try to establish connection with SAP S/4HANA Cloud server. 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. Default value: 300 Example: `300`
Maximum request attempts* `Integer/Expression`	Specify an integer value to set the maximum number of reconnection attempts that the Snap must perform, in case of connection failure or timeout. Default value: 300 Example: `300`
Retry Interval* `Integer/Expression`	Specify the duration in seconds for which the Snap must wait between two reconnection attempts, until the number of retries is reached. Default value: 0 Example: `3`
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`

Behavior of SAP S/4HANA Cloud Delete Snap

Supports Delete operation to Delete data from SAP S/4HANA Cloud instance.
Supports customized HTTP Header. For details, see Usage of Customized header below.
Supports the input schema by which it is allowed to display the Delete 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 dropdown. Note that after selecting an API object, only entities that can be deleted are suggested in the entity field. And after selecting an entity, only relevant parameters will be displayed in the Key parameter dropdown field.

Note: The Key parameters are labeled with a '*' in the Input schema.

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/4HANA. 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 predefined in the Snap. You can however add any custom or specific HTTP headers to fulfill your requirement. The following headers are already defined in the 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, do not provide them in these fields.

An example of a defined custom header is given below:

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 dropdown list.
`Entity does not exist.`	The entered Entity is not found in the server.	Locate and select the Entity from the dropdown list.