Show TOC

Controlling a Communication Channel ExternallyLocate this document in the navigation structure

Use

You can control communication channels externally, for example by connecting to an external scheduler. You switch to external control in the communication channel monitor. For more information, see Managing Communication Channels .

Prerequisites

  • To query the status of communication channels, users must have the xi_af_channel_admin_display action assigned to them.

  • To start or stop communication channels, users must have the xi_af_channel_admin_modify action assigned to them.

Since none of these actions are assigned to a role in AS ABAP by default, you must explicitly assign them to a role in AS Java, which you then in turn assign to a user or a user group.

Procedure

To control communication channels externally, you use an HTTP GET or POST request to the following URL:

http(s)://host:port/AdapterFramework/ChannelAdminServlet?party=party&service=service&channel=channel&action=action

The parameters in this request are as follows:

Parameter

Description

party

Identifies the party of the channel to be administered. You can use an asterisk (*) as a placeholder to administer several channels simultaneously.

service

Identifies the communication component of the channel to be administered. You can use an asterisk (*) as a placeholder to administer several channels simultaneously.

channel

Identifies the name of the channel to be administered. You can use an asterisk (*) as a placeholder to administer several channels simultaneously.

action

Identifies the action to be executed (start, stop, or status).

You use the start and stop actions to start and stop the channels. You can use the status action to query the status of one or more channels.

The XML structure of the HTTP response is available in a document type definition (DTD) and an XML schema definition (XSD). You can call this information using HTTP at the following addresses:

  • http(s)://host:port/AdapterFramework/channelAdmin/ChannelAdmin.dtd

  • http(s)://host:port/AdapterFramework/channelAdmin/ChannelAdmin.xsd

In the event of internal runtime errors, the HTTP response code is set to 503.