This topic lists and describes the Detail Action Language (DAL) elements in this product. 

$TABLEn

Description: Specify a Table

Type: Table Construct.

This is not a DAL statement. It is a special construct that extends the capabilities of any pattern matching function by allowing you to match against a table containing several patterns. Each table contains one or more subtables, or groups of patterns, and you can search either a specific subtable or the entire table.

For more information about tables and how they are used, see DAL-and-JAL-table-management.

Represents any Descriptor that supports pattern matching.

Is a number from the range 1 to 9, used to identify the specific table.

Is a 1-24 character name identifying the specific portion of the table that you wish to use. This must match a name coded on one of the SUBTABLE statements in the table.

Indicates that you want to search all subtables in the table.

Usage:

This construct can be used as the right portion of any pattern matching function. Additionally, it can be used in place of a pattern or %patid in certain Unique Descriptors.

The table search is linear, and terminates as soon as a match is found. If any pattern contained in the specified subtable (or the entire table if '*' is coded) matches the character string contained in the Descriptor named in the left portion of the pattern matching function, a TRUE value is returned.

Examples:

In this example, the Property RACF_OK is set to TRUE if the RACF userid for the job matches any of the entries in the subtable USERS, which is found in the table identified as TABLE1.

$TSSUSER | $TSSU

Description: USER Parameter From JOB Statement

Type: Character string Descriptor.

Maximum Length: 7 characters.

This Descriptor represents the USER parameter from the JOB statement.

