XI_GET_CHANNEL

Use the XI_GET_CHANNEL script element to list communication channels that meet specified filter criteria in the job report. By default, the selection of communication channels is not restricted by filter parameters.

Syntax

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

Parameters

Parameter Description Format Allowed Values Default Value
CHANNEL=

(Optional)

 Name of the communication channel. You can use the * wildcard character in the channel name. Script literal n.a. *
SERVICE=

(Optional)

 Name of the service. You can use the * wildcard character in the service name. Script literal n.a. *
PARTY=

(Optional)

 Name of the partner. You can use the * wildcard character in the partner name. Script literal n.a. *
STATE=

(Optional)

 Status of the communication channel Script literal

  • *

  • ERROR

  • OK

  • INACTIVE

  • UNKNOWN

  • UNREGISTERED

 *
ACTSTATE=

(Optional)

 Activation status of the communication channel Script literal

  • *

  • STARTED

  • STOPPED

 *
NOFOUND=

(Optional)

 Defines the handling if no communication channel that meets the specified filter criteria could be found. If the filter criteria do not apply to any communication channel, you can use this parameter to cancel the job. Script literal

  • NORMAL — The AE job continues.

  • ABEND — The AE job ends abnormally.

 NORMAL

Examples

The following example lists all inactive communication channels:

XI_GET_CHANNEL STATE='INACTIVE'

All started communication channels whose names start with File are listed in the report:

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

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. The following is an example of the XML output written 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>

See also: