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

BW_ACTIVATE_CHAIN

Starts a process chain, monitors processing and stores the logs in the activation reportA report provides more detailed information about a task's execution or a component..

Transaction: RSA1

SAP BW Version: 3.0B and later with Patch SAPKW30B11

Syntax

BW_ACTIVATE_CHAIN

ID=...
[,NOFOUND=...]
[,ERROR=...]
[,PROCESSLOGS=...]
[,RESTART=...]
[,JOBLOGS=...]
[,LONGTEXT=...]
[,REPLICATE=...]
[,STATUSRETRY=...]
[,SCHEDULE=...]
[,SYNCHRONOUS=...]
[,GET_SPOOL=...]
[,COLLECTLOGS=...]

Syntax

Description / Format

ID=

Technical designation of the process chain.
Value format: script literal

NOFOUND=

Handling if a process chain cannot be found.
Value format: scriptA particular Automation Engine object type. literal

Allowed values: NORMAL or ABEND
Default: NORMAL

NORMAL = Script continues, AE jobAn Automation Engine object type for a process that runs on a target system. ends normally.
ABEND = Script aborts, AE job ends abnormally.

ERROR=

Handling if a process chain ends abnormally
Format: script literal

Allowed values: ABEND, IGNORE or SUSPEND
Default: ABEND

ABEND = The script aborts, the AE job ends abnormally.
IGNORE = The script continues, the AE job ends normally.
SUSPEND = The job remains active until a restartA restart refers to the repetition of an object's execution. This action differs from a new start in some parts. of the process chain / its childA subordinate task (such as a task that runs in a workflow). processes has been successful or the job has been canceled manually.
You can use this parameter in order to restart process chains or their child processes. The advantage is that the job does not end which would include that processing continues in a parentThere are different ways of activating objects. The originator of an activation is referred to as the superordinate task (parent). See also: Child; Children (such as a workflowAn object of the Automation Engine that can include several executable objects and which runs them in a specified order. [Formerly called "ProcessFlow" and "JobPlan."]).

PROCESSLOGS=

Output of a process chain's individual process logs.
Format: script literal

Allowed values: YES, NO or ERROR
Default: YES

YES = Individual process logs are added to the process chain log
NO = Only the process chain log is output
ERROR = Individual process logs are output only in case of error.

RESTART=

Number of attempts for continuation of an interrupted process chain
Format: Integer
Default value: 0

JOBLOGS=

Output of the process background job log
Format: script literal

Allowed values: YES, NO or ERROR
Default: YES

YES = Process background job logs are output
NO = Process background job logs are not output
ERROR = Process background job logs are only output if an error occurs.

LONGTEXT=

Output of a log message's long text (diagnostics text).
Format: script literal

Allowed values: YES, NO or ERROR
Default: ERROR

ERROR = The log message long text is only output if an error occurs.
YES = The log message's long text is output.
NO = The log message's long text is not output.

REPLICATE=

Handling of the children of a process chain

Format of the value: script literal

Allowed values: ALL, YES or NO (Default value)

ALL = Replicates all a job's child processes in the AE system (including skipped ones). They are shown in the UserInterfaceThis is the Automation Engine's graphical user interface. [Formerly called the "Rich Client", "RichGUI" and "Dialog Client."]'s Activity Window. Statistical records and reports are also generated in the AE system.
YES = The children of a job are replicated in the AE system. They are displayed in the Activity Window of the UserInterface. Statistical records and reports are also generated in the AE system.
NO = There is no replication in the AE system.

STATUSRETRY=

Number or repeated statusThis represents the condition of a task (such as active, blocked, generating). checks
Format of the value: number

Default value: 0

Due to a special SAP behavior, process chains can show the status "ended" for a short time but continue afterwards. 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 reports this process chain as ended if it has retrieved its status exactly at this point in time. Use the parameter STATUSRETRY= to prevent that the end of a process chain is reported too early. You can determine the number of repeated status checks with this parameter. Only after n repetitions, the Automation EngineThis component drives an Automation Engine system and consists of different types of server processes. will be informed that the process has ended.

SCHEDULE=

New scheduling of process chains
Format of the value: script literal

Allowed values: YES (default) or NO

YES = The process chain is newly scheduled.
NO = There is no new scheduling. Doing so accelerates the process chain's start.

SYNCHRONOUS=

Executes process chains synchronously.
Format of the value: script literal

Allowed values: YES or NO (default)

YES = Synchronous execution. Therefore, the process chain is processed in dialog mode instead of background mode and the individual child processes are completed serially.
NO = No synchronous execution is used.

GET_SPOOL=

Requests the spool listShows entities in a grid view of the started job.
Format of the value: script literal

Allowed values: YES or NO (default)

YES = The spool list is requested. It is stored as a text file in the directory that has been defined in the SAP agent's INI file with the parameter Download_dir= (Sektion [GLOBAL]). The name of this file is structured as follows:
<SAP job count>_<step number>_<spool number>.txt
This file is also registeredThis is the status of a task that runs within a group and is waiting for its start. as job output in the AE job.

NO = The spool list is not requested.

COLLECTLOGS=

Writes the reports of the activated process chain's child processes to the job report.

The reports of replicated child processes are by default available in the job report AND the taskAn executable object that is running. Tasks are also referred to as activities. of the child process. Therefore, this information is redundant in the job and you can decide not to assume this information here.

Allowed values: YES (default) or NO 

YES - Logs of child processes are written to the job report.
NO - Logs of the process chain's child processes are not assumed to the job report.

Note that the reports of the child processes are not available if you specify NO in the parameters REPLICATE and COLLECTLOGS.

Description

This script element starts a process chain. First, determine the start conditions. If the process chain does not start immediately but only following an eventAction that is triggered if particular conditions apply. It can be an Automation Engine object type or an entry in a Policy Orchestrator EventBase. or at a certain time, these start conditions are logged.

When the process chain starts, it is monitored until it ends. The process chain log is always stored in the activation report. Individual process logs or process background job logs are also output depending on the parameters PROCESSLOGS= and JOBLOGS=.

The parameter RESTART= can be used to trigger repeated attempts for the process chain to continue if it has been interrupted.

Examples

This example activates a process chain which has previously been queried by a userIn the Automation Engine, a user is an instance of a User object, and generally the user is a specific person who works with Automic products. The User object is assigned a user ID and then a set of access rights to various parts of the Automation Engine system and product suite. These access rights come in the form of Automation Engine authorizations and privileges, Decision user roles and EventBase rights and ARA web application object rights. You can manage all these centrally in the ECC user management functions. See also, Unified user management.. The values for the relevant script element's parameters also result from this query. These values are assigned to the script element as script variables.

:BEGINREAD
:  
 READ &CHAIN#,"ZTEST,ZSBB1,ZSBB2",'Process chain','ZTEST',M
:   
READ &ERROR#,"IGNORE,ABEND",'ERROR=','ABEND'
:   
READ &NOFOUND#,"NORMAL,ABEND",'NOFOUND=','NORMAL'
:   
READ &LT#,"YES,NO,ERROR",'LONGTEXT=','YES'
:
ENDREAD

BW_ACTIVATE_CHAIN ID='&CHAIN#',ERROR='&ERROR#',NOFOUND='&NOFOUND#',LONGTEXT='&LT#'

 


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

Copyright © 2016 Automic Software GmbH