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 parameters CHANNEL=, SERVICE= and PARTY=.

Syntax

XI_SET_CHANNEL

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

Parameters

  • XI_SET_CHANNEL
    Starts and stops communication channels

  • ACTION=
    Defines the action that should be taken on the communication channel
    Allowed values:

    • START
    • STOP

  • CHANNEL=
    (Optional) Defines the name of the communication channel. You can use the * wildcard character in the channel name.
    Format: script literal
    Default: *

  • SERVICE=
    (Optional) Name of the service. You can use the * wildcard character in the service name.
    Format: script literal
    Default: *

  • PARTY=
    (Optional) Name of the partner. You can use the * wildcard character in the partner name.
    Formal: script literal
    Default: *

  • NOFOUND=
    (Optional) Defines the handling if no communication channel could be found that meets the specified filter criteria.
    Format: script literal
    Allowed values:

    • NORMAL (default)
      The AE job continues
    • ABEND
      The AE job ends abnormally

  • ERROR=
    (Optional) Defines the handling if the defined action could not be processed in any of the communication channels.
    Allowed values:

    • ABEND (default)
      The AE job ends abnormally
    • IGNORE
      The AE job continues

    If a job cannot be started or stopped because of the selected communication channels, you can use the ERROR= parameter to cancel this job. It is due to the interface behavior that the agent still applies ACTION= for all other communication channels. 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.

    Example of XML output 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>

Example

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='*'

See also: