HCL Workload Automation, Version 9.4

BEGIN and END directives

Purpose

These directives, used in pairs, denote the following, depending on the value of the ACTION keyword:

The start and end of the variable substitution action performed by the agent
The start and end of the lines to be included in the tailored job
The start and end of the lines to be excluded from the tailored job

Syntax


>>-//*%OPC BEGIN------------------------------------------------>

   .-.,-----------------------------------------------.   
   V                                                  |   
>----+-ACTION=--+-EXCLUDE-+-------------------------+-+--------><
     |          +-INCLUDE-+                         |     
     |          '-NOSCAN--'                         |     
     |           .-.,--------------------------.    |     
     |           V                             |    |     
     '-COMP=--(----(--comparison expression--)-+--)-'


>>-//*%OPC END--ACTION=--+-EXCLUDE-+---------------------------><
                         +-INCLUDE-+   
                         '-NOSCAN--'

Parameters

ACTION=(EXCLUDE|INCLUDE|NOSCAN)

Specifies which BEGIN/END action is required.

EXCLUDE: This specifies that the lines following this BEGIN directive up to the next END ACTION=EXCLUDE directive should be excluded from the job that is submitted for this operation.
INCLUDE: This specifies that the lines following this BEGIN directive up to the next END ACTION=INCLUDE directive should be included as part of the job that is submitted for this operation.
NOSCAN: This specifies that any variables following this BEGIN directive up to the next END ACTION=NOSCAN directive should not be substituted.

COMP=((comparison expression), (comparison expression),...)

Specifies comparison expressions that are used to decide whether the BEGIN directive should be acted on. If the comparison expression is true, the BEGIN directive is honored. For details on defining comparison expressions, see The COMP keyword on BEGIN and FETCH directives.

Usage Notes

In a job, every BEGIN directive must have a matching END directive specifying the same ACTION. For example, the directive:

//*%OPC BEGIN ACTION=EXCLUDE

requires the following matching END directive:

//*%OPC END ACTION=EXCLUDE

If the agent detects an unpaired BEGIN or END, the processing ends in error. Even a BEGIN statement that is not honored because its comparison expression is not true requires a matching END statement.

Only the following directives can lie within the domain of a BEGIN ACTION=NOSCAN directive and an END ACTION=NOSCAN directive:

SETFORM
SETVAR

When these directives are in the range of a NOSCAN directive, they are always acted upon even if there is a comparison condition that is false.

BEGIN and END directives that specify ACTION=INCLUDE or ACTION=EXCLUDE cannot be nested and cannot overlap. They can, however, completely contain a nested NOSCAN domain.

Consider the following examples:

Example 1

//*%OPC SCAN
//*%OPC BEGIN ACTION=INCLUDE                       1 
//DDNAME1 DD DSN=&HIONE..&DATASET1,DISP=SHR        2 
//DDNAME2 DD DSN=&HIONE..&DATASET2,DISP=SHR        3 
//*%OPC END ACTION=INCLUDE                         4

Example 1 is valid. Lines 2 and 3 will be included in the job for the operation.

Example 2

//*%OPC SCAN                                        1 
//*%OPC BEGIN ACTION=EXCLUDE                        2 
//EXEC PGM=MYPROG                                   3 
//*%OPC BEGIN ACTION=INCLUDE                        4 
//DDNAME1 DD DSN=&HIONE..&DATASET1,DISP=SHR         5 
//SYSOUT  DD SYSOUT=A                               6 
//*%OPC END ACTION=EXCLUDE                          7 
//DDNAME2 DD DSN=&HIONE..&DATASET2,DISP=SHR         8 
//*%OPC END ACTION=INCLUDE                          9

Example 2 is invalid. An EXCLUDE action (lines 2 and 7 ) overlaps an INCLUDE action (lines 4 and 9 ). An error message will be issued.

Example 3

//*%OPC SCAN                                        1 
//*%OPC BEGIN ACTION=INCLUDE                        2 
//EXEC PGM=MYPROG                                   3 
//*%OPC BEGIN ACTION=NOSCAN                         4 
//DDNAME1 DD DSN=&HIONE..&DATASET1,DISP=SHR         5 
//SYSOUT  DD SYSOUT=A                               6 
//*%OPC END ACTION=NOSCAN                           7 
//DDNAME2 DD DSN=&HIONE..&DATASET2,DISP=SHR         8 
//*%OPC END ACTION=INCLUDE                          9

Example 3 is valid. The NOSCAN domain defined by lines 4 and 7 is completely contained within the BEGIN and END ACTION=INCLUDE (lines 2 and 9 ).

Note also that the variable HIONE on line 8 will be substituted, but the variable HIONE on line 5 will not be substituted because it is within a NOSCAN domain.