Start of Content Area

Background documentation XML Validation  Locate the document in its SAP Library structure

XML validation allows you to check the structure of an PI message payload. The structure check is performed using saved data types. You activate the validation in the collaboration agreement. Monitoring and administration takes place in message monitoring of the Runtime Workbench and in the Integration Engine.

There is no semantic check of the message payload. Fault messages, receipt acknowledgments, and exceptions are not validated.

This graphic is explained in the accompanying text

You can perform the structure check at the following points in PI message processing:

      Validation in the sender adapter

If the sender adapter has created the PI message, you can then perform the validation of the PI payload. If the structure of the payload differs from the definition of the data type provided for comparison, message processing is stopped. The adapter sends a synchronous response to the sender of the message, informing it about the structure error. The industry-specific adapters inform the sender asynchronously, as required by the RNIF protocol and the CIDX protocol.

All sender adapters (including non-SAP adapters) can perform this validation.

      Validation in the Integration Engine

In inbound and outbound processing, validation of the PI message payload takes place as a pipeline step of the Integration Engine. If the structure of the message payload does not match the saved definition of the data type, an error description is generated. The error description contains status information and a list of all structure errors. Message processing is stopped. The message is set to error status and an error report is saved.

If validation takes place in the Integration Engine, the sender of the message is not automatically informed of the structure error. The message is set to error status and an administrator can process the message further using the Runtime Workbench.

Handling Synchronous Messages

Synchronous messages consist of a request and a response payload, which are processed in a synchronous call. Both payloads can only be validated together. You configure the validation for inbound requests and outbound responses in the sender agreement. You configure the validation for outbound requests and inbound responses in the receiver agreement.

Data Types from the Enterprise Services Repository

The data types that are used for validation come from the Enterprise Services Repository.

More information: Data Types

Configuration

You define whether and where the validation of the PI message payload takes place in the respective collaboration agreement. In a sender agreement, you can choose between validation in the sender adapter or validation in the Integration Engine. If validation takes place in the adapter, a synchronous response is sent to the sender when an error occurs.

In the receiver agreement, you can configure the validation in the Integration Engine. If validation takes place in the Integration Server, the message is set to error status and can be processed by the administrator in the Runtime Workbench in the case of an error.

More information:

Receiver Agreement

Sender Agreement

Administration in the Runtime Workbench and in the Integration Engine

Messages that have error status following validation can be processed further by an administrator in the Runtime Workbench. The administrator can resend messages and skip the validation step.

More information about monitoring in the Runtime Workbench: Displaying and Managing Messages

More information about monitoring in the Integration Engine: Selecting Processed XML Messages

Setting Up XML Schemas in the File System

More information: Setting Up XML Schemas in the File System

 

 

 

End of Content Area