Automation Engine Script Guide > AE JCL for Applications > SAP > XI_SET_CHANNEL

XI_SET_CHANNEL

Starts and stops communication channels

Syntax

XI_SET_CHANNEL

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

Syntax

Description/Format

ACTION=

Action on the communication channel

Allowed values: "START" and "STOP"

CHANNEL=

Name of the communication channel
Format of the value: scriptA particular Automation Engine object type. 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.

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 jobAn Automation Engine object type for a process that runs on a target system. continues.
"ABEND" =  The AE job ends abnormally.

ERROR=

Handling if the defined actionActions are predefined building blocks for recurring activities. They are commonly used for managing third party systems or in deployment scenarios. could not be processed in any of the communication channels.

Allowed values: "IGNORE" and "ABEND" (default value)
"IGNORE" =  The AE job continues.
"ABEND" =  The AE job ends abnormally.

Comments

This functionPre-defined run book template in the Automation Engine. One single step only, e.g. Start Windows Service, Copy file,… starts or stops one or several communication channels. It is possible to specify either a particular communication channel or filters for several ones using the parameters CHANNEL=, SERVICE= and PARTY=.

The parameter ERROR= can be used to cancel a job if it cannot be started or stopped because of the selected communication channels. Due to the interface behavior, the agentA program that enables the de-centralized execution of processes (such as deployments) on target systems (computers or business solutions) or a service that provides connectivity to a target system (such as for databases or middleware). An agent is also an object type in the Automation Engine. [Formerly called "Executor."] See also: host still applies ACTION= for all other communication channels.

Information about communication channels which could not be controlled is stored in the job reportA report provides more detailed information about a task's execution or a component. as an XML document. It can be read using the script elements for XML.

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

This example starts a communication channel which 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:

XI_GET_CHANNEL

 


Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support

Copyright © 2016 Automic Software GmbH