List of JAL elements (A-F)

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

Related topic

JAL-elements-reference-section

$ACCT

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

This JAL element has the following attributes: 

Attribute

Value

Description

Account field from the JOB statement

This descriptor represents the account number from the JOB statement. This field has the same meaning as if $ACCTFLD(1,string) had been specified.

Type

Character string descriptor

Maximum length

142 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.
  • %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, 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

This compares the account field from the JOB statement with the entries contained in the subtable ACCOUNTS from TABLE1.

$ACCT(AB123)

This compares the string AB123 to the account field from the JOB statement:

//JOBNAME JOB (AB123), ...

$ACCT($TABLE1(ACCOUNTS))

For more information, see $ACCTFLD.

Important

  • This descriptor, along with the $ACCTFLD descriptor, is a special case. The language processor does not know the actual length of the descriptor. This results in an exception in the way comparisons are done.
  • The job accounting data provided in the JOB statement can be composed of an arbitrary number of fields each with an arbitrary length. The fields are delimited by commas. The total aggregate length is known (142 characters) by the language processor, but the length of each field is not known until JAL execution time. In this case, at JAL execution time, the shorter of the strings is extended on the right with blanks until it matches the length of the larger string.
  • For example, if $ACCT(‘ABC ‘) is coded in a JAL statement, and the character string in the account field in the JOB statement was ‘ABC’, then at the time JAL is executed, the account field from the JOB statement would be extended by a blank on the right:
    ‘ABCb’
  • In this case, when the strings are compared, they are equal. The pattern matching function returns a value of TRUE.
  • Similarly, if $ACCT(‘ABC’) is coded in a JAL statement, and the character string in the account field in the JOB statement was ‘ABC’, then at the time JAL is executed, the string coded in the pattern matching function would be extended by a blank on the right, again resulting in a TRUE value.
  • When using the Job Extract Facility, a request of the form $ACCT(nn) returns the nnth sub-field of the account data. The identity of the XFE is the same as for a request without a subscript ($ACCT), but the data returned consists of the length and contents of only the requested sub-field.

$ACCTFLD | $ACCTF

