Payload

Definition

Payloads result as part of error handling in asynchronous services. They include data with which an asynchronous service is called and that could not be posted to the system. The term payload denotes detail data including type information.

Structure

A differentiation is made between the following payloads:

  • Pre-Mapping Payloads: If the data from the proxy structure of the service cannot be transferred to the data structure of the calling API, pre-mapping payloads are created.

  • Post-Mapping Payloads: If the data from the proxy structure of the service cannot be transferred to the data structure of the calling API, post-mapping payloads are created. The API detected a business error during processing of the call (for example, the transfer of an unknown business partner ID) that prevents updating of the data.

The detail data of a payload is always available as a deeply nested DDIC structure. In the case of pre-mapping payloads, this DDIC structure corresponds to the respective proxy structure of the asynchronous service. In the case of post-mapping payloads, this DDIC structure corresponds to the call data of the API that detected the business error.

Each node in the DDIC structure is identified by an extraction path that you can display in Payload Editor using the context menu of the relevant node. In Customizing, you use the extraction paths to define which data from the payload of Error and Conflict Handler you want to extract for the payload attributes and the key fields of the related objects.

In Customizing for Cross-Application Components, you define payload attributes under Start of the navigation pathGeneral Application Functions Next navigation step Error and Conflict Handler Next navigation step Define Payload AttributesEnd of the navigation path.

In Customizing for Cross-Application Components, you assign the extraction paths under Start of the navigation pathGeneral Application Functions Next navigation step Error and Conflict Handler Next navigation step Make Payload-Specific SettingsEnd of the navigation path.

Integration

When you call up Error and Conflict Handler, a related post-processing order is always created in addition to the payload. This means that there is always exactly one postprocessing order in Postprocessing Office for a specific payload.