BW_ACTIVATE_CHAIN

Use the BW_ACTIVATE_CHAIN script element to start a process chain, monitor processing, and store the logs in the activation report. The script element lets you determine the start conditions. If the process chain does not start immediately, but only following an event 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. The script element also lets you store individual process logs or process background job logs, and trigger repeated attempts for the process chain to continue in case of interruption.

Transaction: RSA1
SAP BW Version: 3.0B and later with Patch SAPKW30B11

Syntax

BW_ACTIVATE_CHAIN

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: script literal

Allowed values:

  • NORMAL (default)
    Script continues, AE job ends normally
  • ABEND
    Script aborts, AE job ends abnormally

ERROR=

Handling if a process chain ends abnormally
Format: script literal

Allowed values:

  • ABEND (default)
    Script aborts, the AE job ends abnormally
  • IGNORE
    Script continues, the AE job ends normally
  • SUSPEND
    Job remains active until a restart of the process chain or its child processes has been successful, or the job has been canceled manually

Tip: 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 parent (such as a workflow).

PROCESSLOGS=

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

Allowed values:

  • YES (default)
    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 (default)
    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
    The log message's long text is output
  • NO
    The log message's long text is not output
  • ERROR (default)
    The log message long text is only output if an error occurs

REPLICATE=

Handling of the children of a process chain

Format of the value: script literal

Allowed values:

  • ALL
    Replicates all child processes of a job in the AE system (including skipped ones)
    The child processes are shown in the Process Monitoring perspective. Statistical records and reports are also generated in the AE system.
  • YES
    Replicates the children of a job in the AE system
    The children are displayed in the Process Monitoring perspective. Statistical records and reports are also generated in the AE system.
  • NO (default)
    No replication in the AE system
STATUSRETRY=

Number or repeated status checks
Format of the value: number

Default value: 0

Note: Due to a special SAP behavior, process chains can show the status "ended" for a short time but continue afterward. The agent 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 Engine will be informed that the process has ended.

SCHEDULE=

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

Allowed values:

  • YES (default)
    The process chain is newly scheduled
  • NO
    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
    Synchronous execution
    Therefore, the process chain is processed in dialog mode instead of background mode and the individual child processes are completed serially.
  • NO (default)
    No synchronous execution
GET_SPOOL=

Requests the spool list of the started job.
Format of the value: script literal

Allowed values:

  • YES
    Requests the spool list
    The spool list is stored as a text file in the directory that has been defined in the INI file of the SAP Agent, 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 registered as job output in the AE job.
    For more information, see Agent SAP and Registered Job Output.
  • NO (default)
    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 task 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 (default)
    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: The reports of the child processes are not available if you specify NO in the REPLICATE and COLLECTLOGS parameters .

Status Check

The Automation Engine presumes that the technical status that is submitted when the function status check is called is a "final status". The Interface Repository gives the following description:

The parameter TECHSTATUS is the request's technical status. It always contains one of the following values:

Obviously, these states are not "final states". A status can change to "red" for a short time and then to "yellow" or "green" after a while. AE accounts for this fact. For status checks, a time delay can be activated so that it can be checked n times if the status "red" actually remains in this status, for example. The INI file of the SAP Agent contains the parameters maxruntime= and repeat_check= [SAP_BW]) for this.

Another function is available which checks the states of process chains. It supplies the following values:

AE then converts these states into return codes:

Return code

Status

SAP status

0

ENDED_OK

G or F

4

ENDED_NOT_OK

R

8

ENDED_NOT_OK

X

12

ENDED_NOT_OK

S

Examples

This example activates a process chain which has previously been queried by a user. 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#'