$ACCTFLD(field#,pattern)
or
$ACCTFLD(field#,%patid)
or
$ACCTFLD(field#,table-id)

This JAL element has the following attributes: 

Attribute

Value

Description

Accounting related fields

This descriptor represents an accounting related field from the JOB statement.

Type

Character string descriptor

Maximum length

142 characters

Valid values

  • field#—Indicates the field reference number of the accounting related field and must be specified as decimal digit(s) 1-68.
  • pattern—This is a hard-coded string. It can be 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.
  • %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. 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

This compares the entries from the subtable PAYROLL of TABLE2 with the first accounting field from the JOB statement.

$ACCTFLD(1,12345)

$ACCTFLD(2,PAYROLL)

These compare the specified string with the fields from the JOB statement:

//JOBNAME JOB (12345,PAYROLL,’A/P DEPT’), ...
$ACCTF(1,$TABLE2(PAYROLL))

For more information, see $ACCT.

Important

  • If you use this descriptor with the character substring function the format is:
    ($ACCTFLD(field#),length,[starting-position])
  • This descriptor, along with the $ACCT descriptor, is a special case. The Language Processor does not know the actual length of the descriptor. This results in an exception in the way comparisons are done.
  • The job accounting data provided in the JOB statement can be composed of an arbitrary number of fields each with an arbitrary length. The fields are delimited by commas. The total aggregate length is known (142 characters) by the Language Processor, but the length of each field is not known until JAL execution time. In this case, at JAL execution time, the shorter of the strings is extended on the right with blanks until it matches the length of the larger string.
  • For example, if $ACCTFLD(1,‘ABC’) is coded in a JAL statement, and the character string in the account field in the JOB statement was ‘ABC’, then at the time JAL is executed, the account field from the JOB statement would be extended by a blank on the right:
    ‘ABCb’
  • In this case, when the strings are compared, they are equal. The pattern matching function returns a value of TRUE.
  • Similarly, if $ACCTFLD(1,‘ABC’) is coded in a JAL statement, and the character string in the account field in the JOB statement was ‘ABC’, then at the time JAL is executed, the string coded in the pattern matching function would be extended by a blank on the right, again resulting in a TRUE value.

$ACF2_LIDBEGIN

STRINGDEF %stringid ($ACF2_LIDBEGIN,length[,start])

This JAL element has the following attributes:

Attribute

Value

Description

Extract substring from ACF2 LOGONID

You can use this descriptor to extract a substring from the ACF2 LOGONID record.

Type

Character string descriptor

Maximum length

255 characters

Valid values

  • %stringID—Identification name for the character string that is extracted. The first character must be % followed by 1 to 23 alphabetic, numeric, national (#, @, $), or underscore (_) characters. The name must be unique.
  • length—Number of characters to be extracted, from the range 1–255.
  • start—Starting position within the ACF2 user information at which extraction is to begin. If this parameter is omitted, the default is 1 (the first character).

Usage

In this example, the 20 bytes starting at byte 13 in the ACF2 LOGONID are extracted and placed in the string variable %ACF2INFO.

Example

This descriptor is applicable to TOP SECRET security environments.

STRINGDEF %ACF2INFO ($ACF2_LIDBEGIN,20,13)

For more information, see $ACF2_LIDIFLDS, $ACF2_LIDUSER, $ACF2_LIDUSERX and STRINGDEF.

This descriptor contains data only in an ACF2 environment. In other environments, it returns blanks.

$ACF2_LIDIFLDS  

STRINGDEF %stringid ($ACF2_LIDIFLDS,length[,start])

This JAL element has the following attributes:

Attribute

Value

Description

Extract substring from ACF2 LOGONID record

You can use this descriptor to extract a substring from the ACF2 LOGONID RECORD.

Type

Character string descriptor

Maximum length

192 characters

Valid values

  • %stringID—Identification name for the character string that is extracted. The first character must be % followed by 1 to 23 alphabetic, numeric, national (#, @, $), or underscore (_) characters. The name must be unique.
  • length—Number of characters to be extracted, from the range 1–192.
  • start—Starting position within the ACF2 user information at which extraction is to begin. If this parameter is omitted, the default is 1 (the first character).

Usage

You can use this descriptor in STRINGDEF definition statements.

Example

In this example, the 8 bytes starting at byte 10 in the ACF2 LOGONID record are extracted and placed in the string variable %ACF2INFO.

STRINGDEF %ACF2INFO ($ACF2_LIDIFLDS,8,10)

For more information, see $ACF2_LIDBEGIN, $ACF2_LIDUSER, $ACF2_LIDUSERX and STRINGDEF.

This descriptor contains data only in an ACF2 environment. In other environments, it returns blanks.

$ACF2_LIDUSER

STRINGDEF %stringid ($ACF2_LIDUSER,length[,start])

This JAL element has the following attributes:

Attribute

Value

Description

Extract substring from ACF2 user information

You can use this descriptor to extract a substring from the ACF2 user information.

Type

Character string descriptor

Maximum length

192 characters

Valid values

  • %stringID—Identification name for the character string that is extracted. The first character must be % followed by 1 to 23 alphabetic, numeric, national (#, @, $), or underscore (_) characters. The name must be unique.
  • length—Number of characters to be extracted, from the range 1–192.
  • start—Starting position within the ACF2 user information at which extraction is to begin. If this parameter is omitted, the default is 1 (the first character).

Usage

You can use this descriptor only in STRINGDEF definition statements.

Example

In this example, the 8 bytes starting at byte 10 in the ACF2 user information are extracted and placed in the string variable %ACF2INFO.

STRINGDEF %ACF2INFO ($ACF2_LIDUSER,8,10)

For more information, see $ACF2_LIDUSERX and STRINGDEF.

This descriptor contains data only in an ACF2 environment. In other environments, it returns blanks.

$ACF2_LIDUSERX

STRINGDEF %stringid ($ACF2_LIDUSERX,length[,start])

This JAL element has the following attributes:

Attribute

Value

Description

Extract substring from ACF2 user information

You can use this descriptor to extract a substring from the ACF2 user information extension.

Type

Character string descriptor

Maximum length

192 characters

Valid values

  • %stringID—Identification name for the character string that is extracted. The first character must be % followed by 1 to 23 alphabetic, numeric, national (#, @, $), or underscore (_) characters. The name must be unique.
  • length—Number of characters to be extracted, from the range 1–192
  • start—Starting position within the ACF2 user information extension at which extraction is to begin. If this parameter is omitted, the default is 1 (the first character).

Usage

You can use this descriptor only in STRINGDEF definition statements.

Example

In this example, the 32 bytes starting at byte 4 in the ACF2 user information extension are extracted and placed in the string variable %ACF2XINFO.

STRINGDEF %ACF2XINFO ($ACF2_LIDUSERX,32,4)

For more information, see $ACF2_LIDBEGIN, $ACF2_LIDIFLDS, $ACF2_LIDUSER and STRINGDEF.

This descriptor contains data only in an ACF2 environment. In other environments, it returns blanks.

$ACFLID

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

This JAL element has the following attributes:

Attribute

Value

Description

ACF2 logon ID

This descriptor represents the 8 byte ACF2 logon ID.

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 wildcard characters ? and *.
  • %patternID—Name of a pattern created with the PATTERNDEF statement
  • tableID—Identifies a specific table 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. You can also use this descriptor:

  • As an insert in message definition statements
  • In a substring function
  • In STRINGDEF and PATTERNDEF statements
  • In JLS_LIMITDEF and JLS_CNTLDEF statements
Example
$ACFLID(AB1234)
$ACFLID(JONES)
$ACFLID($TABLE3(*))

For more information, see $ACFSID and $ACFUID.

ACF2 data is only available if the optional ThruPut Manager ACF2 support is installed and activated on your system.

$ACFSID

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

This JAL element has the following attributes:

Attribute

Value

Description

ACF2 Source ID

This descriptor represents the 8 byte ACF2 source id.

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 (-), the period (.), and the wildcard characters ? and *. If pattern contains a blank, or any characters other than those previously listed, it must be enclosed in apostrophes.
  • %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. 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
$ACFSID(READER1)
$ACFSID($TABLE1(SOURCES))

For more information, s ee $ACFLID and $ACFUID.

ACF2 data is only available if the optional ThruPut Manager ACF2 support is installed and activated on your system.

$ACFUID

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

This JAL element has the following attributes:

Attribute

Value

Description

ACF2 UID string

This descriptor represents the 24 byte ACF2 UID string.

Type

Character string descriptor

Maximum length

24 characters

Valid values

  • pattern—Hard-coded string in 1–24 alphabetic, numeric, or national (#, @, $) characters. It can also include the hyphen (-), the period (.), and the wildcard characters ? and *. If pattern contains a blank, or any characters other than those previously listed, it must be enclosed in apostrophes.
  • %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. 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
$ACFUID(OPERATIONS)
$ACFUID(‘CICS TEST #4’)
$ACFUID($TABLE3(OPS))

For more information, see $ACFLID and $ACFSID.

ACF2 data is only available if the optional ThruPut Manager ACF2 support is installed and activated on your system.

$ADDRSPC

$ADDRSPC(REAL | VIRT)

This JAL element has the following attributes:

Attribute

Value

Description

Type of storage request

You can use this logic variable to check the type of storage that the job has requested. The type of storage is set with the ADDRSPC or REGION keyword of the JOB statement or with the SET REGION Action statement.

Type

Logic variable

Maximum Value

Not applicable

Valid values

  • REAL—Returns a TRUE value if central (real) storage was requested.
  • VIRT—Returns a TRUE value if virtual storage was requested.

Usage

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

For more information, see SET REGION.

$BLANK

$Job-Descriptor($BLANK)
or
%stringid($BLANK)

This JAL element has the following attributes:

Attribute

Value

Description

Test for blanks in a field

You can use this reserved word as a pattern to see if a character descriptor is all blank.

Type

Reserved word

Maximum Value

Not applicable

Valid values

  • $Job-Descriptor—A character string descriptor
  • %stringID—Name of a character string created with the STRINGDEF statement

Usage

The $BLANK reserved word is designed to test string character descriptors that are blank.

Example

The Job Property FIELD3_BLANK has a value of TRUE if the third account field was not specified or is all blanks.

EVALUATE FIELD3_BLANK ($ACCTFLD(3,$BLANK))

$BYTES

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

This JAL element has the following attributes:

Attribute

Value

Description

Estimated output bytes

This descriptor represents the estimated number of output bytes.

Type

Range definition descriptor

Maximum value

99999 expressed in 1000s of bytes

Valid values

  • start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified in thousands of bytes as 1–5 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
$BYTES     FEW_BYTES,1000,MANY_BYTES,100000,TOO_MANY_BYTES

For more information, see $CARDS, $LINES, and $PAGES.

This descriptor represents cards and printed output.

$CARDS

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

 This JAL element has the following attributes:

Attribute

Value

Description

Estimated output cards

This descriptor represents the estimated number of output cards.

Type

Range definition descriptor

Maximum Value

9999999 expressed in number of cards

Valid values

  • start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified in number of cards as 1–7 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
$CARDS     NO_CARDS,1,CARDS

For more information, see $BYTES, $LINES, and $PAGES.

$CA7

$CA7(YES | NO)

 This JAL element has the following attributes:

Attribute

Value

Description

CA7–submitted job

You can use this logic variable to determine whether the job was submitted by the CA7 job scheduler. This function returns a TRUE or FALSE value depending on whether the job scheduler submitted it.

Type

Logic variable

Maximum Value

Not applicable

Valid values

  • YES—Returns a TRUE value if the CA7 job scheduler submitted the job, otherwise it returns a FALSE value.
  • NO—Returns a TRUE value if the the CA7 job scheduler did not submit the job, otherwise it returns a FALSE value.

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 ($CA7(YES))
    WTCA7 ...
ELSE
   WTU ...
ENDIF

$CA7_DUEOUT_DATE

$CA7_DUEOUT_DATE

 This JAL element has the following attributes:

Attribute

Values

Description

CA7 due out date

You can use this variable to display a message, in Julian format, the year and date that the job is due out.

Type

Display variable

Maximum length

8 characters

Valid values

$CA7_DUEOUT_DATE—Valid insert in a MSGDEF statement.

Usage

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

For more information, see $CA7 and $CA7_DUEOUT_TIME.

If the job was not submitted by CA7, this descriptor returns zeroes.

$CA7_DUEOUT_TIME

$CA7_DUEOUT_TIME

 This JAL element has the following attributes:

Attribute

Value

Description

CA7 due out time

You can use this variable to display a message, in the format hh:mm, the time that the job is due out.

Type

Display variable

Maximum length

5 characters

Valid value

$CA7_DUEOUT_TIME—Valid insert in a MSGDEF statement.

Usage

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

For more information, see $CA7 and $CA7_DUEOUT_DATE.

If the job was not submitted by CA7, this descriptor returns zeroes.

$CA7_ENTRY

$CA7_ENTRY(method)

 This JAL element has the following attributes:

Attribute

Value

Description

CA7 entry method

You can use this descriptor to determine the method used to bring the job into the CA7 request queue.

Type

Character string descriptor

Maximum length

4 characters

Valid value

method—Is one of the methods by which the job is brought into the CA7 request queue, such as RUN (for a job brought in by the RUN command) or EXTL (for a job submitted external to CA7). The method is matched against the descriptor. If a match occurs, a TRUE value is   returned.

For a list of valid methods, refer to the CA7 supplier-provided documentation.

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

For more information, see $CA7.

If the job was not submitted by CA7, this descriptor returns blanks.

$CA7_INSTANCE_ALIAS

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

 This JAL element has the following attributes:

Attribute

Value

Description

CA7 Tracking Instance Alias

You can use this descriptor to determine the alias of the CA7 tracking instance that submitted the job.

Type

Character string descriptor

Maximum length

4 characters

Valid values

  • pattern—Hard-coded string in 1–4 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.
  • %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. 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
$CA7_INSTANCE_ALIAS(PROD)
$CA7_INSTANCE_ALIAS(PTABLE(NAMES))

For more information, see $CA7 and $CA7_INSTANCE_ID.

Important

 If the job was not submitted by CA7, this descriptor returns blanks.

If the CA7 tracking instance has no alias, this descriptor returns the CA7 instance ID. 

$CA7_INSTANCE_ID

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

This JAL element has the following attributes:

Attribute

Value

Description

CA7 Tracking Instance ID

You can use this descriptor to determine the ID of the CA7 tracking instance that submitted the job.

Type

Character string descriptor

Maximum length

4 characters

Valid values

  • pattern—Hard-coded string in 1–4 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.
  • %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. 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
$CA7_INSTANCE_ID(CA73)
$CA7_INSTANCE_ALIAS(PTABLE(CA7IDS))

For more information, see $CA7 and $CA7_INSTANCE_ALIAS.

If the job was not submitted by CA7, this descriptor returns blanks.   

$CA7_JCLID

$CA7_JCLID

This JAL element has the following attributes:

Attribute

Value

Description

CA7 JCL ID

You can use this variable to display the CA7 job ID in a message.

Type

Display variable

Maximum length

3 characters

Valid values

$CA7_JCLID—Valid insert in a MSGDEF statement.

Usage

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

For more information, see $CA7, $CA7_JOB# and $CA7_SCHID.

If the job was not submitted by CA7, this descriptor returns zeroes. 

$CA7_JOB#

$CA7_JOB#

This JAL element has the following attributes:

Attribute

Value

Description

CA7 Job Number

You can use this variable to display the CA7 job number in a message.

Type

Display variable

Maximum length

4 characters

Valid values

$CA7_JOB#—Valid insert in a MSGDEF statement.

Usage

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

For more information, see $CA7_JCLID and $CA7_SCHID.

If the job was not submitted by CA7, this descriptor returns zeroes. 

$CA7_SCHID

$CA7_SCHID

This JAL element has the following attributes:

Attribute

Value

Description

CA7–schedule ID

You can use this variable to display the CA7 schedule ID in a message.

Type

Display variable

Maximum length

3 characters

Valid values

$CA7_SCHID—Valid insert in a MSGDEF statement.

Usage

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

For more information, see $CA7_JCLID and $CA7_JOB#.

If the job was not submitted by CA7, this descriptor returns zeroes. 

$CHANGED

$CHANGED name (JAL | SAC_TABLE | TABLES)

This JAL element has the following attributes:

Attribute

Value

Description

Check for environment changes

You can use this descriptor to check for changes in the ThruPut Manager environment, such as refreshed JAL or newly disabled or enabled or both tables.

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 (_).
  • JAL—Returns a TRUE value if this is the first invocation of JAL after a /JAL REFRESH operator command, or after ThruPut Manager has been started
  • SAC_TABLE—Returns a TRUE value if this is the first invocation of JAL after a /TBL DISABLE SAC, / TBL ENABLE SAC, or /TBL REFRESH SAC operator command, or after ThruPut Manager has been started.
  • TABLES—Returns a TRUE value if this is the first invocation of JAL after a /TBL DISABLE, /TBL ENABLE, or /TBL REFRESH operator command, or after ThruPut Manager has been started.


Example

This statement evaluates to TRUE the first time JAL is invoked after ThruPut Manager starts, or after a /JAL REFRESH operator command is issued.

PROCEDURE ID(JAL)
...
$CHANGED FIRST_TIME (JAL)

This descriptor is set to FALSE if you check for changes to tables that have never been loaded.

CHARSET

CHARSET %setid (‘chars’)

This JAL element has the following attributes:

Attribute

Value

Description

Define character set

You can use this statement to define sets of characters used with the PATTERNDEFX Definition statement.

Type

Definition statement

Maximum Value

255 characters

Valid values

  • chars—Is 1–255 characters enclosed in single quotes that results in a TRUE value when a character in a descriptor is tested using a PATTERNDEFX statement. Because the string is enclosed in quotes, the set can include a blank character.
  • %setID—Unique identification name for the character set that is created with this statement. The first character must be %, followed by 1–23 alphabetic, numeric, national (#, @, $), or underscore (_) characters.

Usage

A CHARSET definition can be used only in a PATTERNDEFX statement. Each occurrence of the CHARSET name in the PATTERNDEFX statement is compared against one character in the target descriptor.

Example
Assume you want to test for odd digits. The definition would be:

CHARSET    %ODD   (‘13579’)

You could then test for a four digit odd number, for example:

CHARSET     %ODD           (‘13579’)
PATTERNDEFX %TEST_ODD_NUM  (###,%ODD)

For more information, see, PATTERNDEFX.

$CONTROL_M

$CONTROL_M(YES | NO)

This JAL element has the following attributes:

Attribute

Value

Description

CONTROL-M submitted job

You can use this logic variable to determine whether the job was submitted by the Control-M job scheduler. This function returns a TRUE or FALSE value depending on whether the job was submitted by the Control-M job scheduler.

Type

Logic variable

Maximum Value

Not applicable

Valid values

  • YES—Returns a TRUE value if the Control-M job scheduler submitted the job, otherwise it returns a FALSE value
  • NO—Returns a TRUE value if the Control-M job scheduler did not submit the job, otherwise it returns a FALSE value

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 ($CONTROL_M(YES))
 ELSE
   WTU ...
ENDIF

$CONTROL_M_APPL

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

This JAL element has the following attributes:

Attribute

Value

Description

Control-M application name

This descriptor represents the Control-M application name from the APPL= keyword.

Type

Character string descriptor

Maximum Value

8 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 *.
  • %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.

$CONTROL_M_AVG_ELAPSED

$CONTROL_M_AVG_ELAPSED [0,]name1,hh2:mm2,name2[,...,hhN:mmN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Jobs average elapsed time

This descriptor represents the average elapsed time as specified on the AVG_ELAPSED= keyword.

Type

Range definition descriptor

Maximum Value

Not applicable

Valid values

  • hhh:mm—The starting point of a segment. The first starting point must be 0, but can be omitted if desired. Starting points are specified as dates as follows:
    • hhh—The hours (0-999)
    • mm—The minute (0-59)
  • 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.

$CONTROL_M_AVG_CPU

$CONTROL_M_AVG_CPU [0,]name1,hh2:mm2,name2[,...,hhN:mmN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Jobs average CPU time

This descriptor represents the average elapsed time as specified on the AVG_CPU= keyword.

Type

Range definition descriptor

Maximum Value

Not applicable

Valid values

  • hhh:mm—The starting point of a segment. The first starting point must be 0, but can be omitted if desired. Starting points are specified as dates as follows:
    • hhh—The hours (0-999)
    • mm—The minute (0-59)
  • 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.

$CONTROL_M_DUE_IN

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

This JAL element has the following attributes:

Attribute

Value

Description

Date and Time the job needs to start execution

You can use this descriptor to display the CONTROL_M DUE_IN date and time.

Type

Character string descriptor

Maximum length

14 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 *.
  • %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.

$CONTROL_M_DUE_IN_LATE_BY

$CONTROL_M_DUE_IN_LATE_BY [0,]name1,start2,name2[,…,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Time in minutes since the job should have started

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

Type

Range definition descriptor

Maximum Value

9999:00

Valid values

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

$CONTROL_M_DUE_IN_WITHIN

$CONTROL_M_DUE_IN_WITHIN [0,]name1,hh2:mm2,name2[,...,hhN:mmN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Time in minutes until the job should start

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

Type

Range definition descriptor

Maximum Value

9999:00

Valid values

  • hhh:mm—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as dates as follows:
    • hhh—The hours (0-999)
    • mm—The minute (0-59)
  • 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.

$CONTROL_M_FROM_INSTREAM

$CONTROL_M_FROM_INSTREAM(YES | NO)

This JAL element has the following attributes:

Attribute

Value

Description

The job is submitted using JCL that is included in the Control-M job definition itself

This descriptor indicates if FROM INSTREAM was specified. This function returns a TRUE or FALSE value depending on whether or not the job was submitted from INSTREAM.

Type

Logic variable

Maximum length

Not applicable

Valid values

  • YES—Returns a TRUE value if INSTREAM submitted the job, otherwise it returns a FALSE value
  • NO—Returns a TRUE value if INSTREAM did not submit the job, otherwise it returns a FALSE value

$CONTROL_M_FROM_MEMLIB

$CONTROL_M_FROM_OVERLIB(YES | NO)

This JAL element has the following attributes:

Attribute

Value

Description

The job is submitted from an alternate library

This descriptor indicates if FROM OVERLIB was specified. This function returns a TRUE or FALSE value depending on whether the alternate library submitted the job.

Type

Logic variable

Maximum length

Not applicable

Valid values

  • YES—Returns a TRUE value if OVERLIB submitted the job, otherwise it returns a FALSE value
  • NO—Returns a TRUE value if OVERLIB did not submit the job, otherwise it returns a FALSE value

$CONTROL_M_GRP

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

This JAL element has the following attributes:

Attribute

Value

Description

Control-M sub-application name

This descriptor represents the Control-M sub application name from the GRP= keyword.

Type

Character string descriptor

Maximum length

20 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 *.
  • %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.

$CONTROL_M_JCL

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

This JAL element has the following attributes:

Attribute

Value

Description

JCL data set name and optional member name

This descriptor represents the Control-M JCL data set name and optional member name.

Type

Character string descriptor

Maximum length

54 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 *.
  • %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.

$CONTROL_M_ODATE

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

This JAL element has the following attributes:

Attribute

Value

Description

Control-M Order Date

This descriptor represents the order date as specified on the ODATE= keyword.

Type

Character string descriptor

Maximum length

6 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 *.
  • %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.

$CONTROL_M_ORDER_ID

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

This JAL element has the following attributes:

Attribute

Value

Description

Control-M Order Identifier

This descriptor represents the order ID as specified on the ORDER ID= keyword.

Type

Character string descriptor

Maximum length

8 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 *.
  • %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.

$CONTROL_M_PRIORITY

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

This JAL element has the following attributes:

Attribute

Value

Description

Control-M job priority

This descriptor represents the priority as specified on the PRIORITY= keyword.

Type

Character string descriptor

Maximum length

2 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 *.
  • %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 of table support, see DAL-and-JAL-table-management.

$CONTROL_M_PRIORITY_EXCLAMATION

$CONTROL_M_PRIORITY_EXCLAMATION(YES | NO)

This JAL element has the following attributes:

Attribute

Value

Description

The jobs priority urgency

This descriptor indicates that a ! was specified immediately following the priority. This function returns a TRUE or FALSE value depending on whether an exclamation mark followed the job's priority.

Type

Logic variable

Maximum length

Not applicable

Valid values

  • YES—Returns a TRUE value if a ! followed the jobs priority, otherwise it returns a FALSE value.
  • NO—Returns a TRUE value if a ! did not follow the jobs priority, otherwise it returns a FALSE value.

$CONTROL_M_QNAME

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

This JAL element has the following attributes:

Attribute

Value

Description

Control-M task name

This descriptor represents the Control-M subsystem name.

Type

Character string descriptor

Maximum length

8 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 *.
  • %patternID—The 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.

$CONTROL_M_RBC

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

This JAL element has the following attributes:

Attribute

Value

Description

The rule based calendar name

This descriptor represents the rule based calendar name that submitted the job, or "!NORBC" if there is no calendar.

Type

Character string descriptor

Maximum length

20 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 *.
  • %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.

$CONTROL_M_RUN_NO

$CONTROL_M_RUN_NO [0,]name1,start2:mm2,name2[,...,hhN:mmN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Control-M job run number

This descriptor represents the run number as specified on the RUN NO.= keyword.

Type

Range definition descriptor

Maximum value

9999

Valid values

  • start—The starting point of a segment. The first starting point must be 0, but can be omitted if desired.
  • 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.

$CONTROL_M_SCHEDULE

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

This JAL element has the following attributes:

Attribute

Value

Description

Schedule library and optional member name

This descriptor represents the Control-M Schedule data set name and optional member name.

Type

Character string descriptor

Maximum length

54 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 *.
  • %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.

$CONVERTER_ERROR

$CONVERTER_ERROR(YES | NO)

This JAL element has the following attributes:

Attribute

Value

Description

Detect converter error

You can use this descriptor to determine whether the job failed because of the converter error. This is useful only in cases where asymmetric nodes exist, and jobs submitted on one node fail during conversion on that node, although they do not fail on the node at which they actually run.

This function returns a TRUE or FALSE value depending on whether a converter error failed the job.

Type

Logic variable

Maximum value

Not applicable

Valid values

  • YES—Indicates that the job was failed because of an error during JCL conversion
  • NO—The job did not encounter errors during JCL conversion

Usage

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

Example

By testing for a converter error and inserting an appropriate JBS XMIT agent, you can allow the job to remain in the system and ultimately be transmitted to the target node.

IF ($CONVERTER_ERROR(YES))
   JBS ADD BIND(XMIT.NODE2)
   ...

$CPC_TYPE

$CPC_TYPE(pattern | %patid | table-id)
— standard pattern/%patid/table-id information —

This JAL element has the following attributes:

Attribute

Value

Description

Type of CPC

This descriptor represents the 4 digit machine type of the CPC. 

Type

Character string descriptor

Maximum value

4 characters

$CPC_SERIAL

$CPC_SERIAL(pattern | %patid | table-id)
— standard pattern/%patid/table-id information —

This JAL element has the following attributes:

Attribute

Value

Description

CPC serial number

This descriptor represents the serial number of the CPC. 

Type

Character string descriptor

Maximum value

21 characters

$CPU

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

This JAL element has the following attributes:

Attribute

Value

Description

Estimated–CPU time

This descriptor represents the total of the estimated CPU time for all steps in the job or the time specified on the JOB statement (whichever is less).

Type

Range definition descriptor

Maximum value

357912:00

Valid values

  • start—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
$CPU   LOW_CPU,2:30,MEDIUM_CPU,10,HIGH_CPU,60,SPECIAL_CPU

The step CPU values calculated for this descriptor might have been coded directly in JCL, or by step CPU system default, or a combination of both.

For more information, see $JOBCPU, $STEPCPU, and SET CPUCAP.

$CURCLASS | $CRCL

$CURCLASS(class | *)

This JAL element has the following attributes:

Attribute

Value

Description

Current class

This descriptor represents the class in which the ThruPut Manager job analyzer is currently processing the job (the Job Analysis Class or a Deferred Job Analysis Class).

Type

Character string descriptor

Maximum length

8 character

Valid values

  • class—Hard-coded single character from A–Z or 0–9
  • *—Primary Job Analysis Class

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
$CURCLASS(Z)
$CRCL(9)

Important

This is not the Job Submission class.

The use of * allows you to be independent of the specific Job Analysis class. You can alter it without having to change JAL.

For more information, see $INCLASS, $JXCLASS, $XEQCLASS, and SET CLASS.

$CURMSGCLASS

$CURMSGCLASS(class)

This JAL element has the following attributes:

Attribute

Value

Description

Current message class

This descriptor represents the current message class. This can differ from the message class at job submission, since an SOS SET MSGCLASS statement can run during a previous analysis.

Type

Character string descriptor

Maximum length

8 character

Valid value

class—Hard-coded single character from A–Z or 0–9.

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

This returns a TRUE value if the job’s message class is currently set to N.

$CURMSGCLASS(N)

The jobs current message class can differ from the message class at job submission, since an SOS SET MSGCLASS statement might have been executed during a previous analysis.

For more information, see $INMSGCLASS and SOS SET MSGCLASS.

$CURPRIO | $CRPR

$CURPRIO(priority-value)
or
$CURPRIO(low:high)
or
$CURPRIO(low:MAX)

This JAL element has the following attributes:

Attribute

Value

Description

Current priority

This descriptor represents the execution queue priority that the job had at the time it was selected by the Job Analyzer for analysis.

Type

Character string descriptor

Maximum length

6 characters

Valid values

  • priority-value—A value to be tested for equal. It must be in the range of 0–15
  • low—The low end of a range to be tested. It must be in the range 0–14
  • high—Is the high end of a range of priorities. It must be in the range 1–15, and must be higher than low. The value in $CURPRIO must be greater than or equal to low but less than high in order for this descriptor function to evaluate to TRUE
  • MAX—If you want to include jobs with priority 15 use MAX instead of high

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.

Example

This returns a TRUE value if the job’s message class is currently set to N.

$CURPRIO(9)

This function returns a TRUE value only for jobs with a current priority of 9.

$CURPRIO(5:15)

This returns a TRUE value for all jobs with a priority in the range 5 to 14, because the value tested must be less than 15. Note that to specify a range that includes priority 15, you must use the MAX parameter:

$CRPR(5:MAX)

This is not the Job Submission priority.

For more information, see $INPRIO and SET PRIORITY.

$CURRENT_DAY_OF_MONTH

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

This JAL element has the following attributes:

Attribute

Value

Description

Current day of the month

This descriptor provides a number representing the current day of the month.

Type

Range definition descriptor

Maximum value

31

Valid values

  • start—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
$CURRENT_DAY_OF_MONTH  WEEK_1,8,WEEK_2,15,WEEK_3,22,WEEK_4

For more information, see $CURRENT_DAY_OF_WEEK, $CURRENT_DAY_OF_YEAR, $CURRENT_MONTH, $CURRENT_TIME_OF_DAY, and $CURRENT_YEAR.

$CURRENT_DAY_OF_WEEK

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

This JAL element has the following attributes:

Attribute

Value

Description

Current day of the week

This descriptor provides a number representing the current day of the week, with Monday returning a value of 1 and Sunday returning a value of 7.

Type

Range definition descriptor

Maximum value

7

Valid values

  • start—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
$CURRENT_DAY_OF_WEEK  WEEKDAY,6,WEEKEND

For more information, see $CURRENT_DAY_OF_MONTH, $CURRENT_DAY_OF_YEAR, $CURRENT_MONTH, $CURRENT_TIME_OF_DAY, and $CURRENT_YEAR.

$CURRENT_DAY_OF_YEAR

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

This JAL element has the following attributes:

Attribute

Value

Description

Current day of the year

This descriptor provides a number representing the current day of the year, counting from January 1 as day 1. This is the ddd portion of the Julian date (yyddd).

Type

Range definition descriptor

Maximum value

366

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
$CURRENT_DAY_OF_YEAR  Q1,91,Q2,181,Q3,271,Q4

For more information, see $CURRENT_DAY_OF_MONTH, $CURRENT_DAY_OF_WEEK, $CURRENT_MONTH, $CURRENT_TIME_OF_DAY, and $CURRENT_YEAR.

$CURRENT_MONTH

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

This JAL element has the following attributes:

Attribute

Value

Description

Current month

This descriptor provides a number representing the current month, with January returning a value of 1 and December returning a value of 12.

Type

Range definition descriptor

Maximum value

12

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
$CURRENT_MONTH  Q1,4,Q2,7,Q3,10,Q4

For more information, see $CURRENT_DAY_OF_MONTH, $CURRENT_DAY_OF_WEEK, $CURRENT_DAY_OF_YEAR, $CURRENT_TIME_OF_DAY, and $CURRENT_YEAR.

$CURRENT_TIME_OF_DAY

$CURRENT_TIME_OF_DAY   [00:00,]name1,start2,name2[,...,startN,nameN]

This JAL element has the following attributes:

Attribute

Value

Description

Current time of day

This descriptor provides the current time of day in the format hh:mm, using the 24-hour clock.

Type

Range definition descriptor

Maximum value

23:59

Valid values

  • start—The starting point of a segment. The first starting point (if specified) must be 00:00. 
    Starting points are specified in hours and minutes on a 24-hour clock, with 00:00 representing midnight.
  • 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
$CURRENT_TIME_OF_DAY  MORNING,12:00,AFTERNOON,18:00,EVENING

For more information, see $CURRENT_DAY_OF_MONTH, $CURRENT_DAY_OF_WEEK, $CURRENT_DAY_OF_YEAR, $CURRENT_MONTH, and $CURRENT_YEAR.

$CURRENT_YEAR

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

This JAL element has the following attributes:

Attribute

Value

Description

Current year

This descriptor provides a number representing the current year, including the century designation. The format is ccyy, for example 1995.

Type

Range definition descriptor

Maximum value

9999`

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
$CURRENT_YEAR  PRE_1995,1995,YEAR_1995,1996,POST_1995

For more information, see $CURRENT_DAY_OF_MONTH, $CURRENT_DAY_OF_WEEK, $CURRENT_DAY_OF_YEAR, $CURRENT_MONTH, and $CURRENT_TIME_OF_DAY.

$CURSCHENV

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

This JAL element has the following attributes:

Attribute

Value

Description

Scheduling environment

This descriptor represents the scheduling environment in which the ThruPut Manager Job Analyzer is currently processing the job (the scheduling environment for Job Analysis or Deferred Job Analysis).

Type

Character String descriptor

Maximum length

16 characters

Valid values

  • pattern—Hard-coded string in 1–16 alphabetic, numeric, underscore (_), or national (#, @, $) characters. Underscores must be embedded. It can also include 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. 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
$CURSCHENV(PRODUCTION)
$CURSCHENV($TABLE2(ENVIRONS))

If you use $CURSCHENV in JLS_LIMITDEF or JLS_CNTLDEF statements, it is your responsibility to ensure that the result is a valid Control or Limiting Agent name.

For more information, see $IN_SCHENV, $JXSCHENV, and SET SCHENV.

$CURSERVICE_CLASS

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

This JAL element has the following attributes:

Attribute

Value

Description

WLM service class

This descriptor represents the WLM service class in which the ThruPut Manager Job Analyzer is currently processing the job (the service class for Job Analysis or Deferred Job Analysis).

Type

Character string descriptor

Maximum length

8 characters

Valid values

  • pattern—Hard-coded string in 1–8 alphabetic, numeric, underscore (_), or national (#, @, $) characters. Underscores must be embedded. It can also include 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. 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
$CURSERVICE_CLASS(HI_SPEED)
$CURSERVICE_CLASS($TABLE1(WLMCLASS))

If a $ACTIVATE has not been done, $CURSERVICE_CLASS returns blanks.

For more information, see $IN_SERVICE_CLASS, $JXSERVICE_CLASS, and SET SERVICE_CLASS.

$DAL_TEXT_DSNAME

$DAL_TEXT_DSNAME

This JAL element has the following attributes:

Attribute

Value

Description

Display a data set name of currently running DAL

You can use the variable to display the data set name of currently running DAL in a message.

Type

Display variable

Maximum length

44 characters

Valid value

$DAL_TEXT_DSNAME—Valid insert in a MSGDEF statement.

Usage

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

For more information, see $DAL_DESCRIPTION.

$DBS_drivepool

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

This JAL element has the following attributes:

Attribute

Value

Description

JAL ONLY. Maximum number of drives from a DBS drive pool

This descriptor represents the maximum number of tape devices used by any step in the job from the Drive Pool named by the descriptor.

Type

Range definition descriptor

Maximum value

255 drives

Valid values

  • drivepool—Drive Pool, and must be one of the values contained in the table of supported drive pools below.
  • start—The starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as 1–3 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
$DBS_IBM_AUTOMATED_3480  ALLOWED,4,TOOMANY

Supported drive pools

The following table shows the relationship between the drive pools and to the $UNIT-type JAL descriptors. For more information about using JLS and the $UNIT-type descriptors to extend DBS, see DBS and JLS.

Drive pool

Represents the sum Of

$UNIT equivalent

DLM

LUMINEX can be substituted for DLM.

DLM_3480V
DLM_3490V
DLM_3590V

$UNIT_VTS

IBM

IBM_AUTOMATED
IBM_MANUAL
IBM_VIRTUAL

$UNIT_TAPE_ALL

IBM_AUTOMATED

IBM_AUTOMATED_3480S
IBM_AUTOMATED_3490
IBM_AUTOMATED_3590-1

$UNIT_AUTO

IBM_AUTOMATED_3480S

IBM_AUTOMATED_3480
IBM_AUTOMATED_3480X

$UNIT_AUTO_3480

IBM_AUTOMATED_3490

IBM_AUTOMATED_3490_3490E

$UNIT_AUTO_3490E

IBM_AUTOMATED_3590-1

IBM_AUTOMATED_3590-1_3590B
IBM_AUTOMATED_3590-1_3590E
IBM_AUTOMATED_3590-1_3590H
IBM_AUTOMATED_3590-1_3592J

$UNIT_AUTO_3590

IBM_MANUAL

IBM_MANUAL_3400S
IBM_MANUAL_3480S
IBM_MANUAL_3490
IBM_MANUAL_3590-1

$UNIT_REEL
$UNIT_MANUAL_3480
$UNIT_MANUAL_3490
$UNIT_MANUAL_3590

IBM_MANUAL_3490

IBM_MANUAL_3490_3490E
IBM_MANUAL_3490_3592J

$UNIT_MANUAL_3490E

IBM_MANUAL_3590-1

IBM_MANUAL_3590-1_3590B
IBM_MANUAL_3590-1_3590E
IBM_MANUAL_3590-1_3590H
IBM_MANUAL_3590-1_3592J

$UNIT_MANUAL_3590

IBM_VIRTUAL

IBM_VIRTUAL_3490V
IBM_VIRTUAL_3490V_3490E

$UNIT_VTS

STK

STK_AUTOMATED
STK_NON-LIBRARY
STK_VIRTUAL

$UNIT_TAPE_ALL

STK_AUTOMATED

STK_AUTOMATED_3480
STK_AUTOMATED_3490
STK_AUTOMATED_3590-1

$UNIT_AUTO

STK_AUTOMATED_3480_4480

STK_AUTOMATED_3480_4480


STK_AUTOMATED_3490

STK_AUTOMATED_3490_4490
STK_AUTOMATED_3490_9490
STK_AUTOMATED_3490_9490EE
STK_AUTOMATED_3490_SD3
STK_AUTOMATED_3490_9840
STK_AUTOMATED_3490_T9840B
STK_AUTOMATED_3490_T9840C
STK_AUTOMATED_3490_T9940A

$UNIT_AUTO_3490E

STK_AUTOMATED_3590-1

STK_AUTOMATED_3590-1_SD3
STK_AUTOMATED_3590-1_984035
STK_AUTOMATED_3590-1_T9840B35
STK_AUTOMATED_3590-1_T9840C35
STK_AUTOMATED_3590-1_T9940A35

$UNIT_AUTO_3590

STK_NON-LIBRARY

STK_NON-LIBRARY_3480
STK_NON-LIBRARY_3490
STK_NON-LIBRARY_3590-1

$UNIT_MANUAL

STK_NON-LIBRARY_3490

STK_NON-LIBRARY_3490_4490
STK_NON-LIBRARY_3490_9490
STK_NON-LIBRARY_3490_9490EE
STK_NON-LIBRARY_3490_SD3
STK_NON-LIBRARY_3490_9840
STK_NON-LIBRARY_3490_T9840B
STK_NON-LIBRARY_3490_T9840C
STK_NON-LIBRARY_3490_T9940A

$UNIT_MANUAL_3490E

STK_NON-LIBRARY_3590-1

STK_NON-LIBRARY_3590-1_SD3
STK_NON-LIBRARY_3590-1_984035
STK_NON-LIBRARY_3590-1_
T9840B35
STK_NON-LIBRARY_3590-1_
T9840C35
STK_NON-LIBRARY_3590-1_
T9940A35

$UNIT_MANUAL_3590

STK_VIRTUAL

STK_VIRTUAL_3490V
STK_VIRTUAL_3490V_3490E

$UNIT_VTS

STK_VIRTUAL_3490V

STK_VIRTUAL_3490V_3490E

$UNIT_VTS

VTAPE

VTAPE_3480
VTAPE_3490E

$UNIT_VTS

VTFM

VTFM_3480
VTFM_3490E

$UNIT_VTS

DBS SET

DBS SET [PRIORITY(LOW | MEDIUM | HIGH)]
       [WORKGROUP(name)]

This JAL element has the following attributes:

Attribute

Value

Description

Set DBS work group and priority

You can use this statement to set the DBS work group and priority for a job.

Type

Action statement

Maximum value

Not applicable

Valid values

  • PRIORITY(LOW | MEDIUM | HIGH)—Sets the DBS priority for this job. When drive contention occurs, DBS priority is used to determine which job gets the device. The DBS priority does not apply if the job is managed by SLM.
    • LOW—Set a low priority.
    • MEDIUM—(Default) Set a medium priority.
    • HIGH—Set a high priority.
  • WORKGROUP(name)—Assigns the job to a specific DBS work group. This name must be one of the six subgroup names specified in the DBS policy.
  • name—Identifies a subgroup of a work group.

Important

If jobs in different DBS work groups are assigned the same DBS priority, jobs in the lower numbered Work group (as shown in the DBS configuration dialog) are selected first.

If no work group name is specified or the DBS work group doesn’t exist in the ACTIVE policy, the job is assigned to the default work group that was set for the active policy in the DBS configuration dialog and message DTM7418I is issued to the console log.

If multiple DBS SET statements are encountered, the last encounter of the keyword (PRIORITY or WORKGROUP) is effective.

Settings assigned with this statement override the equivalent settings assigned with the JECL statement //*+DBS SET.

For more information, see $JXDBS_PRIORITY and $JXDBS_WORKGROUP.

$DCJECL

$DCJECLname(JECL-statement-type | ANY)

This JAL element has the following attributes:

Attribute

Value

Description

DCS ONLY. Detect DCS JECL usage

This descriptor lets you determine whether or not a particular DCS control statement is present in the job input stream.

Type

Unique descriptor

Maximum value

Not applicable

Valid values

  • name—Unique property name assigned to 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 (_).
  • JECL-statement-type—A list of DCS JECL statements to be detected. The descriptor returns a value of TRUE if a match occurs for any element in the list. The possible values are:
    • ALERT
    • NAG
    • REPO
    • SERVICE
  • ANY—This subparameter is a short form for a list including all the possible values. It is mutually exclusive with the sub parameters listed above.

Usage

You cannot use this unique descriptor with any other statement.

Example
$DCJECL REPO_USER (REPO)
...
IF (REPO_USER)
  WTU ...

DCS ALERT

DCS ALERT [alert-name] [TIME(mmm)]

This JAL element has the following attributes:

Attribute

Value

Description

DCS ONLY. Defines the time for an ALERT

This action statement allows you to request that an ALERT be generated for the jobs after the specified number of minutes has passed without resolving a data set contention situation. The Alert is directed to the destination specified in the Alert definition statement DCS_ALERTDEF. If no destination   was specified it is directed to the default destination for ALERTS. This can be specified by your installation in the DCS initialization statement DCS SET. The built-in default destination name is DCSALERT.

Type

Action statement

Maximum value

Not applicable

Valid values

  • alert-name—(Optional) The name of a DCS_ALERTDEF statement that describes the headers, footers, and destination for the Alert. 
  • TIME(mmm)—Specifies the time, in minutes, that must elapse, before the ALERT is generated. The time interval begins when the job initiation process detects a data set contention situation. If this keyword is omitted, the default ALERT time is used. The time default can be specified by your installation in the DCS initialization statement DCS SET. The built-in default is 10 minutes.
  • mmm—A value from 0 to 999.

Usage

You can use this statement only in JAL Logic.

Example

In this example an Alert is generated if the job is in data set contention for 20 minutes.

DCS ALERT PRODUCTION_JOB TIME(20)

For more information, see $DCJECL, DCS_ALERTDEF, DCS_NAGDEF, and DCS NAG.

Important

If more than one DCS ALERT statement is executed for a job, the last one takes effect.

If the job has a JECL statement requesting the Alert, the JECL ‘DCS ALERT’ statement takes precedence. You can determine if the job has a JECL ‘DCS ALERT’ statement by testing the variable $DCJECL.

The Alert mechanism, if requested, becomes active every time a job is selected for execution and initiation cannot proceed because of data set contention. As a result, a job can generate more than one Alert before it is executed.

DCS_ALERTDEF

DCS_ALERTDEF alert-name [DEST(dest-name) | CA7LTERM(term-name)]
                       [HEADER(‘header-text’)] [HEADER(‘header-text’)]
                       [FOOTER(‘footer-text’)] [FOOTER(‘footer-text’)]

This JAL element has the following attributes:

Attribute

Value

Description

DCS ONLY. Define alert format

This statement allows you to define the destination for an Alert and to provide headers and footers to envelop the Alert text automatically generated by DCS.

Type

Definition statement

Maximum value

Not applicable

Valid values

  • alert-name—(Positional and Required) Unique name identifier used in the DCS ALERT action statement in 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. The first character must be alphabetic or national. The first character cannot be a dollar sign ($) or underscore (_).
  • CA7LTERM(term-name)—Direct the ALERT to a CA7 logical terminal. This keyword is mutually exclusive with the DEST keyword. The short form for this keyword is CA7.
    • term-name—A 1–8 character CA7 logical terminal name.
  • DEST(dest-name)—Specifies a destination name. This keyword is mutually exclusive with the CA7LTERM. If this keyword is omitted, the destination default for ALERTS is used.
    • dest-name—A string of 1–8 characters. They must be alphabetic, national, or numeric. This is the name used to associate the ALERT with a writer.
  • HEADER(header-text)—Indicates that you want to provide a header to the standard ALERT format generated by DCS. You can add two header lines to the Alert. They are printed in the order that you code them.
    • header-text—The text printed in the header or footer. The maximum length is 70 characters. The text may consist of a combination of hard-code characters enclosed in apostrophes and character type descriptors to be substituted for the values when the Alert is constructed. See the Notes below for a list of the descriptors that are allowed as part of the text.
  • FOOTER(footer-text)—Indicates that you want to provide a footer to the standard ALERT format generated by DCS. You can add two footer lines to the Alert. They are printed in the order that you code them.
    • footer-text—The text to be printed in the header or footer. The maximum length is 70 characters. The text may consist of a combination of hard-code characters enclosed in apostrophes and character type descriptors to be substituted for the values when the Alert is constructed. See the Notes below for a list of the descriptors that are allowed as part of the text.

Usage

You can use this statement only in JAL Definition.

Example
DCS_ALERTDEF PAYROLL_JOB DEST(JOBCONT)
DCS_ALERTDEF PAYROLL_JOB HEADER(‘***NOTIFY PAYROLL DEPT***’) +
                          HEADER(‘******EXTENSION 333******’) DEST(JOBCONT)

For more information, see $DCJECL, DCS_NAGDEF, DCS ALERT, and DCS NAG.

The following descriptors are allowed as part of the text for headers and footers:

•  $ACCT

•  $INRMT

•  $NJEUSER | $NJEU

•  $ROOM

•  $ACCTFLD | $ACCTF

•  $INSYSAFF

•  $NOTIFY

•  $SUBMITTER_RACFG

•  $ACFLID

•  $INSYSID

•  $PGMR

•  $SUBMITTER_RACFU

•  $ACFSID

•  $JALNODE

•  $RACFG | $RG

•  $SUBMITTER_TSSU

•  $ACFUID

•  $JALSYS

•  $RACFU | $RU

•  $TSSUSER | $TSSU

•  $DISPLAY_name

•  $JOBNAME | $JOBN

•  $USERCnn

•  $INDEVICE | $INDEV

•  $JOBID

•  $READER_DATE

•  $INNODE

•  $JOBNUMBER | $JOBNUM

•  $READER_TIME

DCS NAG

DCS NAG dcnagdef-name USERID(pattern[,...,pattern])
                     [REPEAT([iterations][,interval])]
  or
DCS NAG $DEFAULT      USERID(pattern[,...,pattern])
                     [REPEAT([iterations][,interval])]
  or
DCS NAG $SUPPRESS     USERID(pattern[,...,pattern])

This JAL element has the following attributes:

Attribute

Value

Description

DCS ONLY. NAG data set holder

This communication statement allows you to issue a customized “nagging” message to TSO users holding a data set that is causing conflicts.

You can code multiple DCS NAG statements per job. This allows you to issue different “nagging” messages to different holders. It also allows the suppression of “nagging” to particular holders.

Type

Communication statement

Maximum value

Not applicable

Valid values

  • dcnagdef-name—The name of a DCS_NAGDEF statement that describes the text of the nagging message.
  • $DEFAULT—You can use this keyword if you do not want to change the default nagging text.
  • USERID(pattern[,...,pattern])—(Required) Indicates that the nagging is only applicable to TSO users that match the user ID pattern specified.
    • pattern—A 1–7 character matching pattern for a TSO user ID. It can be either a hard-coded string or a %patternID. You can specify up to 5 patterns in one DCS NAG statement. 
      The pattern matching rules are as follows:
      • If a list of patterns is provided the matching analysis always proceeds from left to right.
      • If more than one DCS NAG request is present for the same data set, the matching analysis handles the requests in the same order in which they were made.
      • The first specific user ID match is honored. That is, if any of the specified patterns represents a complete user id (7 characters), an attempt is made to match it with the TSO user holding the data set. As soon as a specific user id match occurs the search is stopped. This process includes all the elements in a list for a DCS NAG request and all the DCS NAG requests for the same data set.
      • If there is no specific match, then a pattern match is attempted. As soon as a match occurs the search is stopped.
        If you want the customized nagging to apply to all TSO users causing contention, code USERID(*).
  • REPEAT([iterations][,interval])—(Optional) Specifies the number of nagging times or the frequency or both of the nagging. If this keyword is omitted, the default values are used.
    • iterations—A numeric value from 1–99 that indicates the number of times DCS is to nag the data set holder. If this value is not specified the default value is used. You can specify an installation value in the DCS statement DCS SET. The built-in value is 3 times.
    • interval—A numeric value from 1–99, expressed in minutes, that represents the interval between nagging messages. If this value is not specified the default value is used. You can specify an installation value in the DCS statement DCS SET. The built-in value is 5 minutes.
  • $SUPPRESS—Indicates that nagging is to be suppressed for TSO users that match the patterns specified. You can suppress all nagging by coding: DCS NAG $SUPPRESS USERID(*)

Usage

You can use this communication statement only in the Logic Section of JAL.

Example
DCS NAG LIB_NAG USERID(AP*) REPEAT(10,2)

For more information, see $DCJECL and DCS_NAGDEF.

Important

Requests to nag from JECL take precedence over DAL.

Requests to nag from DAL take precedence over JAL.

DCS_NAGDEF

DCS_NAGDEF nagdef-name (‘nag-text’)

This JAL element has the following attributes:

Attribute

Value

Description

DCS ONLY. Define NAG text

You can use this statement to customize the second line of a message that is generated to a holder, or holders of a data set in contention status.

Type

Definition statement.

Maximum value

Not applicable

Valid values

  • nagdef-name—(Positional and Required) Unique name identifier used in the DCS NAG action statement in 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. The first character must be alphabetic or national. The first character cannot be a dollar sign ($) or underscore (_).
  • nag-text—The text to be printed as the second line of a NAG to TSO data set holders. The maximum length is 120 characters. The text can consist of a combination of:
    • Hard-coded characters enclosed in apostrophes
    • Character type descriptors to be substituted for the values when the NAG is generated
    • STRINGDEF definition statements

Usage

You can use this statement only in the JAL Definition Section.

Example
DCS_NAGDEF PROC_NAG (‘YOU ARE HOLDING PROCLIB-JOB ‘,$JOBNAME,’ NEEDS IT’)
STRINGDEF %NAME1 ($PGMR,5)
DCS_NAGDEF NAG (‘APPLICATION ID ‘,%NAME1)

For more information, see $DCJECL, DCS_ALERTDEF, DCS ALERT, DCS NAG and STRINGDEF.

The descriptors listed below are allowed as part of the text:

•  $ACCT

•  $ACCTFLD

•  $ACFLID

•  $ACFSID

•  $ACFUID

•  $DISPLAY_name

•  $INDEVICE

•  $INNODE

•  $INRMT

•  $INSYSAFF

•  $INSYSID

•  $JALNODE

•  $JALSYS

•  $JOBID

•  $JOBNAME

•  $JOBNUMBER

•  $NJEUSER $ROOM

•  $NOTIFY $SUBMITTER_RACFG

•  $PGMR $SUBMITTER_RACFU

•  $RACFG $SUBMITTER_TSSU

•  $RACFU $TSSUSER

•  $USERCnn

•  $READER_DATE

•  $READER_TIME

•  $NJEUSER

•  $ROOM

DCS RECORD

DCS RECORD REPORTID(‘hard-coded-string’ | %stringid)

This JAL element has the following attributes:

Attribute

Value

Description

DCS ONLY. Requests recording of contention data

This action statement allows you to request the recording of contention data for the job. For contention records to be created the following conditions must be met:

  • A contention situation occurs for the job
  • RECORDING was requested for the job
  • DCS recording services were activated. This is done with the TMSS FILE CMF initialization statement

With the DCS RECORD statement, you can associate a 16-character string with the job. This string can then be used with the DCS reporting system to decide which jobs to include in the reports. 

If more than one DCS RECORD statement is encountered, the last one takes effect.

Type

Action statement

Maximum length

16 bytes

Valid values

  • REPORTID(‘hard-coded-string’ | %stringid)—Associates a character string with the job for report selection.
    • hard-coded-string—Hard-coded string of 1–16 characters enclosed in apostrophes, included in the string by coding two consecutive apostrophes.
  • %stringID—Specifies the name of a dynamically constructed character string that has been defined with a STRINGDEF statement. The length can be up to 16 characters. If the length is greater than 16 a warning message is issued and the string is truncated to 16 characters.

Usage

This action statement can only be used in the logic section of JAL.

Example

IF ...
 DCS RECORD REPORTID(PRODUCTION)
...
IF...
 DCS RECORD REPORTID(TEST)
...

In this case, recording is requested for the job. The REPORTID allows to be selective when producing reports. For example, you can select all jobs with the REPORTID of ‘PRODUCTION’.

Since you are allowed to specify a %stringid, you can use character descriptors from the job to form the REPORTID. This approach gives you complete flexibility in the report selection process. For example:

STRINGDEF %SEL_ID ($JOBNAME) || ($RACFU)
STRINGDEF %SEL_ID_P (%SEL_ID) || (‘P’)
STRINGDEF %SEL_ID_T (%SEL_ID) || (‘T’)
...
IF .../*PRODUCTION JOB*/
DCS RECORD REPORTID(%SEL_ID_P)
...
IF... /*TEST JOB*/
DCS RECORD REPORTID(%SEL_ID_T)
...

In this case the REPORTID contains the job name, the RACF user id, and a ‘P’ or a ‘T’ to distinguish production jobs from test jobs. The string can then be used for report selection.

DCS REPO <Parm>

DCS REPO USERID(pattern[,...,pattern]) [INPUT | EXCLUDE]

This JAL element has the following attributes:

Attribute

Value

Description

DCS ONLY. Request data set repossessing

You can use this action statement to request repossessing data sets from TSO users. You can specify the TSO users to repossess from. You can also request that a particular user, or users, be excluded from any repossessing. DCS REPO statement does not take effect for GDG data sets.

Type

Action statement

Maximum value

Not applicable

Valid values

  • USERID(pattern[,...,pattern])—(Required) Specifies which TSO users are to be affected by the repossessing statement.
    • pattern—A 1–7 character matching pattern for a TSO user ID. It can be either a hard-coded string or a %patternID. You can specify up to 5 patterns in one DCS REPO statement. The pattern matching rules are as follows:
      • If a list of patterns is provided the matching analysis always proceeds from left to right.
      • If more than one DCS REPO request is present for the same data set, the matching analysis handles the requests in the same order as they were made.
      • The first specific user ID match is honored. That is, if any of the specified patterns represents a complete user ID (7 characters), an attempt is made to match it with the TSO user holding the data set. A soon as a specific user id match occurs the search is stopped. This process includes all the elements in a list for a DCS REPO request and all the DCS REPO requests for the same data set.
      • If there is no specific match, then a pattern match is attempted. As soon as a match occurs the search is stopped.
  • INPUT—Indicates that data sets opened for input are to be repossessed. If this keyword is not coded, only data sets that are not opened are repossessed. This keyword is mutually exclusive with EXCLUDE.
  • EXCLUDE—Indicates that the specified TSO user IDs are to be excluded from any data set repossessing. This keyword is mutually exclusive with INPUT.

Usage

This action statement can be used only in the Logic Section of JAL.

Example

In this example repossessing for data sets opened for input can take place for TSO users with ids starting with AP8 and AP9.

DCS REPO USERID(AP8*,AP9*) INPUT

For this statement to take effect, you must have coded CLAIM(R) as the last element of the DCS SERVICE request.

For more information, see $DCJECL and DCS SERVICE.

DCS SERVICE<Parm>

DCS SERVICE (serv-level(interval),...,serv-level(interval),serv-level)
or
DCS SERVICE serv-level

This JAL element has the following attributes:

Attribute

Value

Description

DCS ONLY. Request data set service

You can use this action statement to define the data set contention service level for a job. If more than one statement is encountered for an execution of JAL, the last one determines the service level. 

You can request service level with JECL statements from the job stream, precedence rules are required. They are as follows:

  • ‘/*DCS SERVICE’ JECL statement for data set, if present
  • ‘/*DCS SERVICE’ JECL statement for job, if present
  • DAL request, if made
  • JAL request, if made
  • Installation default, if set (DCS SET initialization statement)
  • DCS system default. It is ‘STANDBY’

Type

Action statement

Maximum value

Not applicable

Valid values

  • serv-level(interval)—The name of a data set service level. It can be one of the following:
  • CLAIM, CONTEND, STANDBY, or $DEFAULT—You can include a list of up to 7 service level terms. Each one of them, with the exception of the last one in the list, must include a time interval.
    DCS will attempt to service the data set (or data sets) using the first service level coded. Once the interval for that service level has expired, the service level is altered to reflect the value of the next element in the list. When the last element of the list is reached, DCS will remain at this service level until the request is honored.
    The last element of the list cannot have an interval time coded since DCS will maintain that service level until the data set becomes available.
    If you want to request data set repossessing you must code CLAIM(R) as the last element in the list. This represents a request to DCS to repossess data sets from TSO users that have the data set allocated but not in use (opened).
    If you also want repossessing of data sets that are opened for input you must code a DCS REPO statement in addition to CLAIM(R) in the SERVICE statement.
    Repossession will not take effect for GDG data sets. For an explanation of data set service and repossessing, refer to the System Programming Guide: TM/ DCS Component .
  • interval—A time interval from 1–999 minutes. It specifies the time that DCS is to keep a particular service level. The last element in the service list cannot have an time interval coded.

Usage

You can use this statement only in JAL Logic.

Example

In this example the initial service requested is STANDBY. If a contention situation occurs and has not been satisfied in 35 minutes, the service is upgraded to CLAIM.

DCS SERVICE (STANDBY(35),CLAIM)

In this example, for the first 30 minutes the default service level is used. After 30 minutes the service is upgraded to CLAIM with the repossessing attribute.

DCS SERVICE ($DEFAULT(30),CLAIM(R))

For more information, see $DCJECL and DCS REPO.

DCS SET

DCS SET MAX_DATASETS(nn)

This JAL element has the following attributes:

Attribute

Value

Description

DCS ONLY. 
Defines the maximum contentions to be managed for this job, allowing you to request the DCS report contentions for a limited number of data sets per job. The default is 11 contentions.

Type

Action statement

Maximum value

99

Valid values

nn—A value from 0 to 99.

Usage

You can use this statement only in JAL Logic.

Example

In this example, the contention count is increased to 25. 

DCS SET MAX_DATASETS(25)

Important

Increasing this number might cause additional overhead.

Use this statement only when necessary and for specific jobs.

DCS SET<Parm>

DCS SET DR(NO | YES)
       DSENQSHR(ALLOW | DISALLOW)

This JAL element has the following attributes:

Attribute

Value

Description

DCS ONLY. Control data set reservation processing and disposition.

You can use this action statement to control whether DCS uses data set reservation support for a job and indicates changes in data set disposition.

Type

Action statement

Maximum value

Not applicable

Valid values

  • DR(NO | YES)—Controls data set reservation processing support by DCS.
    • NO—Indicates that DCS should not obtain an ENQ during job initiation for the absolute data set name associated with a generation data set, or the real data set name associated with an alias.
    • YES—Indicates that DCS should obtain an ENQ during job initiation for the absolute data set name associated with a generation data set, or the real data set name associated with an alias. The DCS SET DR statement has no effect unless data set reservation support has been activated with a DCS SET DR(YES) initialization statement.
  • DSENQSHR(ALLOW | DISALLOW)—Indicates how the system treats changes in data set disposition.
    • ALLOW—Indicates that the system might change the serialization on the data set to shared control.
    • DISALLOW—Indicates that the system is not allowed to change the serialization on the data set to shared control.

Important

If more than one DCS SET statement runs for a job, the last one takes effect. This allows you to undo the effect of a previous DCS SET DR(NO) statement.

If more than one DCS SET statement runs for a job, the last one takes effect. This allows you to undo the effect of a previous DCS SET DSENQSHR(ALLOW) statement.

If no DCS SET statement runs, data set reservation support for a particular job is determined by the setting of the DCS SET initialization statement.

For more information, see $JXDCS_DR.

$DDREF<Parm>

$DDREF name [DDNAME(pattern | %patid | table-id) [DDTYPE(type)]]
           [DSNAME(pattern | %patid | table-id) [MEMBER(pattern | %patid |
            table-id)]]
           [SUBSYS(pattern | %patid | table-id)]

This JAL element has the following attributes:

Attribute

Value

Description

Dataset Name, DDNAME, DD Type, or DD SUBSYS

You can use this descriptor to determine whether a particular DDNAME or particular data set name pattern or both exists in the job JCL stream. You can also determine the use of the SUBSYS keyword and the type of DD statement. When you code more than one keyword it is treated as an ‘AND’ condition. For example, if you code DDNAME and DSNAME, then both must match for the Job Property to be TRUE.

Type

Unique descriptor

Maximum value

Not applicable

Valid values

  • name—Specifies the Property Name to be assigned a value of TRUE or FALSE. This name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_).
  • DDNAME(pattern | %patternID | tableID)—Indicates that you want to check for a particular DDNAME value. You can also use DDN as a short form.
    • pattern—Hard-coded string in 1–8 alphabetic, national (#, @, $), or numeric characters, the first of which must be alphabetic or national. It can also include the wildcard characters ? and *.
    • %patternID—Name of a pattern created with the PATTERNDEF statement
    • tableID—Identifies a specific table and how it to search
      The pattern, %patID, or tableID entry ise matched against the DD names in the job stream. If a match occurs, a TRUE value is returned. Otherwise the value is FALSE.

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

DDTYPE(type)

Value

Description

DDTYPE

Tests the type of DD statement associated with a particular DD name. This keyword is mutually exclusive with DSNAME or SUBSYS keywords. If you code this keyword then DDNAME must also be specified.

type

The actual DD type you want to check for. The following values are allowed:

  • DUMMY
  • INSTREAM
  • SUBSYS
  • SYSOUT
  • TEMPORARY
  • PERMANENT

These subparameters are all self-explanatory.

DSNAME(pattern | %patternID | table-id)

Value

Description

DSNAME

Checks for a particular data set name pattern. The pattern is matched with the names of data sets in the job stream. You can also use DSN as a short form. This keyword and the DDTYPE keyword are mutually exclusive.

pattern

Hard-coded data set name pattern, following the data set pattern conventions as described in Character-string-facilities-tutorial.

%patternID

Name of a pattern created with a PATTERNDEF statement.

tableID

Identifies a specific table and how to search

The pattern, %patternID, or tableID entry is matched against the data set names in the job stream. If a match occurs, a TRUE value is returned. Otherwise the value is FALSE.

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

MEMBER(pattern | %patternID | table-id)

Value

Description

MEMBER

Indicates that you want to check for a particular member name pattern for a partitioned data set.

pattern

Hard-coded string in 1–8 alphabetic, national (#, @, $), or numeric characters, the first of which must be alphabetic or national. It can also include the wildcard characters ? and *.

%patternID

Name of a pattern created with the PATTERNDEF statement

tableID

Identifies a specific table and how to search

 The pattern, %patternID, or tableID entries are matched against the member names in the job stream. If a match occurs, a TRUE value is returned. Otherwise the value is FALSE.

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

SUBSYS(pattern | %patid | table-id)

Value

Description

SUBSYS

Indicates that you want to check for a specific subsystem name. This keyword and the DDTYPE keyword are mutually exclusive.

pattern

Hard-coded string in 1–4 alphabetic, national (#, @, $), or numeric characters, the first of which must be alphabetic or national. It can also include the wildcard characters ? and *.

%patternID

Name of a pattern created with the PATTERNDEF statement

tableID

Identifies a specific table and indicates how it is to be searched

The pattern, %patternID, or tableID entry is matched against the DD SUBSYS names in the job stream. If a match occurs, a TRUE value is returned. Otherwise the value is FALSE.

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 cannot use this unique descriptor with any other statement and can be used only in the Definition Section of JAL.

Example


$DDREF  IDMS   DDNAME(IDMSCKPT) DSN(**.CKPT.**)
$DDREF  JOBLIB DDNAME(JOBLIB)
$DDREF  PRODUCTION_DATASETS DSNAME($TABLE1(PRODDSNS))
$DDREF  SUBSYS01 DDNAME(VECTOR) SUBSYS(VP01)

Important

If both keywords DDNAME and DSNAME are specified, both must be matched in order for this descriptor function to evaluate as TRUE. That is, the DDNAME pattern and the data set name pattern are matched in the same JCL DD statement.

When you code the TYPE keyword the DDNAME keyword is mandatory. Again, for this descriptor to evaluate TRUE the DDNAME and DDTYPE must match in the same JCL DD statement.

You can combine SUBSYS with DDNAME and/or DSNAME.

$DDSYSOUT<Parm>

$DDSYSOUT name DDNAME(pattern | %patid | table-id)
              [CLASS(output-class)]
              [FORMS(pattern | %patid | table-id)]
              [HOLD(YES | NO)]
              [WRITER(pattern | %patid | table-id)]

This JAL element has the following attributes:

Attribute

Value

Description

SYSOUT characteristics for a DD statement

You can use this descriptor determine if a particular DD SYSOUT has certain characteristics. The characteristics specified represent an ’AND’ condition. That is, they all must be true for the descriptor to return a TRUE value.

Type

Unique descriptor

Maximum value

Not applicable

Valid values

  • name—Specifies the Property Name to be assigned a value of TRUE or FALSE. This name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_).
  • DDNAME(pattern | %patternID | tableID)—Indicates that you want to check for a particular DDNAME value. You can also use DDN as a short form. This keyword is mandatory.
    • pattern—Hard-coded string in 1–8 alphabetic, national (#, @, $), or numeric characters, the first of which must be alphabetic or national. It can also include the wildcard characters ? and *.
    • %patternID—Name of a pattern created with the PATTERNDEF statement
    • tableID—Identifies a specific table and how it is to be searched

The pattern, %patternID, or tableID entry is matched against the SYSOUT DD names in the job stream. 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.

CLASS(output-class)

Value

Description

CLASS

Determines how the output class was coded for a SYSOUT DD statement.

output-class

A single character from the range A–Z, or 1–9, or *, or $.

FORMS(pattern | %patternID | table-id)

Value

Description

FORMS

Detects if a particular form-name pattern is associated with this SYSOUT DD statement.

pattern

Hard-coded string in 1–4 alphabetic, numeric, or national characters. It can also include the wildcard characters ? and *.

%patid

Name of a pattern created with the PATTERNDEF statement

tableID

Identifies a specific table and how it is to be searched

The pattern, %patternID, or tableID entry is matched against the form-names coded on the SYSOUT DD statements. 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.

HOLD(YES | NO)

Value

Description

HOLD

Detects if HOLD was specified for a particular SYSOUT DD statement.

YES | NO

Self-explanatory.

WRITER(pattern | %patid | table-id)

Value

Description

WRITER

Detects if a particular writer-name is associated with a SYSOUT DD statement.

pattern

Hard-coded string in 1–8 alphabetic, national (#, @, $), or numeric characters, the first of which must be alphabetic or national. It can also include the wildcard characters ? and *.

%patternID

Name of a pattern created with the PATTERNDEF statement.

tableID

Identifies a specific table and how it is to be searched

The pattern, %patternID, or tableID entry is matched against the writer names coded on the SYSOUT DD statements. 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 cannot use this unique descriptor with any other statement and can be used only in the Definition Section of JAL.

Example

The DDNAME is a required keyword and must be accompanied by at least one of the other keywords.

$DDSYSOUT  REPORT_HELD   DDNAME(REPORT) HOLD(YES)
$DDSYSOUT  PAY_FORMS  DDNAME(*) FORMS($TABLE1(PAYFORMS))

$DISPLAY_name

This JAL element has the following attributes:

Attribute

Value

Description

$DISPLAY_name. Display JAL and ThruPut Manager information

You can use this display variable to insert certain JAL and ThruPut Manager related information into messages.

Type

Display variable

Maximum value

Not applicable

Valid values

  • name—Varies depending on the information desired. It can be one of the following:
    • JAL_CREATE_DATE—Display the time the JAL was created, in the Julian format ccyy.ddd
    • JAL_CREATE_TIME—Displays the time the JAL was created, in the format hh:mm:ss
    • JAL_VERSION—Displays the version of the Language Processor used to create the JAL, in the format Vv Rr.r. For example, V4 R1.0.
    • TM_VERSION—Displays the version of ThruPut Manager, in the format Vv Rr.r. For example, V4 R1.0.

Usage

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

Example


MSGDEF JAL_INFO (‘JAL created on ‘,$DISPLAY_JAL_CREATE_DATE) LOG

$DJC_CLOSE

$DJC_CLOSE(YES | NO)

This JAL element has the following attributes:

Attribute

Value

Description

DJC ONLY. DJC group CLOSE indicator

This Logic variable allows you to determine whether the DJC GROUP JECL statement included the CLOSE keyword.

This function call returns a TRUE or FALSE value depending on whether the JECL statement DJC GROUP is a CLOSE keyword coded.

Type

Logic variable

Maximum value

Not applicable

Valid value

  • YES—Returns a TRUE value if the CLOSE keyword is coded on the DJC GROUP JECL statement.
  • NO—Returns a TRUE value if the CLOSE keyword is not coded on the DJC GROUP JECL statement.

Usage

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

Example


IF ($DJC_CLOSE(YES))
  ...

$DJC_CLOSE_TIME

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

This JAL element has the following attributes:

Attribute

Value

Description

DJC ONLY. Number of hours a DJC group remains open

This descriptor represents the maximum number of hours a DJC Group remains open if no job or operator command requests that it be closed.

Type

Range definition descriptor

Maximum value

99 expressed in hours

Valid values

  • start—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. Note that the first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a property name for ranges 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 there was no CLOSE_TIME keyword coded on the DJC GROUP JECL statement, the value returned is 0. The absence of a CLOSE_TIME keyword does not indicate that the DJC Group does not have an associated CLOSE_TIME period. The CLOSE_TIME period could have been specified on another job in the DJC Group.

$DJC_CLOSE_TIME NO_CLOSE_TIME,1,GOOD_CLOSE_TIME,25,CLOSE_TIME_TOO_LONG

$DJC_GROUP

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

This JAL element has the following attributes:

Attribute

Value

Description

DJC ONLY.  Name of DJC group for the Job

This descriptor allows you to determine the name of the DJC group for the job. If the job does not include a DJC GROUP JECL statement, the $DJC_GROUP descriptor returns blanks.

Type

Character string job descriptor

Maximum length

17 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 *.
  • %patternID—Name of a pattern created with the PATTERNDEF statement.
  • tableID—Identifies a specific table and which subtable is to be searched.

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

$DJC_HISTORY_COUNT

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

This JAL element has the following attributes:

Attribute

Value

Description

DJC ONLY. Number of Levels of DJC Group History

This descriptor represents the maximum number of levels of history retained for the history of a DJC Group.

Type

Range definition descriptor

Maximum value

9 expressed in levels

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. Note that the first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a property name for ranges 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


$DJC_HISTORY_COUNT NO_HISTORY_COUNT,1,GOOD_HISTORY_COUNT,3,HISTORY_COUNT_TOO_HIGH

Important

If there was no HISTORY_COUNT keyword coded on the DJC GROUP JECL statement, the value returned is 0. The absence of a HISTORY_COUNT keyword does not indicate that the DJC Group does not have an associated HISTORY_COUNT parameter. The HISTORY_COUNT keyword could have been specified on another job in the DJC Group, or it could be taken from the defaults specified by the DJC SET operator command.

DJC Group history is also limited by the HISTORY_DAYS keyword. A DJC Group history can therefore expire before HISTORY_COUNT is reached.

For more information, see $DJC_HISTORY_DAYS.

$DJC_HISTORY_DAYS

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

This JAL element has the following attributes:

Attribute

Value

Description

DJC ONLY. Number of days to keep DJC group history 

This job descriptor represents the maximum number of days the history of a DJC Group is retained.

Type

Range Definition Job descriptor

Maximum value

365 expressed in days

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. Note that the first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a property name for ranges 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


$DJC_HISTORY_DAYS NO_HISTORY_DAYS,1,HISTORY_DAYS_OK,25,TOO_MANY_HISTORY_DAYS

Important

If there was no HISTORY_DAYS keyword coded on the DJC GROUP JECL statement, the value returned is 0. The absence of a HISTORY_DAYS keyword does not indicate that the DJC Group does not have an associated HISTORY_DAYS period. The HISTORY_DAYS period could have been specified on another job in the DJC Group, or it could be taken from the defaults specified by the DJC SET operator command.

DJC Group history is also limited by the HISTORY_COUNT keyword. A DJC Group history can therefore expire before HISTORY_DAYS is reached.

For more information, see $DJC_HISTORY_COUNT.

$DJC_HOLD

$DJC_HOLD(YES | NO)

This JAL element has the following attributes:

Attribute

Value

Description

DJC ONLY. DJC Group HOLD Indicator

You can use this logic variable to determine whether the DJC GROUP JECL statement included the HOLD keyword.

This function call returns a TRUE or FALSE value depending on whether the JECL statement DJC GROUP is coded in a HOLD keyword.

Type

Logic variable

Maximum value

Not applicable

Valid values

  • YES—Returns a TRUE value if the HOLD keyword is coded on the DJC GROUP JECL statement.
  • NO—Returns a TRUE value if the HOLD keyword is not coded on the DJC GROUP JECL statement.

Usage

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

Example


IF ($DJC_HOLD(YES))
  ...

ELSE

IF (expression)
    true-action
ELSE
    false-action
ENDIF

This JAL element has the following attributes:

Attribute

Value

Description

Specify alternative action

The ELSE statement is part of an IF logical construction. It must follow an IF statement, and specifies the alternate action(s) taken when the expression evaluated with the IF statement has a FALSE value.

Type

Logic statement

Maximum value

Not applicable

Valid value

  • expression—A logical expression combining job properties or descriptors or both
  • true-action—Any valid JAL statements which are to be performed should the IF expression evaluate to TRUE.
  • false-action—Any valid JAL statements which are to be performed should the IF expression evaluate to FALSE.
Example


IF(OKAY)
EXIT REQUEUE
ELSE
EXIT FAIL
ENDIF

Important

ELSE statements are paired with and follow IF statements. For every IF, there can be only one ELSE.

Logical constructions that include ORIF statements cannot include an ELSE statement. In that type of construction use an OTHERWISE statement.

For more information, see ENDIF, IF, ORIF, and OTHERWISE.

$ENABLED

$ENABLED name (DBS | DCS | DJC | JBS | JCS | JES3 | JLS | JSS | JTS | MELLON |
MHS | NET | SLM | PCS | UHS)

This function call returns a true/false value depending on whether the specified option is enabled.

This JAL element has the following attributes:

Attribute

Value

Description

Test status of TM installed options

You can use this unique descriptor to determine whether any one of installed ThruPut Manager options is enabled or 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 must be alphabetic or national. The first character of each name cannot be a dollar sign ($) or underscore (_).
  • DBS, DCS ,DJC, JBS, JCS, JES3, JLS, JSS, JTS, MELLON, MHS, NET, SLM, PCS, UHS—Indicates existing ThruPut Manager options.
Example


EVALUATE JBS_DISABLED (¬$ENABLED(JBS))
...
IF (JBS_DISABLED)
  WTO ERROR_MSG
ELSE
 JBS ADD BIND
 ...
ENDIF

END

END

This JAL element has the following attributes:

Attribute

Value

Description

 Indicate end of JAL statements

This statement indicates the end of JAL input. Its purpose is to guard against accidentally truncated JAL input.

Type

Language directive

Important

Your JAL input must terminate with an END statement. If it does not, a warning message is generated.

Only one END statement is permitted.

ENDIF

IF(expression)
  ... jal
ENDIF

This JAL element has the following attributes:

Attribute

Value

Description

Terminate a logical IF construction

The ENDIF statement signals the end of an IF, an IF-ELSE, or an IF-ORIF-OTHERWISE construction. ENDIF serves to delimit a block of JAL that is associated with a previous IF statement. It also indicates where execution should resume after runnig JAL as a result of a TRUE IF or ORIF expression.

Type

Logic statement

Valid values

  • expression—A logical expression combining Job Properties or descriptors or both.
  • jal—JAL statements that are part of the IF construct. These can include other logical statements, action statements and communication statements.
Example


IF (BIG_CPU)
  SET CLASS(X)
ELSE
 SET CLASS(Y)
ENDIF

Important

Each IF must have an ENDIF statement paired with it.

ENDIF statements are associated with IF statements only. In the case of ORIF statements, they are part of the IF logical construction and they do not require an ENDIF statement.

For more information, see ELSE, IF, ORIF, and OTHERWISE.

$ESTTIME

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

This JAL element has the following attributes:

Attribute

Value

Description

Estimated elapsed execution time

This descriptor represents the estimated amount of job execution time in real time (the value coded for the TIME= parameter on the /*JOBPARM JCL statement).

Type

Range definition descriptor

Maximum value

9999 in minutes of real time

Valid values

  • start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as minutes of real time in 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

This descriptor is not related to CPU time, it represents an estimate of job elapsed time.

$ESTTIME  TIME_OK,1000,TOO_MUCH_TIME

$ESP

$ESP (YES|NO)

This JAL element has the following attributes:

Attribute

Value

Description

ESP–submitted job

You can use this logic variable to determine whether the job was submitted by the ESP job scheduler. This function returns a TRUE or FALSE value depending on whether the ESP job scheduler submitted it.

Type

Logic variable

Maximum value

Not applicable

Valid values

  • YES—Returns a TRUE value if the ESP job scheduler submitted the job; otherwise, it returns a FALSE value.
  • NO—Returns a TRUE value if the ESP job scheduler did not submit the job; other­wise, it returns a FALSE value.

Usage

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

$ESP_APPL

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

This JAL element has the following attributes:

Attribute

Value

Description

Job's application name

Type

Character string descriptor

Maximum length

8 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 *
  • %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.

$ESP_ELAPSED

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

This JAL element has the following attributes:

Attribute

Value

Description

Average run time of the job

This is the estimated elapsed time of the job in minutes. This is the starting point of a segment. The first starting point (if specified) must be 0.

Type

Range definition descriptor

Maximum value

99,999,999

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.

$ESP_DUE_IN_DATE

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

This JAL element has the following attributes:

Attribute

Value

Description

Date value of the Due in information

Type

Range definition descriptor

Maximum value

2155/366 expressed as year/day

Valid values

start—Starting point of a segment. The first starting point (if specified) must be 0. You can specify starting points as year/day pairs, separated by a slash.

$ESP_DUE_IN_TIME

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

This JAL element has the following attributes:

Attribute

Value

Description

Time value of the Due in information

Type

Range definition descriptor

Maximum value

24:00

Valid values

  • start—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 0 through 59 in seconds. You can specify 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.

$ESP_DUE_OUT_DATE

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

This JAL element has the following attributes:

Attribute

Value

Description

Date value of the Due out information

Type

Range definition descriptor

Maximum value

2155/366 expressed as year/day

Valid values

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

$ESP_DUE_OUT_TIME

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

This JAL element has the following attributes:

Attribute

Value

Description

Time value of the Due out information

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 0 through 59 in seconds. You can specify 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.

$ESP_END_OVERDUE_DATE

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

This JAL element has the following attributes:

Attribute

Value

Description

Date value of the End Overdue information

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.

$ESP_END_OVERDUE_TIME

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

This JAL element has the following attributes:

Attribute

Value

Description

This is the date portion of the End Overdue date and time

This descriptor indicates the time value of the End Overdue information.

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 0 through 59 in seconds. You can specify 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.

$ESP_EXPECTED_COMPLETION_DATE

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

This JAL element has the following attributes:

Attribute

Value

Description

This is the date portion of the Expected completion date and time

This descriptor indicates the date value of the Expected completion information.

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.

$ESP_EXPECTED_COMPLETION_TIME

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

This JAL element has the following attributes:

Attribute

Value

Description

Time value of the expected completion information

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 0 through 59 in seconds. You can specify 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.

$ESP_GEN

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

This JAL element has the following attributes:

Attribute

Value

Description

Job’s generation number

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

Type

Range definition descriptor

Maximum value

999

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.

$ESP_LATE_SUBMIT_DATE

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

This JAL element has the following attributes:

Attribute

Value

Description

This is the date portion of the Late submit date and time

This descriptor indicates the date value of the Late submit information.

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.

$ESP_LATE_SUBMIT_TIME

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

This JAL element has the following attributes:

Attribute

Value

Description

This is the time portion of the Late submit date and time

This descriptor indicates the time value of the Late submit information.

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 0 through 59 in seconds. You can specify 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.

$ESP_JECL_OK

$ESP_JECL_OK (YES|NO)

This JAL element has the following attributes:

Attribute

Value

Description

Indicates the parse status of the obtained ESP information

This descriptor indicates whether all the information is collected successfully. This function call returns a TRUE or FALSE value depending on whether all keywords returned from the ESP call were syntactically correct.

Type

Logic Variable

Maximum value

Not applicable

Valid values

  • YES—Returns a TRUE value if all keywords are syntactically correct
  • NO—Returns a TRUE value if any of the keywords are not syntactically correct

Usage

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

$ESP_SCHEDULE_DATE

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

This JAL element has the following attributes:

Attribute

Value

Description

This is the date portion of the Scheduled date and time

This descriptor indicates the date value of the scheduled information. This indicates the date the job was scheduled.

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.

$ESP_SCHEDULE_DATE

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

This JAL element has the following attributes:

Attribute

Value

Description

This is the time portion of the Scheduled date and time

This descriptor indicates the time value of the scheduled information. This indicates the time the job was scheduled.

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 0 through 59 in seconds. You can specify 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.

$ESP_START_DATE

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

This JAL element has the following attributes:

Attribute

Value

Description

Date when the utility, based on analysis, determines that 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 (if specified) must be 0. Starting points are specified as year/day pairs, separated by a slash. 

$ESP_START_TIME

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

This JAL element has the following attributes:

Attribute

Value

Description

Time when the utility, based on analysis, determines that 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 0 through 59 in seconds. You can specify 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.

$ESP_START_LATE_BY

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

This JAL element has the following attributes:

Attribute

Value

Description

Difference between current time and start time in minutes when the start time is earlier 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 9,999 in minutes and ss ranges from 0 through 59 in seconds. You can specify 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.

$ESP_START_WITHIN

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

This JAL element has the following attributes:

Attribute

Value

Description

The difference between current time and start time in minutes when the start time is later 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 9,999 in minutes and ss ranges from 0 through 59 in seconds. You can specify 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.

$ESP_SUBSYS

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

This JAL element has the following attributes:

Attribute

Value

Description

The subsystem name of the ESP task that scheduled this job

Type

Character string descriptor

Maximum length

8 characters

Valid values

  • pattern—This is a hard-coded string. It can be 1–8 alphabetic, numeric, or national (#, @, $) characters, the first of which must be alphabetic or national. It can also include the wildcard characters ? and *
  • %patternID—The name of a pattern created with the PATTERNDEF statement
  • tableID—Identifies a specific table and indicates which sub-table 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.

EVALUATE | EVAL

EVALUATE name (expression)

This JAL element has the following attributes:

Attribute

Value

Description

EVALUATE a job property

EVALUATE statements allow you to define and initialize a Job Property which is the result of an expression. This expression can have one or more descriptors of the character string type and can also have previously defined JOB Properties of any type. The defined Job Property can then be used in an expression on another EVALUATE statement and/or in an IF statement (also an ORIF statement).

The EVALUATE statement can be abbreviated EVAL.

Type

Definition statement

Valid value

  • name—Name of the job property that contains the value of an expression. It is a required positional operand that can be 1-24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. The first character must be alphabetic or national but it cannot be a $.
  • expression—An expression, consisting of descriptors and Job Properties or both combined through the use of logical operators. For more information on expressions, see DAL-and-JAL-expressions.
Example

This statement defines the Job Property name BIG_JOB, which is TRUE for jobs requiring a large amount of CPU and memory. HIGH_CPU and HIGH_REGION are Job Property names previously defined with the $CPU and $REGION range definition statements.

EVALUATE   BIG_JOB   (HIGH_CPU & HIGH_REGION)

This statement defines the Job Property name PRODUCTION_JOBS, which is TRUE for jobs with the characters PROD as the first four characters of 6, in the third field of the account field on the JOB statement, or those which have a room number of PROD.

EVALUATE   PRODUCTION_JOBS   ($ACCTFLD(3,PROD??) | $ROOM(PROD))

This statement uses the previously defined Job Property name PRODUCTION_JOBS. The Job Property PAYROLL_JOB is TRUE for production jobs (i.e. those for which the PRODUCTION_ JOBS Property is TRUE) which have a programmer name of ACCOUNTING. This example shows how it can be useful to combine previously evaluated Job Property names with additional Properties to help isolate or identify a subset of a large group of jobs that fall into the same category.

EVALUATE   PAYROLL_JOB   (PRODUCTION_JOBS & $PGMR(ACCOUNTING))

We strongly recommend you to set up Job Properties with EVALUATE statements, as opposed to testing character descriptors in your logic section.

EVENT

EVENT event-name(OFF | ON)

This JAL element has the following attributes:

Attribute

Value

Description

Event switch definitions

This definition statement defines an event switch with an initial value (ON or OFF). By means of the ThruPut Manager operator command /JAL EVENT, the value of a switch can be displayed and updated. You can write JAL to use the EVENT switch to decide how a job should be requeued. An operator can then control the requeueing decision by simply changing the value assigned to the switch.

Type

Definition statement

Valid values

  • event-name—Name chosen to identify the event switch. It is a required positional operand which can be 1–24 alphabetic, numeric, national (#, @, $), or underscore (_) characters. The first character must be alphabetic or national. It cannot start with the character $.
  • OFF—Defines an Event Switch that is OFF, or in the context of JAL logic, has a FALSE value.
  • ON—Defines an Event Switch that is ON, or in the context of JAL logic, has a TRUE value.

Important

The name of the EVENT switches you chose must be known to the group that is responsible for altering their status.

When you refresh JAL, EVENT switches are affected as follows:

  • A console message is generated
  • Any EVENT Switch that has changed status as a result of the JAL REFRESH is displayed, indicating the status before and after the refresh
Example
EVENT  BACKUP_RUNNING(ON)

$EXEMPT

$EXEMPT(YES | NO)

This JAL element has the following attributes: 

Attribute

Value

Description

Exempt Class Job

This descriptor allows you to determine if the job belongs to a class that is exempted from ThruPut Manager processing unless certain type of JECL statements are present. This function call returns a TRUE/FALSE value depending on whether or not the submission class for this job is in the ThruPut Manager exempt list.

Type

Logic Variable

Maximum Value

Not applicable

Valid values

  • YES—Returns a TRUE value if this job has been submitted in one of the exempted classes. It is being processed by  ThruPut Manager   because of JECL statements.
  • NO—Returns a TRUE value if this job is not exempted.

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 ($EXEMPT(YES))
WTU...
ENDIF

If any ThruPut Manager JECL statements are encountered when processing the job, it is then selected for Job Analysis, even if it belongs to an exempt class. This descriptor gives you the ability to decide whether to allow ThruPut Manager processing or fail the job.

EXIT

EXIT [REQUEUE | FAIL]

This JAL element has the following attributes:

Attribute

Value

Description

Terminate JAL processing

The EXIT statement signals ThruPut Manager to terminate JAL processing normally.

Type

Action statement

Valid values

  • REQUEUE—Causes a job to be requeued using the service characteristics established by previous SET statements. If no keyword is provided REQUEUE is the default.
  • FAIL—Indicates to ThruPut Manager to queue the job for output (JCL error) instead of execution. This statement lets you reject jobs which your JAL determines should not be run for some reason, such as consuming excessive resources, asking for illegal combinations of resources, or having some violation of standards.
Example

In this example, the job is queued with the attributes assigned by the SET statement.

IF (TAPE_VOLUMES)
 SET CLASS(T)
 EXIT REQUEUE
ENDIF

In this example the job is queued for output as a JCL error.

IF (TAPE_ERROR | DISK_ERROR)
 EXIT FAIL
ENDIF

 

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