XI_SET_CHANNEL

Use the XI_SET_CHANNEL script element to start and stop one or several communication channels. You can define a particular communication channel or filter for several ones by using the CHANNEL=, SERVICE=, and PARTY= parameters.

Syntax

XI_SET_CHANNEL ACTION=...[,CHANNEL=...][,SERVICE=...][,PARTY=...][,NOFOUND=...][,ERROR=...]

Parameters

Parameter Description Format Allowed Values Default Value
ACTION= Defines the action to take on the communication channel Script literal

  • START

  • STOP

 n.a.
CHANNEL=

(Optional)

 Defines the 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. *
NOFOUND=

(Optional)

 Defines the handling if no communication channel that meets the specified filter criteria could be found. Script literal

  • NORMAL — The AE job continues.

  • ABEND — The AE job ends abnormally.

 NORMAL
ERROR=

(Optional)

 Defines the handling if the defined action could not be processed in any of the communication channels. You can use the ERROR= parameter to cancel the job; because of the interface behavior, the agent still applies ACTION= to all other communication channels. Script literal

  • ABEND — The AE job ends abnormally.

  • IGNORE — The AE job continues.

 ABEND

Examples

The following example starts a communication channel that is filtered by name and service:

XI_SET_CHANNEL ACTION='START', CHANNEL='File_Sender_List', SERVICE='SenderList', PARTY='*'

A communication channel is stopped:

XI_SET_CHANNEL ACTION='STOP', CHANNEL='SenderChannel', SERVICE='SenderList', PARTY='*'

Information about communication channels that could not be started or stopped 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>SenderList</Service>
<ChannelName>SenderChannel</ChannelName>
<ChannelID>f2d7791276e8388b995afd2d7a22e1b0</ChannelID>
<ActivationState>STARTED</ActivationState>
<ChannelState>OK</ChannelState>
<ErrorInformation>
com.sap.aii.af.service.administration.impl.WrongAutomationModeException:
The channel "/SenderList/SenderChannel (GUID f2d7791276e8388b995afd2d7a22e1b0)"
is configured to use an automation mode that is not compatible with the type of the
current principal (WSUSER). The channel was not started. Change the channel's
automation mode and repeat the administrative action.
</ErrorInformation>
</Channel>
</Channels>
</Report>

See also: