The input document contains customized header data and/or key parameter data that need to be passed to the Snap and data that must be written (created/updated/deleted) into the SAP S/4HANA server for the selected entity.
Each document contains the data created in the SAP S/4HANA server or updating/deleting result status data for the selected entity. The output document is a multipart binary stream or a document stream.
The binary document 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.
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.
SAP S/4HANA Batch Write
Required. Select the API that you want to access in SAP S/4HANA On-Premise. This drop-down list contains APIs available for the S/4HANA account configured in the Snap, each with a short description.
ZCRM_BUPA_ODATA_0001 (Odata Services for Business Partner)
Required. Select a business object (the Entity or Endpoint) for the API object chosen above.
Required. Select the type of write operation you want to perform.
CREATE: Performs the POST operation to create new data objects.
UPDATE_MERGE: Performs the PATCH operation to partially update the specific data objects.
UPDATE_REPLACE: Performs the PUT operation to update the entire data objects.
DELETE: Performs the DELETE operation to delete a specific data object.
Input navigation level
Select the depth of navigation for your input schema.
Select the number of records to be processed in each request.
Use this section of Snap Settings to specify the connectivity parameters: timeout, retry count and retry interval.
This fieldset comprises the following fields:
Maximum request attempts
Required. Enter, in seconds, the duration for which the Snap must try to establish connection with SAP S/4HANA On-Premise server. If the connection cannot be established within this duration, the Snap times out, writes the event to the log, and waits until the specifiedRetryIntervalbefore attempting to reconnect.
Maximum request attempts
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.
Required. Enter, in seconds, the duration for which the Snap must wait between two reconnection attempts, until the number of retries is reached.
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
API object is not existing.
Allowed API object format is <API ID>(Description).
Locate and select an API object from the drop-down list.
Entity is not existing.
The entered Entity is not found for the selected API object in the server.
Locate and select the Entity from the drop-down list.
The input payload is not found.
The input payload is not found.
Fetch an input payload via Input Schema or input with the root key node Payload.
The input payload should be a JSON object.
The input payload is not passed as a JSON object.
Ensure that the input payload coming from the upstream Snap is a JSON object.
The following contents provide some helpful information to assist you while using the SAP S/4HANA Batch Write Snap.
Snap General Behavior
The SAP S/4HANA Batch Write Snap supports the following:
POST/PUT/DELETE operation tocreate/update/deletedata in the SAP S/4HANA On-Premise server.
Display of only the create/update/delete-compatible input parameter set from the upstream input Snap.
Dynamic loading of API metadata with a Parent-child dependency structure. This means that you can
Select an API object from theAPI objectfield to view only entities that are related to the API object and support POST queries (create operations).
And then, select an entity to view and specify values for only create-compatible parameters related to this entity in the Input Schema.
Sending Batch Request
The SAP S/4HANA supports the OData 2.0 protocol. SAP S/4HANA APIs that support OData 2.0 can send batch requests with specific requirements and for specific operations. See the documentation atOData 2.0 batch request, for more details.
Batch Input Schema
The Input Schema assists you to define the input data for the Batch requests. For SAP S/4HANA Batch Write Snap, the KeyParameterandCustomizedHeader can be defined using the Input Schema. The KeyParameter path will only be shown if the Write Type is set as DELETE or UPDATE_REPLACE in the Snap settings.
Use this property schema to add customized HTTP request headers for implementing specific HTTP requests other than the ones listed under Using Customized Headerssection in SAP S/4HANA Read Snap.
The field name of the customized HTTP request header.
The field value of the customized HTTP request header.
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.
Key parameters are NOT the same as filters which can return multiple records. To use a filter likenormal select, use the parameters at theFilter recordssection instead. Use key parameters only to retrieve specific records.Provide values to all keys found in the drop-down list.
Specify the input data parameters for the selected entities.
Creating Multiple Customer Material Records in SAP S/4HANA Server
This Pipeline example demonstrates how to use a SAP S/4HANA Batch Write Snap to create multiple customer material data objects in the SAP S/4HANA On-Premise instance. The Snap queries the C_CustomerMaterial_F2499T entity via API object ZSD_F2499_CUSTOMER_MATERIAL_SRV_0001 (Customer Material).