List of DAL elements (G-L)

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

GLOBAL DEFINE

GLOBAL DEFINE (name1[,name2,...])

This DAL element has the following attributes:

Attribute	Value
Description	You can use this definition statement to define logic variables that can be set by any DAL and then tested in subsequent DAL or JAL. Global Logic Variables must be defined before they can be used. Until a value is assigned by a GLOBAL SET statement, these variables have the value NOT_SET.
Type	Definition statement
Maximum value	Not applicable
Valid values	name1—(Required) Name of a Global logic variable in 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. The first character must be alphabetic or national but it cannot be a $.

Usage

You can use the Global Logic variables only in EVALUATE statements and in the DAL action statement GLOBAL SET.

Example

GLOBAL DEFINE (PRODUCTION,DAILY)
...
IF ...
GLOBAL SET PRODUCTION(TRUE)
ELSE
GLOBAL SET PRODUCTION(FALSE)
ENDIF

This example sets the Global Logic Variable for both TRUE and FALSE cases. That is because the initial value of the variable is NOT_SET, which allows you to test whether the variable has ever been set.

Important

If you are defining a single Global Logic Variable, you can omit the parentheses.

For more information, see EVALUATE and GLOBAL SET.

GLOBAL SET

GLOBAL SET name(TRUE | FALSE)

This DAL element has the following attributes:

Attribute	Value
Description	Set Global Logic variable This action statement assigns a value of TRUE or FALSE to a Global Logic variable, which must be defined in the DAL that references it.
Type	Action statement
Valid values	name—Is the name of a Global Logic Variable. It can be 1-24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. The first character must be alphabetic or national but it cannot be a $. TRUE—Assigns a TRUE value to the Global Logic Variable FALSE—Assigns a FALSE value to the Global Logic Variable

Important

The following aliases can also be used to set values:

ON and YES for TRUE
OFF and NO for FALSE

For more information, see GLOBAL DEFINE.

IF

IF (expression)
  ...
[ELSE
  ...]
ENDIF
    or
IF (expression)
  ...
ORIF (expression)
  ...
[OTHERWISE
  ...]
ENDIF

This DAL element has the following attributes:

Attribute	Value
Description	Make a Decision An IF statement evaluates an expression, allowing you to execute statements conditionally. It marks the beginning of a logical IF construction that allows several alternate courses of action. IF constructions must be terminated with a corresponding ENDIF statement. IF constructions can be of two types. One form is the IF-ELSE-ENDIF construction. The other form is the IF-ORIF-OTHERWISE-ENDIF construction. IF statements can be nested up to a maximum of 10 levels.
Type	Logic statement
Valid value	expression—A valid DAL expression enclosed in parenthesis. Expressions include character descriptors, DD Properties and logical operators. The expression is evaluated, resulting in a TRUE/FALSE value that controls the flow of DAL logic. ELSE—Specifies the action to be taken should the expression evaluate to FALSE. ORIF—Specifies an alternate IF statement. There can be more than one ORIF statement within an IF construction. OTHERWISE—Specifies the action to be taken when the previous IF and all previous ORIF evaluate to FALSE. ENDIF—A required statement which delimits a block of statements associated with an IF statement.

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

Example

IF ($DATASET_ON(CART))
WTU MOVE_TO_VTS
ENDIF

The previous example represents the simplest form of an IF construction. There are no alternate decisions.

IF (ILLEGAL)
SET $USERL1_TM(TRUE)
RETURN CONTINUE
ELSE
WTU ERROR1
RETURN FAIL
ENDIF

In this example an alternate decision, when the IF statement evaluates to FALSE, is included. The ELSE indicates the beginning of the DAL statements to be executed.

IF (ILLEGAL)
WTU ERROR2
RETURN FAIL
ORIF (MOUNT)
SET $USERL2_TM(TRUE)
RETURN CONTINUE
OTHERWISE
SET $USERL2_TM(FALSE)
RETURN CONTINUE
ENDIF

In the example above, the use of the ORIF and OTHERWISE logical statements is shown.

In general we recommend that you do not use character descriptors in the DAL logic section because it makes it affects performance and makes it more difficult to read; however, the following statement is valid:

IF ($JOBNAME(PP200*) & $ACCTFLD(2,PROD))
...
...
ELSE
...
...
ENDIF

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

$INCLASS | $INCL

$INCLASS(class | *)

This DAL element has the following attributes:

Attribute	Value
Description	This descriptor represents the job submission class (the class requested on the JOB statement).
Type	Character string descriptor
Maximum length	1 character
Valid value	class—A single hard-coded character from A–Z or 0–9 *—Job Analysis class

Usage

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

Example

$INCLASS(A)
$INCL(0)

Important

A job's $INCLASS is not affected by any requeueing done by BMC ThruPut Manager. For example, if a job is submitted in class A but requeued in class D for Deferred Processing, its INCLASS is still A. Likewise, it is not altered by any operator command.

For more information, see $CURCLASS.

$INDEVICE | $INDEV

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

This DAL element has the following attributes:

