XI_GET_CHANNEL

Lists communication channels

Syntax

XI_GET_CHANNEL

[CHANNEL=...]
[,SERVICE=...]
[,PARTY=...]
[,STATE=...]
[,ACTSTATE=...]
[,NOFOUND=...]

Syntax	Description/Format
CHANNEL=	Name of the communication channel Format of the value: script literal Default value: "" The wildcard character "" can be used in the channel name.
SERVICE=	Name of the service Format of the value: script literal Default value: "" The wildcard character "" can be used in the service name.
PARTY=	Name of the partner Format of the value: script literal Default value: "" The wildcard character "" can be used in the partner name.
STATE=	Status of the communication channel Format of the value: script literal Allowed values: "*" (default value) "ERROR" "OK" "INACTIVE" "UNKNOWN" "UNREGISTERED"
ACTSTATE=	Status of the communication channel Allowed values: "*" (default value), "STARTED" and "STOPPED"
NOFOUND=	Handling if no communication channel could be found which meets the specified filter criteria. Format of the value: script literal Allowed values: "NORMAL" (default value) or "ABEND" "NORMAL" = The AE job continues. "ABEND" = The AE job ends abnormally.

This function lists the communication channels which meet the specified filter criteria in the job report. By default, the selection of communication channels is not restricted by filter parameters.

The parameter NOFOUND= can be used to cancel a job if the filter criteria do not apply to any communication channel.

The result is stored in the job report as an XML document. For more information on reading this data, see Script Functions for XML Elements.

Example of XML output to the report:

<Report>
<Channels>
<Channel>
<Party/>
<Service>FileListReceiver</Service>
<ChannelName>FileListReceiverChannel</ChannelName>
<ChannelID>85e07c39f9b831d1817f3c4bec0af8ff</ChannelID>
<ActivationState>STARTED</ActivationState>
<ChannelState>OK</ChannelState>
</Channel>
<Channel>
<Party/>
<Service>X64_107</Service>
<ChannelName>GeneratedReceiverChannel_RFC</ChannelName>
<ChannelID>19729e747d023ff7a27d32d3f566ed79</ChannelID>
<ActivationState>STARTED</ActivationState>
<ChannelState>OK</ChannelState>
</Channel>
<Channel>
<Party/>
<Service>SenderList</Service>
<ChannelName>File_Sender_List</ChannelName>
<ChannelID>8bdda1b7041b37efa313219ae7029906</ChannelID>
<ActivationState>STARTED</ActivationState>
<ChannelState>OK</ChannelState>
</Channel>
</Channels>
</Report>

Example

This example lists all inactive communication channels:

XI_GET_CHANNEL STATE='INACTIVE'

All started communication channels whose name starts with "File" are listed in the report:

XI_GET_CHANNEL CHANNEL='File*',ACTSTATE='STARTED'