Show TOC

Communication ChannelsLocate this document in the navigation structure


You find the Web service description for a communication channel in the following data types in the Communication Channel folder.

Data Types

RestrictedCommunicationChannel (CommunicationChannel)

RestrictedCommunicationChannel (CommunicationChannel)

Defines a communication channel with all attributes for write (read) access.

  • MasterLanguage, AdministrativeData, and Description; more information: Cross-Object-Type Elements

  • CommunicationChannelID: Object Key

  • AdapterMetadata: Specifies the adapter type.

    References adapter metadata in ES Repository

    The metadata for SAP adapters is available in the ES Repository in the software component version SAP BASIS 7.11 in the namespace published on SAP site under Start of the navigation path Adapter Objects Next navigation step Adapter Metadata End of the navigation path.

  • Direction: Specifies whether you are dealing with a sender or receiver channel (possible values: Sender and Receiver).

  • TransportProtocol, TransportProtocolVersion, MessageProtocol, MessageProtocolVersion

    Use this parameter to specify the transport and message protocols. Note that these attributes are adapter-type-specific.

    Enter the protocol and protocol version in the Integration Builder in a single string.


    • Integration Builder:

      Transport-Protokoll = HTTP 1.0

    • Programming interface:

      TransportProtocol = http

      TransportProtocolVersion = 1.0

  • AdapterEngineName: Name of the Adapter Engine

    If you want to use a local Adapter Engine, then you must enter this here.

    Enter the name in the following format: af<SID>.<host>. (here <SID> is the system ID).

    If you do not enter anything, then the Integration Server is specified as the Adapter Engine.

  • AdapterSpecificAttribute, AdapterSpecificTableAttribute

    Specifies the adapter-type dependent attributes of the Communication channel.

  • ModuleProcess: Specifies additional modules that were defined for this adapter.

    The following values are permitted for module type

    • Java Library

    • Local Enterprise Bean

    • Remote Enterprise Bean

    • null (no value)

    The maximum permitted length for the individual elements are:

    • ModuleName: 256

    • ParameterGroupID: 60

    • <Parameter> Name: 127

    • <Parameter> Value: Unlimited

  • SenderIdentifier (for sender communication channel): Specifies the identifier the communication channel is assigned to and whereby the communication channel is addressed. Based on the type ChannelAdditionalIdentifier. Only the identification schema and agency must be entered for the identifier.

  • ReceiverIdentifier (for receiver communication channel): has the same meaning as SenderIdentifier.


Specifies the object key for a communication channel.

The object key of a communication channel consists of a party name (PartyID), the name of the service (ComponentID), and the name of the communication channel (ChannelID).


Defines the communication channel with all attributes if the channel is to be created using a communication channel template.

The difference between this element and the communication channel element is that this element has the additional parameter ChannelTemplate for referencing the communication channel template in the ES Repository.

Further information

Note that the possible parameters for a specific communication channel depend on the adapter-type that is chosen. Furthermore, the possible attributes for the communication channel are in turn dependent on the values of other attributes (security settings, for example). In the Integration Builder, these dependencies are taken into account on the user interface. For example, the input field for a particular attribute is active or inactive, depending on what value was entered for another attribute. These dependencies are not taken into account by the programming interface. Because the communication channel is a very complex object we recommend that you first create an example object in the Integration Directory using the user interface and use this as a reference.

For more information, see: Notes on Working with Complex Configuration Objects

Also see Notes on Working with Passwords .