Attribute	Value
Description	This descriptor represents the name of the device on which the job entered the system or TSO user.
Type	Character string descriptor
Maximum length	8 characters
Valid value	pattern—Hard-coded string in 1–8 alphabetic, numeric, or national (#, @, $) characters. It can also include the hyphen (-) and the wildcard characters ? and . %patternID—Name of a pattern created with the PATTERNDEF statement tableID* —Identifies a specific table and which subtable to search The pattern, %patternID, or tableID entry is matched against the descriptor. If a match occurs, a TRUE value is returned.

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

Usage

You can use this descriptor EVALUATE definition statements and DAL Logic statements and also:

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

Example

$INDEVICE(READER1)
$INDEVICE(INTRDR)
$INDEV(TSO)
$INDEV(L123.JR4)
$INDEV(R345.RD1)
$INDEV($TABLE2(DEVICES))

Important

This descriptor can be checked for INTRDR as well as TSO. They will both be true for a job submitted by a TSO user.

INJOB#

$INJOB# [0,]name1,start2,name2[,...,startN,nameN]

This DAL element has the following attributes:

Attribute	Value
Description	You can use this descriptor to determine how many times you have already seen this data set for the job This allows you to determine if the data set has already been processed within the job.
Type	Range definition descriptor
Maximum value	99,999
Valid value	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 the Definition Section of DAL, and also as an insert in message definition statements.

Example

$INJOB# FIRST,2,DONE
EVALUATE PAY_FIRST ($DSNAME(PAY*.**) & FIRST)
...
IF (PAY_FIRST)
...

For more information, see $INSTEP#.

$INMSGCLASS

$INMSGCLASS(class)

This DAL element has the following attributes:

Attribute	Value
Description	This descriptor represents the message class requested by the JOB statement at job submission.
Type	Character string descriptor
Maximum length	1 character
Valid value	class—A hard-coded single character from A–Z or 0–9.

Usage

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

Example

$INMSGCLASS(N)

For more information, see $CURMSGCLASS.

$INNODE

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

This DAL element has the following attributes:

Attribute	Value
Description	This descriptor specifies the name of the JES2 node on which the job was submitted.
Type	Character string descriptor
Maximum length	8 characters
Valid value	pattern—Hard-coded string in 1–8 alphabetic, numeric, or national (#, @, $) characters. It can also include the hyphen (-) and the wildcard characters ? and . %patternID—Name of a pattern created with the PATTERNDEF statement tableID* —Identifies a specific table and which subtable to search The pattern, %patternID, or tableID entry is matched against the descriptor. If a match occurs, a TRUE value is returned.

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

Usage

You can use this descriptor EVALUATE definition statements and DAL Logic statements and also:

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

Example

$INNODE(HQ)
$INNODE(CITY1)
$INNODE($TABLE1(NODELIST))

$INPRIO | $INPR

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

This DAL element has the following attributes:

Attribute	Value
Description	Input execution queue priority This descriptor represents the job priority at submission time.
Type	Unique descriptor
Maximum value	Not applicable
Valid value	priority-value—A value to be tested for equal. It must in the range of 0 to 15. low—The low end of a range to be tested. It must be in the range 0 to 14. high—Is the high end of a range of priorities. It must be in the range 1 to 15, and must be higher than low. The value in $INPRIO 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

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

Example

$INPRIO(8)

This function returns a TRUE value only for jobs with an input priority of 8.

$INPRIO(9:15)

This returns a TRUE value for all jobs that have a priority in the range 9 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:

$INPR(9:MAX)

Important

This descriptor can be used to test a job for a specific priority, or to see if it falls within a range of priorities.

For more information, see $CURPRIO.

$INRMT

$INRMT(LOCAL)
or
$INRMT(nnnn)
or
$INRMT(nnnn:mmmm)

This DAL element has the following attributes:

Attribute	Value
Description	This descriptor represents the input remote number
Type	Character string descriptor
Maximum value	Not applicable
Valid value	LOCAL—Represents a local device. nnnn—Can be 1-4 digits. mmmm—Can be 1-4 digits.

Usage

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

Example

$INRMT(7)
$INRMT(LOCAL)
$INRMT(3:299)

Important

To indicate a range of remotes, specify nnnn:mmmm, where (nnnn < mmmm < 9999).

This descriptor does not support pattern matching functions.

$IN_SCHENV

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

This DAL element has the following attributes:

Attribute	Value
Description	This descriptor represents the scheduling environment for the job at submission.
Type	Character string descriptor
Maximum length	16 characters
Valid values	pattern—Hard-coded string in 1–16 alphabetic, numeric, or national (#, @, $) characters. It can also include the hyphen (-) and the wildcard characters ? and . %patternID—Name of a pattern created with the PATTERNDEF statement tableID* —Identifies a specific table and which subtable to search The pattern, %patternID, or tableID entry is matched against the descriptor. If a match occurs, a TRUE value is returned.

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

Usage

You can use this descriptor EVALUATE definition statements and DAL Logic statements and also:

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

Example

$IN_SCHENV(PRODUCTION)
$IN_SCHENV($TABLE2(ENVIRONS))

$IN_SERVICE_CLASS

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

This DAL element has the following attributes:

Attribute	Value
Description	This descriptor represents the WLM service class for the job at submission
Type	Character string descriptor
Maximum length	8 characters
Valid value	pattern—Hard-coded string in 1–16 alphabetic, numeric, or national (#, @, $) characters. It can also include the hyphen (-) and the wildcard characters ? and . %patternID—Name of a pattern created with the PATTERNDEF statement tableID—Identifies a specific table and which subtable to search The pattern, %patternID, or tableID* entry is matched against the descriptor. If a match occurs, a TRUE value is returned.

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

Usage

You can use this descriptor EVALUATE definition statements and DAL Logic statements and also:

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

Example

$IN_SERVICE_CLASS(HI_SPEED)
$IN_SERVICE_CLASS($TABLE1(WLMCLASS))

$INSTEP#

$INSTEP# [0,]name1,start2,name2[,...,startN,nameN]

This DAL element has the following attributes:

Attribute	Value
Description	You can use this descriptor to determine how many times you have already seen this data set for this step This allows you to determine if the data set has already been processed within the step.
Type	Range definition descriptor
Maximum value	99,999
Valid value	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 the Definition Section of DAL, and also as an insert in message definition statements.

Example

$INSTEP# FIRST,2,DONE
EVALUATE PAY_FIRST ($DSNAME(PAY*.**) & FIRST)
...
IF (PAY_FIRST)
...

For more information, see $INJOB#.

$INSYSAFF

$INSYSAFF(ANY)
or
$INSYSAFF(IND)
or
$INSYSAFF(system-name)
or
$INSYSAFF(ANY,IND)
or
$INSYSAFF(system-name,IND)

This DAL element has the following attributes:

Attribute	Value
Description	This descriptor represents the JES2 system affinity at job submission time. Note that system affinity can be assigned to jobs by assigning a default to the input device (local or remote). If a job specifies system affinity it overrides the input device assignment.
Type	descriptor.
Maximum length	4 characters
Valid value	ANY—Determines if the job can be executed in any system. IND—Determines if the job requested independent mode. When coded alone, this keyword allows you to determine whether or not independent mode is used regardless of the system affinity. system-name—Determines if the job can run in the system named.

Usage

You can use this descriptor EVALUATE definition statements and DAL Logic statements. This descriptor can also be used as an insert in message definition statements.

Example

$INSYSAFF (SYS1,IND)

In this case, for $INSYSAFF to evaluate TRUE, the job submission system affinity for this job must include SYS1 and be in independent mode.

Important

If you use the input device as a way to assign system affinity defaults, you can use $INDEVICE to test for it. When using the Job Extract Facility, the value returned is the 32 bit System Affinity Mask. Systems prior to JES2 5.1 return an 8 bit mask in the first byte.

This descriptor does not support pattern matching functions.

For more information, see $DALSYS and $INDEVICE.

$INSYSID

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

This DAL element has the following attributes:

Attribute	Value
Description	This descriptor represents the JES2 system ID where the job was last read If the job was submitted at node X and transmitted to node Y, $INSYSID would be the system at node Y that read the job.
Type	Character string descriptor
Maximum length	8 characters
Valid value	pattern—Hard-coded string in 1–8 alphabetic, numeric, or national (#, @, $) characters. It can also include the hyphen (-) and the wildcard characters ? and . %patternID—Name of a pattern created with the PATTERNDEF statement tableID* —Identifies a specific table and which subtable to search The pattern, %patternID, or tableID entry is matched against the descriptor. If a match occurs, a TRUE value is returned.

Usage

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

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

Example

EVALUATE IS_SYS1 ($INSYSID(SYS1))

In this case, for $INSYSID to return a TRUE value, the job must have been submitted on 'SYS1'.

EVALUATE IS_VALID_SYSID ($INSYSID($TABLE1(SYSTEMS)))

$IZWS

$IZWS(YES/NO)

This DAL element has the following attributes:

Attribute	Value
Description	This descriptor indicates that this job is managed by IZWS This function call returns a TRUE/FALSE value depending on whether this is an IZWS job.
Type	Logic Variable
Maximum value	Not applicable
Valid value	YES—Returns a TRUE value the job is managed by IZWS. NO—Returns a TRUE value if the job is not managed by IZWS.

Usage

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

Example

EVALUATE IZWS_JOB ($IZWS(YES))

...

IF (IZWS_JOB)

WTU ...

ENDIF

$IZWS_ADID

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

This DAL element has the following attributes:

Attribute	Value
Description	This descriptor indicates the value of the ADID= keyword on the //*IZWS statement. This is the Application Name.
Type	Character string descriptor
Maximum length	16 characters
Valid value	pattern—Hard-coded string in 1–8 alphabetic, numeric, or national (#, @, $) characters. It can also include the hyphen (-) and the wildcard characters ? and . %patternID—Name of a pattern created with the PATTERNDEF statement tableID—Identifies a specific table and which subtable to search The pattern, %patternID, or tableID* entry is matched against the descriptor. If a match occurs, a TRUE value is returned.

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

$IZWS_CRITICALJOB(Yes/No)

This DAL element has the following attributes:

Attribute	Value
Description	This descriptor indicates the value of the CRITICALJOB= keyword on the //*IZWS statement. This indicates that the job is on critical path. This function call returns a TRUE/FALSE value depending on the value of the CRITICALJOB= keyword.
Type	Logic Variable
Maximum value	Not applicable
Valid value	YES—Returns a TRUE value if CRITICALJOB=YES was encountered. NO—Returns a TRUE value if CRITICALJOB=NO was encountered.

Usage

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

Example

EVALUATE IZWS_CRITICALJOB ($IZWS_CRITICALJOB(YES))

...

IF (IZWS_CRITICALJOB)

WTU ...

ENDIF

$IZWS_CRITICALPRED(Yes/No)

This DAL element has the following attributes:

Attribute	Value
Description	This descriptor indicates the value of the CRITICALPRED= keyword on the //*IZWS statement. This indicates that the job is a critical predecessor. This function call returns a TRUE/FALSE value depending on the value of the CRITICALPRED= keyword.
Type	Logic Variable
Maximum value	Not applicable
Valid value	YES—Returns a TRUE value if CRITICALPRED=YES was encountered. NO—Returns a TRUE value if CRITICALPRED=NO was encountered.

Usage

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

Example

EVALUATE IZWS_CRITICALPRED ($IZWS_CRITICALPRED(YES))

...

IF (IZWS_CRITICALPRED)

WTU ...

ENDIF

$IZWS_DEADLINE_DATE

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

This DAL element has the following attributes:

Attribute	Value
Description	This descriptor indicates the date value of the DEADLINE= keyword on the //*IZWS statement. This indicates the date when the job must end. This descriptor is the date portion
Type	Range definition descriptor
Maximum value	2155/366 expressed as year/day
Valid value	start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as year or day or both pairs, separated by a slash. name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. The first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a property name for ranges that you want to ignore.

Usage

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

Example

$IZWS_DEADLINE_DATE DATE_ONE,1999/365,NEVER_DATE,2000/001,DATE_TWO

$IZWS_DEADLINE_TIME

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

This DAL element has the following attributes:

Attribute	Value
Description	This descriptor indicates the time value of the DEADLINE= keyword on the //*IZWS statement. This indicates the TIME when the job must end. This is the time portion.
Type	Range definition descriptor
Maximum value	24:00
Valid Value	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. The value mmmm can be specified without seconds but ss must be preceded by mmmm. For example, 30 seconds is specified as 0:30. name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. The first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a property name for ranges that you want to ignore.

Usage

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

Example

$IZWS_DEADLINE_TIME DT1,99:30,DT2,199,DST3,999:30,SPECIAL_DT

$IZWS_DURATION

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

This DAL element has the following attributes:

Attribute	Value
Description	This descriptor indicates the numeric value of the DURATION= keyword on the //*IZWS statement. This is the estimated duration of the job in seconds. The starting point of a segment. The first starting point must be 0, but can be omitted if desired.start
Type	Range definition descriptor
Maximum value	99,999,999
Valid value	name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. The first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a property name for ranges that you want to ignore.

Usage

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

Example

$IZWS_DURATION D0,1,D1,2,…,D998,999

$IZWS_IA_DATE

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

This DAL element has the following attributes:

Attribute	Value
Description	This descriptor indicates the date value of the IA= keyword on the //*IZWS statement. This is the input arrival date. This descriptor is the date portion.
Type	Range definition descriptor
Maximum value	2155/366 expressed as year/day
Valid value	start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as year or day or both pairs, separated by a slash. name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. The first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a property name for ranges that you want to ignore.

Usage

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

Example

$IZWS_IA_DATE DATE_ONE,1999/365,NEVER_DATE,2000/001,DATE_TWO

$IZWS_IA_TIME

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

This DAL element has the following attributes:

Attribute	Value
Description	This descriptor indicates the time value of the IA= keyword on the //*IZWS statement. This is the input arrival time.
Type	Range definition descriptor
Maximum value	24:00
Valid value	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. The value mmmm can be specified without seconds but ss must be preceded by mmmm. For example, 30 seconds is specified as 0:30. name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. The first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a property name for ranges that you want to ignore.

Usage

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

Example

$IZWS_IA_TIME IA1,99:30,IA2,199,IA3,999:30,SPECIAL_IA

$IZWS_JECL_OK

$IZWS_JECL_OK(YES/NO)

This DAL element has the following attributes:

Attribute	Value
Description	This descriptor indicates that all //IZWS keywords are syntactically correct This function call returns a TRUE/FALSE value depending on whether all keywords on the //IZWS statement are acceptable.
Type	Logic Variable
Maximum value	Not applicable
Valid value	YES—Returns a TRUE value if all //IZWS keywords are acceptable. NO—Returns a TRUE value if any of the //IZWS keywords are not acceptable.

Usage

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

Example

EVALUATE IZWS_ERROR ($IZWS_JECL_OK(NO))

...

IF (IZWS_ERROR)

WTU ...

ENDIF

$IZWS_LATESTOUT_DATE

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

This DAL element has the following attributes:

Attribute	Value
Description	This descriptor indicates the date value of the LATESTOUT= keyword on the //*IZWS statement. This is the latest date when the job should start. This descriptor is the date portion.
Type	Range definition descriptor
Maximum value	2155/366 expressed as year/day
Valid value	start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as year or day or both pairs, separated by a slash. name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. The first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a property name for ranges that you want to ignore.

Usage

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

Example

$IZWS_LATESTOUT_DATE DATE_ONE,1999/365,NEVER_DATE,2000/001,DATE_TWO

$IZWS_LATESTOUT_TIME

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

This DAL element has the following attributes:

Attribute	Value
Description	This descriptor indicates the time value of the LATESTOUT= keyword on the //*IZWS statement. This is the latest time when the job should start. This is the time portion.
Type	Range definition descriptor
Maximum value	24:00
Valid value	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. The value mmmm can be specified without seconds but ss must be preceded by mmmm. For example, 30 seconds is specified as 0:30. name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. The first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a property name for ranges that you want to ignore.

Usage

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

Example

$IZWS_LATESTOUT_TIME DT1,99:30,DT2,199,DST3,999:30,SPECIAL_DT

$IZWS_OPNO

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

This DAL element has the following attributes:

Attribute	Value
Description	This descriptor indicates the time value of the OPNO= keyword on the //*IZWS statement. This is the operation number.
Type	Range definition descriptor
Maximum value	255
Valid value	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 the Definition Section of JAL, and also as an insert in message definition statements.

Example

$IZWS_OPNO O0,1,O1,2,O2,8,O9

$IZWS_PRIORITY

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

This DAL element has the following attributes:

Attribute	Value
Description	This descriptor indicates the time value of the PRIORITY= keyword on the //*IZWS statement. This is the job’s priority from 1 to 9, where 9 is the most urgent. The starting point of a segment. The first starting point must be 0, but can be omitted if desired.start
Type	Range definition descriptor
Maximum value	9
Valid value	name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. The first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a property name for ranges that you want to ignore.

Usage

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

Example

$IZWS_PRIORITY P0,1,P1,2,P2,8,P9

$IZWS_SUCCESSOR(YES/NO)

$IZWS_SUCCESSOR(Yes/No)

This DAL element has the following attributes:

Attribute	Value
Description	This descriptor indicates the value of the SUCCESSOR= keyword on the //*IZWS statement. This indicates that the job, when completed, will free jobs successor to start. This function call returns a TRUE/FALSE value depending on the value of the SUCCESSOR= keyword.
Type	Logic Variable
Maximum value	Not applicable
Valid value	YES—Returns a TRUE value if SUCCESSOR=YES was encountered NO—Returns a TRUE value if SUCCESSOR=NO was encountered

Usage

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

Example

EVALUATE IZWS_SUCCESSOR ($IZWS_SUCCESSOR(YES))

...

IF (IZWS_SUCCESSOR)

WTU ...

ENDIF

$IZWS_SUBSYS

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

This DAL element has the following attributes:

Attribute	Value
Description	This descriptor indicates the value of the SUBSYS= keyword on the //*IZWS statement. This is the IZWS subsystem name.
Type	Character string descriptor
Maximum length	4 characters
Valid value	pattern—Hard-coded string in 1–8 alphabetic, numeric, or national (#, @, $) characters. It can also include the hyphen (-) and the wildcard characters ? and . %patternID—Name of a pattern created with the PATTERNDEF statement tableID—Identifies a specific table and which subtable to search The pattern, %patternID, or tableID* entry is matched against the descriptor. If a match occurs, a TRUE value is returned.

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

$IZWS_TIMEDEP(YES/NO)

$IZWS_TIMEDEP(Yes/No)

This DAL element has the following attributes:

Attribute	Value
Description	This descriptor indicates the value of the TIMEDEP= keyword on the //*IZWS statement. The job is time dependent. It can not start before IA (input arrival). This function call returns a TRUE/FALSE value depending on the value of the TIMEDEP= keyword.
Type	Logic Variable
Maximum value	Not applicable
Valid value	YES—Returns a TRUE value if TIMEDEP=YES was encountered NO—Returns a TRUE value if TIMEDEP=NO was encountered

Usage

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

$JBACT

This DAL element has the following attributes:

Attribute	Value
Description	JBS only. You can use this descriptor to determine whether a particular Binding Agent is activated in JECL statements. You can also determine if it is activated by using Job Binding Services API, or whether the specified Agent is the only one being activated.
Type	Unique descriptor
Maximum value	Not applicable
Valid value	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 (_). AGENT(pattern \| %patid \| table-id)—Indicates that a search pattern for a Binding Agent follows. pattern—A search pattern for a Binding Agent. The name can only be two levels. This pattern must be 1 to 17 characters and conform to the rules described in the section Pattern-matching-for-binding-agent-names. %patid—The name of a pattern constructed with a PATTERNDEF statement. table-id—Identifies a specific table and how to search. For more information about table support, see DAL-and-JAL-table-management. API—Determines if the API can be used. If the AGENT keyword is coded, the property is assigned a TRUE value if a Binding Agent that matches the pattern that is specified. ONLY—Allows you to test whether the Binding Agents specified are the only ones being activated.

Usage

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

Example

$JBACT IMS_TEST AGENT(IMS.TEST)
$JBACT BMP_TEST AGENT($TABLE9(BMP_AGENTS))
$JBACT PRODUCTION_TEST AGENT(PRODJOBS) ONLY

Important

When using the Job Extract Facility, one Agent name per XFE is returned (if present). Each possible level (up to 2) is returned in an 8-character field left justified.

If ONLY is specified together with a pattern or table entry for the AGENT keyword, the Property Name is assigned a TRUE value only if all Binding Agents found match the pattern or table entry.

For more information, see $EXEMPT, $JBACT#, $JBBIND, $JBBIND#, $JBDEACT, and $JBDEACT#.

$JBACT#

$JBACT# [0,]name1,start2,name2[,...,startN,nameN]

This DAL element has the following attributes:

Attribute	Value
Description	JBS only. This descriptor represents the number of JECL ACTIVATE statements present in a job
Type	Range definition descriptor
Maximum value	99 expressed in number of ACTIVATE JECL statements
Valid value	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 the Definition Section of TM DAL, and also as an insert in message definition statements.

Example

$JBACT# NO_ACTIVATE_JECL,1,ACTIVATE_JECL

For more information, see $EXEMPT, $JBACT#, $JBBIND, $JBBIND#, $JBDEACT, and $JBDEACT#.

$JBBIND

$JBBIND name AGENT(pattern | %patid | table-id) [ONLY]

This DAL element has the following attributes:

Attribute	Value
Description	JBS ONLY. You can use this descriptor to determine whether there is a BIND statement for a particular Binding Agent in JECL statements. You also test whether the specified Agent is the only Agent bound to.
Type	Unique descriptor
Maximum value	Not applicable
Valid value	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 (_). AGENT(pattern \| %patid \| table-id)—Indicates that a search pattern for a Binding Agent follows. pattern—A search pattern for a Binding Agent. The name can only be two levels. This pattern must be 1 to 17 characters and conform to the rules described in the section Pattern-matching-for-binding-agent-names. %patid—The name of a pattern constructed with a PATTERNDEF statement. table-id—Identifies a specific table and how to search. For more information about table support, see DAL-and-JAL-table-management. ONLY—Allows you to test whether the Binding Agents specified are the only ones being activated.

Usage

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

Example

$JBBIND IMS AGENT(IMS.*)
$JBBIND BILL_OF_MATERIALS AGENT($TABLE3(BMPAGNTS))

Important

If ONLY is specified together with a pattern or table entry for the AGENT keyword, the Property Name is assigned a TRUE value only if all Binding Agents found match the pattern or table entry.

When using the Job Extract Facility, up to four Agent names per XFE could be returned. Each possible level (up to 2) is returned in an 8-character field left justified.

For more information, see $EXEMPT, $JBACT#, $JBBIND, $JBBIND#, $JBDEACT, and $JBDEACT#.

$JBBIND#

$JBBIND# [0,]name1,start2,name2[,...,startN,nameN]

This DAL element has the following attributes:

Attribute	Value
Description	JBS ONLY. This descriptor represents the number of JECL BIND statements present in a job.
Type	Range definition descriptor
Maximum value	99 expressed in number of BIND JECL statements
Valid value	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 the Definition Section of TM DAL, and also as an insert in message definition statements.

Example

$JBBIND# NO_BIND,1,SOME_BIND

For more information, see $EXEMPT, $JBACT, $JBACT#, $JBBIND, $JBBIND#, $JBDEACT, and $JBDEACT#.

$JBDEACT

This DAL element has the following attributes:

Attribute	Value
Description	JBS ONLY. You can use this descriptor to determine whether or not a particular binding agent is deactivated in JECL statements. You can also determine if it is deactivated using Job Binding Services API, and whether the specified Agent is the only one deactivated.
Type	Unique descriptor
Maximum value	Not applicable
Valid value	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 (_). AGENT(pattern \| %patid \| table-id)—Indicates that a search pattern for a Binding Agent follows. pattern—A search pattern for a Binding Agent. The name can only be two levels. This pattern must be 1 to 17 characters and conform to the rules described in the section Pattern-matching-for-binding-agent-names. %patid—The name of a pattern constructed with a PATTERNDEF statement. table-id—Identifies a specific table and how to search. For more information about table support, see DAL-and-JAL-table-management. API—Determines if the API can be used. If the AGENT keyword is coded, the property is assigned a TRUE value if a Binding Agent that matches the pattern that is specified. ONLY—Allows you to test whether the Binding Agents specified are the only ones being activated.

Usage

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

Example

$JBDEACT IMS_TEST AGENT(IMS.TEST)
$JBDEACT PAYROLL AGENT($TABLE1(PAYAGNTS))

Important

When using the Job Extract Facility, one Agent name per XFE is returned (if present). Each possible level (up to 2) is returned in an 8-character field left justified.

If ONLY is specified together with a pattern or table entry for the AGENT keyword, the Property Name is assigned a TRUE value only if all Binding Agents found match the pattern or table entry.

For more information, see $EXEMPT, $JBACT, $JBACT#, $JBBIND, $JBBIND#, and $JBDEACT#.

$JBDEACT#

$JBDEACT# [0,]name1,start2,name2[,...,startN,nameN]

This DAL element has the following attributes:

Attribute	Value
Description	JBS ONLY. This descriptor represents the number of JECL DEACTIVATE statements present in a job.
Type	Range definition descriptor
Maximum value	99 expressed in number of DEACTIVATE JECL statements
Valid value	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 the Definition Section of TM DAL, and also as an insert in message definition statements.

Example

$JBDEACT# NO_DEACTIVATE_JECL,1,DEACTIVATE_JECL

For more information, see $EXEMPT, $JBACT, $JBACT#, $JBBIND, $JBBIND#, and $JBDEACT.

JBS ADD BIND

JBS ADD BIND(agent-name-list[,$$DELETE])

This DAL element has the following attributes:

Attribute	Value
Description	JBS ONLY. You can use this action statement to insert a BIND request for the job.
Type	Action statement
Valid value	BIND(agent-name-list[,$$DELETE])—Specifies a BIND request is to be inserted for the job. For each invocation of DAL you can have up to 24 BIND requests. That is, you can execute up to 24 JBS ADD BIND statements without an intervening JBS DELETE BIND statement. DAL BIND requests are additions to any JECL BIND requests the job might have. list—A list, separated by commas, of up to four Binding Agents that can satisfy the BIND request. name—The names represent an OR condition. That is, if any one of them is Active the job can be selected for execution. $$DELETE— is a special Agent name that causes the Bind request to be ignored if it causes an incompatibility. If included, $$DELETE counts as one of the four allowable Agent names, and must be the last name in the list.

Example

JBS ADD BIND(IMS.ONLINEA,IMS.ONLINEB)

In this example two Binding Agents are listed. If either of them is active the job can be selected for execution.

JBS ADD BIND(PREFER.SYS3,$$DELETE)

If the Agent PREFER.SYS3 is incompatible with another Bind request for this job, the special Agent name $$DELETE causes this Bind request to be ignored.

Important

This facility is equivalent to the user placing the JECL statement /*JBS BIND in the job stream.

You can determine if you have previously added any BIND request by testing the logic variable $JXJBANY.

You can determine if you can add any more requests by testing the logic variable $JXJBMAX. If this variable returns a value of TRUE, it means that you have already reached the maximum number allowed.

The Language Processor parameter VERIFY allows you to verify whether JBS agents exist on the system on which the processor is running. This is a useful final step before implementing a new DAL.

For more information, see JBS DELETE BIND, JBS REPLACE BIND, $JXJBANY, and $JXJBMAX.

JBS DELETE BIND

JBS DELETE [BIND | ALL_BINDS]

This DAL element has the following attributes:

Attribute	Value
Description	JBS ONLY. This action statement deletes the last previously executed JBS ADD BIND or JBS REPLACE BIND request
Type	Action statement
Valid value	BIND—Specifies that the previously run JBS ADD BIND or JBS REPLACE BIND request is to be deleted. Only the last BIND request prior to the JBS DELETE BIND request is affected. ALL_BINDS—Specifies that all existing Binding Agent requests are to be deleted.

Important

This facility covers situations where in your main logic you might JBS ADD or JBS REPLACE a BIND request that in your "exception conditions" logic you may want to eliminate.

The source of the last previously executed BIND request (from DAL or from exits) does not affect JBS DELETE BIND processing.

If no JBS ADD BIND or JBS REPLACE BIND request has been previously executed, this statement is ignored.

For more information, see JBS ADD BIND, JBS REPLACE BIND, $JXJBANY, and $JXJBMAX.

$JBS_NEEDS

$JBS_NEEDS name ENVIRONMENT(pattern | %patid | table-id) [ONLY]

This DAL element has the following attributes:

Attribute	Value
Description	You can use this descriptor to determine whether a particular JBS Environment is requested in JECL statements, and whether the specified Environment is the only one requested.
Type	Unique descriptor
Maximum value	Not applicable. Component: JBS
Valid value	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 (_). ENVIRONMENT(pattern \| %patid \| table-id)—Indicates that a search pattern for a JBS Environment follows. This keyword can be abbreviated to ENV. pattern—A search pattern for an Environment. This pattern must be 1 to 16 characters and conform to the naming conventions for JBS Environments. %patid—The name of a pattern constructed with a PATTERNDEF statement. table-id—Identifies a specific table and how to search. For more information about table support, see DAL-and-JAL-table-management. ONLY—Allows you to test whether the Binding Agents specified are the only ones being activated.

Usage

This descriptor can be used only in the Definition Section.

Example

$JBS_NEEDS MAINT ENVIRONMENT(MAINTENANCE)
$JBS_NEEDS BACKUP ENV($TABLE3(ENVIRONS))

For more information, see $JBS_NEEDS#.

$JBS_NEEDS#

$JBS_NEEDS# name1,1,name2

This DAL element has the following attributes:

Attribute	Value
Description	Number of NEEDS Statements This descriptor represents whether a JECL JBS NEEDS statement is present in the job. In this case only one statement can be present.
Type	Range definition descriptor
Maximum value	1
Component	JBS
Valid value	name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. The first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a property name for ranges that you want to ignore.

Usage

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

Example

$JBS_NEEDS# NO_NEEDS,1,NEEDS

For more information, see $JBS_NEEDS.

JBS REPLACE BIND

JBS REPLACE BIND(agent-name-list)

This DAL element has the following attributes:

Attribute	Value
Description	JBS ONLY. This action statement allows you to replace the last previously executed JBS ADD BIND request for the job.
Type	Action statement.
Valid value	BIND(agent-name-list)—This keyword indicates that the previously executed JBS ADD BIND request is to be replaced with a new Agent list. Only the last BIND request prior to the JBS REPLACE BIND request is affected. If no JBS ADD BIND statement has been executed, this statement is treated as the first JBS ADD BIND statement. agent-name-list—A list, separated by commas, of up to four Binding Agents that can satisfy the BIND request. The names represent an OR condition. That is, if any one of them is Active the job can be selected for execution.

Usage

Normally used with exception conditions logic, where in your main line you may have a JBS ADD BIND request that is replaced under some unique logic conditions.

Example

JBS REPLACE BIND(IMS.ONLINEA,IMS.ONLINEB)

Important

The Language Processor parameter VERIFY allows you to verify whether JBS agents exist on the system on which the processor is running. This is a useful final step before implementing a new DAL.

The source of the last previously executed BIND request (from DAL or from exits) does not affect JBS REPLACE BIND processing.

For more information, see JBS ADD BIND, JBS DELETE BIND, $JXJBANY, and $JXJBMAX.

$JBS_SET

$JBS_SET name RESOURCE(pattern | %patid | table-id) [ONLY]

This DAL element has the following attributes:

Attribute	Value
Description	This descriptor lets you determine whether or not a particular JBS Resource Element is SET by JECL statements, and whether the specified Resource is the only one set.
Type	Unique descriptor
Maximum value	Not applicable
Component	JBS
Valid value	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 (_). RESOURCE(pattern \| %patid \| table-id)—Indicates that a search pattern for a JBS Resource Element follows. This keyword can be abbreviated to RES. pattern—A search pattern for a Resource Element. This pattern must be 1 to 16 characters and conform to the naming conventions for JBS Resource Elements. %patid—The name of a pattern constructed with a PATTERNDEF statement. table-id—Identifies a specific table and indicates how it is to be searched. For a description of table support, see to "Section. DAL-and-JAL-table-management" in the DAL and JAL User Guide. ONLY—Allows you to test whether the Resource Element specified is the only one being set.

Usage

This descriptor can be used only in the Definition Section.

Example

$JBS_SET SETS_SHIFT RESOURCE(SHIFT)
$JBS_SET SETS_DAY RES($TABLE3(RESOURCE))

For more information, see $JBS_SET#.

$JBS_SET#

$JBS_SET# [0,]name1,start2,name2[,...,startN,nameN]

This DAL element has the following attributes:

Attribute	Value
Description	This descriptor allows you to determine the number of JBS SET JECL statements present in a job. Number of JBS SET JECL Statements
Type	Range definition descriptor
Maximum value	99 expressed in number of JBS SET JECL statements
Component	JBS
Valid value	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 the Definition Section and also as an insert in message definition statements.

Example

$JBS_SET# NO_JBS_SETS,1,JBS_SETS

For more information, see $JBS_SET.

JCL ADD

JCL ADD DDN(ddname) DSN(DATASETname) DISP(SHR|OLD) [FIRST | LAST] BLKSIZE(nnn)
or
JCL ADD RESET

This DAL element has the following attributes:

Attribute	Value
Description	TM ONLY. This statement allows you to add a DD statement to the current step. The disposition of an added DD statement is SHR. All applicable DALs are driven for added DD statements. The disposition of an added DD statement defaults to DISP(SHR)
Type	Action statement
Valid value	DDN(ddname)—Specifies the name of the DD statement to be added. If the DD name already exists in the job, the addition is treated as a concatenation. The position of the data set in the concatenation is determined by the FIRST or LAST keyword. ddname—Is a valid DD name. DSN(DATASETname)—Specifies the name of the data set for the DD statement to be added. DATASETname—Is a valid data set name. FIRST—(Default) If the added data set is part of a concatenation, indicates that it is to be added as the first data set. LAST—If the added data set is part of a concatenation, indicates that it is to be added as the last data set. RESET—Undoes the effect of all previous JCL ADD statements in this invocation of TM DAL. This keyword is mutually exclusive with all other JCL ADD keywords. DISP(SHR or OLD) BLKSIZE – any valid block size

For more information, see $JCL_ADD.

$JCL_ADD

$JCL_ADD(NO | YES)

This DAL element has the following attributes:

Attribute	Value
Description	This Logic Variable allows you to determine whether the current DD statement was added by a previous TM DAL.
Type	Logic Variable
Valid value	NO—Returns a TRUE value if the current DD statement was not added by a previous TM DAL. YES—Returns a TRUE value if the current DD statement was added by a previous TM DAL.

Usage

You can use this descriptor EVALUATE definition statements and DAL Logic statements. This descriptor can also be used as an insert in message definition statements.

For more information, see JCL ADD.

JCL ALTER

JCL ALTER keyword[,keyword,...] [ANALYSIS_ONLY]

JCL ALTER RESET

This DAL element has the following attributes:

Attribute	Value
Description	TM ONLY. This statement allows you to alter certain DD statement keywords during DAL type TM analysis of a DD statement.
Type	Action statement
Valid value	ANALYSIS_ONLY—Alters JCL for the purpose of analysis. The changes will not affect execution. RESET—Undoes the effects of any previous JCL ALTER statement and restores the DD statement to its original state. This keyword is mutually exclusive with all other JCL ALTER keywords. keyword[,keyword,...]—Allows you to set values for the corresponding DD statement keyword. The new value must be valid according to the DD statement syntax, for example, EXPDT(2002/365). You can choose one or more of the following keywords: BLKSIZE(blksize) BUFL(bufl) BUFND(bufnd) BUFNI(bufni) BUFNO(bufno) BUFSP(bufsp) DSORG(dsorg) EXPDT(expdt) FREE(free) LRECL(lrecl) RETPD(retpd) RETPD(retpd) STRNO(strno) SUBSYS(name \| %stringid) TRTCH(trtch) %stringid—The name of a character string created with the STRINGDEF statement. DATACLAS(dataclas \| %stringid) MGMTCLAS(mgmtclas \| %stringid) STORCLAS(storclas \| %stringid) Allows you to set SMS parameters for the corresponding DD statement, provided that the option has been enabled with the JES2 initialization TMPARM. dataclas \| mgmtclas \| stroclas—Specifies a new value that must be valid according to the SMS keyword syntax. %stringid—The name of a character string created with the STRINGDEF statement. DEFER(YES \| NO)—Allows you to control requests for deferred mounts. YES—Alters the UNIT keyword to include DEFER. NO—If DEFER was coded, it is removed. IGNORE_VOLUMES—Hides any volume serial numbers coded on the DD statement from further JAL/DAL processing. To remove volumes from the DD statement, use REMOVE_VOL_SER. PROTECT(YES \| NO)—Allows you control requests to PROTECT data sets. YES—Adds a PROTECT=YES keyword to the DD statement. NO—If PROTECT=YES was coded, it is removed. RETAIN(YES \| NO)—Allows you control requests for RETAINed volumes. YES—Alters the VOLUME keyword to include RETAIN. NO—If RETAIN was coded, it is removed. REMOVE_VOL_SER—Removes any volume serial numbers that were coded on the DD statement. To hide volume serial numbers from further JAL/DAL processing without removing them from the DD statement, use the keyword IGNORE_VOLUMES. UNIT_AFF(YES \| NO)—Allows you control unit affinity for the specific TAPE DD statements.If the DD does not reference a TAPE and not a concatenated DD, the request will be ignored. YES—Unit affinity will be added, referring back to the initial DD in the concatenation. NO—Unit affinity will be removed. UNITNAME(unitname \| %stringid)—Allows you to specify a new unitname. If the DD statement refers to a cataloged data set, the specified unit must be of the same device type, otherwise MVS allocation ignores it. This behavior is identical to coding UNIT on the DD statement. If the DD statement refers to an SMS managed data set, the unitname may be ignored. See SMS message IGDxxxxI in the job output. The original unitname (if coded) must be valid. %stringid—The name of a character string created with the STRINGDEF statement. If the intent is to remove the unitname, use a blank STRINGDEF, e.g. STRINGDEF %BLANKS (' '). UNIT_COUNT(unitcount)—Allows you to provide a specific unit count, or override an existing count. VOLUME_COUNT(volcount)—Allows you to provide a specific volume count, or override an existing count.

Example

JCL ALTER BLKSIZE(1024) DSORG(PS)
JCL ALTER UNITNAME(3480) ANALYSIS_ONLY
JCL ALTER EXPDT(2002/365)

Important

JCL ALTER actions are logged in SYSMSGS of the affected job unless the JAL statement JCL SET is used to turn off logging.

$JCL_BLKSIZE

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

This DAL element has the following attributes:

Attribute	Value
Description	This descriptor represents the blocksize coded in JCL, if any was coded.
Type	Range definition descriptor
Maximum value	65,535 bytes
Valid value	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 the Definition Section of DAL, and also as an insert in message definition statements.

Example

$JCL_BLKSIZE OK_FOR_DASD,32760,MUST_BE_TAPE

$JCL_BUFL

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

This DAL element has the following attributes:

Attribute	Value
Description	This descriptor represents the buffer length coded in JCL, if any was coded.
Type	Range definition descriptor
Maximum value	32,760 bytes
Valid value	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 the Definition Section of DAL, and also as an insert in message definition statements.

Example

$JCL_BUFL SMALL,1024,NORMAL,16384,LARGE

$JCL_BUFND

This DAL element has the following attributes:

Attribute	Value
Description	Number of VSAM Data Buffers from JCL This descriptor represents the BUFND= value coded in JCL, if any were coded.
Type	Range definition descriptor
Maximum value	32,767 bytes
Valid value	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 the Definition Section of DAL, and also as an insert in message definition statements.

Example

$JCL_BUFND SMALL,1024,NORMAL,16384,LARGE

$JCL_BUFNI

This DAL element has the following attributes:

Attribute	Value
Description	Number of VSAM Data Buffers from JCL This descriptor represents the BUFNI= value coded in JCL, if any were coded.
Type	Range definition descriptor
Maximum value	32,767 bytes
Valid value	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 the Definition Section of DAL, and also as an insert in message definition statements.

Example

$JCL_BUFNI SMALL,1024,NORMAL,16384,LARGE

$JCL_BUFNO

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

This DAL element has the following attributes:

Attribute	Value
Description	Number of Buffers from JCL This descriptor represents the buffer length coded in JCL, if any was coded.
Type	Range definition descriptor
Maximum value	15 buffers
Valid value	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 the Definition Section of DAL, and also as an insert in message definition statements.

Example

$JCL_BUFNO OK,8,NOT_OK

$JCL_BUFSP

This DAL element has the following attributes:

Attribute	Value
Description	Maximum number of bytes in user area specified in JCL This descriptor represents the BUFSP= value coded in JCL, if any was coded.
Type	Range definition descriptor
Maximum value	8388607 bytes
Valid value	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 the Definition Section of DAL, and also as an insert in message definition statements.

Example

$JCL_BUFSP SMALL,1024,NORMAL,16384,LARGE

$JCL_CODED

This DAL element has the following attributes:

Attribute	Value
Description	Test for certain keywords. This unique descriptor allows you to determine whether any of the following keywords were coded anywhere in the job: DEFER EXEC_REGIONX EXPDT JOB_REGIONX LABEL=EXPDT LABEL=RETPD RETPD PROTECT=YES UNIT=AFF UNITNAME VOL=REF VOL=SER This function call returns a TRUE or FALSE or both value depending on whether the keyword you are testing for was coded on any DD statement in the job.
Type	Unique descriptor
Maximum value	Not applicable
Valid value	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 (_). DEFER—Specifies whether the DEFER subparameter of the UNIT keyword was coded on any DD statement in the job. If this subparameter is present, $JCL_CODED assumes a TRUE value. EXEC_REGIONX—Specifies whether REGIONX was coded on any EXEC statement in the job. If $JCL_CODED is coded in JAL it will be TRUE if any step of the job contains the REGIONX keyword. If $JCL_CODED is coded in DAL it will be TRUE if the current step of the job contains the REGIONX keyword. EXPDT—Specifies whether the EXPDT or LABEL=EXPDT keyword was coded on any DD statement in the job. If either of these keywords is present, $JCL_CODED assumes a TRUE value. EXPDT_NEW—Specifies whether the EXPDT or LABEL=EXPDT keyword was coded on any DD statement in the job using the new (ccyy/ddd) form for the expiry date. If either of these keywords is present and uses the new date format, $JCL_CODED assumes a TRUE value. EXPDT_OLD—Specifies whether the EXPDT or LABEL=EXPDT keyword was coded on any DD statement in the job using the old (yyddd) form for the expiry date. If either of these keywords is present and uses the old date format, $JCL_CODED assumes a TRUE value. JOB_REGIONX—Specifies whether the REGIONX keyword was coded on the JOB statement. If this keyword is present, $JCL_CODED assumes a TRUE value. PROTECT—Specifies whether the PROTECT=YES keyword was coded on the DD statement. If this keyword is present, $JCL_CODED assumes a TRUE value. RETPD—Specifies whether the RETPD or LABEL=RETPD keyword was coded on any DD statement in the job. If either of these keywords is present, $JCL_CODED assumes a TRUE value. UNIT_AFF—Specifies whether UNIT=AFF was coded on any DD statement in the job. If this keyword is present, $JCL_CODED assumes a TRUE value. UNITNAME—Specifies whether a unit name was coded on any DD statement in the job. If a unit name is present, $JCL_CODED assumes a TRUE value. VOL_REF—Specifies whether VOL=REF was coded on any DD statement in the job. If this keyword is present, $JCL_CODED assumes a TRUE value. VOLSER—Specifies whether VOL=SER was coded on any DD statement in the job. If this keyword is present, $JCL_CODED assumes a TRUE value.

$JCL_COND

$JCL_COND(NO | YES)

This DAL element has the following attributes:

Attribute	Value
Description	Check COND keyword You can use this logic variable to determine whether the COND keyword was coded for the current step.
Type	Logic Variable
Maximum value	Not applicable
Valid value	YES—Returns a TRUE value if the COND keyword applies to the current step. NO—Returns a TRUE value if the COND keyword does not apply to the current step.

Usage

You can use this descriptor EVALUATE definition statements and DAL Logic statements. This descriptor can also be used as an insert in message definition statements.

$JCL_COND_EVEN

$JCL_COND_EVEN(NO | YES)

This DAL element has the following attributes:

Attribute	Value
Description	Check COND=EVEN Keyword You can use this logic variable to determine whether the current step contains COND=EVEN.
Type	Logic Variable
Maximum value	Not applicable
Valid value	YES—Returns a TRUE value if the COND =EVEN keyword applies to the current step. NO—Returns a TRUE value if the COND=EVEN keyword does not apply to the current step.

Usage

You can use this descriptor EVALUATE definition statements and DAL Logic statements. This descriptor can also be used as an insert in message definition statements.

$JCL_COND_ONLY

$JCL_COND_ONLY(NO | YES)

This DAL element has the following attributes:

Attribute	Value
Description	Check COND=EVEN Keyword You can use this logic variable to determine whether the current step contains COND=EVEN.
Type	Logic Variable
Maximum value	Not applicable
Valid value	YES—Returns a TRUE value if the COND =ONLY keyword applies to the current step. NO—Returns a TRUE value if the COND=ONLY keyword does not apply to the current step.

Usage

You can use this descriptor EVALUATE definition statements and DAL Logic statements. This descriptor can also be used as an insert in message definition statements.

JCL DELETE

JCL DELETE [RESET]

This DAL element has the following attributes:

Attribute	Value
Description	TM ONLY. Delete the Current DD statement This statement deletes the current DD statement from the job.
Type	Action statement
Maximum value	Not applicable
Valid value	RESET—Undoes the effect of a previous JCL DELETE statement

$JCL_DSKEYLBL

$JCL_DSKEYLBL($BLANK | key value)

This DAL element has the following attributes:

Attribute	Value
Description	Check DSKEYLBL DD keyword You can use this logic variable to determine the value coded for the DSKEYLBL keyword on the DD statement being processed. $BLANK Allows you to test for an "all blanks" condition.
Type	Logic variable
Maximum value	64 characters

Usage

You can use this descriptor EVALUATE definition statements and DAL Logic statements. This descriptor can also be used as an insert in message definition statements.

$JCL_DSNTYPE

$JCL_DSNTYPE($BLANK | LIBRARY | HFS | PDS | PIPE)

This DAL element has the following attributes:

Attribute	Value
Description	Check DSNTYPE DD keyword You can use this logic variable to determine the value coded for the DSNTYPE keyword on the DD statement being processed.
Type	Logic Variable
Maximum value	Not applicable
Valid value	$BLANK—Tests for an "all blanks" condition. LIBRARY—Specifies whether the LIBRARY subparameter was coded for the DSNTYPE keyword on the DD statement. If LIBRARY was coded, $JCL_DSNTYPE returns a TRUE value. HFS—Specifies whether the HFS subparameter is coded for the DSNTYPE keyword on the DD statement. If HFS was coded, $JCL_DSNTYPE returns a TRUE value. PDS—Specifies whether the PDS subparameter is coded for the DSNTYPE keyword on the DD statement. If PDS was coded, $JCL_DSNTYPE returns a TRUE value. PIPE—Specifies whether the PIPE subparameter is coded for the DSNTYPE keyword on the DD statement. If PIPE was coded, $JCL_DSNTYPE returns a TRUE value.

Usage

You can use this descriptor EVALUATE definition statements and DAL Logic statements. This descriptor can also be used as an insert in message definition statements.

$JCL_DSORG

$JCL_DSORG(CX | DA | DAU | GS | IS | ISU | PO | POU | PS | PSU)

This DAL element has the following attributes:

Attribute	Value
Description	Check DSORG DD keyword You can use this logic variable to determine the value coded for the DSORG keyword on the DD statement being processed.
Type	Logic Variable
Maximum value	Not applicable
Valid value	CX—Tests for the CX (communications line group) data set organization. DA—Tests for the DA (direct access) data set organization. DAU—Tests for the DAU (direct access with location-dependent information) data set organization. GS—Tests for the GS (graphic data control block) data set organization. IS—Tests for the IS (indexed sequential) data set organization. ISU—Tests for the ISU (indexed sequential with location-dependent information) data set organization. PO—Tests for the PO (partitioned, PDS or PDSE) data set organization. POU—Tests for the POU (partitioned (PDS) with location-dependent information) data set organization. PS—Tests for the PS (physical sequential) data set organization. PSU—Tests for the PSU (physical sequential with location-dependent information) data set organization.

Usage

You can use this descriptor EVALUATE definition statements and DAL Logic statements. This descriptor can also be used as an insert in message definition statements.

$JCL_EATTR

$JCL_EATTR(OPT | NO)

This DAL element has the following attributes:

Attribute	Value
Description	Support for extended attributes You can use this descriptor to determine whether the data set can support extended attributes (format 8 and 9 DSCBs) or not.
Type	Unique descriptor
Maximum value	Not applicable
Valid value	OPT—Specifies that extended attributes are optional. The data set can have extended attributes and reside in EAS. This is the default value for VSAM data sets. NO—Specifies that there are no extended attributes. The data set cannot have extended attributes (format 8 and 9 DSCBs) or reside in EAS. This is the default value for non-VSAM data sets.

Usage

You can use this descriptor EVALUATE definition statements and DAL Logic statements. This descriptor can also be used as an insert in message definition statements.

$JCL_EXEC_REGIONX_ABOVE

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

This DAL element has the following attributes:

Attribute	Value
Description	Above-the-line storage allocation This descriptor represents above-the-line storage allocation coded on an EXEC statement.
Type	Range definition descriptor
Maximum value	Not applicable
Valid value	start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified in K. name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. The first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a property name for ranges that you want to ignore.

Usage

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

Example

$JCL_EXEC_REGIONX_ABOVE REGIONA1,4096,REGIONA2,51200,REGIONA3

For more information, see $JCL_JOB_REGIONX_ABOVE, $JCL_JOB_REGIONX_BELOW, and $JCL_EXEC_REGIONX_BELOW.

$JCL_EXEC_REGIONX_BELOW

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

This DAL element has the following attributes:

Attribute	Value
Description	Below-the-line storage specification This descriptor represents below-the-line storage specification coded on an JOB statement.
Type	Range definition descriptor
Maximum value	99999 expressed in K and M
Valid value	start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified in K, M and G bytes of memory 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 the Definition Section of DAL, and also as an insert in message definition statements.

Example

$JCL_EXEC_REGIONX_BELOW REGIONB1,4096,REGIONB2,51200,REGIONB3

For more information, see $JCL_JOB_REGIONX_ABOVE, $JCL_JOB_REGIONX_BELOW, and $JCL_EXEC_REGIONX_ABOVE.

$JCL_EXPDT

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

This DAL element has the following attributes:

Attribute	Value
Description	Expiration Date from JCL This descriptor represents the expiration date from JCL, if any was coded. It was either specified as an expiration date or as a retention cycle in JCL.
Type	Range definition descriptor
Maximum value	2155/366 expressed as year/day
Valid value	start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified as year or day pairs, separated by a slash. name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. The first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a property name for ranges that you want to ignore.

Usage

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

Example

$JCL_EXPDT SCRATCH_LOW,2009/365,NEVER_SCRATCH,2010/001,SCRATCH_HIGH
$JCL_EXPDT JCL_NO_DATE,1900/001,JCL_DATE

For more information, see $JCL_RETPD.

$JCL_FILEDATA

$JCL_FILEDATA($BLANK | BINARY | TEXT | RECORD)

This DAL element has the following attributes:

Attribute	Value
Description	Check FILEDATA DD keyword You can use this Logic Variable to determine the value coded for the FILEDATA keyword on the DD statement being processed.
Type	Logic variable
Maximum value	Not applicable
Valid value	$BLANK—Tests an "all blanks" condition. BINARY—Specifies whether the BINARY subparameter was coded for the FILEDATA keyword on the DD statement. If BINARY was coded, $JCL_FILEDATA returns a TRUE value. TEXT—Specifies whether the TEXT subparameter was coded for the FILEDATA keyword on the DD statement. If TEXT was coded, $JCL_FILEDATA returns a TRUE value. RECORD—Specifies whether the RECORD subparameter was coded for the FILEDATA keyword on the DD statement. If RECORD was coded, $JCL_FILEDATA returns a TRUE value.

Usage

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

$JCL_FREE

$JCL_FREE(CLOSE | END)

This DAL element has the following attributes:

Attribute	Value
Description	Check FREE keyword You can use this logic variable to determine what has been coded for the FREE keyword.
Type	Logic variable
Maximum value	Not applicable
Valid value	CLOSE—Returns a TRUE value if CLOSE was coded for the FREE keyword. END—Returns a TRUE value if END was coded for the FREE keyword.

Usage

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

Important

If the FREE keyword was not coded, $JCL_FREE(END) returns a TRUE value, since FREE=END is the IBM default value.

$JCL_FREEVOL

$JCL_FREEVOL(EOV | END)

This DAL element has the following attributes:

Attribute	Value
Description	Check FREEVOL DD keyword You can use this logic variable to determine the value coded for the FREEVOL keyword on the DD statement being processed.
Type	Logic variable
Maximum value	Not applicable
Valid value	EOV—Specifies whether the EOV subparameter was coded for the FREEVOL keyword on the DD statement. If EOV was coded, $JCL_FREEVOL returns a TRUE value. END—Specifies whether the END subparameter was coded for the FREEVOL keyword on the DD statement. If EOV was coded, $JCL_FREEVOL returns a TRUE value.

Usage

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

Example

The following example provides the JAL to verify if FREEVOL was NOT coded.

EVAL FREE_EOV ($JCL_FREEVOL(EOV))
EVAL FREE_END ($JCL_FREEVOL(END))
EVAL FREEVOL_NOT_SPECIFIED (FREE_EOV & FREE_END)

$JCL_GDGORDER

$JCL_GDGORDER (USECATLG| LIFO | FIFO)

This DAL element has the following attributes:

Attribute	Value
Description	Check GDGORDER DD keyword You can use this logic variable to determine the value coded for the GDGORDER keyword on the DD statement being processed.
Type	Logic variable
Maximum value	Not applicable
Valid value	USECATLG—Specifies whether the USECATLG subparameter was coded for the GDGORDER keyword on the DD statement. If USECATLG was coded, $JCL_GDGORDER returns a TRUE value. LIFO—Specifies whether the LIFO subparameter was coded for the GDGORDER keyword on the DD statement. If LIFO was coded, $JCL_GDGORDER returns a TRUE value. FIFO—Specifies whether the FIFO subparameter was coded for the GDGORDER keyword on the DD statement. If FIFO was coded, $JCL_GDGORDER returns a TRUE value.

Usage:

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

$JCL_JOB_DSENQSHR

$JCL_JOB_DSENQSHR(YES | NO)

This DAL element has the following attributes:

Attribute	Value
Description	Check if DSENQSHR Value Coded on the JOB Statement You can use this logic variable to determine whether the DSENQSHR value was coded on the JOB statement or a default value was assigned.
Type	Logic variable
Maximum value	Not applicable
Valid value	YES—Returns a TRUE value if the DSENQSHR = is coded on the JOB statement by user . NO—Returns a TRUE value if the DSENQSHR= is not user coded and the system default value is assigned.

Usage

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

$JCL_JOB_REGIONX_ABOVE

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

This DAL element has the following attributes:

Attribute	Value
Description	Above-the-line Storage Allocation This descriptor represents above-the-line storage allocation coded on a JOB statement.
Type	Range definition descriptor
Maximum value	Not applicable
Valid value	start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified in K. name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. The first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a property name for ranges that you want to ignore.

Usage

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

Example

$JCL_JOB_REGIONX_ABOVE REGIONA1,4096,REGIONA2,51200,REGIONA3

For more information, see $JCL_JOB_REGIONX_BELOW, $JCL_EXEC_REGIONX_ABOVE, and $JCL_EXEC_REGIONX_BELOW.

$JCL_JOB_REGIONX_BELOW

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

This DAL element has the following attributes:

Attribute	Value
Description	Below-the-line storage allocation This descriptor represents below-the-line storage allocation coded on a JOB statement.
Type	Range definition descriptor
Maximum value	Not applicable
Valid value	start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified in K. name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. The first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a property name for ranges that you want to ignore.

Usage

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

Example

$JCL_JOB_REGIONX_BELOW REGIONB1,4096,REGIONB2,51200,REGIONB3

For more information, see $JCL_JOB_REGIONX_ABOVE, $JCL_EXEC_REGIONX_ABOVE, and $JCL_EXEC_REGIONX_BELOW.

$JCL_JOB_SYSAFF

$JCL_JOB_SYSAFF(YES | NO)

This DAL element has the following attributes:

Attribute	Value
Description	Check SYSAFF keyword coded on the JOB statement You can use this logic variable to determine whether the SYSAFF keyword was coded on the JOB statement.
Type	Logic Variable
Maximum value	Not applicable
Valid value	YES—Returns a TRUE value if the SYSAFF keyword coded on the JOB statement. NO—Returns a TRUE value if the SYSAFF keyword is not coded on the JOB statement.

Usage

You can use this descriptor EVALUATE definition statements and DAL Logic statements. This descriptor can also be used as an insert in message definition statements.

$JCL_JOB_SYSTEM

$JCL_JOB_SYSTEM(YES | NO)

This DAL element has the following attributes:

Attribute	Value
Description	Check SYSTEM keyword coded on the JOB statement You can use this logic variable to determine whether the SYSTEM keyword was coded on the JOB statement.
Type	Logic Variable
Maximum value	Not applicable
Valid value	YES—Returns a TRUE value if the SYSTEM keyword coded on the JOB statement. NO—Returns a TRUE value if the SYSTEM keyword is not coded on the JOB statement.

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

$JCL_JOB_UJOBCORR

$JCL_JOB_UJOBCORR (user-correlator | $BLANK)

This DAL element has the following attributes:

Attribute	Value
Description	Defines the UJOBCORR value on a JOB statement This descriptor represents UJOBCORR value coded on the JOB statement.
Type	Character descriptor
Maximum value	32 characters
Valid value	user-correlator—Indicates UJOBCORR value coded on the JOB statement. $BLANK—Is a special subparameter that checks for blanks.

Usage

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

$JCL_LABEL

$JCL_LABEL name TYPE(label) [PROCESS_AS(IN | OUT)]

This DAL element has the following attributes:

Attribute	Value
Description	Indicates the type of label You can use this descriptor to determine what has been coded in the DD LABEL field.
Type	Unique descriptor
Maximum value	Not applicable
Valid value	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. TYPE—This keyword indicates you want to determine if a particular label type was coded. label—Can be one of the following: AL, AUL, BLP, SUL, NSL, SL, NL PROCESS_AS—Determines the type of processing requested in JCL. IN—Tests for the presence of IN in the JCL. OUT—Tests for the presence of OUT in the JCL.

Usage

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

Important

The keywords TYPE and PROCESS_AS are treated as an AND if both are specified, that is, both conditions must be met to assign a TRUE value to the Property Name.

$JCL_LRECL

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

This DAL element has the following attributes:

Attribute	Value
Description	Record length from JCL This descriptor represents the record length coded in JCL, if any was coded.
Type	Range definition descriptor
Maximum value	32,761 bytes
Valid value	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 the Definition Section of DAL, and also as an insert in message definition statements.

Example

$JCL_LRECL USUAL,80,UNUSUAL

$JCL_MAXGENS

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

This DAL element has the following attributes:

Attribute	Value
Description	Maximum Number of Generations for Members in a Version 2 PDSE This parameter specifies the maximum number of generations for members in a Version 2 PDSE.
Type	Range definition descriptor
Maximum value	2,000,000,000
Valid value	start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified in number of days as 1-4 decimal digits. name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. The first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a property name for ranges that you want to ignore.

Usage

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

Example

$JCL_MAXGENS 0,NONE,1,SOME,10000,MORE,1500000000,LOTS

$JCL_MODELDSN

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

This DAL element has the following attributes:

Attribute	Value
Description	Model data set name This descriptor allows you to determine the MODEL data set name as coded in the DCB keyword for the DD currently being processed in DAL
Type	Character string descriptor
Maximum value	44 characters
Valid value	pattern—Hard-coded valid data set name pattern to be matched against the data set name on the DD statement being processed. %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 EVALUATE definition statements and DAL Logic statements and also:

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

Example

EVAL MODEL1
($JCL_MODELDSN(Z5900.TESTMDL))
EVAL MODEL2
($JCL_MODELDSN(Z5900.**))
...

$JCL_PROC_LIBRARY

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

This DAL element has the following attributes:

Attribute	Value
Description	Procedure library name This descriptor represents the procedure library name.
Type	Character string descriptor
Maximum value	44 characters
Valid value	pattern—Hard-coded string in 1–8 alphabetic, numeric, or national (#, @, $) characters. It can also include the hyphen (-) and the wildcard characters ? and . %patternID—Name of a pattern created with the PATTERNDEF statement tableID* —Identifies a specific table and which subtable to search The pattern, %patternID, or tableID entry is matched against the descriptor. If a match occurs, a TRUE value is returned. For INSTREAM TYPE the library name is "INSTREAM"

Usage

You can use this descriptor EVALUATE definition statements and DAL Logic statements and also:

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

For more information, see $JCL_PROC_NAME and $JCL_PROC_TYPE.

$JCL_PROC_NAME

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

This DAL element has the following attributes:

Attribute	Value
Description	Procedure name This descriptor represents the procedure name.
Type	Character string descriptor
Maximum value	8 characters
Valid value	pattern—Hard-coded string in 1–8 alphabetic, numeric, or national (#, @, $) characters. It can also include the hyphen (-) and the wildcard characters ? and . %patternID—Name of a pattern created with the PATTERNDEF statement tableID* —Identifies a specific table and which subtable to search The pattern, %patternID, or tableID entry is matched against the descriptor. If a match occurs, a TRUE value is returned. For INSTREAM TYPE the library name is "INSTREAM"

Usage

You can use this descriptor EVALUATE definition statements and DAL Logic statements and also:

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

For more information, see $JCL_PROC_LIBRARY and $JCL_PROC_TYPE.

$JCL_PROC_TYPE

$JCL_PROC_TYPE(INSTREAM | PRIVATE | SYSTEM)

This DAL element has the following attributes:

Attribute	Value
Description	Procedure library type You can use this logic variable to determine the TYPE of procedure library.
Type	Logic variable
Maximum value	Not applicable
Valid value	INSTREAM—Returns a TRUE value if the procedure Type is INSTREAM. PRIVATE—Returns a TRUE value if the procedure Type is PRIVATE SYSTEM—Returns a TRUE value if the procedure Type is SYSTEM.

Usage

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

For more information, see $JCL_PROC_LIBRARY and $JCL_PROC_NAME.

$JCL_PROTECT

$JCL_PROTECT(NO | YES)

This DAL element has the following attributes:

Attribute	Value
Description	Check PROTECT keyword You can use this logic variable to determine whether the PROTECT=YES keyword was coded on the current DD statement.
Type	Logic variable
Maximum value	Not applicable
Valid value	NO—Returns a TRUE value if the keyword PROTECT=YES was not coded on the current DD statement. YES—Returns a TRUE value if the keyword PROTECT=YES was coded on the current DD statement.

Usage

You can use this descriptor EVALUATE definition statements and DAL Logic statements. This descriptor can also be used as an insert in message definition statements.

JCL REPLACE

JCL REPLACE DSN(DATASETname)
or
JCL REPLACE RESET

This DAL element has the following attributes:

Attribute	Value
Description	TM ONLY. Replace data set Name for Current DD Statement You can use this statement to replace the data set named on the current DD statement. All other parameters for the data set are unchanged..
Type	Action statement
Maximum value	Not applicable
Valid value	DSN(DATASETname)—Specifies the data set name to replace the current data set name. DATASETname—Is a valid data set name. RESET—Undoes the effect of any previous JCL REPLACE statement. This keyword is mutually exclusive with the DSN keyword.

Important

If multiple JCL REPLACE statements are executed, the last one encountered takes effect.

For more information, see $JCL_REPLACE.

$JCL_REPLACE

$JCL_REPLACE(NO | YES)

This DAL element has the following attributes:

Attribute	Value
Description	Check whether data set name was replaced You can use this logic variable to determine whether the data set name on the current DD statement was replaced by a previous TM DAL.
Type	Logic variable
Maximum value	Not applicable
Valid value	NO—Returns a TRUE value if the data set name on the current DD statement was not replaced by a previous TM DAL. YES—Returns a TRUE value if the current DD statement was added by a previous TM DAL.

Usage

You can use this descriptor EVALUATE definition statements and DAL Logic statements. This descriptor can also be used as an insert in message definition statements.

For more information, see JCL REPLACE.

$JCL_RETPD

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

This DAL element has the following attributes:

Attribute	Value
Description	Retention period for the DD statement You can use this descriptor to determine the retention period specified in JCL for the DD statement being processed
Type	Range definition descriptor
Maximum value	9999 expressed in days
Valid value	start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified in number of days as 1-4 decimal digits. name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. The first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a property name for ranges that you want to ignore.

Usage

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

For more information, see $JCL_EXPDT.

$JCL_SCHEDULE_AFTER

$JCL_SCHEDULE_AFTER (YES | NO)

This DAL element has the following attributes:

Attribute	Value
Description	Indicate if AFTER parameter is coded on the SCHEDULE statement You can use this logic variable to determine whether the AFTER parameter is coded on the SCHEDULE statement. This function returns a TRUE/FALSE value depending on whether or not the job AFTER parameter was coded.
Type	Logic descriptor
Maximum value	Not applicable
Valid value	YES—Returns a value of TRUE if AFTER parameter was coded, otherwise it returns a FALSE value. NO—Returns a value of TRUE if AFTER parameter was not coded, otherwise it returns a FALSE value.

Usage

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

For more information, see $JCL_SCHEDULE_BEFORE, $JCL_SCHEDULE_JOBGROUP, and $JCL_SCHEDULE_WITH.

$JCL_SCHEDULE_BEFORE

$JCL_SCHEDULE_BEFORE (YES | NO)

This DAL element has the following attributes:

Attribute	Value
Description	Indicate if BEFORE parameter is coded on the SCHEDULE statement You can use this logic variable to determine whether the BEFORE parameter is coded on the SCHEDULE statement. This function returns a TRUE or FALSE value depending on whether or not the job BEFORE parameter was coded.
Type	Logic descriptor
Maximum value	Not applicable
Valid value	YES—Returns a value of TRUE if BEFORE parameter was coded, otherwise it returns a FALSE value. NO—Returns a value of TRUE BEFORE parameter was not coded, otherwise it returns a FALSE value.

Usage

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

For more information, see $JCL_SCHEDULE_AFTER, $JCL_SCHEDULE_JOBGROUP, and $JCL_SCHEDULE_WITH.

$JCL_SCHEDULE_HOLDUNTL

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

This DAL element has the following attributes:

Attribute	Value
Description	HOLDUNTL time parameter on the SCHEDULE statement This descriptor represents the difference between the specified "hold until" time and the time of analysis.
Type	Range definition descriptor
Maximum value	357912:00
Valid value	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 357,912 in minutes and ss ranges from 0 to 59 in seconds. The value mmmm can be specified without seconds but ss must be preceded by mmmm. For example, 30 seconds is specified as 0:30. name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. The first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a property name for ranges that you want to ignore.

Usage

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

Example

$JCL_SCHEDULE_HOLDUNTL NO-HOLD,00:01,HOLD-SRT,1:30,HOLD-LNG,12:30,HOLD-SUPER

Important

This descriptor is displayed in messages in the same format as HOLDUNTL parameter is coded in the SCHEDULE statement (+hh:mm or hh:mm mm/dd/yyyy or hh:mm ddd/yyyy).

For more information, see $JCL_SCHEDULE_JOBGROUP and $JCL_SCHEDULE_STARTBY.

$JCL_SCHEDULE_JOBGROUP

$JCL_SCHEDULE_JOBGROUP (pattern | %patid | table-id | $BLANK)

This DAL element has the following attributes:

Attribute	Value
Description	JOBGROUP name specified on the SCHEDULE statement This descriptor represents the JOBGROUP name coded on the SCHEDULE statement.
Type	Character descriptor
Maximum value	17 characters
Valid value	$BLANK—Is a special subparameter that allows you to check for blanks.

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

Usage

You can use this descriptor EVALUATE definition statements and DAL Logic statements and also:

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

Example

$JCL_SCHEDULE_JOBGROUP(GROUP.PROD)
$JCL_SCHEDULE_JOBGROUP($TABLE3(GROUPN))
EVALUATE FIELDGR_BLANK ($JCL_SCHEDULE_JOBGROUP(3,$BLANK))

For more information, see $JCL_SCHEDULE_AFTER, and $JCL_SCHEDULE_WITH, and $JCL_SCHEDULE_HOLDUNTL.

$JCL_SCHEDULE_STARTBY

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

This DAL element has the following attributes:

Attribute	Value
Description	STARTBY time parameter specified on the SCHEDULE statement This descriptor represents the difference between the specified start by time and the time of analysis.
Type	Range definition descriptor
Maximum value	23:59
Valid value	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 357,912 in minutes and ss ranges from 0 to 59 in seconds. The value mmmm can be specified without seconds but ss must be preceded by mmmm. For example, 30 seconds is specified as 0:30. name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. The first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a property name for ranges that you want to ignore.

Usage

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

Example

$JCL_SCHEDULE_STRTBY NO-WAIT,00:01,WAIT-SRT,1:30,WAIT-LNG,12:30,WAIT-EXTRA

Important

This descriptor is displayed in messages in the same format as STARTBY parameter is coded in JCL SCHEDULE statement (+hh:mm or hh:mm mm/dd/yyyy or hh:mm ddd/yyyy).

For more information, see $JCL_SCHEDULE_JOBGROUP and $JCL_SCHEDULE_HOLDUNTL.

$JCL_SCHEDULE_WITH

$JCL_SCHEDULE_WITH (YES | NO)

This function returns a TRUE/FALSE value depending on whether or not the job WITH parameter was coded.

This DAL element has the following attributes:

Attribute	Value
Description	Indicate if WITH parameter is coded on the SCHEDULE statement You can use this logic variable to determine whether the WITH parameter is coded on the SCHEDULE statement.
Type	Logic descriptor
Maximum value	Not applicable
Valid value	YES—Returns a value of TRUE if AFTER parameter was coded, otherwise it returns a FALSE value. NO—Returns a value of TRUE if AFTER parameter was not coded, otherwise it returns a FALSE value.

Usage

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

For more information, see $JCL_SCHEDULE_AFTER, $JCL_SCHEDULE_BEFORE, and $JCL_SCHEDULE_JOBGROUP.

$JCL_STMT#

This DAL element has the following attributes:

Attribute	Value
Description	JCL Statement Number You can use this display variable to to insert the number of the JCL statement being analyzed into a message.
Type	Display variable
Maximum value	65,535
Valid value	$JCL_STMT#—Is a valid insert in a MSGDEF statement.

Usage

This variable can be used only as an insert in message definition statements.

$JCL_STRNO

This DAL element has the following attributes:

Attribute	Value
Description	Number of VSAM concurrent request parameter lists from JCL This descriptor represents the STRNO= value coded in JCL, if any was coded.
Type	Range definition descriptor
Maximum value	32,767 bytes
Valid value	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 the Definition Section of DAL, and also as an insert in message definition statements.

Example

$JCL_STRNO SMALL,1024,NORMAL,16384,LARGE

$JCL_SYMBOLS

$JCL_SYMBOLS(JCLONLY | EXECSYS | CNVTSYS]

This DAL element has the following attributes:

Attribute	Value
Description	Indicates that SYMBOLS keyword coded on the DD statement You can use this descriptor to determine what has been coded in the DD SYMBOLS field.
Type	Unique descriptor
Maximum value	Not applicable
Valid value	JCLONLY—Specifies that the names of JCL symbols and JES symbols found in the in-stream data set are replaced with their values. EXECSYS—Specifies that the names of JCL symbols and JES symbols found in the in-stream data set are replaced with their values. In addition, system symbols defined on the system during job execution can be used in the in-stream data. CNVTSYS—Specifies that the names of JCL symbols and JES symbols found in the in-stream data set are replaced with their values. In addition, system symbols defined on the system during job execution can be used in the in-stream data, with the exception that system symbols used for substitution are taken not from the system where the job is executing, but from the system where the job has undergone JCL conversion.

Usage

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

$JCL_SYMBOLS_LOGDD

$JCL_LOGDD(ddname | $BLANK)

This DAL element has the following attributes:

Attribute	Value
Description	Logging-DDname specified within the SYMBOLS= operands. This descriptor indicates if a logging-DDname was specified within the SYMBOLS= operands.
Type	Character descriptor
Maximum value	8 characters
Valid value	ddname—The logging-DDname specified in the SYMBOLS=. $BLANK—The logging-DDname was NOT specified.

Usage

This descriptor can be used only as an insert in message definition statements.

For more information, see $BLANK.

$JCL_TRTCH

$JCL_TRTCH(C |E | T | ET | COMP | NOCOMP | $BLANK)

This DAL element has the following attributes:

Attribute	Value
Description	Check TRTCH DD keyword You can use this logic variable to determine the value coded for the TRTCH keyword on the DD statement being processed.
Type	Logic Variable
Maximum value	Not applicable
Valid value	These keywords are described in the IBM JCL Reference manual

Usage

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

$JCL_UNITNAME_MATCH

$JCL_UNITNAME_MATCH name
(unitname-list)

This DAL element has the following attributes:

Attribute	Value
Description	Matches JCL unit name with a list of names You can use this unique descriptor to determine whether at least one of a list of unit names is coded on the DD statement that is being analyzed.
Type	Unique descriptor
Maximum value	Not applicable
Valid value	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 (_). unitname-list—A list of unit names, patterns, %patids, and/or tables separated by commas. pattern—Hard-coded string in 1-8 alphabetic, numeric, or national (#, @, $) characters. It can also include the wildcard characters ? and *. %patid—The name of a pattern created with the PATTERNDEF statement. table-id—Identifies a specific table and how to search.

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

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

For more information, see $JCL_CODED and $UNITNAME.

$JCL_UNITNAME_TMMAP

$JCL_UNITNAME_TMMAP(NO | YES)

This DAL element has the following attributes:

Attribute	Value
Description	TM unit mapping in effect You can use this logic variable to determine if BMC ThruPut Manager unit name mapping is in effect. It indicates that at least one unit name coded in the job has been mapped to another unit name for Job Analysis purposes. Unit name mapping is provided by either the TM UNIT initialization statement or the TM UNIT operator command.
Type	Logic variable
Maximum value	Not applicable
Valid value	NO—Returns a value of TRUE when TM unit name mapping is not in effect. YES—Returns a value of TRUE when TM unit name mapping is in effect.

Usage

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

$JCL_VOLSER

$JCL_VOLSER(YES | NO)

This DAL element has the following attributes:

Attribute	Value
Description	Indicates if volume serial is coded You can use this logic variable to determine if a volume serial number is coded in JCL for the DD statement being processed. It tests whether at least one hard-coded volume serial number is present.
Type	Logic variable
Maximum value	Not applicable
Valid value	NO—Returns a value of TRUE when a volume serial number was not coded. YES—Returns a value of TRUE when a volume serial number was coded.

Usage

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

$JECL_verb

$JECL_verb(YES | NO)

This DAL element has the following attributes:

Attribute	Value
Description	Indicates if a JECL statement is coded. You can use this Logic descriptor to determine if the specific JECL statement is included in the JCL.
Type	Logic descriptor
Maximum value	Not applicable
Valid value	NO—Returns a value of TRUE when a when a specified JECL statement was not included. YES—Returns a value of TRUE when a specified JECL statement was included.

Usage

These descriptors can be used in EVALUATE definition statements and DAL Logic statements, and also as an inserts in message definition statements.

$JECL descriptor	JECL Statement
$JECL_CA7(YES\|NO)	//* CA-7
$JECL_AFTER(YES\|NO)	//*+AFTER
$JECL_BEFORE(YES\|NO)	//*+BEFORE
$JECL_CNTL(YES\|NO)	//*+CNTL
$JECL_DAL(YES\|NO)	//*+DAL
$JECL_DAL_TRACE(YES\|NO)	//*+DAL TRACE
$JECL_DBS(YES\|NO)	//*+DBS
$JECL_DBS_RESERVE(YES\|NO)	//*+DBS RESERVE
$JECL_DBS_SET(YES\|NO)	//*+DBS SET
$JECL_DCS(YES\|NO)	//*+DCS
$JECL_DCS_ALERT(YES\|NO)	//*+DCS ALERT
$JECL_DCS_ALERTF1(YES\|NO)	//*+DCS ALERTF1
$JECL_DCS_ALERTF2(YES\|NO)	//*+DCS ALERTF2
$JECL_DCS_ALERTH1(YES\|NO)	//*+DCS ALERTH1
$JECL_DCS_ALERTH2(YES\|NO)	//*+DCS ALERTH2
$JECL_DCS_DF_GROUP(YES\|NO)	//*+DCS DF_GROUP
$JECL_DCS_FORDSN(YES\|NO)	//*+DCS FORDSN
$JECL_DCS_NAG(YES\|NO)	//*+DCS NAG
$JECL_DCS_NAGTEXT(YES\|NO)	//*+DCS NAGTEXT
$JECL_DCS_REPO(YES\|NO)	//*+DCS REPO
$JECL_DCS_SERVICE(YES\|NO)	//*+DCS SERVICE
$JECL_DJC(YES\|NO)	//*+DJC
$JECL_DJC_ANDIF(YES\|NO)	//*+DJC ANDIF
$JECL_DJC_CONDIF(YES\|NO)	//*+DJC CONDIF
$JECL_DJC_FLUSHIF(YES\|NO)	//*+DJC FLUSHIF
$JECL_DJC_MESSAGE(YES\|NO	//*+DJC MESSAGE
$JECL_DJC_RUNIF(YES\|NO)	//*+DJC RUNIF
$JECL_DJC_SIGNAL(YES\|NO)	//*+DJC SIGNAL
$JECL_JAL(YES\|NO)	//*+JAL
$JECL_JAL_TRACE(YES\|NO)	//*+JAL TRACE
$JECL_JBS(YES\|NO)	//*+JBS
$JECL_JBS_ACTIVATE(YES\|NO)	//*+JBS ACTIVATE
$JECL_JBS_BIND(YES\|NO)	//*+JBS BIND
$JECL_JBS_DEACTIVATE(YES\|NO)	//*+JBS DEACTIVATE
$JECL_JBS_NEEDS(YES\|NO)	//*+JBS NEEDS
$JECL_JBS_SET(YES\|NO)	//*+JBS SET
$JECL_JCS(YES\|NO)	//*+JCS
$JECL_JCS_AFTER(YES\|NO)	//*+JCS AFTER
$JECL_JCS_BATCH(YES\|NO)	//*+JCS BATCH
$JECL_JCS_BEFORE(YES\|NO)	//*+JCS BEFORE
$JECL_JCS_WITH(YES\|NO)	//*+JCS WITH
$JECL_JLS(YES\|NO)	//*+JLS
$JECL_JLS_ENQ(YES\|NO)	//*+JLS ENQ
$JECL_JLS_LIMIT(YES\|NO)	//*+JLS LIMIT
$JECL_JSS(YES\|NO)	//*+JSS
$JECL_JSS_PREVENT(YES\|NO)	//*+JSS PREVENT
$JECL_JSS_SERVICE(YES\|NO)	//*+JSS SERVICE
$JECL_JTS(YES\|NO)	//*+JTS
$JECL_JTS_HOLD_UNTIL(YES\|NO)	//*+JTS HOLD_UNTIL
$JECL_JTS_RELEASE(YES\|NO)	//*+JTS RELEASE
$JECL_MHS_USER(YES\|NO)	//*+MHS_USER
$JECL_MHS_USER_HOLD(YES\|NO)	//*+MHS_USER HOLD
$JECL_PCS(YES\|NO)	//*+PCS
$JECL_SLM(YES\|NO)	//*+SLM
$JECL_SLM_SERVICE(YES\|NO)	//*+SLM SERVICE
$JECL_TM(YES\|NO)	//*+TM
$JECL_TM_CAPTURE(YES\|NO)	//*+TM CAPTURE
$JECL_TM_EXEMPT(YES\|NO)	//*+TM EXEMPT
$JECL_TM_MESSAGE(YES\|NO)	//*+TM MESSAGE
$JECL_TM_TRACE(YES\|NO)	//*+TM TRACE
$JECL_WITH(YES\|NO)	//*+WITH
$JECL_DATASET(YES\|NO)	//*DATASET
$JECL_FORMAT(YES\|NO)	//*FORMAT
$JECL_MAIN(YES\|NO)	//*MAIN
$JECL_NET(YES\|NO)	//*NET
$JECL_NETACCT(YES\|NO)	//*NETACCT
$JECL_OPERATOR(YES\|NO)	//*OPERATOR
$JECL_PROCESS(YES\|NO)	//*PROCESS
$JECL_ROUTE(YES\|NO)	//*ROUTE
$JECL_ZEKE(YES\|NO)	//*ZEKECTL

JLS ADD LIMIT

JLS ADD LIMIT(limitdef-id[(weight[,DRAIN])])

This DAL element has the following attributes:

Attribute	Value
Description	TM ONLY. Associates job with a limiting agent. You can use this action statement to associate a job with a limiting agent.
Type	Action statement.
Maximum value	Not applicable
Valid value	LIMIT(limitdef-id[(weight[,DRAIN])])—This keyword indicates that you want to associate a Limiting Agent with the job. For each invocation of DAL you can have up to 24 Limiting Agents. That is, you can run up to 24 JLS ADD LIMIT statements without an intervening JLS DELETE LIMIT statement. limitdef-ID—The name-id of a JLS_LIMITDEF statement that defines a Limiting Agent. weight—This can be expressed either as: A numerical value from 1 to 999. Any Range descriptor.(For example, $USERN1) If a job is given a weight of n, it counts as if n jobs were executing. The default value is 1. DRAIN—This subparameter indicates that once this job reaches the top of the execution queue, other jobs associated with this Limiting Agent are to be held until this job is initiated.

Example

JLS_LIMITDEF GROUPA LEVEL1('DEVA') LEVEL2($RACFU) LIMIT(3)
...
JLS ADD LIMIT(GROUPA)
...

In this example a Limiting Agent with a limit value of 3 is associated with the job.

JLS_LIMITDEF GROUPB LEVEL1('DEVB') LEVEL2($RACFU) LIMIT(5)
...
JLS ADD LIMIT(GROUPB(3,DRAIN))
...

In this example, a Limiting Agent with a limit value of 5 is associated with the job. The job is to be treated as though one job were executing for each unit used by the DD statement, and is important enough to delay other jobs once it reaches the head of the execution queue.

Important

You can determine if you have executed any JLS ADD LIMIT for this job by testing the logic variable $JXJLANY.

You can determine if you can add more requests by testing the logic variable $JXJLMAX. If this variable is TRUE, you have reached the maximum.

The DRAIN subparameter should be used with care, since assigning it to multiple jobs diminishes its effect.

For more information, see JLS DELETE LIMIT, JLS REPLACE LIMIT, JLS_LIMITDEF, $JXJLANY, and $JXJLMAX.

JLS DELETE LIMIT

JLS DELETE [LIMIT | ALL_LIMITS]

This DAL element has the following attributes:

Attribute	Value
Description	TM ONLY. Deletes limit association This action statement removes a previously associated Limiting Agent.
Type	Action statement
Maximum value	Not applicable
Valid value	LIMIT—Indicates that the association with a Limiting Agent previously created with a JLS ADD LIMIT statement be removed. ALL_LIMITS—Indicates that you want to delete all existing Limiting Agent associations that have not been added through JECL.

Important

This facility covers situations where your main logic has a JLS ADD LIMIT request that you want to eliminate in your "exception conditions" logic.

If no JLS ADD LIMIT request has been previously executed, this statement is ignored.

For more information, s ee JLS ADD LIMIT, JLS REPLACE LIMIT, JLS_LIMITDEF, $JXJLANY, and $JXJLMAX.

JLS REPLACE LIMIT

JLS REPLACE LIMIT(limitdef-id[(weight[,DRAIN])])

This DAL element has the following attributes:

Attribute	Value
Description	TM ONLY. Replaces a previous JLS ADD LIMIT request You can use this action statement to replace the last previously executed JLS ADD LIMIT request for the job.
Type	Action statement
Valid value	LIMIT(limitdef-id[(weight[,DRAIN)])—This keyword indicates that the last previously executed JLS ADD LIMIT request is to be replaced with a new request. If no JLS ADD LIMIT statement has been executed, this statement is treated as the first JLS ADD LIMIT statement. limitdef-ID—The name-id of a JLS_LIMITDEF statement defining the Limiting Agent. weight—This can be expressed either as: A numerical value from 1 to 999 A numerical descriptor such as $USERN1. If a job is given a weight of n, it counts as if n jobs were executing. The default value is 1. DRAIN—This subparameter indicates that once this job reaches the top of the execution queue, other jobs associated with this Limiting Agent are to be held until this job is initiated.

Example

JLS REPLACE LIMIT(GROUP1)
JLS REPLACE LIMIT(GROUP2(3,DRAIN))

Important

Normally used with exception conditions logic, where your main logic has a JLS ADD LIMIT request that you want to replace under certain conditions.

The DRAIN subparameter should be used with care, since assigning it to multiple jobs diminishes its effect.

For more information, see JLS ADD LIMIT, JLS DELETE LIMIT, JLS_LIMITDEF, $JXJLANY, and $JXJLMAX.

$JLS_LIMIT

$JLS_LIMIT name AGENT(pattern | %patid | table-id) [ONLY]

This DAL element has the following attributes:

Attribute	Value
Description	TM ONLY. Job limiting services LIMIT reference You can use this descriptor to determine whether there is a JLS LIMIT statement for a particular Limiting Agent in JECL statements. You can also test whether the specified agent is the only agent accessed.
Type	Unique descriptor
Maximum value	Not applicable
Valid value	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 (_). AGENT(pattern \| %patid \| table-id)—Indicates that a search pattern for a Binding Agent follows. pattern—A search pattern for a Binding Agent. The name can only be two levels. This pattern must be 1 to 17 characters and conform to the rules described in the section Pattern-matching-for-binding-agent-names. %patid—The name of a pattern constructed with a PATTERNDEF statement. table-id—Identifies a specific table and how to search. For more information about table support, see DAL-and-JAL-table-management. ONLY—Tests whether the limiting agents specified are the only ones being accessed.

Usage

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

Example

$JLS_LIMIT IMS AGENT(IMS.*)
$JLS_LIMIT BILL_OF_MATERIALS AGENT($TABLE3(BMPAGNTS))

Important

If ONLY is specified together with a pattern for the AGENT keyword, the Property Name is assigned a TRUE value only if all Limiting Agents found match the pattern.

For more information, s ee $JLS_LIMIT#.

$JLS_LIMIT#

$JLS_LIMIT# [0,]name1,start2,name2[,...,startN,nameN]

This DAL element has the following attributes:

Attribute	Value
Description	TM ONLY. Number of JLS LIMIT JECL statements This descriptor represents the number of JECL JLS LIMIT statements present in a job.
Type	Range definition descriptor
Maximum value	99 expressed in number of JLS LIMIT JECL statements
Valid value	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 the Definition Section of DAL, and also as an insert in message definition statements.

Example

$JLS_LIMIT# NO_LIMITS,1,SOME_LIMITS

For more information, see $JLS_LIMIT.

JLS_LIMITDEF

JLS_LIMITDEF name-id LEVEL1(first-level-name)
                    [LEVEL2(second-level-name)]
                    LIMIT(nnn | $USERNnn)
                    [PANEL(panelid)]

This DAL element has the following attributes:

Attribute	Value
Description	TM ONLY. Defines Limiting Agents This statement allows you to define the name and characteristics of a Limiting Agent.
Type	Definition statement
Maximum value	Not applicable
Valid value	name-id—Unique name ID in 1-24 alphabetic, numeric, national (#, @, $), or underscore (_) characters, the first of which must be alphabetic or national. Note that the first character cannot be a $. The name-id is used in the JLS ADD LIMIT and JLS REPLACE LIMIT statements to indicate the Limiting Agent: JLS ADD LIMIT(name-id) LEVEL1(first-level-name)—Indicates that a level one name for the Limiting Agent is provided in 1-8 alphabetic, numeric, national (#, @, $), or underscore (_) characters. The first character of the fully constructed level name can be a numeric value but it cannot be a $. If the first character of the name is a plus sign (+), the scope of the agent is restricted to a single system. For more information, see Job-Limiting-Service-function. first-level-name—The name can be constructed using one of the following techniques: A hard coded string, enclosed in apostrophes, such as SETUP. A request to create the name dynamically from a character descriptor. For example: JLS_LIMITDEF DEVELOP LEVEL1($RACFU) ... A request to create the name dynamically from a portion of a descriptor using the substring function. The format for this built-in function call is: LEVEL1(descriptor,length,[starting position]) An example: JLS_LIMITDEF DEVELOP LEVEL1($RACFU,5) ... The first level of the agent name is constructed from the first 5 characters of the RACFU field. For more information about the substring function, see Character-string-facilities-tutorial, with some additional restrictions: If the substring contains all blanks, an error occurs since no name can be constructed. If the substring contains embedded blanks, an error occurs since otherwise an invalid Agent name would be created. If the length exceeds 8, the string is truncated and a warning message is issued. One of the JAL execution time string variables created with STRINGDEF. For example: JLS_LIMITDEF DEVELOP LEVEL1(%FLNAME)... LEVEL2(second-level-name)—Indicates that a level two name for the Limiting Agent is provided. This keyword is optional. second-level-name—The same options as documented above for first-level-name LIMIT(nnn \| $USERNnn)—This keyword is used to indicate the limit to be placed for the selection of jobs that are associated with this Limiting Agent. It represents the maximum number of jobs in the MAS complex that can be executing concurrently. nnn \| $USERNnn—A numerical value from 1-999, such as LIMIT(10), or a numeric user variable, $USERNnn. PANEL(panelid)—Allows you to add the identifier for an ISPF panel that can be invoked to display installationdefined information when using the UDF facility. panelid—Is a valid ISPF panel identifier.

Example

JLS_LIMITDEF DEVELOP LEVEL1('DEVJOBS') LEVEL2($XEQCLASS) LIMIT(1)
...
JLS ADD LIMIT(DEVELOP)

This statement allows you to limit the concurrent execution of jobs to only one per different execution class.

JLS_LIMITDEF BACKUP LEVEL1('BACKUP') LEVEL2('DASD') LIMIT(1)
...
JLS ADD LIMIT(BACKUP)

In this case you do not want more than one backup job at a time.

JLS_LIMITDEF LIMITG1 LEVEL1('GROUP1') LEVEL2($ACCT,3) LIMIT(2)

In this case the first three characters of the account field are chosen to form the second level for the Limiting Agent name. The JLS ADD LIMIT statements associates this job with two Limiting Agents.

...
JLS ADD LIMIT(BACKUP)
JLS ADD LIMIT(LIMITG1)
...

For more information, see JLS ADD LIMIT, JLS DELETE LIMIT, JLS REPLACE LIMIT, $JXJLANY, and $JXJLMAX.

$JOBCPU

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

This DAL element has the following attributes:

Attribute	Value
Description	CPU Time From JOB Statement This descriptor represents the amount of CPU time specified in the TIME= parameter on the JOB statement.
Type	Range definition descriptor
Maximum value	357912:00 minutes
Valid value	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 the Definition Section of DAL, and also as an insert in message definition statements.

Example

$JOBCPU NO_CPU,0:01,JOB_TIME

Important

If TIME= was not specified, the value is 0.

$JOBID

This DAL element has the following attributes:

Attribute	Value
Description	JES2 Job Identifier This is an execution time Display Variable. It allows you to display the JES2 job identifier: For jobs with five digits or less, this variable displays JOBnnnnn. For jobs with six digits or more, this variable displays Jnnnnnnn.
Type	Display variable
Maximum value	8 characters
Valid value	$JOBID—Is a valid insert in a MSGDEF statement. It prints the JES2 job identifier.

Usage

This Variable can be used only as an insert in message definition statements.

For more information, see $JOBNUMBER.

$JOBNAME | $JOBN

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

This DAL element has the following attributes:

Attribute	Value
Description	Jobname from the JOB statement This descriptor represents the jobname from the JOB statement.
Type	Character string descriptor
Maximum value	8 characters
Valid value	pattern—Hard-coded string in 1–8 alphabetic, numeric, or national (#, @, $) characters. It can also include the hyphen (-) and the wildcard characters ? and . %patternID—Name of a pattern created with the PATTERNDEF statement tableID—Identifies a specific table and which subtable to search The pattern, %patternID, or tableID* entry is matched against the descriptor. If a match occurs, a TRUE value is returned.

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

Usage

You can use this descriptor EVALUATE definition statements and DAL Logic statements and also:

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

Example

$JOBNAME(JOB1234)
$JOBN(PAYROLL)
$JOBNAME($TABLE3(JOBNAMES))

$JOBNUMBER | $JOBNUM

$JOBNUMBER
$JOBNUM

This DAL element has the following attributes:

Attribute	Value
Description	JES2 job number This is the run time display variable. Displays the JES2 job number.
Type	Display variable
Maximum value	5 characters
Valid value	$JOBNUMBER—Is a valid insert in a MSGDEF statement. This prints the JES2 job number.

Usage

This Variable can be used only as an insert in message definition statements.

For more information, see $JOBID.

$JOB_PERFORM

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

This DAL element has the following attributes:

Attribute	Value
Description	Performance group from JOB statement This descriptor returns a number in the range 1-999, representing the value coded for the PERFORM= keyword on the JOB statement.
Type	Range definition descriptor
Maximum value	999
Valid value	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 the Definition Section of DAL, and also as an insert in message definition statements.

For more information, see $PERFORM.

JSS ALLOW

JSS ALLOW [HSM_RECALLS] [TAPE_ALLOCATION]
or
JSS ALLOW RESET

This DAL element has the following attributes:

Attribute	Value
Description	TM ONLY. Allow override of IEFBR14 bypass The BMC ThruPut Manager JSS SET initialization statement allows an installation to bypass allocation processing in IEFBR14-type steps: HSM recalls for data sets with a primary disposition of DELETE. Tape data sets. This action statement overrides the specified bypass(es).
Type	Action statement
Maximum value	999
Valid value	HSM_RECALLS—Requests that HSM processing be allowed for this step. TAPE_ALLOCATION—Requests that tape allocation processing be allowed for this step. RESET—Undoes the effect of a previous JSS ALLOW statement. If no JSS ALLOW statement has been encountered, the RESET is ignored.

For more information, see $JSS_BYPASS_RECALLS and $JSS_BYPASS_TAPE_ALLOC.

$JSS_BYPASS_RECALLS

$JSS_BYPASS_RECALLS(NO | YES)

This DAL element has the following attributes:

Attribute	Value
Description	TM ONLY. Test for override of HSM recall bypassing You can use this logic variable to determine if a request has already been made by a JSS ALLOW statement to allow the step to override the JSS SET initialization statement for HSM recalls for data sets with a primary disposition of DELETE.
Type	Logic variable
Maximum value	Not applicable
Valid value	NO—A value of TRUE is returned if you do not run a JSS ALLOW HSM_RECALLS statement YES—A value of TRUE is returned if you run a JSS ALLOW HSM_RECALLS statement

Usage

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

For more information, see JSS ALLOW.

$JSS_BYPASS_TAPE_ALLOC

$JSS_BYPASS_TAPE_ALLOC(NO | YES)

This DAL element has the following attributes:

Attribute	Value
Description	TM ONLY. Test for override of tape allocation bypassing You can use this logic variable to determine if a request has already been made by a JSS ALLOW statement to allow the step to override the JSS SET initialization statement for tape allocation. This function call returns a TRUE or FALSE value depending on whether or not a JSS ALLOW TAPE_ ALLOCATION statement has been executed.
Type	Logic variable
Maximum value	Not applicable
Valid value	NO—A value of TRUE is returned if you cannot run a JSS ALLOW HSM_TAPE_ALLOC statement YES—A value of TRUE is returned if you run a JSS ALLOW HSM_TAPE_ALLOC statement

Usage

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

For more information, see JSS ALLOW.

JSS IGNORE

JSS IGNORE [RESOURCES | RESET]

This DAL element has the following attributes:

Attribute	Value
Description	Ignore resource requirements This statement nullifies the resource counts for the DD statement being examined, effectively causing it to be treated as a DD DUMMY.
Type	Action statement
Maximum value	Not applicable
Valid value	RESOURCES—Indicates that the resource counts for this DD statement are to be ignored. This keyword is mutually exclusive with RESET. RESET—Undoes the effect of a previously executed JSS IGNORE statement. This keyword is mutually exclusive with RESOURCES.

Important

If more than one JSS IGNORE statement is specified, the last one encountered takes effect.

JSS INCREMENT

JSS INCREMENT [3480(nnn)]
             [3480V(nnn)]
             [3490(nnn)]
             [3490V(nnn)]
             [3590-1(nnn)]

This DAL element has the following attributes:

Attribute	Value
Description	Increment tape device resource requirements This statement increments the count of devices of a particular type that a job requires, allowing you to account for dynamic allocations. Usually, you can use this statement in TM DAL, as there is no invocation of DAL for a dynamic allocation.
Type	Action statement
Valid value	3480(nnn)3480V(nnn)3490(nnn)3490V(nnn)3590-1(nnn)—Indicates the type of device for which the resource count is to be incremented. nnn—Is a number from 1-255, specifying how many units are to be added to the resource count.

Example

JSS INCREMENT 3480(2)

This statement increases the resource count by two for $UNIT_3480_ALL and the DBS Drive Pool for 3480 devices.

Important

This statement affects the BMC ThruPut Manager base unit counts ($UNIT_devicetype_ALL) for the type of device specified. See the example.

JSS RECALL

JSS RECALL YES | DASD | TAPE | MAX_WAIT(nnn)]
or
JSS RECALL NO

This DAL element has the following attributes:

Attribute	Value
Description	Request DFSMShsm recall Specifies whether BMC ThruPut Manager can initiate recalls for a data set that has been migrated to archival storage by DFSMShsm. This statement is ignored if the DD statement does not see to a migrated data set.
Type	Action statement
Valid value	RECALL—Indicates that if there is any DFSMShsm migrated data set, a DFSMShsm recall is to be initiated. NO—Indicates that no DFSMShsm recall is to be initiated. This keyword is mutually exclusive with YES, DASD, TAPE, and MAX_WAIT. YES—Specifies that a DFSMShsm recall is to be initiated for a migrated data set, regardless of data set location. This keyword is mutually exclusive with NO, DASD, and TAPE. DASD—Specifies that a DFSMShsm recall is to be initiated only for a data set whose catalog entry indicates that it has been migrated to DASD. This keyword is mutually exclusive with NO, YES, and TAPE. TAPE—Specifies that a DFSMShsm recall is to be initiated only for a data set whose catalog entry indicates that it has been migrated to tape. This keyword is mutually exclusive with NO, YES, and DASD. mmm—A number from the range 1-999, indicating how many minutes to delay before automatically releasing the job. MAX_WAIT(nnn)—Indicates that the job is to be placed in JSS hold, DFSMShsm category. The job will be removed from this hold category automatically when the required data set has been recalled, or after the specified time has expired regardless of whether the data set recall has completed. This keyword is mutually exclusive with NO. If request is also issued by JAL, the higher MAX_WAIT time will be used. nnn—A number from the range 1-999, indicating the maximum number of minutes to wait before automatically releasing the job.

Important

The recall request can be reset at any time during the execution of the DAL. When DAL processing is completed, the value from the last JSS RECALL statement executed is used.

If no JSS RECALL statement is executed, the default is 'NO', that is, no DFSMShsm recalls are initiated.

If MAX_WAIT has not been specified, asynchronous DFSMShsm recalls are issued (the job will not be held).

JSS STAGE

JSS STAGE [ALL(YES |NO) IBM(YES | NO) STORAGETEK(YES | NO) VTAPE(YES | NO)]
MAX_HOLD(nnn)

This DAL element has the following attributes:

Attribute	Value
Description	Requests staging for virtual volumes This statement requests that virtual volumes be staged.
Type	Action statement
Valid value	ALL(YES \| NO)—Indicates that this staging request applies to virtual volumes for all vendors. This keyword is mutually exclusive with the IBM, STORAGETEK, and VTAPE keywords. IBM(YES \| NO)—Indicates that this staging request applies to IBM virtual volumes. This keyword is mutually exclusive with the ALL, STORAGETEK, and VTAPE keywords. STORAGETEK(YES \| NO)—Indicates that this staging request applies to Sun/StorageTek virtual volumes. This keyword is mutually exclusive with the ALL, IBM, and VTAPE keywords. VTAPE(YES \| NO)—Indicates that this staging request applies to CA-Vtape virtual volumes. This keyword is mutually exclusive with the ALL, IBM, and STORAGETEK keywords. For all keywords above: YES—Requests staging for all the vendor's virtual volumes that need to be staged. NO—Requests that none of the vendor's virtual volumes be staged. This can be used to undo the effect of a previous JSS STAGE statement. MAX_HOLD(nnn)—Indicates the maximum time that the job will be held by JSS for VVS. If staging is complete before this time, the job is released early. This is a required keyword. If request is also issued by JAL, the higher MAX_HOLD time will be used. (nnn)—Number of minutes from 1 to 999.

$JTS_DATE

$JTS_DATE [0,]name1,yyyy2/ddd2,name2[,...,yyyyN/dddN,nameN]

This DAL element has the following attributes:

Attribute	Value
Description	UCS ONLY. JTS "hold until" date This descriptor represents the JTS "hold until" date specified for the job.
Type	Range definition descriptor
Maximum value	9999/366 expressed as year/Julian date
Valid value	yyyy/ddd—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: yyyy—The year. ddd—The Julian date, including leading zeros. name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. The first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a property name for ranges that you want to ignore.

Usage

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

Example

$JTS_DATE NO_JTS_DATE,2000/001,$,2000/091,APRIL,2000/121,$

Example

If the job does not contain a JTS JECL statement, this descriptor returns a zero value (0000/000).

For more information, see $JTS_TIME.

$JTS_TIME

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

This DAL element has the following attributes:

Attribute	Value
Description	UCS ONLY. JTS "hold until" date This descriptor represents the JTS "hold until" date specified for the job.
Type	Range definition descriptor
Maximum value	23:59 expressed as hours:minutes
Valid value	hh: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: hh—The hour, using the 24 hour clock. 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.

Usage

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

Example

$JTS_TIME NO_JTS_TIME,00:01,OVERNIGHT,08:00,DAY,16:00,EVENING

Important

If the job does not contain a JTS JECL statement, this descriptor returns a zero value.

For more information, see $JTS_DATE.

$JXFAIL

$JXFAIL(NO | YES)

This DAL element has the following attributes:

Attribute	Value
Description	Test for Job fail request You can use this logic variable to determine if a request has already been made by a DAL RETURN statement to fail the job at the end of JAL processing.
Type	Logic Variable
Maximum value	Not applicable
Valid value	NO—A value of TRUE is returned if DAL has not requested that the job be failed. YES—A value of TRUE is returned if DAL has requested that the job be failed.

Usage

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

$JXJBANY

$JXJBANY(NO | YES)

This DAL element has the following attributes:

Attribute	Value
Description	TM ONLY. JBS ADD BIND indicator You can use this logic variable to determine if at least one JBS ADD BIND statement is run without an intervening JBS DELETE BIND statement.
Type	Logic Variable
Maximum value	Not applicable
Valid value	NO—If $JXJBANY returns a TRUE value, no JBS ADD BIND is active. YES—If $JXJBANY returns a TRUE value, at least one JBS ADD BIND is active.

Usage

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

Example

IF ($JXJBANY(YES))
...

For more information, see JBS ADD BIND, JBS DELETE BIND, JBS REPLACE BIND, and $JXJBMAX.

$JXJBMAX

$JXJBMAX(NO | YES)

This DAL element has the following attributes:

Attribute	Value
Description	TM ONLY. Maximum JBS ADD BIND indicator You can use this logic variable to determine the maximum number of JBS ADD BIND requests allowed in this invocation of DAL. The number is 24.
Type	Logic Variable
Maximum value	Not applicable
Valid value	NO—If $JXJBMAX returns a TRUE value, you can make at least one more JBS ADD BIND request. YES—If $JXJBMAX returns a TRUE value, there are 24 JBS ADD BIND requests active for this DAL. You cannot make additional successful JBS ADD BIND requests.

Usage

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

Example

IF ($JXJBMAX(YES))
JBS DELETE BIND
...

For more information, s ee JBS ADD BIND, JBS DELETE BIND, JBS REPLACE BIND, and $JXJBANY.

$JXJLANY

$JXJLANY(NO | YES)

This DAL element has the following attributes:

Attribute	Value
Description	TM ONLY. JLS ADD LIMIT indicator You can use this logic variable to determine if, at least, one JLS ADD LIMIT statement has been executed without an intervening JLS DELETE LIMIT statement.
Type	Logic Variable
Maximum value	Not applicable
Valid value	NO—If $JXJLANY returns a TRUE value, no JLS ADD LIMIT is active. YES—If $JXJLANY returns a TRUE value, at least one JLS ADD LIMIT is active.

Usage

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

Example

IF ($JXJLANY(YES))
...

For more information, see JLS ADD LIMIT, JLS DELETE LIMIT, JLS REPLACE LIMIT, JLS_LIMITDEF, and $JXJLMAX.

$JXJLMAX

$JXJLMAX(NO | YES)

This DAL element has the following attributes:

Attribute	Value
Description	TM ONLY. Maximum JLS ADD LIMIT indicator You can use this logic variable to determine if you have reached the maximum number of JLS ADD LIMIT requests allowed in this invocation of DAL. The number is 24.
Type	Logic Variable
Maximum value	Not applicable
Valid value	NO—If $JXJLMAX returns a TRUE value, you can make at least one more JLS ADD LIMIT request. YES—If $JXJLMAX returns a TRUE value, there are 24 JLS ADD LIMIT requests active for this DAL. You cannot make additional successful JBS ADD LIMIT requests.

Usage

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

Example

IF ($JXJLMAX(YES))
JLS DELETE LIMIT
...

For more information, see JLS ADD LIMIT, JLS DELETE LIMIT, JLS REPLACE LIMIT, JLS_LIMITDEF, and $JXJLANY.

$JXMHS_HOLD

$JXMHS_HOLD(NO | YES)

This DAL element has the following attributes:

Attribute	Value
Description	MHS HOLD status indicator You can use this logic variable to determine if at least one MHS ADD statement has been executed without an intervening MHS DELETE statement
Type	Logic Variable
Maximum value	Not applicable
Valid value	NO—If $JXMHS_HOLD returns a TRUE value, no MHS ADD has been applied to the job. YES—If $JXMHS_HOLD returns a TRUE value, at least one MHS ADD has been applied to the job.

Usage

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

For more information, see MHS ADD, MHS REPLACE, and MHS DELETE.

$JXVTAPE

This DAL element has the following attributes:

Attribute	Value
Description	Display VTAPE setting This is a DAL run time display variable. You can use this variable to display the value set by a previous VTAPE SET statement.
Type	Display variable.
Maximum value	3 characters
Valid value	This is a valid insert in a MSGDEF statement. NO—If you run the no VTAPE SET statement or a VTAPE SET VIRTUAL(NO) statement YES—If VTAPE SET VIRTUAL(YES) was specified

Usage

This Variable can be used only as an insert in message definition statements.

For more information, see VTAPE SET.

$LAST_DAY_OF_MONTH

$LAST_DAY_OF_MONTH(YES | NO)

This DAL element has the following attributes:

Attribute	Value
Description	Display VTAPE setting This Logic Variable allows you to determine whether or not today is the last day of a month. This descriptor l returns a TRUE/FALSE value depending on whether today is the last day of a month.
Type	Logic variable.
Maximum value	Not applicable
Valid value	This is a valid insert in a MSGDEF statement. NO—Today is not the last day of the month. YES—Today is the last day of the month.

Usage

You can use this variable in DAL Logic statements.

Example

$LAST_DAY_OF_MONTH(YES)

$LINES

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

This DAL element has the following attributes:

Attribute	Value
Description	Output lines This descriptor represents the estimated number of output lines.
Type	Range definition descriptor
Maximum value	999999 expressed in thousands of lines
Valid value	start—Starting point of a segment. The first starting point (if specified) must be 0. Starting points are specified in thousands of lines as 1-6 decimal digits. name—Unique property name assigned to a segment of the range, consisting of 1–24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. The first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a property name for ranges that you want to ignore.

Usage

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

Example

$LINES FEW_LINES,1000,MANY_LINES

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