This is a hard-coded string. It can be 1-142 alphabetic, numeric, or national (#, @, $) characters, the first of which must be alphabetic or national. It can also include the wildcard characters '?' and '*'.

The name of a pattern created with the PATTERNDEF statement.

Identifies a specific table and indicates which subtable is to be searched.

The pattern, %patid, or table entries are matched against the Descriptor. If a match occurs, a TRUE value is returned.

For more information about character string facilities, see Character string facilities tutorial. For more information about table support, see DAL and JAL table management .

Usage:

You can use this descriptor EVALUATE definition statements and DAL Logic statements.

This Descriptor can also be used:

• As an insert in message definition statements.
• In a substring function.
• In STRINGDEF and PATTERNDEF statements.

Examples:

$TSSUSER(PM800MP)
$TSSUSER($TABLE1(TSSUSERS))

For more information, see $SUBMITTER_TSSU.

Notes:

This Descriptor is applicable to TOP SECRET security environments.

Under certain circumstances this field may be internally supplied (as opposed to JCL coded). In that case you might want to look at an 8-character field. The Descriptor $TSSUSER8 is provided for that purpose.

$TYPHOLD

Description: Job Submission TYPRUN=HOLD

Type: Logic Variable.

Maximum Value: Not applicable.

This Logic Variable returns a TRUE/FALSE value depending on how the job was submitted.

Jobs submitted with TYPRUN=HOLD will only be processed (before they are released from JES2 HOLD) if the keyword TYPHOLD was coded in the TMPARM JES2 initialization statement.

When TRUE, it indicates that the job has not been submitted with TYPRUN=HOLD.

When TRUE, it indicates that the job has been submitted with TYPRUN=HOLD.

Usage:

This Variable can be used in EVALUATE definition statements and DAL Logic statements, and also as an insert in message definition statements.

Examples:

IF ($TYPHOLD(YES))
   WTU...

Notes:

The default for jobs submitted TYPRUN=HOLD is to be held at the end of the Job Analysis phase. You can override this via the action statement SET.

BMC ThruPut Manager will not process a job submitted with TYPRUN=HOLD (before job being released from JES2 HOLD) unless the keyword TYPHOLD has been coded in the TMPARM JES2 initialization statement.

$TYPSCAN

Description: Job Submission TYPRUN=SCAN

Type: Logic Variable.

Maximum Value: Not applicable.

This Logic Variable returns a TRUE/FALSE value depending on how the job was submitted.

Note that BMC ThruPut Manager will process jobs submitted with TYPRUN=SCAN only if TYPSCAN has been coded in TMPARM JES2 initialization statement.

When TRUE, it indicates that the job has not been submitted with TYPRUN=SCAN.

When TRUE, it indicates that the job has been submitted with TYPRUN=SCAN.

Usage:

This Variable can be used in EVALUATE definition statements and DAL Logic statements, and also as an insert in message definition statements.

Examples:

IF ($TYPSCAN(YES))
   WTU...

Notes:

Jobs that are submitted with TYPRUN=SCAN are not allowed to continue to execution regardless of what you code in DAL. This variable is provided in case you may want to alter DAL processing.

BMC ThruPut Manager will not process jobs submitted as TYPRUN=SCAN unless the TYPSCAN keyword was included in the TMPARM JES2 initialization statement.

$UNIT_AFF

Description: Unit Affinity In Effect

Type: Logic Variable.

Maximum Value: Not applicable.

This Logic Variable allows you to determine whether unit affinity is in effect for this DD statement.

Returns a value of TRUE when unit affinity is not in effect for this DD statement.

Returns a value of TRUE when unit affinity is in effect for this DD statement.

Usage:

This Variable can be used in EVALUATE definition statements and DAL Logic statements, and also as an insert in message definition statements.

for more information, see $JCL_CODED.

Notes:

Unit affinity could have been requested for the DD statement but not granted due to inconsistent device types. To test whether UNIT=AFF was requested, use $JCL_CODED.

$UNIT_COUNT

Description: Count of Units Allocated

Type: Range Definition Descriptor.

Maximum Value: 59

This descriptor returns the number of units allocated to the current DD statement. These units might already have been counted for a previous DD statement.

The starting point of a segment. The first starting point must be 0, but can be omitted if desired.

The Property Name assigned to a segment of the range. Each Property Name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a Property Name for ranges you wish to ignore.

Usage:

You can use this descriptor the Definition Section of DAL, and also as an insert in message definition statements.

Notes:

If no count is coded for the UNIT keyword on the DD statement, this Descriptor returns a value of 1 (the JCL default).

If UNIT=AFF is coded on the DD statement, this Descriptor returns the value coded for the referenced DD statement.

$UNITNAME

Description: UNIT Name from DD Statement

Type: Character string Descriptor.

Maximum Length: 8 characters.

This Descriptor represents the unit name originally coded on the DD statement that is being analyzed. If no UNIT name is coded, this Descriptor returns the generic unit name unless the data set is not cataloged. In that case, the Descriptor returns blanks.

This is a hard-coded string. It can be 1-8 alphabetic, numeric, or national (#, @, $) characters, the first of which must be alphabetic or national. It can also include the wildcard characters '?' and '*'.

The name of a pattern created with the PATTERNDEF statement.

Identifies a specific table and indicates which subtable is to be searched.

The pattern, %patid, or table entries are matched against the Descriptor. If a match occurs, a TRUE value is returned.

For more information about character string facilities, see Character string facilities tutorial. For more information about table support, see DAL and JAL table management.

Usage:

You can use this descriptor EVALUATE definition statements and DAL Logic statements.

This Descriptor can also be used:

• As an insert in message definition statements.
• In a substring function.
• In STRINGDEF and PATTERNDEF statements.

Examples:

For more information, see $JCL_CODED and $JCL_UNITNAME_MATCH.

Notes:

This Descriptor should be used together with $JCL_CODED to determine whether the unit name was coded on the DD statement.

If the data set described by the DD statement is not found, this Descriptor returns blanks.

$USERCnn

Description: Character User Descriptor

Type: Character string User Descriptor.

Maximum Length: 50 characters.

One of 99 character User Descriptors provided for use by installation exits. These Descriptors are initialized to 50 blanks each time BMC ThruPut Manager starts analyzing a job. Your exits can then assign values.

Identifies a character User Descriptor.

Is one or two digits from the range 1 to 99.

This is a hard-coded string. It can be 1-50 alphabetic, numeric, or national (#, @, $) characters. It can also include the wildcard characters '?' and '*'. If pattern contains a blank, or any characters other than those previously listed, it must be enclosed in apostrophes.

The name of a pattern created with the PATTERNDEF statement.

Identifies a specific table and indicates which subtable is to be searched.

The pattern, %patid, or table entries are matched against the Descriptor. If a match occurs, a TRUE value is returned.

For more information about character string facilities, see Character string facilities tutorial. For more information about table support, see DAL and JAL table management.

Usage:

You can use this descriptor EVALUATE definition statements and DAL Logic statements.

This Descriptor can also be used:

• As an insert in message definition statements.
• In a substring function.
• In STRINGDEF and PATTERNDEF statements.

Examples:

$USERC1(SAMP*)
$USERC5($TABLE3(*))

For more information, see $USERNnn.

$USERLn_DCS

Description: User Logic Variable

Type: User Logic Variable.

Maximum Value: Not applicable.

Nine User Logic Variables are provided to communicate the results of DCS DAL processing to JAL or subsequent iterations of DCS DAL. These Logic Variables are initialized to FALSE.

Identifies a User Logic Variable.

Is a digit from the range 1-9.

Indicates the User Logic Variable is being tested for a FALSE value.

Indicates the User Logic Variable is being tested for a TRUE value.

Usage:

This Variable can be used in the DCS DAL action statement SET $USERLn_DCS, in EVALUATE definition statements in JAL and DCS DAL, and also as an insert in message definition statements in JAL and DCS DAL.

For more information, see SET $USERLn_type.

$USERLn_SOS

Description: User Logic Variable

Type: User Logic Variable.

Maximum Value: Not applicable.

Nine User Logic Variables are provided to communicate the results of SOS DAL processing to JAL or subsequent iterations of SOS DAL. These Logic Variables are initialized to FALSE.

Identifies a User Logic Variable.

Is a digit from the range 1-9.

Indicates the User Logic Variable is being tested for a FALSE value.

Indicates the User Logic Variable is being tested for a TRUE value.

Usage:

This Variable can be used in the SOS DAL action statement SET $USERLn_SOS, in EVALUATE definition statements in JAL and SOS DAL, and also as an insert in message definition statements in JAL and SOS DAL.

For more information, see SET $USERLn_type.

$USERLn_TM

Description: User Logic Variable

Type: User Logic Variable.

Maximum Value: Not applicable.

Nine User Logic Variables are provided in TM DAL to communicate the results of TM DAL processing to JAL or subsequent iterations of DAL. These Logic Variables are initialized to FALSE.

Identifies a TM DAL User Logic Variable.

Is a digit from the range 1-9.

Indicates the User Logic Variable is being tested for a FALSE value.

Indicates the User Logic Variable is being tested for a TRUE value.

Usage:

This Variable can be used in the TM DAL action statement SET $USERLn_TM, in EVALUATE definition statements in JAL and TM DAL, and also as an insert in message definition statements in JAL and TM DAL.

For more information, see SET $USERLn_type.

$USERNnn

Description: Numeric User Descriptor

Type: Range Definition User Descriptor.

Maximum Value: 99,999,999.

One of 99 numeric User Descriptors provided for use by your installation exits. These Descriptors are initialized to zero each time BMC ThruPut Manager starts analyzing a job. Your exits can then assign values.

Identifies a numeric User Descriptor.

Is one or two digits from the range 1 to 99.

The starting point of a segment. The first starting point must be 0, but can be omitted if desired.

Starting points can be any value up to 99,999,999.

The Property Name assigned to a segment of the range. Each Property Name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a Property Name for ranges you wish to ignore.

Usage:

You can use this descriptor the Definition Section of DAL, and also as an insert in message definition statements.

Examples:

For more information, see $USERCnn.

$VERIFY

Description: Table Verification

Type: Unique Descriptor.

Maximum Value: Not applicable.

This Descriptor allows you to verify whether or not a particular table/subtable has been loaded. When using tables, a return of FALSE can indicate either:

• The table/subtable does not exist, or
• The table exists, but all subtables have been disabled.

Specifies the Property Name to be assigned a value of TRUE or FALSE. This name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. The first character must be alphabetic or national. Note that the first character of each name cannot be a dollar sign ($) or underscore (_).

The name of the table whose status you want to verify. n can be a value from the range 1 to 9. This keyword is mutually exclusive with SACTABLE.

If you specify more than one table in a single $VERIFY statement, the result is TRUE only if all conditions are satisfied. In other words, it is treated as an "AND" verification request.

The subtable names whose status you want to verify. This is an "and" list. That is, all subtables must be present to result in a TRUE value.

This parameter is mutually exclusive with '*'. You must code one of them.

This parameter allows you to verify that the table has been loaded and at least one of its subtables is active.

This parameter is mutually exclusive with subtable-name. You must code one of them.

Requests verification that the SAC table has been properly loaded. This keyword is mutually exclusive with TABLEn.

Usage:

This Descriptor can be used only in the Definition Section of DAL.

Examples:

$VERIFY  PROD_TABLE_OK   TABLE1(PRODUCTION_TABLE)
$VERIFY  DEV_TABLE_1_OK  TABLE1(DEVICE_TABLE_1)
$VERIFY  DEV_TABLE_2_OK  TABLE1(DEVICE_TABLE_2)

In this example, the verifications for subtables are done individually. As a result, you can take different actions depending on the condition of each subtable:

IF (PROD_TABLE_OK)
...
OTHERWISE
...

If you want to treat it as an all or nothing test you can code:

$VERIFY   ALL_TABLES_OK   TABLE1(PRODUCTION_TABLE,DEVICE_TABLE_1,DEVICE_TABLE_2)
...
...
IF (ALL_TABLES_OK)
...

If you simply want to ensure that table 1 has been loaded and contains at least one active subtable you can code:

Note that the SAC table must be verified independently:

For more information, see $TABLEn.

$VOL_AUTO

Description: Automated Volumes

Type: Range Definition Descriptor.

Maximum Value: 9999 cartridge volumes.

This Descriptor represents the number of non-scratch automated cartridge volumes required by the DD statement, including the number of volumes represented by the value in $VOL_TO_ENTER.

The starting point of a segment. The first starting point must be 0, but can be omitted if desired.

Starting points are specified in number of volumes as 1-4 decimal digits.

The Property Name assigned to a segment of the range. Each Property Name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a Property Name for ranges you wish to ignore.

Usage:

You can use this descriptor the Definition Section of DAL, and also as an insert in message definition statements.

Examples:

For more information, see $VOL_TO_ENTER.

$VOL_MANUAL

Description: Cartridge Volumes

Type: Range Definition Descriptor.

Maximum Value: 9999 cartridge volumes.

This Descriptor represents the number of non-scratch cartridge volumes required by a non-automated DD statement that must be fetched before step execution.

The starting point of a segment. The first starting point must be 0, but can be omitted if desired.

Starting points are specified in number of volumes as 1-4 decimal digits.

The Property Name assigned to a segment of the range. Each Property Name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a Property Name for ranges you wish to ignore.

Usage:

You can use this descriptor the Definition Section of DAL, and also as an insert in message definition statements.

Examples:

For more information, see $VOL_AUTO and $VOL_REEL.

$VOL_MATCH

Description: Match the Volumes Requested

Type: Unique Descriptor.

Maximum Value: Not applicable.

This Unique Descriptor allows you to match the volume serial numbers required by the DD statement against a list of volumes, either hard-coded or contained in a BMC ThruPut Manager Table.

Specifies the Property Name to be assigned a value of TRUE or FALSE. This name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. The first character must be alphabetic or national. Note that the first character of each name cannot be a dollar sign ($) or underscore (_).

Indicates that cartridge volume serial numbers are to be matched. This keyword is mutually exclusive with DASD and REEL.

Only automated cartridges are included in the list to match.

Only manual cartridges are included in the list to match.

Indicates that both automated and manual cartridges are included in the list to match.

Indicates that DASD volume serial numbers are to be matched. This keyword is mutually exclusive with CART and REEL.

Indicates that volume serial numbers for reels are to be matched. This keyword is mutually exclusive with CART and DASD.

Specifies the source of the list of volumes to be matched.

A hard coded volume list, separated by commas.

The name of a pattern created with the PATTERNDEF statement.

Identifies a specific table to be matched against.

The Property is TRUE if all the volumes in the DD statement are found in the list or table, or if the volume count is 0. This keyword is mutually exclusive with NONE and SOME.

The Property is TRUE only if none of the volumes in the DD statement are found in the list or table. This keyword is mutually exclusive with ALL and SOME.

The Property is TRUE if at least one volume in the DD statement is found in the list or table. This keyword is mutually exclusive with ALL and NONE.

This is the default.

Usage:

This Descriptor can be used only in the Definition Section of DAL.

$VOL_REEL

Description: Non-Cartridge Tape Volumes

Type: Range Definition Descriptor.

Maximum Value: 9999 non-cartridge tape volumes.

This Descriptor represents the number of non-scratch non-cartridge tape volumes required by the DD statement that must be fetched before step execution.

The starting point of a segment. The first starting point must be 0, but can be omitted if desired.

Starting points are specified in number of volumes as 1-4 decimal digits.

The Property Name assigned to a segment of the range. Each Property Name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a Property Name for ranges you wish to ignore.

Usage:

You can use this descriptor the Definition Section of DAL, and also as an insert in message definition statements.

Examples:

For more information, see $VOL_AUTO and $VOL_MANUAL.

$VOL_SCRATCH

Description: Indicates the Type of Volume Request

Type: Logic Variable.

Maximum Value: Not applicable.

This Logic Variable allows you to determine whether the request was for a scratch volume (non-specific) or a specific volume.

Returns a value of TRUE for a specific volume request, i.e. when a volume serial number was hard-coded in JCL or the data set is cataloged.

Returns a value of TRUE for a scratch request, i.e. when no volume serial number was coded for a non-cataloged data set.

Usage:

This Variable can be used in EVALUATE definition statements and DAL Logic statements, and also as an insert in message definition statements.

$VOL_TO_EJECT

Description: Automated Volumes Required Outside the Automated Library

Type: Range Definition Descriptor.

Maximum Value: 9999 cartridge volumes.

This Descriptor represents the number of non-scratch cartridge volumes required by the DD statement that are within the automated system but are required in non-automated drives.

The starting point of a segment. The first starting point must be 0, but can be omitted if desired.

Starting points are specified in number of volumes as 1-4 decimal digits.

The Property Name assigned to a segment of the range. Each Property Name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a Property Name for ranges you wish to ignore.

Usage:

You can use this descriptor the Definition Section of DAL, and also as an insert in message definition statements.

Examples:

For more information, see $VOL_AUTO, $VOL_REEL, and $VOL_TO_ENTER.

$VOL_TO_ENTER

Description: Automated Volumes Outside the Automated Library

Type: Range Definition Descriptor.

Maximum Value: 9999 cartridge volumes.

This Descriptor represents the number of non-scratch cartridge volumes required by the DD statement that are outside the automated system but are to be treated as automated. This situation occurs when an "AUTOMATED" UNIT name has been coded in the JCL and the volumes associated with that DD are not resident in any automated library system.

The starting point of a segment. The first starting point must be 0, but can be omitted if desired.

Starting points are specified in number of volumes as 1-4 decimal digits.

The Property Name assigned to a segment of the range. Each Property Name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a Property Name for ranges you wish to ignore.

Usage:

You can use this descriptor the Definition Section of DAL, and also as an insert in message definition statements.

Examples:

For more information, see $VOL_AUTO, $VOL_REEL, and $VOL_TO_EJECT.

$VOLUME_COUNT

Description: Volume Count from JCL

Type: Range Definition Descriptor.

Maximum Value: 255 volumes.

This Descriptor represents the volume count that was coded as a subparameter of the VOLUME keyword of the DD statement being analyzed.

The starting point of a segment. The first starting point must be 0, but can be omitted if desired.

The Property Name assigned to a segment of the range. Each Property Name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a Property Name for ranges you wish to ignore.

Usage:

You can use this descriptor the Definition Section of DAL, and also as an insert in message definition statements.

Notes:

If no volume count was coded, this Descriptor returns the default value of 1.

VTAPE SET

Description: Specify a VTAPE data set

Type: Action Statement.

In a CA-Vtape environment, this statement allows you to control whether a data set should be treated as a virtual tape data set:

• The data set must be new.
• The data set must reside on a cartridge.
• The DD statement must not specify UNIT=AFF.

Indicates whether or not the data set being allocated by the current DD statement should be treated as a CA-Vtape virtual data set.

Self-explanatory.

Notes:

If the data set is already virtual, VIRTUAL(NO) is ignored.

$WLM_MODE

Description: Detect Workload Manager Mode

Type: Logic Variable.

Maximum Value: Not applicable.

This Logic Variable lets you determine if the system that is analyzing the job is in WLM GOAL or COMPATIBILITY mode.

Returns a value of TRUE if the analyzing system is running in COMPATIBILITY mode, otherwise it returns a value of FALSE.

Returns a value of TRUE if the analyzing system is running in GOAL mode, otherwise it returns a value of FALSE.

Usage:

This Variable can be used in EVALUATE definition statements and DAL Logic statements, and also as an insert in message definition statements.

WTCA7

Description: Write a Message to a CA7 Logical Terminal

Type: Communication statement.

This DAL statement causes a message to be written to a CA7 logical terminal associated with the CA7 instance of the current job.

Specifies the symbols or list of symbols associated with CA7 messages, as established by prior MSGDEF statements.

Examples:

MSGDEF AUTO_MSG (‘STEP ‘,$STEPNAME,’ USES ‘,$VOL_AUTO,’ AUTOMATED VOLUMES.’) +
                CA7LTERM(LIBRARY)
...
WTCA7 AUTO_MSG

For more information, see $CA7, MSGDEF, SEND, WTO, and WTU.

Notes:

You can omit the parentheses () if a single message identifier is specified.

The routing of CA7 messages is controlled by the CA7LTERMkeywordofthe MSGDEFstatement.

WTO

Description: Write a Message to Operator

Type: Communication statement.

This DAL statement causes a message to be written to an operator console.

Specifies the symbols or list of symbols associated with operator messages, as established by prior MSGDEF statements.

Examples:

MSGDEF AUTO_MSG (‘STEP ‘,$STEPNAME,’ USES ‘,$VOL_AUTO,’ AUTOMATED VOLUMES.’) +
                ROUTCDE(120)
...
WTO AUTO_MSG

For more information, see MSGDEF, SEND, WTCA7, and WTU.

Notes:

You can omit the parentheses () if a single message identifier is specified.

The routing of operator messages is controlled by keywords of the MSGDEF statement.

WTU

Description: Write a Message to User

Type: Communication statement.

This DAL statement causes a message to be written to the job's SYSMSGS file or the Job LOG.

Specifies the symbols or list of symbols associated with user messages, as established by prior MSGDEF statements.

Examples:

MSGDEF BAD_ACCT_MSG ($ACCT,’ IS AN INVALID ACCOUNT.’)
...
WTU BAD_ACCT_MSG

For more information, see MSGDEF, SEND, WTCA7, and WTO.

Notes:

The default destination for WTU is the SYSMSGS file.

You can omit the parentheses () if a single message identifier is specified.

If you want the message to appear in the job's log, then you must code the LOG keyword in the MSGDEF statement.