Show TOC

Defining Receiver AgreementsLocate this document in the navigation structure


To configure the outbound processing of a message, define a receiver agreement .

You must specify a receiver agreement for all adapter types to ensure that outbound processing is executed correctly.


To define a receiver agreement, perform the following tasks:

1. Creating a Receiver Agreement

Create a receiver agreement.

For more information, see: Create Objects

Specify at least the party or communication component and the inbound interface for the sender and receiver.

You can enter a wildcard character ( * ) for the sender party, sender communication component, and receiver interface if the receiver agreement is to apply for multiple instances (for example, for all interfaces of the receiver).

For more information, see: Generic/Specific Definition of Configuration Objects

2. Assign Communication Channel

Select the communication channel in the Receiver Communication Channel field. Use the input help. The input help displays the communication channels that are assigned to the receiver (in the key for the receiver agreement).

3. Define Schema Validation

You can specify whether you want the structure of the payload of the outbound message to be checked.

  1. For XML validation to be executed correctly, you must specify the software component version of the interface that is entered in the key for the receiver agreement. Only then is it possible to define the message structure uniquely. Use the input help for the Software Component Version field.

  2. If you want the message to be validated, select Validation by Integration Engine .


f you change an object in the ES Repository that is required for validation (a data type, for example) the change is not automatically accepted in the runtime cache. To be sure that you are accessing the current object version in the runtime cache, activate the receiver agreement again.

4. Specify Adapter-Specific Attributes

If you have assigned the receiver agreement a communication channel with adapter type XI , SOAP, Mail , RNIF , CIDX , or WS you can specify further adapter-specific attributes.

Which adapter-specific attributes are available depends on the adapter type of the assigned communication channel.

  • Using Adapter-Specific Attributes with a Communication Channel with Adapter Type WS

    For more information, see: Adapter-Specific Attributes


    If you have assigned a communication channel with an older adapter type version, you can find more information under Adapter-Specific Attributes (Version 7.10) and Adapter-Specific Attribute (Version 7.11) .

  • Adapter-Specific Attributes when Using XI, SOAP, Mail, RNIF, or CIDX Adapters

    If you have assigned the receiver agreement a communication channel with adapter type XI , SOAP, Mail , RNIF or CIDX , you can make settings for message security by using the adapter-specific attributes.

    To be able to configure the security settings, the following settings must be set in the assigned communication channel:

    • For adapter types XI and SOAP : You must select the checkbox Choose Security Profile and the security profile Web Service Security.

    • For adapter types RNIF and CIDX : You must select the checkbox under Security Settings .

    • For adapter type Mail : Message log XIPAYLOAD message protocol and S/MIME checkbox must be set.

    For more information, see:

5. Defining the Scope of Data for Service Call Statistics

For scenarios where communication is based on the proxy runtime or Web service runtime, the service provider is automatically sent statistical information about all service consumers that call it. This function is also activated for scenarios where there is an Integration Server between service consumers and providers. The transfer of this data is always activated, but you can configure the scope of data that is to be transferred to the provider in the service call statistics.

In the receiver agreement, you define the scope of consumer data that is to be transferred to the service provider.


To ensure the appropriate input fields are displayed, the receiver agreement must be assigned a communication channel with adapter type XI , SOAP , or WS in version 7.11 .

You can choose between the following values for the scope of data:

  • Minimal Data Transfer

  • Elementary Data Transfer

  • Enhanced Data Transfer

The default setting for the scope of data is Minimal Data Transfer .

If you have assigned a communication channel with adapter type SOAP or WS (version 7.11) to the receiver agreement, you can also specify a specific protocol for transferring data for service metering.

6. Define Header Mappings

If you want to define that the values of the address fields (party, communication component) be transformed in the header of the outbound message, define a header mapping.

For more information, see: Define Header Mappings

7. Define Principal Propagation

If you want the Integration Server to propagate principals to the receiver (based on authentication assertion tickets), select the Propagate Principal checkbox under Settings for Principal Propagation .


This function is only supported for receiver channels with adapter type XI , RFC , or SOAP .

For more information, see: Configuring Principal Propagation (Authentication Assertion Ticket)


When you copy a receiver agreement, the users and passwords that are specified there are not copied as well for security reasons. Note that you therefore need to specify the users and passwords again after the copying process.