Show TOC

Using Sender AgreementsLocate this document in the navigation structure

Use

Obligatory Sender Agreements

You must specify a collaboration agreement if you want to make security settings for the processing of the message.

If you do not want to make any security settings, you must nevertheless always specify a receiver agreement for the definition of outbound processing of the message, regardless of the type of adapter that is used.

For more information, see: Defining Receiver Agreements

However, you only need to specify a sender agreement in particular cases (when using specific adapters). This depends which information from the adapter configuration in the sender channel is required for successful inbound processing.

The following table specifies the sender adapter types that always require the definition of a sender agreement (even if no security settings are made).

Sender Adapter Type

Sender Agreement Required

JMS, JDBC, File/FTP

Required (see remarks below)

RFC

Required

IDoc

-

HTTP

-

XI

-

WS

Required

SOAP

-

RNIF

Required

CIDX

Required

Mail

-

Marketplace

Required

BC

Required

Note

If you use adapters from third-party vendors, check the relevant documentation for the adapters to determine whether you need to define a sender agreement when using their third-party adapters.

Special Conditions when Using the Sender JMS, JDBC, or File/FTP Adapter

In the case of these adapter types, the information about address fields of the message header is determined from the sender agreement that the communication channel is assigned to. The following conditions apply to sender agreements that use communication channels with these adapter types.

  • The sender channel must not be assigned to more than one sender agreement.

  • No key fields may contain the wildcard character ( * ).

  • At least the interface (name and namespace) and the sender communication component must be specified in the sender agreement because the corresponding address fields in the message must be set uniquely. The remaining fields are optional (see the key fields for the sender agreement).

The sender agreement is determined from the sender channel at runtime. The information from the sender agreement is used to construct the address header of the message.

Defining Sender Agreements Specifically/Generically

Rule: Most Specific Object Has Priority

The Most Specific Object Has Priority rule always applies for all adapter types.

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

The adapter type is not part of the object key of a sender agreement. A sender agreement is therefore always valid for all adapter types. At runtime, the inbound processing of the message is only successful if the message is sent to the adapter that is configured in the communication channel used.

In other words, using the "most specific object has priority" rule, it is implicitly specified (using the communication channel used in the relevant sender agreement) which adapter is to be used for the inbound processing of the message.

Special Case: Multiple Adapter Engines Involved

If multiple Adapter Engines are involved in the message exchange, you must take the following into account.

The "most specific object has priority" rule does not apply to all Adapter Engines in the case of sender agreements. When messages arrive, the Adapter Engine only knows those sender communication channels and the sender agreements based on them that are defined for them.

The following sender agreements are defined in the Integration Directory as examples.

Key Attributes

Sender Agreement

Sender Agreement2

Sender Agreement3

Sender

Partners

A

*

A

Communication Component

*

*

B

Interface (Name)

OutboundExample

OutboundExample

OutboundExample

Namespace

http://example

http://example

http://example

Receiver

Partners

P1

P2

P3

Communication Component

S1

S2

S3

Adapter Engine (x)

AE 1

AE 1

AE 2

(x): Adapter Engine of the communication channel used by the sender agreement

In the configured scenario, the Adapter Engine AE1 receives a message from communication component B of party A .

Although Sender Agreement3 is the specific sender agreement, the sender agreement that is applied in this case is Sender Agreement1 . Sender Agreement3 uses a communication channel that is unknown to Adapter Engine AE1 .

Note

In the case of receiver agreements, however, the "most specific object has priority" rule applies to all Adapter Engines.