Creating Adapter Metadata
Use
You can define the
configuration information that is required for your adapter type in the
adapter metadata. You use adapter metadata to define the part of a
communication
channel that is specific to the adapter type.
The metadata is used to generate the user interface and save the configuration data in the database. The adapter metadata is an XML document.
Interface Overview
Characteristic |
Value |
Name |
XI adapter metadata |
Purpose |
Defines the configuration parameters of the adapter. Adapter metadata is used to generate the user interface and to publish the configuration data. |
Type |
XML document |
Technical Name |
n/a |
Certification |
Mandatory |
Syntax |
See under path: (.\appendix) |
Prerequisites
The adapter must support at least either the sender/inbound or the receiver/outbound direction. It should support both directions.
Features
● In the adapter metadata schema, a differentiation is made between the sender/inbound direction and the receiver/outbound direction.
A sender adapter sends from the connected system to the Integration Server or the PCK; a receiver adapter receives from the Integration Server or the PCK for the connected system. The view is always that as seen from the connected system.
● The adapter configuration differentiates between the transport layer and the message layer. The external protocol provided by the adapter determines what is configured in the transport layer and what is configured in the message layer. In some adapters this differentiation is not relevant.
You define the transport and message protocol depending on the sender/inbound and the receiver/outbound direction. The adapter definition permits several transport and message protocols to be supported. The user interface displays the selection options for the protocols as selection lists. When the user selects one of the protocols, the interface displays the corresponding attributes.
In the definition for the JMS adapter, you can choose between various providers such as JNDI, SonicMQ, and so on for the transport protocol. Depending on your selection, you must then make the provider-specific entries in the adapter configuration.
● The adapter metadata schema consists of a main part (Main Part of the Adapter Metadata) and schemas for the following groups and attributes:
○ TransportProtocol and MessageProtocol
○ ChannelAttribute, SecurityAttribute, and GlobalChannelAttribute
● If you need to set a large number of parameters for your adapter type, you can split the configuration interface into tab pages.
More information: Defining Tab Pages for Adapter Configuration