Show TOC

Background documentationCommunication Channels Locate this document in the navigation structure

 

The Web Service for a communication channel is described by the external definition CommunicationChannelService.

The external definition contains structure elements of the following table. WSDL Description

Element

Description

CommunicationChannelID

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).

CommunicationChannel

Defines the communication channel with all attributes.

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

  • CommunicationChannelID: Object Key

  • AdapterMetadata: Specifies the adapter type.

    Refers to adapter metadata in the ES Repository, based on the type DesignObjectID.

    Note Note

    The metadata for SAP adapters is available in the ES Repository in the software component version SAP BASIS 7.11 in the namespace http://sap.com/xi/XI/System under   Adapter Objects   Adapter Metadata  .

    End of the note.

  • 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.

    Example:

    • Integration Builder:

      Transport Protocol = 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.

CommunicationChannelTemplateBased

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 thecommunication channel element is that this element has the following additional parameters for referencing the communication channel template in the ES Repository.

ChannelTemplate; based on the type DesignObjectID.

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.

Example

The following example shows how to enter authentication data for a communication channel of adapter type XI using the programming interface when the authentication type Use Logon Data for SAP System is shown.

Syntax Syntax

  1. <AdapterSpecificAttribute xmlns="urn:com.sap.aii.ibdir.server.api.types">
  2.     <Name>authenticationModeBasicAnon</Name>
  3.     <Value>basicSAP</Value>
  4. </AdapterSpecificAttribute>
  5. <AdapterSpecificAttribute xmlns="urn:com.sap.aii.ibdir.server.api.types">
  6.     <Name>logonUser</Name>
  7.     <Value>testuser</Value>
  8. </AdapterSpecificAttribute>
  9. <AdapterSpecificAttribute xmlns="urn:com.sap.aii.ibdir.server.api.types">
  10.     <Name>logonPassword</Name>
  11. </AdapterSpecificAttribute>
  12. <AdapterSpecificAttribute xmlns="urn:com.sap.aii.ibdir.server.api.types">
  13.     <Name>logonLanguage</Name>
  14.     <Value>EN</Value>
  15. </AdapterSpecificAttribute>
  16. <AdapterSpecificAttribute xmlns="urn:com.sap.aii.ibdir.server.api.types">
  17.     <Name>logonClient</Name>
  18.     <Value>100</Value>
  19. </AdapterSpecificAttribute>
End of the code.

The following table compares the technical names for the attributes and attribute values that you must use for the programming interface, with the names that are displayed on the user interface (in logon language English).

Name on User Interface and when Using Programming Interface

Name on the User Interface

Technical Name on the Programming Interface

Attributes

Authentication Type

authenticationModeBasicAnon

User Name

logonUser

User Password

logonPassword

Logon Language

logonLanguage

Client

logonClient

Attribute Values

Use LogonData for SAP System

basicSAP