List of JAL elements (T-Z)


This topic lists and describes the Job Action Language (JAL) elements in this product.

$TABLEn

descriptor($TABLEn[(subtable-name | *)]) 

This JAL element has the following attributes: 

Attribute

Value

Description

Specify a table

This is not a JAL 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.

Type

Table construct

Valid values

  • descriptor($TABLEn[(subtable-name | *)—Represents any Descriptor that supports pattern matching.
  • n—Is a number from the range 1 to 9, used to identify the specific table.
  • subtable-name—Is a 1-24 character name identifying the specific portion of the table that you want 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

You can use this construct 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.

Example

In this example, the Job 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.

EVALUATE   RACF_OK   ($RACFU($TABLE1(USERS))

$TAPEVOLS

$TAPEVOLS [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes: 

Attribute

Value

Description

Tape volumes

This descriptor represents the total number of non-scratch tape volumes (cartridges and reels) that must be fetched before running a job. It is the sum of the values represented by $VOL_MANUAL, $VOL_REEL, and $VOL_TO_ENTER.

Type

Range definition descriptor

Maximum Value

9999 tape volumes

Valid values

  • start  Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified in number of volumes as 14 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$TAPEVOLS  NO_TAPE_VOLS,1,TAPE_VOLS,16,CANT_RUN

For more information, see $LIST_TAPEVOLS, $VOL_MANUAL, $VOL_REEL, and $VOL_TO_ENTER

$TAUNITS

$TAUNITS [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

This descriptor represents the maximum number of tape drives used by any step in the job (cartridge and non-cartridge). For each step, the sum of the values represented by $UNIT_MANUAL, $UNIT_ REEL, and $UNIT_AUTO is calculated. This descriptor represents the high water mark for that sum.

Type

Range definition descriptor

Maximum Value

9999 tape units (cartridge and non-cartridge)

Valid values

  • start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$TAUNITS   NO_TAPE_DRIVES,1,TAPE_DRIVES

For more information, see $UNIT_AUTO, $UNIT_MANUAL, and $UNIT_REEL

$TSSUSER | $TSSU

$TSSUSER(pattern | %patid | table-id)

This JAL element has the following attributes:

Attribute

Value

Description

This descriptor represents the USER parameter from the JOB statement.

Type

Character string descriptor

Maximum Length

8 characters

Valid values

  • pattern—Hard-coded string in 1–8 alphabetic, numeric, or national (#, @, $) characters. It can also include the hyphen (-) and the wildcard characters ? and *.
  • %patternID—Name of a pattern created with the PATTERNDEF statement
  • tableID—Identifies a specific table and which subtable to search

The pattern, %patternID, or tableID entry is 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 in EVALUATE definition statements and JAL Logic statements. Also, you can use the descriptor for:

  • As an insert in message definition statements
  • In a substring function
  • In STRINGDEF and PATTERNDEF statements
  • In JLS_LIMITDEF and JLS_CNTLDEF statements
Example

This descriptor is applicable to TOP SECRET security environments.

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

$TYPHOLD

$TYPHOLD(YES | NO)

This JAL element has the following attributes: 

Attribute

Value

Description

Job submission TYPRUN=HOLD

You can use this logic variable to determine if a job was submitted as TYPRUN=HOLD. This function call returns a TRUE or FALSE or both value depending on how the job was submitted. Jobs submitted with TYPRUN=HOLD are processed (before they are released from JES2 HOLD) only if the keyword TYPHOLD was coded in the TMPARM JES2 initialization statement.

Type

Logic variable

Maximum Value

Not applicable

Valid values

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

Usage

You can use this variable in EVALUATE definition statements and JAL Logic statements, and also as an insert in message definition statements.

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

Important

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.

ThruPut Manager does  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. If the TYPHOLD keyword was not coded, this descriptor is not valid.

$TYPSCAN

$TYPSCAN(YES | NO)

This JAL element has the following attributes: 

Attribute

Value

Description

Job submission TYPRUN=SCAN

You can use this logic variable to determine if a job was submitted as TYPRUN=SCAN. This function call returns a TRUE or FALSE or both value depending on how the job was submitted.

ThruPut Manager processes jobs submitted with TYPRUN=SCAN only if TYPSCAN has been coded in TMPARM JES2 initialization statement.

Type

Logic variable

Maximum Value

Not applicable

Valid values

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

Usage

You can use this variable can be used in EVALUATE definition statements and JAL Logic statements, and also as an insert in message definition statements.

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

Important

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

Jobs submitted as TYPRUN=SCAN will not be processed by ThruPut Manager unless the TYPSCAN keyword was included in the TMPARM JES2 initialization statement.

$UNIT_3480_ALL

$UNIT_3480_ALL [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes: 

Attribute

Value

Description

This descriptor represents the maximum number of 3480 drives used by any step in the job as recorded in the selected Job Profile. For each step, the sum of the values represented by $UNIT_MANUAL_3480 and $UNIT_AUTO_3480 is calculated. This descriptor represents the high water mark for that sum.

Type

Range definition descriptor

Maximum Value

9999 3480 drives.

Valid values

  • start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$UNIT_3480_ALL   NO_3480_DRIVES,1,SOME_3480_DRIVES

For more information, see $UNIT_AUTO_3480 and $UNIT_MANUAL_9840

$UNIT_3490E_ALL

$UNIT_3490E_ALL [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Maximum Number of 3490E Drives

This descriptor represents the maximum number of 3490E drives used by any step in the job as recorded in the selected Job Profile. For each step, the sum of the values represented by $UNIT_ MANUAL_3490E and $UNIT_AUTO_3490E is calculated. This descriptor represents the high water mark for that sum.

Type

Range definition descriptor

Maximum Value

9999 3490E drives

Valid values

  • start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$UNIT_3490E_ALL   NO_3490E_DRIVES,1,SOME_3490E_DRIVES

For more information, see $UNIT_AUTO_3490E and $UNIT_MANUAL_3490E

$UNIT_3590_ALL

$UNIT_3590_ALL [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Maximum Number of 3590 Drives

This descriptor represents the maximum number of 3590 drives used by any step in the job as recorded in the selected Job Profile. For each step, the sum of the values represented by $UNIT_MANUAL_3590 and $UNIT_AUTO_3590 is calculated. This descriptor represents the high water mark for that sum.

Type

Range definition descriptor

Maximum Value

9999 3590 drives

Valid values

  • start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$UNIT_3590_ALL   NO_3590_DRIVES,1,SOME_3590_DRIVES

For more information, see $UNIT_AUTO_3590 and $UNIT_MANUAL_3590

$UNIT_9840_ALL

$UNIT_9840_ALL [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Maximum Number of 9840 Drives

This descriptor represents the maximum number of 9840 drives used by any step in the job as recorded in the selected Job Profile. For each step, the sum of the values represented by $UNIT_MANUAL_9840 and $UNIT_AUTO_9840 is calculated. This descriptor represents the high water mark for that sum.

Type

Range definition descriptor

Maximum Value:

9999 9840 drives

Valid values

  • start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

$UNIT_9840_ALL   NO_9840_DRIVES,1,SOME_9840_DRIVES

For more information, see $UNIT_AUTO_9840 and $UNIT_MANUAL_9840

$UNIT_9940_ALL

$UNIT_9940_ALL [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Maximum Number of 9940 Drives

This descriptor represents the maximum number of 9940 drives used by any step in the job as recorded in the selected Job Profile. For each step, the sum of the values represented by $UNIT_MANUAL_9940 and $UNIT_AUTO_9940 is calculated. This descriptor represents the high water mark for that sum.

Type

Range definition descriptor

Maximum Value

9999 9940 drives.

Valid values

  • start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example

$UNIT_9940_ALL   NO_9940_DRIVES,1,SOME_9940_DRIVES

For more information, see $UNIT_AUTO_9940 and $UNIT_MANUAL_9940

$UNIT_AUTO

$UNIT_AUTO [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Maximum Number of Automated Drives

This descriptor represents the maximum number of automated drives needed by any step in the job as recorded in the selected Job Profile. This represents the high water mark of automated drives for a step.

Type

Range definition descriptor

Maximum Value

9999 automated cartridge drives

Valid values

  • start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$UNIT_AUTO   NO_AUTO_UNITS,1,AUTO_UNITS

Automated drives represent drives that are under the control of an automated tape library system.

For more information, see $UNIT_CART_ALL

$UNIT_AUTO_3480

$UNIT_AUTO_3480 [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Maximum Number of Automated 3480 Drives

This descriptor represents the maximum number of automated 3480 drives needed by any step in the job as recorded in the selected Job Profile. This represents the high water mark of automated drives for a step.

Type

Range definition descriptor

Maximum Value

9999 automated 3480 drives

Valid values

  • start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$UNIT_AUTO_3480   NO_AUTO_3480_UNITS,1,AUTO_3480_UNITS

Automated 3480 drives represent drives that are under the control of an automated tape library system.

For more information, see $UNIT_9940_ALL and $UNIT_MANUAL_9840

$UNIT_AUTO_3490E

$UNIT_AUTO_3490E [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Maximum Number of Automated 3490E Drives

This descriptor represents the maximum number of automated 3490E drives needed by any step in the job as recorded in the selected Job Profile. This represents the high water mark of automated drives for a step.

Type

Range definition descriptor

Maximum Value

9999 automated 3490E drives

Valid values

  • start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$UNIT_AUTO_3490E   NO_AUTO_3490E_UNITS,1,AUTO_3490E_UNITS

Automated 3490E drives represent drives that are under the control of an automated tape library system.

For more information, see $UNIT_3490E_ALL and $UNIT_MANUAL_3490E

$UNIT_AUTO_3590

$UNIT_AUTO_3590 [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Maximum Number of Automated 3590 Drives

This descriptor represents the maximum number of automated 3590 drives needed by any step in the job as recorded in the selected Job Profile. This represents the high water mark of automated drives for a step.

Type

Range definition descriptor

Maximum Value

9999 automated 3590 drives

Valid values

  • start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$UNIT_AUTO_3590   NO_AUTO_3590_UNITS,1,AUTO_3590_UNITS

Automated 3590 drives represent drives that are under the control of an automated tape library system.

For more information, see $UNIT_3590_ALL and $UNIT_MANUAL_3590

$UNIT_AUTO_9840

$UNIT_AUTO_9840 [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Maximum Number of Automated 9840 Drives

This descriptor represents the maximum number of automated 9840 drives needed by any step in the job as recorded in the selected Job Profile. This represents the high water mark of automated drives for a step.

Type

Range definition descriptor

Maximum Value

9999 automated 9840 drives

Valid values

  • start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$UNIT_AUTO_9840   NO_AUTO_9840_UNITS,1,AUTO_9840_UNITS

Automated 9840 drives represent drives that are under the control of an automated tape library system.

For more information, see $UNIT_9840_ALL and $UNIT_MANUAL_9840

$UNIT_AUTO_9940

$UNIT_AUTO_9940 [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Maximum Number of Automated 9940 Drives

This descriptor represents the maximum number of automated 9940 drives needed by any step in the job as recorded in the selected Job Profile. This represents the high water mark of automated drives for a step.

Type

Range definition descriptor

Maximum Value

9999 automated 9940 drives

Valid values

  • start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$UNIT_AUTO_9940   NO_AUTO_9940_UNITS,1,AUTO_9940_UNITS

Automated 9940 drives represent drives that are under the control of an automated tape library system.

For more information, see $UNIT_9940_ALL and $UNIT_MANUAL_9940

$UNIT_CART_ALL

$UNIT_CART_ALL [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Maximum Number of Cartridge Drives

This descriptor represents the maximum number of cartridge drives used by any step in the job as recorded in the selected Job Profile. For each step, the sum of the values represented by $UNIT_ MANUAL and $UNIT_AUTO is calculated. This descriptor represents the high water mark for that sum.

Type

Range definition descriptor

Maximum Value

9999 cartridge units

Valid values

  • start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$UNIT_CART_ALL    NO_CART_DRIVES,1,CART_DRIVES

For more information, see $UNIT_AUTO and $UNIT_MANUAL

$UNIT_DISK

$UNIT_DISK [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Maximum Disk Drives

This descriptor represents the maximum number of mountable disk drives (high water mark) required by any step in the job. This count excludes disk drives which are permanently resident or reserved disk volumes.

Type

Range definition descriptor

Maximum Value

9999 disk drives

Valid values

  • start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$UNIT_DISK   NO_DASD_MOUNT,1,DASD_MOUNTS,4,SPECIAL_DASD

$UNIT_MANUAL

$UNIT_MANUAL [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes: 

Attribute

Value

Description

Maximum Number of Cartridge Drives

This descriptor represents the maximum number of manual cartridge drives (i.e. non-automated) needed by any step in the job as recorded in the selected Job Profile. This represents the high water mark of manual cartridge drives for a step.

Type

Range definition descriptor

Maximum Value

9999 manual cartridge drives.

Valid values

  • start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$UNIT_MANUAL   NO_MANUAL_UNITS,1,MANUAL_UNITS

For more information, see $UNIT_AUTO and $UNIT_CART_ALL

$UNIT_MANUAL_3480

$UNIT_MANUAL_3480 [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Maximum Number of Manual 3480 Drives

This descriptor represents the maximum number of manual 3480 drives (i.e. non-automated) needed by any step in the job as recorded in the selected Job Profile. This represents the high water mark of manual 3480 drives for a step.

Type

Range definition descriptor

Maximum Value

9999 3480 drives.

Valid values

  • start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$UNIT_MANUAL_3480   NO_MANUAL_3480_UNITS,1,MANUAL_3480_UNITS

For more information, see $UNIT_AUTO_3480 and $UNIT_9940_ALL

$UNIT_MANUAL_3490E


$UNIT_MANUAL_3490E [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Maximum Number of Manual 3490E Drives

This descriptor represents the maximum number of manual 3490E drives (i.e. non-automated) needed by any step in the job as recorded in the selected Job Profile. This represents the high water mark of manual 3490E drives for a step.

Type

Range definition descriptor

Maximum Value

9999 3490E drives

Valid values

  • start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$UNIT_MANUAL_3490E   NO_MANUAL_3490E_UNITS,1,MANUAL_3490E_UNITS

For more information, see $UNIT_AUTO_3490E and $UNIT_3490E_ALL

$UNIT_MANUAL_3590

$UNIT_MANUAL_3590 [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Maximum Number of Manual 3590 Drives

This descriptor represents the maximum number of manual 3590 drives (i.e. non-automated) needed by any step in the job as recorded in the selected Job Profile. This represents the high water mark of manual 3590 drives for a step.

Type

Range definition descriptor

Maximum Value

9999 3590 drives

Valid values

  • start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$UNIT_MANUAL_3590   NO_MANUAL_3590_UNITS,1,MANUAL_3590_UNITS

For more information, see $UNIT_AUTO_3590 and $UNIT_3590_ALL.

$UNIT_MANUAL_9840

$UNIT_MANUAL_9840 [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Maximum Number of Manual 9840 Drives

This descriptor represents the maximum number of manual 9840 drives (i.e. non-automated) needed by any step in the job as recorded in the selected Job Profile. This represents the high water mark of manual 9840 drives for a step.

Type

Range definition descriptor

Maximum Value

9999 9840 drives

Valid values

  • start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$UNIT_MANUAL_9840   NO_MANUAL_9840_UNITS,1,MANUAL_9840_UNITS

For more information, see $UNIT_AUTO_9840 and $UNIT_9840_ALL.

$UNIT_MANUAL_9940

$UNIT_MANUAL_9940 [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Maximum Number of Manual 9940 Drives

This descriptor represents the maximum number of manual 9940 drives (i.e. non-automated) needed by any step in the job as recorded in the selected Job Profile. This represents the high water mark of manual 9940 drives for a step.

Type

Range definition descriptor

Maximum Value

9999 9940 drives

Valid values

  • start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$UNIT_MANUAL_9940   NO_MANUAL_9940_UNITS,1,MANUAL_9940_UNITS

For more information, see $UNIT_AUTO_9940 and $UNIT_9940_ALL

$UNIT_REEL

$UNIT_REEL [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Maximum Number of Non-Cartridge Tape Drives

This descriptor represents the maximum number of non-cartridge tape drives (reels) needed by any step in the job. This represents the high water mark for a step.

Type

Range definition descriptor

Maximum Value

9999 non-cartridge tape drives (reels)

Valid values

  • start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$UNIT_REEL  NO_TAPE_DRIVES,1,TAPE_DRIVES,16,TOO_MANY_TAPE_DRIVES

For more information, see $TAUNITS.

$UNIT_TAPE_ALL

$UNIT_TAPE_ALL [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Maximum Number of Tape Units

This descriptor represents the maximum number of tape drives used by any step in the job. For each step, the sum of the values represented by $UNIT_CART_ALL and $UNIT_VTS is calculated. This descriptor represents the high water mark for that sum.

Type

Range definition descriptor.

Maximum Value

9999 tape units.

Valid values

  • start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$UNIT_TAPE_ALL   NO_TAPE_DRIVES,1,TAPE_DRIVES

For more information, see $UNIT_CART_ALL and $UNIT_VTS.

$UNIT_VTS

$UNIT_VTS [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Maximum number of Virtual Tape Units

This descriptor represents the maximum number of Virtual Tape units used by any step in the job.

Type

Range definition descriptor

Maximum Value

9999 VTS units

Valid values

  • start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$UNIT_VTS   NO_VIRTUAL_UNITS,1,SOME_VIRTUAL_UNITS

$USERCnn

$USERCnn(pattern | %patid | table-id)

This JAL element has the following attributes:

Attribute

Value

Description

Character user descriptor

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

Type

Character string user descriptor

Maximum Length

50 characters

Valid values

  • $USERCnn(pattern | %patid | table-id)—Identifies a character user descriptor.
  • nn—Is one or two digits from the range 1 to 99.
  • pattern—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.
  • %patid—The name of a pattern created with the PATTERNDEF statement.
  • table-id—Identifies a specific table and which subtable to search.

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 in EVALUATE definition statements and JAL Logic statements, and also:

  • As an insert in message definition statements
  • In a substring function
  • In STRINGDEF and PATTERNDEF statements
  • In JLS_LIMITDEF and JLS_CNTLDEF statements
Example
$USERC1(SAMP*)
$USERC5($TABLE3(*))

When using the Job Extract Facility, requests for these tokens return meaningful data only when issued from a post-JAL Job Analyzer exit.

For more information , see $USERNnn.

$USERLn_DCS

$USERLn_DCS(FALSE | TRUE)
DCS ONLY

This JAL element has the following attributes:

Attribute

Value

Description

User logic variable

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.

Type

User logic variable

Maximum Value

Not applicable

Valid values

  • $USERLn_DCS—Identifies a user logic descriptor.
  • n—Is a digit from the range 1-9.
  • FALSE—Indicates the user logic variable is being tested for a FALSE value.
  • TRUE—Indicates the user logic variable is being tested for a TRUE value.

Usage

You can use this variable in EVALUATE definition statements and also as an insert in message definition statements.

DCS User logic variables can be set only in DCS DAL, but can be tested in JAL.

$USERLn_SOS

$USERLn_SOS(FALSE | TRUE)

This JAL element has the following attributes:

Attribute

Value

Description

User logic variable

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.

Type

User logic variable

Maximum Value

Not applicable

Valid values

  • $USERLn_SOS—Identifies a User logic variable.
  • n—Is a digit from the range 1-9.
  • FALSE—Indicates the User logic variable is being tested for a FALSE value.
  • TRUE—Indicates the User logic variable is being tested for a TRUE value.

Usage

You can use this variable in EVALUATE definition statements and also as an insert in message definition statements.

SOS User logic variables can be set only in SOS DAL, but can be tested in JAL.

$USERLn_TM

$USERLn_TM(FALSE | TRUE)

This JAL element has the following attributes:

Attribute

Value

Description

User logic variable

Nine user logic variables are provided in TM DAL to communicate the results of TM DAL processing to JAL or subsequent iterations of TM DAL. These logic variables are initialized to FALSE.

Type

User logic variable

Maximum Value

Not applicable

Valid values

  • $USERLn_TM—Identifies a TM DAL User logic variable.
  • n—Is a digit from the range 1-9.
  • FALSE—Indicates the User logic variable is being tested for a FALSE value.
  • TRUE—Indicates the User logic variable is being tested for a TRUE value.

Usage

You can use this variable in EVALUATE definition statements, and also as an insert in message definition statements,

TM DAL User logic variable can be set only in TM DAL, but can be tested in JAL.

$USERSCHED

$USERSCHED(YES/NO)

This JAL element has the following attributes:

Attribute

Value

Description

A //*USERSCHED statement was encountered.

This function call returns a TRUE or FALSE value depending on whether an installation scheduler submitted it.

Type

Logic variable.

Maximum Value

Not applicable

Valid values

  • YES—Returns a TRUE value if an installation scheduler submitted the job.
  • NO—Returns a TRUE value if an installation scheduler did not submit the job.

Usage

You can use this variable in EVALUATE definition statements and JAL Logic statements, and as an insert in message definition statements.

$USERSCHED_APPL

$USERSCHED_APPL(pattern | %patid | table-id)

This JAL element has the following attributes:

Attribute

Value

Description

The APPL= value on a //*USERSCHED statement.

Type

Character string descriptor

Maximum Length

16 characters

Valid values

  • pattern—Hard-coded string in 1–50 alphabetic, numeric, or national (#, @, $) characters. It can also include the hyphen (-) and the wildcard characters ? and *.
  • %patternID—Name of a pattern created with the PATTERNDEF statement
  • tableIDIdentifies a specific table and which subtable to search

The pattern, %patternID, or tableID entry is 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

$USERSCHED_DUE_IN_DATE

$USERSCHED_DUE_IN_DATE [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

The DATE the job must start to avoid being late.

Type

Range definition descriptor

Maximum Value

2155/366 expressed as year/day

Valid values

  • start—The starting point of a segment. The first starting point (is specified) must be 0. Starting points are specified as year/day pairs, separated by a slash.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

$USERSCHED_DUE_IN_TIME

$USERSCHED_DUE_IN_TIME [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

The TIME the job must start to avoid being late.

Type

Range definition descriptor

Maximum Value

24:00

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as mmmm:ss, where mmmm ranges from 0 through 9,999 in minutes and ss ranges from 059 in seconds. You can specify the value mmmm without seconds, but ss must be preceded by mmmm. For example, 30 seconds is specified as 0:30.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

$USERSCHED_DUE_IN_LATE_BY

$USERSCHED_DUE_IN_LATE_BY [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

The difference between the current time and DUE-IN time

Type

Range definition descriptor

Maximum Value

24:00

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as mmmm:ss, where mmmm ranges from 0 through 9999 in minutes and ss ranges from 059 in seconds. You can specify the value mmmm without seconds, but ss must be preceded by mmmm. For example, 30 seconds is specified as 0:30.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

$USERSCHED_DUE_IN_WITHIN

$USERSCHED_DUE_IN_WITHIN [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

The difference between the current time and DUE-IN time.

Type

Range definition descriptor

Maximum Value

24:00

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as mmmm:ss, where mmmm ranges from 0 through 9999 in minutes and ss ranges from 059 in seconds. You can specify the value mmmm without seconds, but ss must be preceded by mmmm. For example, 30 seconds is specified as 0:30.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

$USERSCHED_DUE_OUT_DATE

$USERSCHED_DUE_OUT_DATE [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

The DATE the job must end to avoid being late.

Type

Range definition descriptor

Maximum Value

2155/366 expressed as year/day

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as year/day pairs, separated by a slash.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

$USERSCHED_DUE_OUT_TIME

$USERSCHED_DUE_OUT_TIME [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

The TIME the job must end in order not to be late

Type

Range definition descriptor

Maximum Value

24:00

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as year or day pairs, separated by a slash.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

$USERSCHED_ELAPSED

$USERSCHED_ELAPSED [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

The ELAPSED= value on a //*USERSCHED statement

The starting point of a segment. The first starting point (if specified) must be 0.

Type

Range definition descriptor

Maximum Value

99:59

Valid values

name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

 Usage

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

$USERSCHED_JECL_OK

$USERSCHED_JECL_OK(YES/NO)

This JAL element has the following attributes:

Attribute

Value

Description

All //*USERSCHED keywords are syntactically correct

This function call returns a TRUE or FALSE value depending on whether an installation scheduler submitted it.

Type

Logic variable

Maximum Value

Not applicable

Valid values

  • YES—Returns a TRUE value if an installation scheduler submitted the job.
  • NO—Returns a TRUE value if an installation scheduler did not submit the job.

Usage

You can use this variable in EVALUATE definition statements and JAL Logic statements, and as an insert in message definition statements.

$USERSCHED_NAME

$USERSCHED_NAME(pattern | %patid | table-id)

This JAL element has the following attributes:

Attribute

Value

Description

The NAME= value on a //*USERSCHED statement

Type

Character string descriptor

Maximum Length

16 characters

Valid values

  • pattern—Hard-coded string in 1–8 alphabetic, numeric, or national (#, @, $) characters. It can also include the hyphen (-) and the wildcard characters ? and *.
  • %patternID—Name of a pattern created with the PATTERNDEF statement
  • tableIDIdentifies a specific table and which subtable to search

The pattern, %patternID, or tableID entry is 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.

$USERSCHED_PRIORITY

$USERSCHED_PRIORITY [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

A PRIORITY= value as specified on the //*USERSCHED Statement

The starting point of a segment. The first starting point (if specified) must be 0.

Type

Range definition descriptor

Maximum Value

255

Valid values

name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

$USERNnn

$USERNnn [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Numeric User descriptor

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

Type

Range Definition User descriptor

Maximum Value

99,999,999

Valid values

  • $USERNnn—Identifies a numeric User descriptor
  • nn—One or two digits from 1 to 99
  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points can be any value up to 99,999,999.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$USERN3   NONE,1,SOME,99999,LOTS

When using the Job Extract Facility, requests for these tokens return meaningful data only when issued from a post-JAL Job Analyzer exit.

For more information, see $USERCnn.

$VERIFY

$VERIFY name TABLEn(subtable-name-list | *) [TABLEn(subtable-name-list | *) ...]
or
$VERIFY name SACTABLE

This JAL element has the following attributes:

Attribute

Value

Description

Table Verification

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, o
  • The table exists, but all subtables have been disabled

Type

Unique descriptor.

Maximum Value

Not applicable

Valid values

  • name—Unique property name to be assigned a value of TRUE or FALSE, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.
  • TABLEn(subtable-name-list | *)—The name of the table whose status you want to verify. n can be a value from the range 19. 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.
  • subtable-name-list—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.
  • SACTABLE—Requests verification that the SAC table has been properly loaded. This keyword is mutually exclusive with TABLEn.

Usage

You can use this descriptor only in the Definition Section of JAL.

Example
$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:

$VERIFY   TABLE_1_OK  TABLE1(*)

Note that the SAC table must be verified independently:

$VERIFY   SAC_TABLE_OK  SACTABLE

For more information, see $TABLEn.

$VOL_AUTO

$VOL_AUTO [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Automated Volumes

This descriptor represents the number of non-scratch automated cartridge volumes required by the job as recorded in the selected Job Profile, including the number of volumes represented by the value in $VOL_TO_ENTER.

Type

Range definition descriptor

Maximum Value

9999 cartridge volumes

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified in number of volumes as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$VOL_AUTO   NO_AUTO_VOLS,1,AUTO_VOLS,16,SPECIAL_AUTO

For more information, see $LIST_VOL_AUTO, $VOL_CART_ALL, $VOL_MANUAL, and $VOL_TO_ENTER.

$VOL_CART_ALL

$VOL_CART_ALL [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Cartridge Volumes

This descriptor represents the total number of non-scratch cartridge volumes that the job requires as recorded in the selected Job Profile. It is the sum of the values represented by $VOL_MANUAL and $VOL_AUTO.

Type

Range definition descriptor

Maximum Value

9999 cartridge volumes

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified in number of volumes as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

$VOL_CART_ALL   NO_CART_VOLS,1,CART_VOLS,16,CANT_RUN

For more information, see $LIST_VOL_CART_ALL, $VOL_AUTO and $VOL_MANUAL.

$VOL_DISK

$VOL_DISK   [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Disk Volumes

This descriptor represents the number of disk volumes that must be fetched before job execution. This is found by counting the number of unique disk volumes required by the job, then subtracting those found to be either permanently resident or reserved.

Type

Range definition descriptor

Maximum Value

9999 disk volumes

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$VOL_DISK  NO_DISK_VOLS,1,DISK_VOLS

For more information, see $LIST_VOL_DISK

$VOL_MANUAL

$VOL_MANUAL [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Cartridge Volumes

This descriptor represents the number of non-scratch cartridge volumes that must be fetched before job execution as recorded in the selected Job Profile.

Type

Range definition descriptor

Maximum Value

9999 manual cartridge volumes

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified in number of volumes as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$VOL_MANUAL   NO_CART_VOLS,1,CART_VOLS,16,SPECIAL_CART_VOLS

For more information, see $LIST_VOL_MANUAL, $VOL_AUTO and $VOL_MANUAL.

$VOL_MATCH

$VOL_MATCH name VOLUMES(vol-list | %patid | table-id)
               [CART(AUTOMATED | MANUAL | BOTH) | DASD | REEL]
               [ALL | NONE | SOME]

This JAL element has the following attributes:

Attribute

Value

Description

Match the Volumes Requested

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

Type

Unique descriptor

Maximum Value

Not applicable

Value values

  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.
  • CART(AUTOMATED | MANUAL | BOTH)—Indicates that cartridge volume serial numbers are to be matched. This keyword is mutually exclusive with DASD and REEL.
    • AUTOMATED—Only automated cartridges are included in the list to match.
    • MANUAL—Only manual cartridges are included in the list to match.
    • BOTH—Indicatesthatbothautomatedandmanualcartridgesareincludedinthelisttomatch.
  • DASD—Indicates that DASD volume serial numbers are to be matched. This keyword is mutually exclusive with CART and REEL.
  • REEL—Indicates that volume serial numbers for reels are to be matched. This keyword is mutually exclusive with CART and DASD.
  • VOLUMES(vol-list | %patid | table-id)—Specifies the source of the list of volumes to be matched. You must specify at least one volume.
    • vol-list—A hard coded volume list, separated by commas.
    • %patid—The name of a pattern created with the PATTERNDEF statement.
    • table-id—Identifies a specific table to be matched against.
  • ALL—The Property is TRUE only if all the volumes in the job are found in the list or table. This keyword is mutually exclusive with NONE and SOME.
  • NONE—The Property is TRUE if none of the volumes in the job are found in the list or table, or if the volume count is 0. This keyword is mutually exclusive with ALL and SOME.
  • SOME—(Default) The Property is TRUE if at least one volume in the job is found in the list or table. This keyword is mutually exclusive with ALL and NONE.

Usage

You can use this descriptor only in the Definition Section of JAL. 

$VOL_REEL

$VOL_REEL [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Non-Cartridge Tape Volumes

This descriptor represents the number of non-scratch non-cartridge tape volumes that must be fetched before job execution.

Type:

Range definition descriptor

Maximum Value

9999 non-cartridge tape volumes

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified in number of volumes as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$VOL_REEL   NO_TAPE_REELS,1,TAPE_REELS

For more information, see $LIST_VOL_REEL, $TAPEVOLS, $VOL_AUTO, and $VOL_MANUAL.

$VOL_TO_EJECT

$VOL_TO_EJECT [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Automated Volumes Required Outside the Automated Library

This descriptor represents the number of non-scratch cartridge volumes required by the job that are within the automated system but are required in non-automated drives, as recorded in the selected Job Profile. This situation occurs when a MANUAL unit name has been coded in the JCL and the volumes associated with that DD are resident in any automated library system.

Type

Range definition descriptor

Maximum Value

9999 cartridge volumes

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified in number of volumes as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$VOL_TO_EJECT   NONE_RESIDENT,1,CARTS_TO_EJECT

For more information, see $LIST_VOL_TO_EJECT, $VOL_AUTO and $VOL_TO_ENTER

$VOL_TO_ENTER

$VOL_TO_ENTER [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Automated Volumes Required Inside the Automated Library

This descriptor represents the number of non-scratch cartridge volumes required by the job that are outside the automated system but are to be treated as automated, as recorded in the selected Job Profile. 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.

Type

Range definition descriptor

Maximum Value

9999 cartridge volumes

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified in number of volumes as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$VOL_TO_ENTER   ALL_RESIDENT,1,CARTS_OUT

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

$VOL_VTS

$VOL_VTS [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Number of Virtual Tape Volumes

This descriptor represents the number of Virtual Tape volumes used by the job. It is the sum of the values represented by $VOL_VTS_IBM, $VOL_VTS_STK, $VOL_VTS_VTAPE, and $VOL_VTS_ VTFM.

Type

Range definition descriptor

Maximum Value

9999 VTS Volumes

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified in number of volumes as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$VOL_VTS  NO_VIRTUAL_VOLS,1,SOME_VIRTUAL_VOLS

For more information, see $LIST_VOL_VTS, $VOL_VTS_VTFM, $VOL_VTS_IBM, $VOL_VTS_STK, and $VOL_VTS_VTAPE.

$VOL_VTS_IBM

$VOL_VTS_IBM [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Number of IBM Virtual Volumes

This descriptor represents the number of IBM virtual tape volumes used by the job. It is the sum of the values represented by $VOL_VTS_IBM_RESIDENT and $VOL_VTS_IBM_NOTRESIDENT.

Type

Range definition descriptor

Maximum Value

9999 VTS Volumes

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified in number of volumes as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$VOL_VTS_IBM   NO_IBM_VOLS,1,SOME_IBM_VOLS

For more information, see $VOL_VTS, $VOL_VTS_IBM_RESIDENT and $VOL_VTS_IBM_NOTRESIDENT.

$VOL_VTS_IBM_RESIDENT

$VOL_VTS_IBM_RESIDENT [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Number of Resident IBM Virtual Volumes

This descriptor represents the number of resident IBM virtual tape volumes that are used by the job.

Type

Range definition descriptor

Maximum Value

9999 VTS Volumes

Valid value

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified in number of volumes as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$VOL_VTS_IBM_RESIDENT   NO_IBM_IN,1,SOME_IBM_IN

For more information, see $VOL_VTS_IBM and $VOL_VTS_IBM_NOTRESIDENT.

$VOL_VTS_IBM_NOTRESIDENT

$VOL_VTS_IBM_NOTRESIDENT   [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Number of IBM Virtual Volumes Not Resident

This descriptor represents the number of IBM virtual tape volumes that are not resident and are used by the job.

Type

Range definition descriptor

Maximum Value

9999 VTS Volumes

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified in number of volumes as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$VOL_VTS_IBM_NOTRESIDENT   IBM_ALLIN,1,SOME_IBM_NOTIN

For more information, see $VOL_VTS_IBM and $VOL_VTS_IBM_RESIDENT.

$VOL_VTS_STK

$VOL_VTS_STK   [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Number of STK Virtual Volumes

This descriptor represents the number of STK virtual tape volumes used by the job. It is the sum of the values represented by $VOL_VTS_STK_RESIDENT and $VOL_VTS_STK_NOTRESIDENT.

Type

Range definition descriptor

Maximum Value

9999 VTS Volumes

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified in number of volumes as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$VOL_VTS_STK   NO_STK_VOLS,1,SOME_STK_VOLS

For more information, see $VOL_VTS, $VOL_VTS_STK_RESIDENT and $VOL_VTS_STK_NOTRESIDENT.

$VOL_VTS_STK_RESIDENT

$VOL_VTS_STK_RESIDENT [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Number of Resident STK Virtual Volumes

This descriptor represents the number of resident STK virtual tape volumes that are used by any step in the job.

Type

Range definition descriptor

Maximum Value

9999 VTS Volumes

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified in number of volumes as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Examples
$VOL_VTS_STK_RESIDENT   NO_STK_IN,1,SOME_STK_IN

For more information, see  $VOL_VTS_STK and $VOL_VTS_STK_NOTRESIDENT.

$VOL_VTS_STK_NOTRESIDENT

$VOL_VTS_STK_NOTRESIDENT [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Number of STK Virtual Volumes Not Resident

This descriptor represents the number of STK virtual tape volumes that are not resident and are used by any step in the job.

Type

Range definition descriptor

Maximum Value

9999 VTS Volumes

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified in number of volumes as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$VOL_VTS_STK_NOTRESIDENT   STK_ALLIN,1,SOME_STK_NOTIN

For more information, see $VOL_VTS_STK and $VOL_VTS_STK_RESIDENT.

$VOL_VTS_VTAPE

$VOL_VTS_VTAPE [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Number of CA-Vtape Volumes

This descriptor represents the number of CA-Vtape virtual tape volumes used by the job. It is the sum of the values represented by $VOL_VTS_VTAPE_INCACHE and $VOL_VTS_VTAPE_ NOTINCACHE.

Type

Range definition descriptor

Maximum Value

9999 VTS Volumes

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified in number of volumes as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$VOL_VTS_VTAPE   NO_CAVTAPE_VOLS,1,SOME_CAVTAPE_VOLS

For more information, see $VOL_VTS, $VOL_VTS_VTAPE_INCACHE, and $VOL_VTS_VTAPE_NOTINCACHE.

$VOL_VTS_VTAPE_INCACHE

$VOL_VTS_VTAPE_INCACHE [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Number of CA-Vtape INCACHE Volumes

This descriptor represents the number of CA-Vtape virtual tape volumes that are in the cache and are used by the job.

Type

Range definition descriptor

Maximum Value

9999 VTS Volumes

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified in number of volumes as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$VOL_VTS_VTAPE_INCACHE   NO_CAVTAPE_IN,1,SOME_CAVTAPE_IN

For more information, see $VOL_VTS_VTAPE and $VOL_VTS_VTAPE_NOTINCACHE.

$VOL_VTS_VTAPE_NOTINCACHE

$VOL_VTS_VTAPE_NOTINCACHE [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Number of CA-Vtape Volumes Not In Cache

This descriptor represents the number of CA-Vtape virtual tape volumes that have not yet been loaded into the cache and are used by the job.

Type

Range definition descriptor

Maximum Value

9999 VTS Volumes

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified in number of volumes as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

$VOL_VTS_VTAPE_NOTINCACHE   CAVTAPE_ALLIN,1,SOME_CAVTAPE_NOTIN

For more information, see $VOL_VTS_VTAPE and $VOL_VTS_VTAPE_INCACHE.

$VOL_VTS_VTFM

$VOL_VTS_VTFM [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Number of VTFM Virtual Volumes

This descriptor represents the number of VTFM virtual tape volumes used by the job. It is the sum of the values represented by $VOL_VTS_VTFM_ONDISK and $VOL_VTS_VTFM_MIGRATED.

Type

Range definition descriptor

Maximum Value

9999 VTS Volumes

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified in number of volumes as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$VOL_VTS_VTFM   NO_VTFM_VOLS,1,SOME_VTFM_VOLS

For more information, see $VOL_VTS, $VOL_VTS_VTFM_ONDISK and $VOL_VTS_VTFM_MIGRATED.

$VOL_VTS_VTFM_ONDISK

$VOL_VTS_VTFM_ONDISK [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Number of VTFM Virtual Volumes On Disk

This descriptor represents the number of VTFM virtual tape volumes that are available on disk and are used by any step in the job.

Type

Range definition descriptor

Maximum Value

9999 VTS Volumes

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified in number of volumes as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$VOL_VTS_VTFM_ONDISK   NO_VTFM_IN,1,SOME_VTFM_IN

For more information, see $VOL_VTS_VTFM and $VOL_VTS_VTFM_MIGRATED.

$VOL_VTS_VTFM_MIGRATED

$VOL_VTS_VTFM MIGRATED [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Number of VTFM Virtual Volumes Not On Disk

This descriptor represents the number of VTFM virtual tape volumes that are not on disk and are used by any step in the job.

Type

Range definition descriptor

Maximum Value

9999 VTS Volumes

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified in number of volumes as 1-4 decimal digits.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$VOL_VTS_VTFM_MIGRATED   VTFM_ALLIN,1,SOME_VTFM_NOTIN

For more information, see $VOL_VTS_VTFM and $VOL_VTS_VTFM_ONDISK.

$WLM_MODE

$WLM_MODE(COMPAT | GOAL)

This JAL element has the following attributes:

Attribute

Value

Description

Detect Workload Manager Mode

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

Type

Logic variable

Maximum Value

Not applicable

Valid values

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

Usage

You can use this variable in EVALUATE definition statements and JAL Logic statements, and also as an insert in message definition statements.

WTCA7

WTCA7 (id1[,id2,...idN])

This JAL element has the following attributes:

Attribute

Value

Description

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

Type

Communication statement

Valid values

id—Specifies the symbols or list of symbols associated with CA7 messages, as established by prior MSGDEF statements. The MSGDEF statement that WTCA7 references must contain ether CA7LTERM or USERID keyword. If neither is supplied the request is ignored.

Example
MSGDEF CART_MSG (‘JOB ‘,$JOBNAME,’ NEEDS ‘,$VOL_CART_ALL,’ VOLUMES.’) +
                 CA7LTERM(LIBRARY)

...
WTCA7  CART_MSG

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

Important

  • You can omit the parentheses () if a single message identifier is specified.
  • The routing of CA7 messages is controlled by the CA7LTERM and USERID keywords of the MSGDEF statement.
  • WTCA7 directs messages only to the CA7 that is managing the job. For example, you cannot send a message to CA73 for a CA75 job, or to a CA7 user for a non-managed job.

WTO

WTO (id1[,id2,...idN])

This JAL element has the following attributes:

Attribute

Value

Description

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

Type

Communication statement

Valid values

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

Example
MSGDEF CART_MSG (‘JOB ‘,$JOBNAME,’ NEEDS ‘,$VOL_CART_ALL,’ VOLUMES.’) +
                 ROUTCDE(120)

...
WTO  CART_MSG

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

Important

  • 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

WTU (id1[,id2,...idN])

This JAL element has the following attributes:

Attribute

Value

Description

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

Type

Communication statement

Valid values

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

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

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

Important

  • 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.

$XEQCLASS

JLS_LIMITDEF ... [LEVEL1($XEQCLASS) | LEVEL2($XEQCLASS)]...

This JAL element has the following attributes:

Attribute

Value

JBS ONLY

Description

The $XEQCLASS unique variable is provided for the construction of Limiting Agent Names. It represents the execution class assigned to the job at the end of JAL. This class is either the result of a SET CLASS statement (the last one executed) or, if no SET CLASS statement has been executed, the default value: job submission class.

Type

Unique Variable

Valid values

  • LEVEL1 | LEVEL2—Keywords in JLS_LIMITDEF statement
  • $XEQCLASS—Requests that the execution class be used as part of the Agent Name

Usage

You can use this variable only in the construction of Limiting Agent Names.

Example
SET CLASS(L)
...
JLS_LIMITDEF DEVELOP LEVEL1(‘GROUP1’) LEVEL2($XEQCLASS)

This forms the Agent:

GROUP1.L

$ZEKE

$ZEKE(YES | NO)

This JAL element has the following attributes:

Attribute

Value

Description

A //*ZEKECTL Statement was Encountered

This descriptor indicates that a //ZEKECTL statement was encountered. This function call returns a TRUE/FALSE value depending on whether or not the //*ZEKECTL statement was encountered.

Type

Logic variable

Maximum Value

Not applicable

Valid values

  • YES—Returns a TRUE value if a //*ZEKECTL statement was encountered.
  • NO—Returns a TRUE value if a //*ZEKECTL statement was not encountered.

Usage

You can use this variable in EVALUATE definition statements and JAL Logic statements, and also as an insert in message definition statements.

Example
EVALUATE ZEKE_JOB ($ZEKE(YES))
...
IF (ZEKE_JOB)
WTU ...
ENDIF

$ZEKE_APPL

$ZEKE_APPL(pattern | %patid | table-id)

This JAL element has the following attributes:

Attribute

Value

Description

The Event’s Application

This descriptor represents the event’s application

Type

Character string descriptor

Maximum Length

8 characters

Valid values

  • pattern—Hard-coded string in 1–8 alphabetic, numeric, or national (#, @, $) characters. It can also include the hyphen (-) and the wildcard characters ? and *.
  • %patternID—Name of a pattern created with the PATTERNDEF statement
  • tableIDIdentifies a specific table and which subtable to search 

The pattern, %patternID, or tableID entry is matched against the descriptor. If a match occurs, a TRUE value is returned.

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

Usage

You can use this descriptor in EVALUATE definition statements and JAL Logic statements. This descriptor can also be used:

  • As an insert in message definition statements
  • In a substring function
  • In STRINGDEF and PATTERNDEF statements
  • In JLS_LIMITDEF and JLS_CNTLDEF statements
Example
$ZEKE_APPL(PAYROLL)
$ZEKE_APPL($TABLE3(PAYROLL))

$ZEKE_CAL

$ZEKE_CAL(pattern | %patid | table-id)

This JAL element has the following attributes:

Attribute

Value

Description

The Event’s Calendar

This descriptor represents the event’s calendar name.

Type

Character string descriptor.

Maximum Length

8 characters

Valid values

  • pattern—Hard-coded string in 1-142 alphabetic, numeric, or national (#, @, $) characters. It can also include the hyphen (-) and the wildcard characters ? and *. If pattern contains a blank, or any characters other than those previously listed, it must be enclosed in apostrophes.
  • %patid—The name of a pattern created with the PATTERNDEF statement.
  • table-id—Identifies a specific table and which subtable to search.

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 in EVALUATE definition statements and JAL Logic statements and also:

  • As an insert in message definition statements
  • In a substring function
  • In STRINGDEF and PATTERNDEF statements
  • In JLS_LIMITDEF and JLS_CNTLDEF statements
Example
$ZEKE_CAL(AB123)

$ZEKE_CATID

$ZEKE_CATID(pattern | %patid | table-id)

This JAL element has the following attributes:

Attribute

Value

Description

The CATID of the Event’s ZEKE Database

This descriptor represents the CATID of the event’s ZEKE database.

Type

Character string descriptor

Maximum Length

8 characters

Valid values

  • pattern—Hard-coded string in 1-142 alphabetic, numeric, or national (#, @, $) characters. It can also include the hyphen (-) and the wildcard characters ? and *. If pattern contains a blank, or any characters other than those previously listed, it must be enclosed in apostrophes.
  • %patid—The name of a pattern created with the PATTERNDEF statement.
  • table-id—Identifies a specific table and which subtable to search.

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 in EVALUATE definition statements and JAL Logic statements and also:

  • As an insert in message definition statements
  • In a substring function
  • In STRINGDEF and PATTERNDEF statements
  • In JLS_LIMITDEF and JLS_CNTLDEF statements
Example
$ZEKE_CATID(ABBASE)

$ZEKE_CLASSES

$ZEKE_CLASSES(pattern | %patid | table-id)

This JAL element has the following attributes:

Attribute

Value

Description

The Event’s Classes

  This descriptor represents ZEKE event’s classes.

Type

Character string descriptor

Maximum Length

6 character

Valid values

  • pattern—Hard-coded string in 1-142 alphabetic, numeric, or national (#, @, $) characters. It can also include the hyphen (-) and the wildcard characters ? and *. If pattern contains a blank, or any characters other than those previously listed, it must be enclosed in apostrophes.
  • %patid—The name of a pattern created with the PATTERNDEF statement.
  • table-id—Identifies a specific table and which subtable to search.

The pattern, %patid, or tableID 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 in EVALUATE definition statements and JAL Logic statements. This descriptor can also be used:

  • As an insert in message definition statements
  • In a substring function
  • In STRINGDEF and PATTERNDEF statements
  • In JLS_LIMITDEF and JLS_CNTLDEF statements
Example
$ZEKE_CLASSES(ABCDE)

$ZEKE_CPU

$ZEKE_CPU [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

This descriptor represents the event’s average CPU time.

Type

Range definition descriptor

Maximum Value

357912:00

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as mmmmmm:ss, where, mmmmmm ranges from 0 through 357912 in minutes and ss ranges from 0 through 59 in seconds. The value mmmmmm can be specified without seconds but ss must be preceded by mmmmmm. For example, 30 seconds is specified as 0:30.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$ZEKE_CPU   LOW_CPU,2:30,MEDIUM_CPU,10,HIGH_CPU,60,SPECIAL_CPU

$ZEKE_DISPID

$ZEKE_DISPID(pattern | %patid | table-id)

This JAL element has the following attributes:

Attribute

Value

Description

The Dispatch ID of the Event’s Schedule Record.

This descriptor represents the dispatch ID.

Type

Character string descriptor

Maximum Length

8 characters

Valid values

  • pattern—Hard-coded string in 1-142 alphabetic, numeric, or national (#, @, $) characters. It can also include the hyphen (-) and the wildcard characters ? and *. If pattern contains a blank, or any characters other than those previously listed, it must be enclosed in apostrophes.
  • %patid—The name of a pattern created with the PATTERNDEF statement.
  • table-id—Identifies a specific table and which subtable to search.

The pattern, %patternID, or tableID entry is 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 in EVALUATE definition statements and JAL Logic statements. This descriptor can also be used:

  • As an insert in message definition statements
  • In a substring function
  • In STRINGDEF and PATTERNDEF statements
  • In JLS_LIMITDEF and JLS_CNTLDEF statements
Example
$ZEKE_DISPID(AB123)

$ZEKE_DISPSYS

$ZEKE_DISPSYS(pattern | %patid | table-id)

This JAL element has the following attributes:

Attribute

Value

Description

The ZEKE System Name that Dispatched the Event

This descriptor represents the ZEKE system that dispatched the event.

Type

Character string descriptor

Maximum Length

8 character

Valid value

  • pattern—Hard-coded string in 1-142 alphabetic, numeric, or national (#, @, $) characters. It can also include the hyphen (-) and the wildcard characters ? and *. If pattern contains a blank, or any characters other than those previously listed, it must be enclosed in apostrophes.
  • %patid—The name of a pattern created with the PATTERNDEF statement.
  • table-id—Identifies a specific table and which subtable to search.

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 in EVALUATE definition statements and JAL Logic statements. This descriptor can also be used:

  • As an insert in message definition statements
  • In a substring function
  • In STRINGDEF and PATTERNDEF statements
  • In JLS_LIMITDEF and JLS_CNTLDEF statements
Example
$ZEKE_DISPSYS(SYS123)

$ZEKE_DPRTY

$ZEKE_DPRTY [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

The Event’s Dispatch Priority

This descriptor represents the event’s dispatch priority.

Type

Range definition descriptor

Maximum Value

255

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$ZEKE_DPRTY  LOW_DPRTY,2,MEDIUM_DPRTY,10,HIGH_DPRTY,60,SPECIAL_DPRTY

$ZEKE_DRL

$ZEKE_DRL   [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

The Event’s Disaster Recovery Level

This descriptor represents the event’s disaster recovery level.

Type

Range definition descriptor

Maximum Value

99

Valid value

  • start—The starting point of a segment. The first starting point (if specified) must be 0.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$ZEKE_DRL  LOW_DRL,2,MEDIUM_DRL,10,HIGH_DRL,70,SPECIAL_DRL

$ZEKE_DUR

$ZEKE_DUR   [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

The Event’s Average Duration

This descriptor represents the event’s average duration.

Type

Range definition descriptor

Maximum Value

357912:00

Valid value

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as mmmmmm:ss, where, mmmmmm ranges from 0 to 357912 in minutes and ss ranges from 0 to 59 in seconds. The value mmmmmm can be specified without seconds but ss must be preceded by mmmmmm. For example, 30 seconds is specified as 0:30.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$ZEKE_DUR   LOW_DUR,2:30,MEDIUM_DUR,10,HIGH_DUR,60,SPECIAL_DUR

$ZEKE_EVT

$ZEKE_EVT   [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

The Event Number

This descriptor represents the event’s number.

Type

Range definition descriptor

Maximum Value

999999

Valid value

  • start—The starting point of a segment. The first starting point (if specified) must be 0.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$ZEKE_EVT   EVENT,2,EVENT2,10,EVENT3,70,SPECIAL

$ZEKE_EVTNAME

$ZEKE_EVTNAME(pattern | %patid | table-id)

This JAL element has the following attributes:

Attribute

Value

Description

The Event’s Name

This descriptor represents the event’s name.

Type

Character string descriptor

Maximum Length

12 characters

Valid values

  • pattern—Hard-coded string in 1-8 alphabetic, numeric, or national (#, @, $) characters, the first of which must be alphabetic or national. It can also include the wildcard characters ? and *.
  • %patid—The name of a pattern created with the PATTERNDEF statement.
  • table-id—Identifies a specific table and which subtable to search.

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 in EVALUATE definition statements and JAL Logic statements. This descriptor can also be used:

  • As an insert in message definition statements
  • In a substring function
  • In STRINGDEF and PATTERNDEF statements
  • In JLS_LIMITDEF and JLS_CNTLDEF statements
Examples
$ZEKE_EVTNAME(EVENT1)

$ZEKE_EVTNAME($TABLE3(EVENT1))

$ZEKE_EVTSYS

$ZEKE_EVTSYS(pattern | %patid | table-id)

This JAL element has the following attributes:

Attribute

Value

Description

The Event’s System ID

This descriptor represents the event’s system ID.

Type

Character string descriptor

Maximum Length

8 character

Valid values

  • pattern—Hard-coded string in 1-142 alphabetic, numeric, or national (#, @, $) characters. It can also include the hyphen (-) and the wildcard characters ? and *. If pattern contains a blank, or any characters other than those previously listed, it must be enclosed in apostrophes.
  • %patid—The name of a pattern created with the PATTERNDEF statement.
  • table-id—Identifies a specific table and which subtable to search.

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 in EVALUATE definition statements and JAL Logic statements. This descriptor can also be used:

  • As an insert in message definition statements
  • In a substring function
  • In STRINGDEF and PATTERNDEF statements
  • In JLS_LIMITDEF and JLS_CNTLDEF statements
Example
$ZEKE_EVTSYS(SYS123)

$ZEKE_GRP

$ZEKE_GRP(pattern | %patid | table-id)

This JAL element has the following attributes:

Attribute

Value

Description

The Event’s Group

This descriptor represents the event’s group.

Type

Character string descriptor

Maximum Length

3 character

Valid values

  • pattern—Hard-coded string in 1-142 alphabetic, numeric, or national (#, @, $) characters. It can also include the hyphen (-) and the wildcard characters ? and *. If pattern contains a blank, or any characters other than those previously listed, it must be enclosed in apostrophes.
  • %patid—The name of a pattern created with the PATTERNDEF statement.
  • table-id—Identifies a specific table and which subtable to search.

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 in EVALUATE definition statements and JAL Logic statements. This descriptor can also be used:

  • As an insert in message definition statements
  • In a substring function
  • In STRINGDEF and PATTERNDEF statements
  • In JLS_LIMITDEF and JLS_CNTLDEF statements
Example
$ZEKE_GRP(123)

$ZEKE_JCLOVRD

$ZEKE_JCLOVRD(YES | NO)

This JAL element has the following attributes:

Attribute

Value

Description

The Event’s JCL was Overridden

This descriptor indicates that JCLOVRD keyword was specified.

This function call returns a TRUE/FALSE value depending on whether or not the JCLOVRD keyword was specified.

Type

Logic variable

Maximum Value

Not applicable

Valid values

  • YES—Returns a TRUE value if the JCLOVRD keyword was specified.
  • NO—Returns a TRUE value if a JCLOVRD keyword was not specified.

Usage

You can use this variable in EVALUATE definition statements and JAL Logic statements, and also as an insert in message definition statements.

Example
EVALUATE ZEKE_JOB ($ZEKE_JCLOVRD(YES))
...
IF (ZEKE_JOB) WTU ...
ENDIF

$ZEKE_JECL_OK

$ZEKE_JECL_OK(YES | NO)

This JAL element has the following attributes:

Attribute

Value

Description

All //*ZEKECTL Keywords are Acceptable

This descriptor indicates that all //ZEKECTL control keywords are correct.

This function call returns a TRUE/FALSE value depending on whether or not all keywords in //*ZEKECTL statement are acceptable.

Type

Logic variable

Maximum Value

Not applicable

Valid values

  • YES—Returns a TRUE value if all keywords in //*ZEKECTL statement were acceptable.
  • NO—Returns a TRUE value if one or more keywords in //*ZEKECTL statement were not acceptable.

Usage

You can use this variable in EVALUATE definition statements and JAL Logic statements, and also as an insert in message definition statements.

Example
EVALUATE ZEKE_JOB ($ZEKE_JECL_OK(NO))
...
IF (ZEKE_JOB)
WTU ...
ENDIF

$ZEKE_LATESTART

$ZEKE_LATESTART   [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

The Event’s Late Start Time

This descriptor represents the event’s late start time.

Type

Range definition descriptor

Maximum Value

48:00

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as hh:mm, where, hh ranges from 0 to 48 in hours and mm ranges from 0 to 59 in minutes. The value hh can be specified without minutes but mm must be preceded by mm. For example, 30 minutes is specified as 0:30.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$ZEKE_LATESTART   LST1,2:30,LST2,10,LST3,40,SPECIAL_LST

$ZEKE_MANUAL

$ZEKE_MANUAL(YES | NO)

This JAL element has the following attributes:

Attribute

Value

Description

Event was Manually Scheduled

This descriptor indicates that keyword MANUAL was specified.

This function call returns a TRUE/FALSE value depending on whether or not keyword MANUAL was specified.

Type

Logic variable

Maximum value

Not applicable

Valid values

  • YES—Returns a TRUE value if MANUAL keyword was specified.
  • NO—Returns a TRUE value if MANUAL keyword was not specified.

Usage

You can use this variable in EVALUATE definition statements and JAL Logic statements, and also as an insert in message definition statements.

Example
EVALUATE ZEKE_JOB ($ZEKE_MANUAL(YES))
...
IF (ZEKE_JOB)
WTU ...
ENDIF

$ZEKE_MILESTONE

$ZEKE_MILESTONE(YES | NO)

This JAL element has the following attributes:

Attribute

Value

Description

This descriptor indicates that keyword MILESTONE was specified.

This function call returns a TRUE or FALSE or both value depending on whether keyword MILESTONE was specified.

Type

Logic variable

Maximum Value

Not applicable

Valid values

  • YES—Returns a TRUE value if MILESTONE keyword was specified.
  • NO—Returns a TRUE value if MILESTONE keyword was not specified.

Usage

You can use this variable in EVALUATE definition statements and JAL Logic statements, and also as an insert in message definition statements.

Example
EVALUATE ZEKE_JOB ($ZEKE_MILESTONE(YES))
...
IF (ZEKE_JOB)
WTU ...
ENDIF

$ZEKE_MUSTSTART

$ZEKE_MUSTSTART

This JAL element has the following attributes:

Attribute

Value

Description

You can use this display Variable to insert certain start time related information into messages.

Type

Display Variable

Maximum Value

Not applicable

Valid values

$ZEKE _MUSTSTART—displays only variable in the following form:

  • Represents a Julian date: YYYY/DDD.HH:MM and  YYYY/DDD
  • Represents hours and minutes: HH:MM

Usage

You can use this variable only as an insert in message definition statements.

Example
MSGDEF MUSTST_INFO (‘Job must start at ‘,$ZEKE_MUSTSTART) LOG

For more information, see $ZEKE_MUSTSTART_WITHIN and $ZEKE_MUSTSTART_LATE_BY.

$ZEKE_MUSTSTART_WITHIN

$ZEKE_MUSTSTART_WITHIN   [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

This descriptor represents the difference between current time and MUSTSTART time. MUSTSTART time is higher than the current time.

Type

Range definition descriptor

Maximum Value

9999:00

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as  mmmm:ss, where, mmmm  ranges from 0 to 9999 in minutes and ss  ranges from 0 to 59 in seconds. The value mmmm can be specified without seconds but ss must be preceded by mmmm. For example, 30 seconds is specified as 0:30.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example

If the job is late the $ZEKE_MUSTSTART_WITHIN returns 0. If $ZEKE_MUSTSTART_WITHIN is not specified, the default is 9999:00

$ZEKE_MUSTSTART_WITHIN  ST1,99:30,ST2,199,LST3,999:30,SPECIAL_ST

For more information, see $ZEKE_MUSTSTART and $ZEKE_MUSTSTART_LATE_BY.

$ZEKE_MUSTSTART_LATE_BY

$ZEKE_MUSTSTART_LATE_BY   [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

This descriptor represents the difference between current time and MUSTSTART time. MUSTSTART time is lower than the current time.

Type

Range definition descriptor

Maximum Value

9999:00

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as  mmmm:ss , where, mmmm  ranges from 0 through 9999 in minutes and ss  ranges from 0 through 59 in seconds. The value mmmm can be specified without seconds but ss must be preceded by mmmm. For example, 30 seconds is specified as 0:30.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example

If the job is not late the $ZEKE_MUSTSTART_LATE_BY returns 0. If $ZEKE_MUSTSTART_ LATE_BY is not specified, the default is 9999:00

$ZEKE_MUSTSTART_LATE_BY  ST1,99:30,ST2,199,LST3,999:30,SPECIAL_ST

For more information, see $ZEKE_MUSTSTART and $ZEKE_MUSTSTART_WITHIN.

$ZEKE_PDSDD

$ZEKE_PDSDD(pattern | %patid | table-id)

This JAL element has the following attributes:

Attribute

Value

Description

This descriptor represents the DDNAME of the PDS file that contains the event’s JCL.

Type

Character string descriptor

Maximum Length

8 character

Valid values

  • pattern—Hard-coded string in 1-142 alphabetic, numeric, or national (#, @, $) characters. It can also include the hyphen (-) and the wildcard characters ? and *. If pattern contains a blank, or any characters other than those previously listed, it must be enclosed in apostrophes.
  • %patid—The name of a pattern created with the PATTERNDEF statement.
  • table-id—Identifies a specific table and which subtable to search.

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 in EVALUATE definition statements and JAL Logic statements. This descriptor can also be used:

  • As an insert in message definition statements
  • In a substring function
  • In STRINGDEF and PATTERNDEF statements
  • In JLS_LIMITDEF and JLS_CNTLDEF statements
Example
$ZEKE_PDSDD(PAYROLL)

$ZEKE_PDSMEM

$ZEKE_PDSMEM(pattern | %patid | table-id)

This JAL element has the following attributes:

Attribute

Value

Description

This descriptor represents the name of the member in the PDS file that contains the event’s JCL.

Type

Character string descriptor

Maximum Length

8 character

Valid values

  • pattern—Hard-coded string in 1-142 alphabetic, numeric, or national (#, @, $) characters. It can also include the hyphen (-) and the wildcard characters ‘?’ and ‘*’. If pattern contains a blank, or any characters other than those previously listed, it must be enclosed in apostrophes.
  • %patid—The name of a pattern created with the PATTERNDEF statement.
  • table-id—Identifies a specific table and which subtable to search.

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 in EVALUATE definition statements and JAL Logic statements. This descriptor can also be used:

  • As an insert in message definition statements
  • In a substring function
  • In STRINGDEF and PATTERNDEF statements
  • In JLS_LIMITDEF and JLS_CNTLDEF statements
Example
$ZEKE_PDSMEM(ACCT)

$ZEKE_RESTART

$ZEKE_RESTART(YES | NO)

This JAL element has the following attributes:

Attribute

Value

Description

This descriptor indicates that keyword RESTART was specified.

This function call returns a TRUE/FALSE value depending on whether or not keyword RESTART was specified.

Type

Logic variable

Maximum Value

Not applicable

Valid values

  • YES—Returns a TRUE value if RESTART keyword was specified.
  • NO—Returns a TRUE value if RESTART keyword was not specified.

Usage

You can use this variable in EVALUATE definition statements and JAL Logic statements, and also as an insert in message definition statements.

Example
EVALUATE ZEKE_JOB ($ZEKE_RESTART(YES))
...
IF (ZEKE_JOB)
WTU ...
ENDIF

$ZEKE_SCHED

$ZEKE_SCHED   [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

This descriptor represents the event’s scheduled time.

Type

Range definition descriptor

Maximum Value

48:00

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as  hh:mm, where, hh ranges from 0 through 48 in hours and mm  ranges from 0 through 59 in minutes. The value hh can be specified without minutes but  mm must be preceded by  mm. For example, 30 minutes is specified as 0:30.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$ZEKE_SCHED   LSCH1,2:30,LSCH2,10,LSCH3,11:40,SPECIAL_LSH

$ZEKE_SDATE

$ZEKE_SDATE   [0,]name1,start2,name2[,...,startN,nameN]

  This JAL element has the following attributes:

Attribute

Value

Description

This descriptor represents the event’s scheduled date.

Type

Range definition descriptor

Maximum Value

2155/366 expressed as year/day. This descriptor represents the event’s scheduled date.

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as year/day pairs, separated by a slash.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$ZEKE_SDATE   DATE_ONE,1999/365,NEVER_DATE,2000/001,DATE_TWO

$ZEKE_SUBSYS

$ZEKE_SUBSYS(pattern | %patid | table-id)

  This JAL element has the following attributes:

Attribute

Value

Description

This descriptor represents the ZEKE Subsystem that dispatched the event.

Type

Character string descriptor

Maximum Length

4 character

Valid values

  • pattern—Hard-coded string in 1-142 alphabetic, numeric, or national (#, @, $) characters. It can also include the hyphen (-) and the wildcard characters ? and *. If pattern contains a blank, or any characters other than those previously listed, it must be enclosed in apostrophes.
  • %patid—The name of a pattern created with the PATTERNDEF statement.
  • table-id—Identifies a specific table and which subtable to search.

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 in EVALUATE definition statements and JAL Logic statements. This descriptor can also be used:

  • As an insert in message definition statements
  • In a substring function
  • In STRINGDEF and PATTERNDEF statements
  • In JLS_LIMITDEF and JLS_CNTLDEF statements
Example
$ZEKE_SUBSYS(PRD1)

$ZEKE_USERID

$ZEKE_USERID(pattern | %patid | table-id)

This JAL element has the following attributes:

Attribute

Value

Description

This descriptor represents the event’s user ID.

Type

Character string descriptor

Maximum Length

8 character

Valid values

  • pattern—Hard-coded string in 1-142 alphabetic, numeric, or national (#, @, $) characters. It can also include the hyphen (-) and the wildcard characters ? and *. If pattern contains a blank, or any characters other than those previously listed, it must be enclosed in apostrophes.
  • %patid—The name of a pattern created with the PATTERNDEF statement.
  • table-id—Identifies a specific table and which subtable to search.

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 in EVALUATE definition statements and JAL Logic statements. This descriptor can also be used:

  • As an insert in message definition statements
  • In a substring function
  • In STRINGDEF and PATTERNDEF statements
  • In JLS_LIMITDEF and JLS_CNTLDEF statements
Example
$ZEKE_USERID(RSI01)

$ZEKE_VER

$ZEKE_VER [0,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

This descriptor represents the event’s version number.

Type

Range definition descriptor

Maximum Value

65535

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 0.
  • name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. 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 that you want to ignore.

Usage

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

Example
$ZEKE_VER   VER_TEST,2,VER_PROD,10,VER_EPT60,SPECIAL_SYS

$PI,TMDYNAM

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*