Object Key in Configuration Objects

Use

The object key enables you to identify a configuration object uniquely. In the case of configuration objects, the structure of the object key depends on the object type.

Note

The object key is assigned when the object is created, after which it can no longer be changed.

More information: Creating Objects

Collaboration Profile Objects

The objects of the collaboration profile define possible senders and receivers of messages and their (technical) communication options. Depending on the use case, the addressing of senders and receivers is supported in two ways:

As a party with an assigned communication component
As a communication component independently of a party

A communication channel defines the technical details of the inbound or outbound processing of a message for a sender or receiver. Therefore, depending on the chosen method of address, you can define a communication channel for a party and a communication component, or for a communication component independently of a party.

This results in the following object keys:

Key Fields in Collaboration Profile Objects

(The fields marked with an X are key fields.)

Key Field	Party	Communication Component	Communication Channel
Party (name)	X
Communication Component (name)	X	X
Communication Channel (name)	X	X	X

Note the following when naming these configuration objects:

The name length is limited to 120 characters.
The first character must be a letter (upper or lower case).
The remaining characters must be made up of letters (upper or lower case), numbers ( 0 to 9 ), or the underscore ( _ ) character.
Blanks are not permitted.

Recommendation
We recommend that you adhere to Upper Camel Case (UCC) notation when you name objects. This notation does not use blanks to separate parts of names; instead it only uses a switch from lowercase to uppercase letters (for example, CheckFlightSeatAvailability ).

Use British English for the individual parts of the name.

Objects for Configuring Message Exchange

This object group is made up of the following object types:

Objects of the logical routing (receiver determinations and interface determinations)
Receiver agreements and sender agreements
Integrated configurations
Direct connections

These objects each define the rules for the routing and message processing for a specific combination of sender, receiver, and interface . These objects do not have their own names. The object key instead comprises the sender, receiver, and interface, and defines the “range” in which the configuration data contained in these objects is valid.

Example

In the receiver determination example you find these relationships explained under Example for Object Key (Receiver Determination) .

Note

Since these objects do not have a name, the object key of each is displayed in the navigation area of the Integration Builder. Since the display can be overwhelming if there are a large number of objects, you have the option of grouping the objects according to selected key components.

More information: Navigation Area

You can define the objects for configuring message exchange generically for particular key attributes by masking the key fields. This enables you to specify a general definition range for these objects.

More information: Defining Configuration Objects Generically/Specifically

The following table shows the parts of the object key for which you can define the objects of the logical routing and collaboration agreement generically.

Maskable Key Fields in Objects in Logical Routing Collaboration Agreements, and Direct Connections

(The fields marked with an * are maskable key fields.)

Key Field	Receiver Determination	Interface Determination	Receiver Agreement	Sender Agreement
Sender Party	*	*	*
Sender Component	*	*	*
Receiver Party	*	*		*
Receiver Component	*	*		*
Interface			*	*

Note

Interface means the name and namespace of the interface in each case. Note that this refers to the interface at the sender , except in the receiver agreement. In the receiver agreement, it refers to the receiver interface.

Caution

Note the special restrictions for the key fields of sender agreements that are assigned a sender JMS, sender JDBC, or sender File/FTP adapter.

More information: Defining Sender Agreements