List of JAL elements (G-L)


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

GLOBAL DEFINE

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

This JAL element has the following attributes: 

Attribute

Value

Description

Define Global Logic Variable

This definition statement allows you 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 value

name1—Is the name of a Global Logic Variable. It is a required positional operand that can be 1-24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. The first character must be alphabetic or national but it cannot be a $.

Usage

Global Logic variables can be used 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.

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

For more information, see EVALUATE.

$HRECALL

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

This JAL element has the following attributes:

Attribute

Value

Description

To Be Recalled Datasets

This Descriptor represents the number of data sets that must be recalled by the archival storage manager, such as IBM’s Hierarchical Storage Manager (DFSMShsm) system.

Type

Range Definition Descriptor

Maximum Value

9999 recalled data sets

Valid values

  • startThe starting point of a segment. The first starting point must be 0, but can be omitted if desired. Starting points are specified as 1-4 decimal digits.
  • nameThe Property Name assigned to a segment of the range. Each Property Name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a Property Name for ranges you wish to ignore.

Usage

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

Example
$HRECALL  NO_HSM_RECALL,1,HSM_RECALLS


Example

Migrated data sets are detected by their reference to a “trigger” volume serial number. This volume is defined to ThruPut Manager with the initialization statement VOL SET.

When the  ThruPut Manager initialization statement JSS SET is used to bypass HSM processing for IEFBR14-type jobs, if all of the job’s HSM volumes are consequently bypassed then the $HRECALL count is 0 and cannot be used to test whether HSM is needed. Use $HSM_MIGRATES instead.

For more information, see $HRECALL_DASD, $HRECALL_TAPE, JSS RECALL, $HSM_MIGRATES, and $JXRECALL.

$HRECALL_DASD

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

This JAL element has the following attributes:

Attribute

Value

Description

Recalled data sets from DASD

This Descriptor represents the number of data sets whose catalog entry indicates that they must be recalled from DASD by DFSMShsm.

Type

Range Definition Descriptor

Maximum Value

9999 recalled data sets

Valid values

  • startThe starting point of a segment. The first starting point must be 0, but can be omitted if desired. Starting points are specified as 1-4 decimal digits.
  • nameThe Property Name assigned to a segment of the range. Each Property Name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a Property Name for ranges you wish to ignore.

Usage

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

Example
$HRECALL_DASD  NO_DASD_RECALL,1,DASD_RECALLS

For more information, see $HRECALL, $HRECALL_TAPE, JSS RECALL, and $JXRECALL.

Migrated data sets are detected by their reference to a “trigger” volume serial number. This volume is defined to ThruPut Manager with the initialization statement VOL SET.

$HRECALL_TAPE

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

This JAL element has the following attributes:

Attribute

Value

Description

Recalled Datasets from Tape

This Descriptor represents the number of data sets whose catalog entry indicates that they must be recalled from tape by DFSMShsm.

Type

Range Definition Descriptor

Maximum Value

9999 recalled data sets

Valid values

  • startThe starting point of a segment. The first starting point must be 0, but can be omitted if desired. Starting points are specified as 1-4 decimal digits.
  • nameThe Property Name assigned to a segment of the range. Each Property Name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a Property Name for ranges you wish to ignore.

Usage

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

Example
$HRECALL_TAPE   NO_TAPE_RECALL,1,TAPE_RECALLS

For more information, see $HRECALL, $HRECALL_DASD, JSS RECALL, and $JXRECALL.

Migrated data sets are detected by their reference to a “trigger” volume serial number. This volume is defined to ThruPut Manager with the initialization statement VOL SET.

$HSM_MIGRATES

$HSM_MIGRATES(YES | NO)

This JAL element has the following attributes:

Attribute

Value

Description

Indicate Whether Job Requires HSM Processing

This Logic Variable allows you to determine whether a job requires HSM processing, even if the job uses only HSM volumes that are bypassed using the  ThruPut Manager   initialization statement JSS SET.

Type

Logic Variable

Maximum Value

Not applicable

Valid values

  • YESReturns a value of TRUE when the job uses HSM volumes, regardless of whether recall processing is bypassed.
  • NOReturns a value of TRUE when the job does not use HSM volumes.

Usage

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

For more information, see $HRECALL.

This Logic Variable provides an accurate test of whether a job requires DFSMShsm processing. When the ThruPut Manager initialization statement JSS SET is used to bypass HSM processing for IEFBR14type jobs, if all of the job’s HSM volumes are consequently bypassed then the $HRECALL count is 0 and cannot be used to test whether HSM is needed. Note that under these circumstances HSM is still actually needed to process the DELETE request.

IF

IF (expression)
  ...
[ELSE
  ...]
ENDIF

 or

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

This JAL 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 values

  • expressionA valid JAL expression enclosed in parenthesis. Expressions include character Descriptors, Job Properties and logical operators. The expression is evaluated, resulting in a TRUE/FALSE value that controls the flow of JAL logic. For more information about JAL expressions and examples, see DAL-and-JAL-expressions.
  • ELSESpecifies the action to be taken should the expression evaluate to FALSE.
  • ORIFSpecifies an alternate IF statement. There can be more than one ORIF statement within an IF construction.
  • OTHERWISESpecifies the action to be taken when the previous IF and all previous ORIF evaluate to FALSE.
  • ENDIFA required statement which delimits a block of statements associated with an IF statement.
Example

IF (TAPES)
 SET CLASS(H)
ENDIF

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

IF (¬ILLEGAL)
  SET CLASS(X)
  EXIT REQUEUE
ELSE
  WTU ERROR1
 EXIT FAIL
ENDIF

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

IF (ILLEGAL)
  WTU ERROR2
 EXIT FAIL
ORIF (MOUNT)
  SET CLASS(H)
  EXIT REQUEUE
OTHERWISE
  SET CLASS(I)
 EXIT REQUEUE
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 JAL logic section because it makes it more difficult to read; however, the following statement is valid:

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

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

$INCLASS | $INCL

$INCLASS(class | *)

This JAL element has the following attributes:

Attribute

Value

Description

 Input Job Submission Class

This Descriptor represents the job submission class (the class requested on the JOB statement)

Type

Character string Descriptor

Maximum Length

8 character

Valid values

  • classA single hard-coded character from A-Z or 0-9.
  • *Primary Job Analysis class.

Usage

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

Example

$INCLASS(A)
$INCL(0)

For more information, see $CURCLASS and SET CLASS.

A job’s $INCLASS is not affected by any requeueing done by 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.

$INCLASS_DEFAULT

$INCLASS_DEFAULT(YES | NO)

This JAL element has the following attributes:

Attribute

Value

Description

 Substitution of Invalid Input Job Class by DEFAULT Job Class

This Descriptor defines if an invalid input job class has been substituted with the DEFAULT job class.

This function returns a TRUE/FALSE value depending on whether the invalid $INCLASS was substituted with the DEFAULT job class.

Type

Logic Descriptor

Maximum Value

Not applicable

Valid values

  • YESWhen TRUE, it indicates that the invalid $INCLASS has been substituted with DEFAULT job class.
  • NOWhen TRUE, it indicates that invalid $INCLASS has not been substituted with DEFAULT job class.

Usage

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

Example

EVALUATE DEFCL ($INCLASS_DEFAULT(YES))
IF (DEFCL)
  WTU...

$INCLASS_DSENQSHR

$INCLASS_DSENQSHR (AUTO |ALLOW | DISALLOW)

This JAL element has the following attributes:

Attribute

Value

Description

Define the DSENQSHR= Value for the Job’s INPUT Submission Class

This Descriptor represents the job submission class’ DSENQSHR= value.

Type

Character string Descriptor

Maximum Length

Not applicable

Valid values

  • AUTOIndicates that the system may change the serialization on the data set to shared control when the DSENQSHR parameter value for the JES job class is AUTO.
  • ALLOWIndicates that the system may change the serialization on the data set to shared control when the DSENQSHR parameter value for the JES job class is AUTO or ALLOW.
  • DISALLOWIndicates that the system is not allowed to change the serialization on the data set to shared control.

Usage

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

$INDEVICE | $INDEV

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

This JAL element has the following attributes:

Attribute

Value

Description

Name of Device on Which Job Entered System or TSO User

This Descriptor represents the name of the device on which the job entered the system.

Type

Character string Descriptor

Maximum Length

8 characters

Valid values

  • patternThis is a hard-coded string. It can be 1-8 alphabetic, numeric, or national (#, @, $) characters. It can also include the period (.) and the wildcard characters ‘?’ and ‘*’.
  • %patidThe name of a pattern created with the PATTERNDEF statement.
  • table-idIdentifies a specific table and indicates which subtable is to be searched.

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

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

Usage

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

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

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

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

$INMSGCLASS

$INMSGCLASS(class)

This JAL element has the following attributes:

Attribute

Value

Description

 Message Class from the JOB statement

This Descriptor represents the message class requested by the JOB statement at job submission.

Type

Character string Descriptor

Maximum Length

8 character

Valid values

classA hard-coded single character from A-Z or 0-9.

Usage

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

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

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

$INNODE

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

This JAL element has the following attributes:

Attribute

Value

Description

Name of Node on Which Job Was Submitted

This Descriptor specifies the name of the JES2 node on which the job was submitted. If the job was submitted at node X and transmitted to node Y, $INNODE would be the original system: node X.

Type

Character string Descriptor

Maximum Length

8 characters

Valid values

  • patternThis is a hard-coded string. It can be 1-8 alphabetic, numeric, or national (#, @, $) characters, the first of which must be alphabetic or national. It can also include the wildcard characters ‘?’ and ‘*’.
  • %patidThe name of a pattern created with the PATTERNDEF statement.
  • table-idIdentifies a specific table and indicates which subtable is to be searched.

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

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

Usage

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

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

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

$INPRIO | $INPR

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

This JAL element has the following attributes:

Attribute

Value

Description

Input Execution Queue Priority

This Descriptor represents the job priority at submission time.

Type

Character string Descriptor

Maximum Length

6 characters

Valid values

  • priority-valueA value to be tested for equal. It must in the range of 0 to 15.
  • lowThe low end of a range to be tested. It must be in the range 0 to 14.
  • highIs 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.
  • MAXIf you want to include jobs with priority 15 use MAX instead of high.

Usage

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

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

For more information, see $CURPRIO and SET PRIORITY.

You can use this descriptor to test a job for a specific priority, or to see if it falls within a range of priorities.

$INRMT

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

This JAL element has the following attributes:

Attribute

Value

Description

Input Remote Number

This Descriptor represents the input remote number. If the job was submitted at node X and transmitted to node Y, $INRMT would be the remote at node X.

Type

Character string Descriptor

Maximum Length

9 characters

Valid values

  • LOCALRepresents a local device.
  • nnnnCan be 1-4 digits.
  • mmmmCan be 1-4 digits.

Usage

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

Example

$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_REPORT_CLASS

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

This JAL element has the following attributes:

Attribute

Value

Description

Input WLM Report Class

This Descriptor represents the WLM report class for the job at submission.

Type

Character String Descriptor

Maximum Length

8 characters

Valid values

  • patternThis is a hard-coded string. It can be 1-8 alphabetic, numeric, underscore (_), or national (#, @, $) characters. Underscores must be embedded. It can also include the wildcard characters ‘?’ and ‘*’.
  • %patidThe name of a pattern created with the PATTERNDEF statement.
  • table-idIdentifies a specific table and indicates which subtable is to be searched.

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

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

Usage

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

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

$IN_REPORT_CLASS(DEFREPT)
$IN_REPORT_CLASS(WLMREPT))

For more information, see $IN_SERVICE.

$IN_SCHENV

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

This JAL element has the following attributes:

Attribute

Value

Description

Input Scheduling Environment

This Descriptor represents the scheduling environment for the job at submission.

Type

Character String Descriptor

Maximum Length

16 characters

Valid values

  • patternThis is a hard-coded string. It can be 1-16 alphabetic, numeric, underscore (_), or national (#, @, $) characters. Underscores must be embedded. It can also include the wildcard characters ‘?’ and ‘*’.
  • %patidThe name of a pattern created with the PATTERNDEF statement.
  • table-idIdentifies a specific table and indicates which subtable is to be searched.

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

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

Usage

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

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

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

Important

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

If SCHENV has not been specified anywhere, $IN_SCHENV returns blanks.

For more information, see $CURSCHENV and SET SCHENV.

$IN_SERVICE_CLASS

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

This JAL element has the following attributes:

Attribute

Value

Description

Input WLM Service Class

This Descriptor represents the WLM service class for the job at submission.

Type

Character String Descriptor

Maximum Length

8 characters

Valid values

  • patternThis is a hard-coded string. It can be 1-8 alphabetic, numeric, underscore (_), or national (#, @, $) characters. Underscores must be embedded. It can also include the wildcard characters ‘?’ and ‘*’.
  • %patidThe name of a pattern created with the PATTERNDEF statement.
  • table-idIdentifies a specific table and indicates which subtable is to be searched.

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

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

Usage

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

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

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

For more information, see $CURSERVICE_CLASS and SET SERVICE_CLASS.

$INSYSAFF

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

This JAL element has the following attributes:

Attribute

Value

Description

Job Submission System Affinity

This Descriptor represents the JES2 system affinity at job submission time. If the job was submitted at node X and transmitted to node Y, $INSYSAFF would be the JES2 system affinity at node Y.

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

Character string Descriptor

Maximum Length

7 characters

Valid values

  • ANYAllows you to determine if the job can be executed in any system.
  • INDAllows you to determine 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-nameAllows you to determine if the job can execute in the system named.

Usage

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

Example

EVALUATE  S1_IND_MODE  ($INSYSAFF(SYS1,IND))

In this case, for $INSYSAFF to return a TRUE value 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.

This Descriptor does not support pattern matching functions.

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.

For more information, see $JALSYS.

$INSYSID

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

This JAL element has the following attributes:

Attribute

Value

Description

JES2 ID of the System Where the Job Was Last Read

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

4 characters

Valid values

  • patternThis is a hard-coded string. It can be 1-4 alphabetic, numeric, or national (#, @, $) characters. It can also include the wildcard characters ‘?’ and ‘*’.
  • %patidThe name of a pattern created with the PATTERNDEF statement.
  • table-idIdentifies a specific table and indicates which subtable is to be searched.

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

Usage

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

  • As an insert in message definition statements
  • In a substring function
  • In STRINGDEF and PATTERNDEF statements
  • In JLS_LIMITDEF and JLS_CNTLDEF statements 
Example
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)))

For more information, see $ORIGINAL_INSYSID.

$IZWS

$IZWS(YES/NO)

This JAL element has the following attributes:

Attribute

Value

Description

A //*IZWS Statement was encountered

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 values

  • YESReturns a TRUE value the job is managed by IZWS.
  • NOReturns 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 JAL element has the following attributes:

Attribute

Value

Description

An ADID= keyword was encountered on the //*IZWS Statement

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 values

  • patternThis is a hard-coded string. It can be 1-8 alphabetic, numeric, or national (#, @, $) characters, the first of which must be alphabetic or national. It can also include the wildcard characters ‘?’ and ‘*’.
  • %patidThe name of a pattern created with the PATTERNDEF statement.
  • table-idIdentifies a specific table and indicates which subtable is to be searched.

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

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

$IZWS_CRITICALJOB(Yes/No)

$IZWS_CRITICALJOB(Yes/No)

This JAL element has the following attributes:

Attribute

Value

Description

A CRITICALJOB= keyword was encountered on the //*IZWS Statement

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 values

  • YESReturns a TRUE value if CRITICALJOB=YES was encountered.
  • NOReturns 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)

$IZWS_CRITICALPRED(Yes/No)

This JAL element has the following attributes:

Attribute

Value

Description

A CRITICALPRED= keyword was encountered on the //*IZWS Statement

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 values

  • YESReturns a TRUE value if CRITICALPRED=YES was encountered.
  • NOReturns 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 JAL element has the following attributes:

Attribute

Value

Description

A DEADLINE= keyword was encountered on the //*IZWS Statement.  This descriptor is the date portion.

This Descriptor indicates the date value of the DEADLINE= keyword on the //*IZWS statement.

This indicates the date when the job must end.

Type

Range Definition Descriptor

Maximum Value

2155/366 expressed as year/day

Valid values

  • startThe starting point of a segment. The first starting point must be 0, but can be omitted if desired. Starting points are specified as year/day pairs, separated by a slash.
  • nameThe Property Name assigned to a segment of the range. Each Property Name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a Property Name for ranges you wish to ignore.

Usage

You can use this descriptor in 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 JAL element has the following attributes:

Attribute

Value

Description

A DEADLINE= keyword was encountered on the //*IZWS Statement. This is the time portion.

This Descriptor indicates the time value of the DEADLINE= keyword on the //*IZWS statement.

This indicates the TIME when the job must end.

Type

Range Definition Descriptor

Maximum Value

24:00

Valid values

  • startThe starting point of a segment. The first starting point must be 0, but can be omitted if desired. Starting points are specified as mmmm:ss, where, mmmm ranges from 0 through 9999 in minutes and ss ranges from 0 through 59 in seconds. The value mmmm can be specified without seconds but ss must be preceded by mmmm. For example, 30 seconds is specified as 0:30.
  • nameThe Property Name assigned to a segment of the range. Each Property Name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a Property Name for ranges you wish to ignore.

Usage

You can use this descriptor in 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 JAL element has the following attributes:

Attribute

Value

Description

A DURATION= keyword was encountered on the //*IZWS Statement

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

99999999

Valid values

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

Usage

You can use this descriptor in 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 JAL element has the following attributes:

Attribute

Value

Description

A IA= keyword was encountered on the //*IZWS Statement.  This descriptor is the date portion.

This Descriptor indicates the date value of the IA= keyword on the //*IZWS statement.

This is the input arrival date.

Type

Range Definition Descriptor

Maximum Value

2155/366 expressed as year/day

Valid values

  • startThe starting point of a segment. The first starting point must be 0, but can be omitted if desired. Starting points are specified as year/day pairs, separated by a slash.
  • nameThe Property Name assigned to a segment of the range. Each Property Name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a Property Name for ranges you wish to ignore.

Usage

You can use this descriptor in 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 JAL element has the following attributes:

Attribute

Value

Description

An IA= keyword was encountered on the //*IZWS Statement.  This is the time portion.

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 values

  • startThe starting point of a segment. The first starting point must be 0, but can be omitted if desired. 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.
  • nameThe Property Name assigned to a segment of the range. Each Property Name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a Property Name for ranges you wish to ignore.

Usage

You can use this descriptor in 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 JAL element has the following attributes:

Attribute

Value

Description

All //*IZWS keywords are acceptable

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 values

  • YESReturns a TRUE value if all //*IZWS keywords are acceptable.
  • NOReturns 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 JAL element has the following attributes:

Attribute

Value

Description

A LATESTOUT= keyword was encountered on the //*IZWS Statement.  This descriptor is the date portion.

This Descriptor indicates the date value of the LATESTOUT= keyword on the //*IZWS statement.

This is the latest date when the job should start.

Type

Range Definition Descriptor

Maximum Value

2155/366 expressed as year/day

Valid values

  • startThe starting point of a segment. The first starting point must be 0, but can be omitted if desired. Starting points are specified as year/day pairs, separated by a slash.
  • nameThe Property Name assigned to a segment of the range. Each Property Name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a Property Name for ranges you wish to ignore.

Usage

You can use this descriptor in 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 JAL element has the following attributes:

Attribute

Value

Description

A LATESTOUT= keyword was encountered on the //*IZWS Statement.  This is the time portion.

This Descriptor indicates the time value of the LATESTOUT= keyword on the //*IZWS statement.

This is the latest time when the job should start.

Type

Range Definition Descriptor

Maximum Value

24:00

Valid values

  • startThe starting point of a segment. The first starting point must be 0, but can be omitted if desired. 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.
  • nameThe Property Name assigned to a segment of the range. Each Property Name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a Property Name for ranges you wish to ignore.

Usage

You can use this descriptor in 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 JAL element has the following attributes:

Attribute

Value

Description

An OPNO= keyword was encountered on the //*IZWS Statement.

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 values

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

Usage

You can use this descriptor in 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 JAL element has the following attributes:

Attribute

Value

Description

A PRIORITY= keyword was encountered on the //*IZWS Statement

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 values

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

Usage

You can use this descriptor in 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 JAL element has the following attributes:

Attribute

Value

Description

A SUCCESSOR= keyword was encountered on the //*IZWS Statement

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 values

  • YESReturns a TRUE value if SUCCESSOR=YES was encountered.
  • NOReturns 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 JAL element has the following attributes:

Attribute

Value

Description

A SUBSYS= keyword was encountered on the //*IZWS Statement

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 values

  • patternThis is a hard-coded string. It can be 1-8 alphabetic, numeric, or national (#, @, $) characters, the first of which must be alphabetic or national. It can also include the wildcard characters ‘?’ and ‘*’.
  • %patidThe name of a pattern created with the PATTERNDEF statement.
  • table-idIdentifies a specific table and indicates which subtable is to be searched.

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

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

$IZWS_TIMEDEP(YES/NO)

$IZWS_TIMEDEP(Yes/No)

This JAL element has the following attributes:

Attribute

Value

Description

A TIMEDEP= keyword was encountered on the //*IZWS Statement

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 values

  • YESReturns a TRUE value if TIMEDEP=YES was encountered.
  • NOReturns 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.

JAL COMPARE

JAL COMPARE REPORT(SYSMSGS | SMF | ALL) HOLD | NOHOLD

This JAL element has the following attributes:

Attribute

Value

Description

Invoke secondary JAL and verify the results

Invoke a secondary JAL and compare any difference to how a job is classified. These can be written to the job’s SYSMSGS data set and/or SMF records for later reporting.

Type

Action Statement

Valid values

  • REPORT(SYSMSGS | SMF | ALL)
    • SYSMSGSWrite differences to the SYSMSGS data set for each individual job.
    • SMFWrite differences to the SMF record defined in the  ThruPut Manager   SMF initialization statement.
    • ALLWrite differences to both the SYSMSGS data set for the job and the  ThruPut Manager   SMF record.
  • HOLD | NOHOLD
    • Hold the job if differences are found between the primary and secondary JALs.

Usage

The JAL Compare feature allows an installation to load a second JAL for verification. Any differences between how a job was classified from the primary JAL are noted in messages in the Job SYSMSGS data set and/or in the SMF if requested. New ThruPut Manager SMF records (subtype-14) are produced, which allow the installation to generate reports. This allows the JALs to be run for a period of time and compare the results of numerous jobs.

For more information, see JAL-compare-facility.

$JAL_DESCRIPTION

$JAL_DESCRIPTION

This JAL element has the following attributes:

Attribute

Value

Description

Display JAL Description

This Display Variable allows you to display in a message the JAL description from the PROCEDURE statement.

Type

Display Variable

Maximum Length

24 characters

Valid values

Is a valid insert in a MSGDEF statement.

Usage

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

For more information, see PROCEDURE and $JAL_TEXT_DSNAME.

$JALNODE

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

This JAL element has the following attributes:

Attribute

Value

Description

Name of Node on Which JAL Is Executing

This Descriptor allows you to determine the name of the JES2 node where the JAL is executing.

Type

Character string Descriptor

Maximum Length

8 characters

Valid values

  • patternThis is a hard-coded string. It can be 1-8 alphabetic, numeric, or national (#, @, $) characters, the first of which must be alphabetic or national. It can also include the wildcard characters ‘?’ and ‘*’.
  • %patidThe name of a pattern created with the PATTERNDEF statement.
  • table-idIdentifies a specific table and indicates which subtable is to be searched.

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

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

Usage

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

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

For more information, see $JALSYS.

$JALSYS

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

This JAL element has the following attributes:

Attribute

Value

Description

JES2 System ID Where JAL is Executing

This Descriptor represents the JES2 system id of the system where the JAL is executing.

Type

Character string Descriptor

Maximum Value

4 characters.

Valid values

  • patternThis is a hard-coded string. It can be 1-4 alphabetic, numeric, or national (#, @, $) characters. It can also include the wildcard characters ‘?’ and ‘*’.
  • %patidThe name of a pattern created with the PATTERNDEF statement.
  • table-idIdentifies a specific table and indicates which subtable is to be searched.

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

Usage

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

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

For more information, see $JALNODE.

$JAL_TEXT_DSNAME

$JAL_TEXT_DSNAME

This JAL element has the following attributes:

Attribute

Value

Description

Display the Dataset Name of Currently Running JAL

This Display Variable allows you to display in a message the data set name of currently running JAL.

Type

Display Variable

Maximum Value

54 characters

Valid values

Is a valid insert in a MSGDEF statement.

Usage

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

For more information, see $JAL_DESCRIPTION.

$JBACT

$JBACT name AGENT(pattern | %patid | table-id)
or
$JBACT name AGENT(pattern | %patid | table-id) ONLY
or
$JBACT name API
or
$JBACT name AGENT(pattern | %patid | table-id) API
or
$JBACT name AGENT(pattern | %patid | table-id) API ONLY

This JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. Job Binding Activate Name Reference

This Descriptor lets you determine whether or not a particular Binding Agent is activated in JECL statements. It also allows you to determine if it is activated using Job Binding Services API, or whether the specified Agent is the only one being activated.

Type

Unique Descriptor

Maximum Value

Not applicable

Valid values

  • nameSpecifies the Property Name to be assigned a value of TRUE or FALSE. This name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_).
  • AGENT(pattern | %patid | table-id)Indicates that a search pattern for a Binding Agent follows.
  • patternA 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” in “. Character String Facilities” in the  DAL/JAL User Guide.
  • %patidThe name of a pattern constructed with a PATTERNDEF statement.
  • table-idIdentifies a specific table and indicates how it is to be searched. For a description of table support, refer to the “ DAL and JAL Table Management” in the  DAL/JAL User Guide
  • APIAllows you to determine if the API is to 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.
  • ONLYAllows you to test whether the Binding Agents specified are the only ones being activated.

Usage

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

Example

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

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

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.

$JBACT#

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

This JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. Number of Job Binding ACTIVATE JECL Statements

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 values

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

Usage

You can use this descriptor in the Definition Section of JAL, 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 JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. Job Binding Agent Name Reference

This descriptor lets you determine whether or not there is a BIND statement for a particular Binding Agent in JECL statements. It also allows you to test whether the specified Agent is the only Agent bound to.

Type

Unique Descriptor

Maximum Value

Not applicable

Valid values

  • nameSpecifies the Property Name to be assigned a value of TRUE or FALSE. This name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_).
  • AGENT(pattern | %patid | table-id)Indicates that a search pattern for a Binding Agent follows.
  • patternA 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” in “ Character String Facilities” in the  DAL/JAL User Guide.
  • %patidThe name of a pattern constructed with a PATTERNDEF statement.
  • table-idIdentifies a specific table and indicates how it is to be searched. For a description of table support, refer to “ DAL and JAL Table Management” in the  DAL/JAL User Guide.
  • ONLYAllows you to test whether the Binding Agents specified are the only ones being bound to.

Usage

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

Example

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

Important

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.

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#, $JBDEACT, $JBDEACT#, and $LIST_JBS_BIND.

$JBBIND#

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

This JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. Number of Job BIND JECL Statements

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 values

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

Usage

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

Example
$JBBIND# NO_BIND,1,SOME_BIND

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

$JBDEACT

$JBDEACT name AGENT(pattern | %patid | table-id)
or
$JBDEACT name AGENT(pattern | %patid | table-id) ONLY
or
$JBDEACT name API
or
$JBDEACT name AGENT(pattern | %patid | table-id) API
or
$JBDEACT name AGENT(pattern | %patid | table-id) API ONLY

This JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. Job Binding DEACTIVATE Agent Name Reference

This Descriptor lets you determine whether or not a particular binding agent is deactivated in JECL statements. It also allows you to 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 values

  • nameSpecifies the Property Name to be assigned a value of TRUE or FALSE. This name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_).
  • AGENT(pattern | %patid | table-id)Indicates that a search pattern for a Binding Agent follows.
  • patternA 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” in “ Character String Facilities Tutorial” in the  DAL/ JAL User Guide.
  • %patidThe name of a pattern constructed with a PATTERNDEF statement.
  • table-idIdentifies a specific table and indicates how it is to be searched. For a description of table support, refer to “ DAL and JAL Table Management” in the  DAL/JAL User Guide.
  • APIAllows you to determine if the API is to 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.
  • ONLYAllows you to test whether the Binding Agents specified are the only ones being deactivated.

Usage

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

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#, $JBDEACT#, and $LIST_JBDEACT.

$JBDEACT#

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

This JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. Number of DEACTIVATE JECL Statements

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 values

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

Usage

You can use this descriptor in the Definition Section of JAL, 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 JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. Adds a BIND request.

This action statement allows you to “insert” a BIND request for the job.

Type

Action statement

Valid values

  • BIND(agent-name-list[,$$DELETE])This keyword indicates that a BIND request is to be inserted for the job. For each job 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. JAL BIND requests are additions to any JECL BIND requests the job might have.
  • agent-name-list[,$$DELETE]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. 

$$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. For more information, see JBS: Incompatible Agents in the  System Programming Guide: TM/JBS Component.

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

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

JBS BIND

JBS BIND FROM_EXITS
or
JBS BIND FROM_SAC

This JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. Adds Binding Agents from External Source

This statement allows you to insert BIND requests from an external source.

Type

Action Statement

Valid values

  • FROM_EXITSThis keyword indicates that BIND requests supplied through pre-JAL installation exits ( ThruPut Manager exits 1 through 5 and 19) are to be inserted for the job. For more information about how BIND requests are specified in exits, see to the publication System Programming Guide: Exits.
  • FROM_SACThis keyword indicates that BIND requests supplied through the Software Access Control (SAC) table are to be inserted for the job. These BIND requests are additions to, not replacements for any JAL and JECL BIND requests the job might have.
Example
JBS BIND FROM_EXITS

Important

These BIND requests are additions to any DAL, JAL and JECL BIND requests the job might have.

BINDs that are added with this facility cannot be deleted or replaced.

This facility is equivalent to specifying the JBS ADD BIND statement in JAL.

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

JBS DELETE BIND

JBS DELETE [BIND | ALL_BINDS]

This JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. Deletes Bind request

This action statement deletes the last previously executed JBS ADD BIND or JBS REPLACE BIND request.

Type

Action statement

Valid values

  • BINDThis keyword indicates that the previously executed 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_BINDSThis keyword indicates 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 JAL 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 ENVIRONMENT(environment1[,environment2,environment3,environment4])
or
JBS NEEDS NO_ENVIRONMENT

This JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. Request JBS Environment

This statement allows you to request a JBS Environment for the job. Up to four Environments can be specified, any of which can satisfy the request. Only one Environment is effective for a job.

Type

Action Statement

Valid values

  • ENVIRONMENT(environment1[,environment2,environment3,environment4])Indicates that one or more JBS Environments is requested for this job. A request for more than one Environment is treated as a logical OR, that is, any one of the Environments satisfies the request. The short form for this keyword is ENV.
  • environmentnIs the name of the JBS Environment requested, and can be 1-16 alphanumeric, national ($, #, @) or embedded underscore (_) characters.
  • NO_ENVIRONMENTIndicates that the job does not need a JBS Environment. This keyword can be used to undo the effects of a previous JBS NEEDS statement or to negate a JECL request for a JBS Environment.
Example

JBS NEEDS ENVIRONMENT(CICSPROD)
JBS NEEDS ENV(WEEKLY_BACKUP,MONTHLY_BACKUP)

The second example indicates that the job can run if either the WEEKLY_BACKUP or MONTHLY_ BACKUP Environment is active.

For more information, see $JBS_NEEDS, $JBS_NEEDS#, and $LIST_JBS_NEEDS

If multiple JBS NEEDS statements are executed for a job, only the last one executed is effective.

$JBS_NEEDS

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

This JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. JBS NEEDS Environment Reference

This Descriptor lets you determine whether or not 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

Valid values

  • nameSpecifies the Property Name to be assigned a value of TRUE or FALSE. This name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_).
  • ENVIRONMENT(pattern | %patid | table-id)Indicates that a search pattern for a JBS Environment follows. This keyword can be abbreviated to ENV.
  • patternA search pattern for an Environment. This pattern must be 1 to 16 characters and conform to the naming conventions for JBS Environments.
  • %patidThe name of a pattern constructed with a PATTERNDEF statement.
  • table-idIdentifies a specific table and indicates how it is to be searched. For a description of table support, refer to “ DAL and JAL Table Management” in the  DAL/JAL User Guide.
  • ONLYAllows you to test whether the Environment specified is the only one being requested.

Usage

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

Example

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

For more information, see JBS NEEDS and $JBS_NEEDS#.

$JBS_NEEDS#

$JBS_NEEDS#   name1,1,name2

This JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. Number of NEEDS Statements

This descriptor represents whether or not 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

Valid values

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

Usage

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

Example
$JBS_NEEDS# NO_NEEDS,1,NEEDS

For more information, see JBS NEEDS and $JBS_NEEDS.

JBS REPLACE BIND

JBS REPLACE BIND(agent-name-list)

This JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. Replaces a previous JBS ADD BIND request

This action statement allows you to replace the last previously executed JBS ADD BIND request for the job.

Type

Action statement

Valid values

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

The source of the last previously executed BIND request (from JAL 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 JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. JBS SET Resource Element Reference

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

Valid values

  • nameSpecifies the Property Name to be assigned a value of TRUE or FALSE. This name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_).
  • RESOURCE(pattern | %patid | table-id)Indicates that a search pattern for a JBS Resource Element follows. This keyword can be abbreviated to RES.
  • patternA search pattern for a Resource Element. This pattern must be 1 to 16 characters and conform to the naming conventions for JBS Resource Elements.
  • %patidThe name of a pattern constructed with a PATTERNDEF statement.
  • table-idIdentifies a specific table and indicates how it is to be searched. For a description of table support, refer to “ DAL and JAL Table Management” in the  DAL/JAL User Guide.
  • ONLYAllows you to test whether the Resource Element specified is the only one being set.

Usage

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

Example

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

For more information, see $JBS_SET# and $LIST_JBS_SET.

$JBS_SET#

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

This JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. Number of JBS SET JECL Statements

This Descriptor allows you to determine the number of JBS SET JECL statements present in a job.

Type

Range Definition Descriptor

Maximum Value

99 expressed in number of JBS SET JECL statements

Valid values

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

Usage

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

Example
$JBS_SET# NO_JBS_SETS,1,JBS_SETS

For more information, see $JBS_SET.

JBS SET SYSAFF

JBS SET SYSAFF(system-name-list | ANY | $)

This JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. SET Execution Affinity

This statement sets the JES2 system affinity for the execution of the job.

Type

Action statement

Valid values

  • SYSAFF(system-name-list | ANY | $)Execution affinity for the job is to be set.
  • system-name-listA list, separated by commas, of up to 32 system names where the job can be selected for execution.
  • ANYIndicates that the job can be selected for execution in any system.
  • $The same as the job submission system affinity list.

Important

The execution affinity can be reset at any time during the execution of the JAL. When JAL processing is finished, the value from the last JBS SET SYSAFF statement executed is the value that is used.

If no JBS SET SYSAFF statement is executed, the default is the job affinity at Job Analysis time. Normally this is the same as the job submission affinity unless it has been altered with a JES2 command.

The assigned affinity can be displayed using the JAL execution time variable $JXJBSYSAFF. It displays either ‘ANY’ or a list of system names.

For more information, see $JXJBSYSAFF.

$JCBATCH

$JCBATCH name ID(pattern | %patid | table-id)

This JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. Batch Name Reference

This Descriptor allows you to determine the Batch Name-pattern used in a JECL statement (if any).

Type

Unique Descriptor

Maximum Value

Not applicable

Valid values

  • nameSpecifies the Property Name to be assigned a value of TRUE or FALSE. This name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_).
  • ID(pattern | %patid | table-id)Indicates that a search pattern for a Batch Name follows.
  • patternA search pattern for a Batch Name. The name can only be two levels. The same rules    that apply to Binding Agent names apply to Batch Names. For more information, see Pattern-matching-for-binding-agent-names.
  • %patidThe name of a pattern constructed with a PATTERNDEF statement.
  • table-idIdentifies a specific table and indicates how it is to be searched. For more information about table support, see DAL-and-JAL-table-management.

Usage

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

Example

$JCBATCH DEV ID(DEV.*)
$JCBATCH ACCT_PAYABLE ID($TABLE1(APBATCH))

For more information, see $EXEMPT, $JCBATCH#, $JCS_BATCH_ID, JCS SET BATCH, and $JXJCBAT.

$JCBATCH#

$JCBATCH#   name1,1,name2

This JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. Number of BATCH Statements

This Descriptor represents whether or not a JECL BATCH statement is present in the job. The range definition format is used for compatibility with BIND and LIMIT formats. In this case only one statement can be present.

Type

Range Definition Descriptor

Maximum Value

1

Valid values

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

Usage

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

Example
$JCBATCH# NO_BATCH_JECL,1,BATCH_JECL

For more information, see $EXEMPT, $JCBATCH, $JCS_BATCH_ID, JCS SET BATCH, and $JXJCBAT.

JCL ALTER

JCL ALTER keyword[,keyword,...]

This JAL element has the following attributes:

Attribute

Value

Description

Alter JOB Statement Keywords

This statement allows you to alter certain JOB statement keywords during JAL processing.

Type

Action statement

Valid values

  • keyword[,keyword,...]Is one or more of the following keywords:
  • GDGBIAS(JOB | STEP)Allows you to control the GDGBIAS processing

JCL ALTER PROGRAM

JCL ALTER PROGRAM(name) [PARM(parm) NEWPROGRAM(name)   

This JAL element has the following attributes: 

Attribute

Value

Description

Alter specific PGM= values on an EXEC statement.
This statement allows you to alter certain PGM= values and replace them with another program name.

Type

Action Statement

Valid values

PROGRAM (name) or PGM(name) is the original program that is to be replaced.
PARM (parm) is the program parameters that need to match before replacement will occur. A STRINGDEF value may be used.  
This keyword is optional.
NEWPROGRAM(name) (or NEWPGM(name)) is the program name to be replaced when the above match is found.

Examples: 
JCL ALTER PGM(COMMAND) PARM(‘F *,SRVCLASS=*’) NEWPGM(IEFBR14)
JCL ALTER PGM(SORT) NEWPGM(XYZSORT)

$JCL_CODED

$JCL_CODED name (DEFER | EXEC_REGIONX| EXPDT | JOB_REGIONX | EXPDT_OLD | EXPDT_
NEW | RETPD | PROTECT| UNIT_AFF | UNITNAME | VOL_REF | VOLSER)

This JAL 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_REGION
  • EXPDT
  • JOB_REGION
  • LABEL=EXPDT
  • LABEL=RETPD
  • RETPD
  • PROTECT=YES
  • UNIT=AFF
  • UNITNAME
  • VOL=REF=
  • VOL=SER=

This function call returns a true/false 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 values

  • nameSpecifies the Property Name to be assigned a value of TRUE or FALSE. This name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. The first character must be alphabetic or national. Note that the first character of each name cannot be a dollar sign ($) or underscore (_).
  • DEFERIndicates that you want to know 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_REGIONXIndicates that you want to know whether REGIONX was coded on any EXEC statement in the job.
    • If $JCL_CODED is specified in JAL it will be TRUE if any step of the job contains the REGIONX keyword.
    • If $JCL_CODED is specified in DAL it will be TRUE if the current step of the job contains the REGIONX keyword.
  • EXPDTIndicates that you want to know 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_NEWIndicates that you want to know 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_OLDIndicates that you want to know 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_REGIONXIndicates that you want to know whether the REGIONX keyword was coded on the JOB statement. If this keyword is present, $JCL_CODED assumes a TRUE value.
  • PROTECTIndicates that you want to know whether the PROTECT=YES keyword was coded on the DD statement. If this keyword is present, $JCL_CODED assumes a TRUE value.
  • RETPDIndicates that you want to know 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_AFFIndicates that you want to know whether UNIT=AFF was coded on any DD statement in the job. If this keyword is present, $JCL_CODED assumes a TRUE value.
  • UNITNAMEIndicates that you want to know 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_REFIndicates that you want to know whether VOL=REF was coded on any DD statement in the job. If this keyword is present, $JCL_CODED assumes a TRUE value.
  • VOLSERIndicates that you want to know whether VOL=SER was coded on any DD statement in the job. If this keyword is present, $JCL_CODED assumes a TRUE value.

Usage

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

Use caution when checking for the old and new formats for the expiry date. If you check for a specific format but the expiry date was coded using the alternate format, $JCL_CODED returns a FALSE value.

$JCL_DSENQSHR

$JCL_DSENQSHR (USEJC | ALLOW | DISALLOW)

This JAL element has the following attributes:

Attribute

Value

Description

Defines the DSENQSHR= Value for the Job

This Descriptor represents the DSENQSHR= value coded on the JOB statement or the system default.

Type

Character Descriptor

Maximum Value

Not applicable

Valid values

  • USEJCIndicates that you want to know whether the USEJC subparameter of the DSENQSHR keyword was coded or was being used by default on the JOB statement in the job. If this subparameter is present, $JCL_DSENQSHR assumes a TRUE value.
  • ALLOWIndicates that you want to know whether the ALLOW subparameter of the DSENQSHR keyword was coded on the JOB statement in the job. If this subparameter is present, $JCL_ DSENQSHR assumes a TRUE value.
  • DISALLOWIndicates that you want to know whether the DISALLOW subparameter of the DSENQSHR keyword was coded on the JOB statement in the job. If this subparameter is present, $JCL_ DSENQSHR assumes a TRUE value.

Usage

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

$JCL_NOTIFY_EMAIL_n

$JCL_NOTIFY_EMAIL_n (email address |$BLANK)

This JAL element has the following attributes:

Attribute

Value

Description

Provides value of one of 8 EMAIL= coded on the NOTIFY JCL statement

This Char Variable represents one of 8 EMAIL values coded on the NOTIFY JCL statement.

Type

Char Variable

Maximum Value

246 characters

Valid values

  • nA value of 1 to 8.
  • emailThe value of the email coded on the NOTIFY JCL statement.
  • $BLANKA special subparameter that allows you to check for blanks.

Usage

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

$JCL_JOB_DSENQSHR

$JCL_JOB_DSENQSHR(YES | NO)

This JAL element has the following attributes:

Attribute

Value

Description

Check if DSENQSHR Value Coded on the JOB Statement

This Logic Variable allows you 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 values

  • YESReturns a TRUE value if the DSENQSHR = is coded on the JOB statement by user.
  • NOReturns a TRUE value if the DSENQSHR= is not user coded and the system default value is assigned.

Usage

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

$JCL_JOB_EMAIL

$JCL_JOB_EMAIL (email address |$BLANK)

This JAL element has the following attributes:

Attribute

Value

Description

Provide value of EMAIL= coded on the JOB Statement

This Char Variable represents the EMAIL value coded on the JOB statement.

Type

Char Variable

Maximum Value

246 characters

Valid values

  • emailThe value of the email coded on the JOB statement.
  • $BLANKA special subparameter that allows you to check for blanks.

Usage

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

$JCL_JOB_PASSWORD (YES/NO)

$JCL_JOB_PASSWORD(YES|NO)

This JAL element has the following attributes:

Attribute

Value

Description

Check if the PASSWORD Keyword was coded on the JOB Statement

This Logic Variable allows you to determine whether the PASSWORD keyword was coded on the JOB statement.

Type

Logic Variable

Maximum Value

Not applicable

Valid values

  • YESReturns a TRUE value if the PASSWORD keyword coded on the JOB statement.
  • NOReturns a TRUE value if the PASSWORD keyword is not coded on the JOB statement.

Usage

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

This value will be true even if a NULL password was specified.

$JCL_JOB_REGIONX_ABOVE

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

This JAL element has the following attributes:

Attribute

Value

Description

Above-the-line Storage Allocation

This descriptor represents above-the-line storage specification coded on a JOB statement.

Type

Range Definition Descriptor

Maximum Value

Not applicable

Valid values

  • startThe starting point of a segment. The first starting point must be 0, but can be omitted if desired. Starting points are specified in K.
  • nameThe Property Name assigned to a segment of the range. Each Property Name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a Property Name for ranges you wish to ignore.

Usage

You can use this descriptor in the Definition Section of JAL, 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, and $REGION.

$JCL_JOB_REGIONX_BELOW

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

This JAL element has the following attributes:

Attribute

Value

Description

Below-the-line Storage Allocation

This Descriptor represents below-the-line storage specification coded on a JOB statement.

Type

Range Definition Descriptor

Maximum Value

Not applicable

Valid values

  • startThe starting point of a segment. The first starting point must be 0, but can be omitted if desired. Starting points are specified in K.
  • nameThe Property Name assigned to a segment of the range. Each Property Name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a Property Name for ranges you wish to ignore.

Usage

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

Example
$JCL_JOB_REGIONX_BELOW  REGIONB1,4096M,REGIONB2,51200M,REGIONB3

For more information, see $JCL_JOB_REGIONX_ABOVE, and $REGION.

$JCL_JOB_SYSAFF

$JCL_JOB_SYSAFF(YES | NO)

This JAL element has the following attributes:

Attribute

Value

Description

Check SYSAFF Keyword Coded on the JOB Statement

This Logic Variable allows you to determine whether the SYSAFF keyword was coded on the JOB statement.

Type

Logic Variable

Maximum Value

Not applicable

Valid values

  • YESReturns a TRUE value if the SYSAFF keyword coded on the JOB statement.
  • NOReturns a TRUE value if the SYSAFF keyword is not coded on the JOB statement.

Usage

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

$JCL_JOB_SYSTEM

$JCL_JOB_SYSTEM(YES | NO)

This JAL element has the following attributes:

Attribute

Value

Description

Check SYSTEM Keyword Coded on the JOB Statement

This Logic Variable allows you to determine whether the SYSTEM keyword was coded on the JOB statement.

Type

Logic Variable

Maximum Value

Not applicable

Valid values

  • YESReturns a TRUE value if the SYSTEM keyword coded on the JOB statement.
  • NOReturns a TRUE value if the SYSTEM keyword is not coded on the JOB statement.

Usage

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

$JCL_JOB_UJOBCORR

$JCL_JOB_UJOBCORR (user-correlator | $BLANK)

This JAL 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 values

  • user-correlatorIndicates UJOBCORR value coded on the JOB statement.
  • $BLANKIs a special subparameter that allows you to check for blanks.

Usage

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

$JCL_JOBCLASS

$JCL_JOBCLASS (class | $BLANK)

This JAL element has the following attributes:

Attribute

Value

Description

Defines the CLASS= Value on a JOB Statement

This Descriptor represents CLASS value coded on the JOB statement.

Type

Character Descriptor

Maximum Value

8 characters

Valid values

  • classIndicates value coded on JOB statement.
  • $BLANKIs a special subparameter that allows you to check for blanks.

Usage

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

JCL SET

JCL SET [LOG_ALTERS | DO_NOT_LOG_ALTERS]

This JAL element has the following attributes:

Attribute

Value

Description

Control JCL ALTER Logging

This statement allows you to control the logging of JAL or TM DAL JCL ALTER actions in SYSMSGS. This statement allows you to control the logging of JAL or TM DAL JCL ALTER actions in SYSMSGS.

Type

Action Statement

Valid values

  • LOG_ALTERSIndicates that actions requested by the TM DAL statement JCL ALTER are to be logged in the job’s SYSMSGS. This is the default.
  • DO_NOT_LOG_ALTERSIndicates that actions requested by the TM DAL statement JCL ALTER are not to be logged in the job’s SYSMSGS.

$JCL_SCHEDULE_AFTER

$JCL_SCHEDULE_AFTER (YES | NO)

This JAL element has the following attributes:

Attribute

Value

Description

Indicate if AFTER Parameter is coded on the SCHEDULE Statement

This Logic Variable allows you 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 values

  • YESReturns a value of TRUE if AFTER parameter was coded, otherwise it returns a FALSE value.
  • NOReturns 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 JAL 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 JAL element has the following attributes:

Attribute

Value

Description

Indicate if BEFORE Parameter is coded on the SCHEDULE Statement

This Logic Variable allows you to determine whether the BEFORE parameter is coded on the SCHEDULE statement. This function returns a TRUE/FALSE value depending on whether or not the job BEFORE parameter was coded.

Type

Logic Descriptor

Maximum Value

Not applicable

Valid values

  • YESReturns a value of TRUE if BEFORE parameter was coded, otherwise it returns a FALSE value.
  • NOReturns 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 JAL 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 JAL 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 values

  • startThe starting point of a segment. The first starting point must be 0, but can be omitted if desired. 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.
  • nameThe Property Name assigned to a segment of the range. Each Property Name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a Property Name for ranges you wish to ignore.

Usage

You can use this descriptor in the Definition Section of JAL, 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

For more information, see $JCL_SCHEDULE_JOBGROUP and $JCL_SCHEDULE_STARTBY.

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

$JCL_SCHEDULE_JOBGROUP

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

This JAL 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 values

  • patternThis is a hard-coded string. It can be 1-8 alphabetic, numeric, or national (#, @, $) characters, the first of which must be alphabetic or national. It can also include the wildcard characters ‘?’ and ‘*’.
  • %patidThe name of a pattern created with the PATTERNDEF statement.
  • table-idIdentifies a specific table and indicates which subtable is to be searched. 
    The pattern, %patid, or table entries are matched against the Descriptor. If a match occurs, a TRUE value is returned.
  • $BLANKIs a special subparameter that allows you to check for blanks.

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

Usage

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

  • As an insert in message definition statements
  • In a substring function
  • In STRINGDEF and PATTERNDEF statements
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 JAL element has the following attributes:

Attribute

Value

Description

STARTBY Time ParameterSpecified 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 values

  • startThe starting point of a segment. The first starting point must be 0, but can be omitted if desired. 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.
  • nameThe Property Name assigned to a segment of the range. Each Property Name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a Property Name for ranges you wish to ignore.

Usage

You can use this descriptor in the Definition Section of JAL, 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

For more information, see $JCL_SCHEDULE_JOBGROUP and $JCL_SCHEDULE_HOLDUNTL.

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

$JCL_SCHEDULE_WITH

$JCL_SCHEDULE_WITH (YES | NO)

This JAL element has the following attributes:

Attribute

Value

Description

Indicate if WITH Parameter is coded on the SCHEDULE Statement

This Logic Variable allows you to determine whether the WITH parameter is coded on the SCHEDULE statement. This function returns a TRUE/FALSE value depending on whether or not the job WITH parameter was coded.

Type

Logic Descriptor

Maximum Value

Not applicable

Valid values

  • YESReturns a value of TRUE if AFTER parameter was coded, otherwise it returns a FALSE value.
  • NOReturns 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 JAL 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_UNITNAME_MATCH

$JCL_UNITNAME_MATCH   name(unitname-list)

This JAL element has the following attributes:

Attribute

Value

Description

Matches JCL Unit Name with a List of Names

This Unique Descriptor allows you to determine whether at least one of a list of unit names is coded on any DD in the job’s JCL.

Type

Unique Descriptor

Maximum Value

Not applicable

Valid values

  • nameSpecifies the Property Name to be assigned a value of TRUE or FALSE. This name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. The first character must be alphabetic or national. Note that the first character of each name cannot be a dollar sign ($) or underscore (_).
  • unitname-listA list of unit names, patterns, %patids, and/or tables separated by commas.
  • patternThis is a hard-coded string. It can be 1-8 alphabetic, numeric, or national (#, @, $) characters. It can also include the wildcard characters ‘?’ and ‘*’.
  • %patidThe name of a pattern created with the PATTERNDEF statement.
  • table-idIdentifies a specific table and indicates how it is to be searched.

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

Usage

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

$JCL_VOLSER

$JCL_VOLSER(YES | NO)

This JAL element has the following attributes:

Attribute

Value

Description

Indicates If Volume Serial Is Coded

This Logic Variable allows you to determine if a volume serial number is coded in JCL for any DD statement of the job. It tests whether at least one hard-coded volume serial number is present.

Type

Logic Variable

Maximum Value

Not applicable

Valid values

  • NOReturns a value of TRUE when a volume serial number was not coded.
  • YESReturns a value of TRUE when a volume serial number was coded.

Usage

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

$JCL_UNITNAME_TMMAP

$JCL_UNITNAME_TMMAP(YES | NO)

This JAL element has the following attributes:

Attribute

Value

Description

TM Unit Mapping in Effect

This Logic Variable allows you to determine if 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 values

  • YESReturns a value of TRUE when TM unit name mapping is in effect.
  • NOReturns a value of TRUE when TM unit name mapping is not in effect.

Usage

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

$JCS_BATCH_ID

$JCS_BATCH_ID

This JAL element has the following attributes:

Attribute

Value

Description

JCS Batch Name

This Descriptor provides the JCS Batch Name for the job.

Type

Character string Descriptor

Maximum Value

17 characters

Valid values

Is the JCS Batch Name, which can be up to 17 characters, consisting of two levels of 1-8 characters plus a separating period.

Usage

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

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

For more information, see $JCBATCH, $JCBATCH#, JCS SET BATCH, and $JXJCBAT.

JCS SET BATCH

JCS SET BATCH(batch-name | %stringid) [SEQ]

This JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. Assigns Batch Name to Job

The JCS SET BATCH statement associates a job with a particular Batch Name for Job Chaining purposes. Batch Names can also be assigned to jobs with a JECL statement. For further details of Job Chaining Services, refer to the  System Programming Guide: TM/JBS Component.

Type

Action statement

Valid values

  • BATCH(batch-name | %stringid)Indicates that a Batch Name is to be associated with the job.
  • batch-nameA one or two-level name that follows data set naming conventions.
  • %stringidYou can specify the name of a dynamically constructed character string that has been defined with a STRINGDEF statement. The length can be up to 17 characters, consisting of two levels of 1through 8 characters plus a separating period. If the length is greater than 17 a warning message is issued and the string is truncated to 17 characters.
  • SEQThis keyword specifies that, within the named BATCH, jobs must be executed in the same sequence in which they were read in. Sequencing applies as long as there are at least two jobs from the named BATCH still in the system.

For more information, see $JCBATCH, $JCBATCH#, $JCS_BATCH_ID, and $JXJCBAT.

If the job has a JECL statement that assigns a Batch Name to the job, then the JAL JCS SET BATCH is ignored. You can determine if a JECL statement is present by testing the descriptor $JCBATCH#. You can verify naming conventions by interrogating a name pattern with the $JCBATCH unique descriptor.

$JECL_verb

$JECL_verb(YES | NO)

This JAL element has the following attributes:

Attribute

Value

Description

Indicates if a JECL Statement is Coded

This Logic Descriptor allows you to determine if the specific JECL statement is included in the JCL.

Type

Logic Descriptor

Maximum Value

Not applicable

Valid values

  • YESReturns a value of TRUE when a specified JECL statement was included.
  • NOReturns a value of TRUE when a when a specified JECL statement was not included.

Usage

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

Below is a list of all the $JECL descriptors and their associated JECL 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 JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. Associates Job with a Limiting Agent.

This action statement allows you to associate a job with a Limiting Agent.

Type

Action statement

Valid values

  • LIMIT(limitdef-id[(weight[,DRAIN])])This keyword indicates that you want to associate a Limiting Agent with the job. You can associate each job with up to 24 Limiting Agents. That is, you can execute up to 24 JLS ADD LIMIT statements without an intervening JLS DELETE LIMIT statement.
  • limitdef-idThe name-id of a JLS_LIMITDEF statement that defines a Limiting Agent.
  • weightThis 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.
  • DRAINThis 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 3 jobs were executing, 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 sub parameter 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, $JXJLMAX, $LIST_JLS_ADD, and $LIST_JLS_ADD_LAST.

JLS DELETE LIMIT

JLS DELETE [LIMIT | ALL_LIMITS]

This JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. Deletes Limit Association

This action statement removes a previously associated Limiting Agent.

Type

Action statement

Valid values

  • LIMITThis keyword indicates that the association with a Limiting Agent previously created with a JLS ADD LIMIT statement be removed.
  • ALL_LIMITSThis keyword indicates that you want to delete all existing Limiting Agent associations that have not been added through JECL.

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

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.

JLS REPLACE LIMIT

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

This JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. Replaces a previous JLS ADD LIMIT request

This action statement allows you to replace the last previously executed JLS ADD LIMIT request for the job.

Type

Action statement

Valid values

  • 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-IDThe name-id of a JLS_LIMITDEF statement defining the Limiting Agent.
  • weightThis 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.
  • DRAINThis 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))

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


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.

JLS SET CNTL

JLS SET CNTL(name-id(SHARED | EXCLUSIVE[,DRAIN]))

This JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. Associate Job with Control Agent

The JLS SET CNTL statement associates a job with a Control Agent, for the purpose of job serialization. It replicates the JECL control facility of Mellon Bank.

Type

Action statement

Valid values

  • CNTL(name-id(SHARED | EXCLUSIVE[,DRAIN]))Requests that an association with a Control Agent be established.
  • name-idThe name-id of a JLS_CNTLDEF statement defining the Control Agent.
  • SHAREDIndicates that this job does not require serialization. You can use the short form SHR.
  • EXCLUSIVEIndicates that this job requires serialization. The job is not selected for execution if any other job running in the MAS complex is associated with the Agent. You can use the short form EXC.
  • DRAINThis keyword is only valid if EXCLUSIVE has been coded. DRAIN allows you to indicate to  ThruPut Manager   that If a job requires exclusive control and it cannot get the resource because other jobs are using it in shared mode then: 
    • The resource is “drained” by not allowing any other job (requiring that resource) to be selected for execution. 
    • When the last executing job that was using the resource in shared mode terminates, then the job with the DRAIN attribute is selected.

The DRAIN facility addresses situations where exclusive control of a resource cannot be obtained because there is a continuous stream of jobs requesting it in shared mode.

The DRAIN facility takes effect only after the job has been selected for execution under normal JES2 job selection rules but initiation could not proceed because the resource was in use. Prior to the time the job is selected for execution, other jobs requesting the resource are not affected.

Example
JLS SET CNTL(DEVELG1(EXCLUSIVE,DRAIN))

In this case, a request is made for the job to have exclusive control under the DEVELG1 Control Agent. If it cannot get exclusive control, it blocks any other job associated with the Agent. This is because of the DRAIN keyword.

For more information, see JLS_CNTLDEF.

Only one JLS SET CNTL can be in effect per job. If more than one JLS SET CNTL is executed for a job, only the last one issued is effective.

JLS_CNTLDEF

JLS_CNTLDEF name-id LEVEL1(first-level-name)
                   [LEVEL2(second-level-name)]

This JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. Defines Control Agent 

This statement allows you to define Control Agents that replicate the JECL Control Facility of Mellon Bank in JAL. It simply allows jobs to externalize an arbitrary resource name and indicate whether or not they require exclusive control. It is similar to the data set OLD/SHR mechanism.

Type

Definition statement

Maximum Value

Not applicable

Valid values

  • name-idCan be 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 SET CNTL statement to indicate the Control Agent. The name-id must be unique.
JLS SET CNTL(name-id(SHR))
  • LEVEL1(first-level-name)Indicates that a level one name for the Control Agent is provided.

first-level-nameThe 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_CNTLDEF 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_CNTLDEF DEVELOP LEVEL1($RACFU,5) ...

The first level of the Agent name is constructed from the first 5 characters of the RACF user field.

The substring function call follows the rules discussed in the section “Character Facilities String Tutorial” in the publication  DAL/JAL User Guide, 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 execution time string variables created with STRINGDEF. For example: JLS_CNTLDEF DEVELOP LEVEL1(%FLNAME) ...

  • LEVEL2(second-level-name)Indicates that a level two name for the Control Agent is provided. This keyword is optional.
    • second-level-name The same options as documented above for first-level-name.

Control Agent name rules are similar to data set name rules with two important differences: They can only be one or two level names and either level can start with a numeric character. For example, a valid Control Agent Name is: 900.GROUP1

Example

JLS_CNTLDEF FILE1 LEVEL1(‘GROUP1’) LEVEL2(‘FILE1’)
...
IF ...
JLS SET CNTL(FILE1(EXCLUSIVE)) ELSE
JLS SET CNTL(FILE1(SHR))

For more information, see JLS SET CNTL.

$JLS_ENQ

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

This JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY.  Job Limiting Services ENQ Reference

This Descriptor lets you determine whether or not there is a JLS ENQ statement for a particular Agent in JECL statements. It also allows you to test whether the specified Agent is the only Agent accessed.

Type

Unique Descriptor

Maximum Value

Not applicable

Valid values

  • nameSpecifies the Property Name to be assigned a value of TRUE or FALSE. This name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_).
  • AGENT(pattern | %patid | table-id)Indicates that a search pattern for an Agent follows.
  • patternA search pattern for an 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” in “ Character String Facilities Tutorial” in the  DAL/JAL User Guide.
  • %patidThe name of a pattern constructed with a PATTERNDEF statement.
  • table-idIdentifies a specific table and indicates how it is to be searched. For more information about table support, see DAL-and-JAL-table-management.
  • ONLYAllows you to test whether the Agents specified are the only ones being accessed.

Usage

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

Example

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

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

For more information, see $JLS_ENQ# and $LIST_JLS_ENQ.

$JLS_ENQ#

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

This JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. Number of JLS ENQ JECL Statements

This Descriptor represents the number of JECL JLS ENQ statements present in a job.

Type

Range Definition Descriptor

Maximum Value

99 expressed in number of JLS ENQ JECL statements

Valid values

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

Usage

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

Example
$JLS_ENQ# NO_ENQS,1,SOME_ENQS

For more information, see $JLS_ENQ.

$JLS_LIMIT

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

This JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. Job Limiting Services LIMIT Reference

This Descriptor lets you determine whether or not there is a JLS LIMIT statement for a particular Limiting Agent in JECL statements. It also allows you to test whether the specified Agent is the only Agent accessed.

Type

Unique Descriptor

Maximum Value

Not applicable

Valid values

  • nameSpecifies the Property Name to be assigned a value of TRUE or FALSE. This name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_).
  • AGENT(pattern | %patid | table-id)Indicates that a search pattern for a Limiting Agent follows.
  • pattern A search pattern for a Limiting 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” in “ Character String Facilities Tutorial” in the  DAL/ JAL User Guide.
  • %patidThe name of a pattern constructed with a PATTERNDEF statement.
  • table-idIdentifies a specific table and indicates how it is to be searched. For a description of table support, refer to “ DAL and JAL Table Management” in the  DAL/JAL User Guide.
  • ONLYAllows you to test whether the Limiting Agents specified are the only ones being accessed.

Usage

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

Example

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

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, see $JLS_LIMIT# and $LIST_JLS_LIMIT.

$JLS_LIMIT#

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

This JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. Job Limiting Services LIMIT Reference

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 values

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

Usage

You can use this descriptor in the Definition Section of JAL, 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 JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. Defines Limiting Agents

This statement allows you to associate the JAL name id with the name and characteristics of a Limiting Agent.

Type

Definition statement

Maximum Value

Not applicable

Valid values

  • name-idCan be 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). The name-ID must be unique.
  • LEVEL1(first-level-name)
    • LEVEL n Indicates that a level one name for the Limiting Agent is provided. Can be 1 through 8 alphabetic, numeric, national (#, @, $), or underscore (_) characters. Note that 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 limited by the JESplex value and system level limit.
      For more information, see Job Limiting Services (JLS) Function in the  System Programming Guide: TM/JBS Component.
    • first-level-nameThe 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.

The substring function call follows the rules discussed in “ Character Facilities String Tutorial” in the  DAL/JAL User Guide, 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 mandatory 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, as set in a Job Analyzer exit.
    • PANEL(panelid)  Allows you to add the identifier for an ISPF panel that can be invoked to display installation defined 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)
...

Below is an example using a System Level Limiting Agent.

JLS_LIMITDEF BACKUP LEVEL1(’+SYSBAK’) LIMIT(2)
...
JLS ADD LIMIT(BACKUP)

In this case the System Level Limiting Agent +SYSBAK is associated with this job and LIMIT(2) specifies that no more than two jobs limited by +SYSBAK can be executing in the JESplex. However, the job will not be eligible to run until a non-zero limit has been set for agent +SYSBAK on a specific system. For example, a  ThruPut Manager operator command:

JLS SET +SYSBAK SYSTEM(PROD1,PROD2,PROD3) LIMIT(1)

will make the job eligible to run on PROD1, PROD2 or PROD3.

As the result of this a display command will show:

JLS DISPLAY AGENT +SYSBAK
DTM6420I JLS DISPLAY

+SYSBAK      - LIMIT=2/2 REF=1 ACT=1
             - LIMIT=2 ACT=1 FOR SYSTEM PROD1
             - LIMIT=2 ACT=1 FOR SYSTEM PROD2
             - LIMIT=2 ACT=1 FOR SYSTEM PROD3

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

JOB STORE

JOB STORE USER_DATA(LINE1(datadef-id),...,LINEnn(datadef-id))
         OPER_DATA(LINE1(datadef-id),...,LINEnn(datadef-id)) [ON_REQUEST]

This JAL element has the following attributes:

Attribute

Value

Description

Associate Data With a Job

This JAL action statement associates data defined by prior JOB_DATADEF statements with the job currently being processed by  ThruPut Manager .

Type

Action statement

Valid values

  • USER_DATA(LINE1(datadef-id),...,LINEnn(datadef-id))Associates data with a job for later display by an ISPF user invoking the User Display Facility.
    • LINEnnA value from 1 to 25. It indicates which of the 25 possible lines is to hold the data. The list can contain requests to store any or all the possible lines.
    • datadef-idEach symbolic datadef-id name must have been previously defined by a JOB_DATADEF statement. If $DELETE is specified, the line will be deleted. If the line was not previously stored, $DELETE is ignored.
  • OPER_DATA(LINE1(datadef-id),...,LINEnn(datadef-id))Associates data with a job for later display with the JOB DISPLAY command.
    • LINEnnA value from 1 to 25. It indicates which of the 25 possible lines is to hold the data. The list can contain requests to store any or all the possible lines
    • datadef-idEach symbolic datadef-id name must have been previously defined by a JOB_DATADEF statement. If $DELETE is specified, the line will be deleted. If it was never stored, it is ignored.
  • ON_REQUESTIndicates that this particular line is to be displayed to the operator only if specifically requested by the JOB DISPLAY command.
Example

This example shows several aspects of the power of JOB STORE. The JOB_DATADEF statements define several lines, some of which are intended for use with both the User Display Facility and the JOB DISPLAY command. For the User Display Facility, two lines are defined to be used exclusive of one another, giving information about a job’s cartridge requirements. JAL logic is used to determine which line is stored for display.

For the JOB DISPLAY command, a line is defined and stored for display only when the command includes the ONREQUEST keyword.

JOB_DATADEF BOTH_DISPLAY_ALL_L1 (‘Submission Class=’,$INCLASS)
JOB_DATADEF BOTH_DISPLAY_ALL_L2 (‘Execution class=’,$JXCLASS)
JOB_DATADEF USER_DISPLAY_NCART_L3 (‘No cartridges required’)
JOB_DATADEF USER_DISPLAY_CART_L3 (‘Cartridges required=’,$VOL_CART_ALL)
JOB_DATADEF OPER_DISPLAY_RACF_L3 (‘RACF Userid=’,$RACFU)
...
...
JOB STORE USER_DATA(LINE1(BOTH_DISPLAY_ALL_L1),LINE2(BOTH_DISPLAY_ALL_L2))
...
...
JOB STORE OPER_DATA(LINE1(BOTH_DISPLAY_ALL_L1),LINE2(BOTH_DISPLAY_ALL_L2))
JOB STORE OPER_DATA(LINE3(OPER_DISPLAY_RACF_L3)) ONREQUEST
...
...
IF (CARTS)
JOB STORE USER_DATA(LINE3(USER_DISPLAY_CARTS_L3))
ELSE
JOB STORE USER_DATA(LINE3(USER_DISPLAY_NCARTS_L3))
ENDIF

Important

Each line can be stored and replaced independently of the other lines. The last JOB STORE for a particular line replaces any previously stored data for that line.

If no data is stored for a particular line, the User Display Facility or the JOB DISPLAY command will not show that line. For a particular line to show in the display, you have to issue a JOB STORE for that line (the text could be blanks, if you want a blank line to be displayed).

For more information, see JOB_DATADEF.

JOB USER_DISPLAY

JOB USER_DISPLAY [ACCT(account-list)]
        [PROMPT(string | %stringid)]
        [USERID(user-list)]
        [ACFUID(acfid-list) | RACFU(racfid-list) | TSSUSER(tssid-list)]

or

JOB USER_DISPLAY EXIT [DATA(data | %stringid)]

This JAL element has the following attributes:

Attribute

Value

Description

Set Display Authority for a Job

This JAL action statement provides authorization information to the User Display Facility. If you code more than one of the pattern-matching operands, authorization is granted as soon as one of them is satisfied. If you code PROMPT in addition to one or more pattern-matching operands, the user is prompted only if none of the patterns result in a match.

Type

Action statement

Valid values

  • ACCT(account)Specifies TSO job account patterns identifying users who are authorized to view job-related data.
  • account-listA list of up to sixteen 1through 142 character matching patterns for an account, separated by commas. %patid is allowed.
  • PROMPT(string)Specifies that the ISPF user is to be prompted to enter some information before being granted permission to view job-related data.
  • stringA 1 through 8 character string that must match exactly with the information supplied by the user. The string is not case sensitive, and must consist of alphabetic, numeric, and national characters. Embedded blanks are not permitted.
  • %stringidThe name of a character string created with the STRINGDEF statement.
  • USERID(user-list)Specifies TSO userid patterns identifying users who are authorized to view job-related data.
  • user-listA list of up to sixteen 1through 7 character matching patterns for a TSO userid, separated by commas. %patid is allowed.
  • ACFUID(acfid-list)Specifies ACF2 userid patterns identifying users who are authorized to view job-related    data.
  • acfid-listA list of up to sixteen 1through 24 character matching patterns for an ACF2 userid, separated by commas. %patid is allowed.
  • RACFU(racfid-list)Specifies RACF userid patterns identifying users who are authorized to view job-related   data.
  • racfid-listA list of up to sixteen 1through 7 character matching patterns for a RACF userid, separated by commas. %patid is allowed.
  • TSSUSER(tssid-list)Specifies TOP SECRET userid patterns identifying users who are authorized to view job-related data.
  • tssid-listA list of up to sixteen 1through 7 character matching pattern for a TOP SECRET userid, separated by commas. %patid is allowed.
  • EXITSpecifies that the installation exit used to process the TSO STATUS command is to be invoked when a user attempts to use the  ThruPut Manager  User Display Facility to examine this job. This keyword is mutually exclusive with all the other keywords.
  • DATA(data | %stringid)Specifies information that is to be passed to an installation exit. This is an optional keyword, and is valid only when used with the EXIT keyword.
  • dataA 1through 255 character string of data to be passed to the exit. If the string contains embedded blanks, the entire string must be enclosed in apostrophes.
  • %stringidThe name of a character string created with the STRINGDEF statement.


Example

This statement allows all ISPF users whose TSO userid begins with the characters AB or ALT to view job-related data for the job that is being processed by the Job Analyzer.

JOB USER_DISPLAY USERID(AB*,ALT*)

This statement allows all ISPF users whose ACF2 logonid begins with the character T to view job-related data for the job that is being processed by the Job Analyzer. If the ACF2 logonid does not begin with T, the user is prompted to provide the string TELLME.

JOB USER_DISPLAY PROMPT(TELLME) ACFUID(T*)

This statement allows all ISPF users whose RACF userid begins with the characters FR3 or whose account is PR9000 to view job-related data for the job that is being processed by the Job Analyzer.

JOB USER_DISPLAY ACCT(PR9000) RACFU(FR3*)

This example passes the exit a string of data that was previously built by STRINGDEF statements. Through this facility, any data that can be included in a STRINGDEF is available to your installation’s exit.

JOB USER_DISPLAY EXIT DATA(%AUTHINF)

Important

If multiple JOB USER_DISPLAY statements are executed for a job, only the last one executed is effective. Any previous JOB USER_DISPLAY statements are completely overridden.

If you code any combination of:

  • ACCT
  • USERID
  • RACFU/ACFUID/TSSUSER
  • PROMPT

then authority validation proceeds in the order shown above until one of the patterns results in a match. The installation exit used to process the TSO STATUS command is not called.

JOB_DATADEF

JOB_DATADEF name([(COL,n,align)],variable | ‘hard-coded-text’,
                [(COL,n,align)]...)

This JAL element has the following attributes:

Attribute

Value

Description

Define Display Information

JAL allows you to communicate job-related information to ISPF users through the User Display Facility, or operators through JOB Services. The data line can include Descriptors or Properties combined with text.

Up to 25 lines can be stored with a job for User Display, and another 25 lines for operator services.

Type

Definition statement

Maximum Length

Any information exceeding 60 characters is truncated.

Valid values

  • nameA symbolic name used as the data-line identifier, consisting of 1-24 alphabetic, numeric or national characters. The first character must be alphabetic or national (excluding $). This symbol is positional and required. To issue the data-line defined by this statement, use this symbol with the Action Statement JOB STORE. This name must be unique.
  • (COL,n,align)

This is an optional text definition construct that indicates you want column alignment.


    • COLThis must be coded as shown.
    • nSpecifies the reference column, and can be a value from 1 to 60.
    • alignSpecifies the desired alignment, and must be one of:
    • L, indicating left alignment.
    • R, indicating right alignment.

The considerations for data alignment are:


    • For left-aligned data, the column number represents the first column for the first character of data, and subsequent characters are inserted on the left, i. e. in ascending column order.
    • For right-aligned data, the column number represents the last column for the last character of data, and subsequent characters are inserted on the right, i. e. in descending column order.
    • If you miscalculate and some of your data is overlaid, it might help you to solve your problem if you remember that alignment is performed element by element from left to right.
  • variable | ‘hard-coded-text’
    • A description of the text to be displayed. For variable, this can be any Descriptor or Job Property. ‘hard-coded text’ can be any text. After any substitution required for the variable text is resolved, the following considerations apply.
    • The maximum length must not exceed 60 characters. This includes the “blanks” that may have to be inserted to satisfy the alignment. Data-lines that are longer than the maximum length are truncated. The basic rules when building a line of text are:
      • Separate each element with commas.
      • Include text within apostrophes (‘’). To code an apostrophe in the text to be displayed, you must use two consecutive apostrophes.
      • When formatting text lines, also keep the following in mind:
    • To separate Descriptors and Job Properties from your text, you must insert padding blanks or column align them.
    • If COL is not coded, Numeric Descriptors are right-justified, stripped of leading zeros.
    • If COL is not coded, Character string Descriptors are left-justified, stripped of trailing blanks.
    • Job Properties and Logic Variables print ‘T’ for TRUE and ‘F’ for FALSE.
    • For the values displayed for Display Variables (variables with a name starting with
    • $JX) refer to the description for the variable.
    • EVENT Switches display as ‘ON’ and ‘OFF’.
    • For Numeric Descriptors, the inserted value is in the units normally used for that Descriptor. For example, CPU time is shown in minutes and seconds.
    • A value in thousands is shown by the character K.
    • A value in millions is shown by the character M.

For more information about a complete discussion of the facilities provided for formatting messages and displays, see Defining-and-using-messages-and-displays.

Example

JOB_DATADEF LINE1  (‘Region Size=’,(COL,18,R),$REGION,    +
                  (COL,24,L),’Execution Class=’,$JXCLASS)

A data-line can contain, in any order, a mixture of text, Descriptors, and Job Properties. Each one of them may be optionally preceded by a column alignment specification.

For more information, see JOB STORE.

$JOB_PERFORM

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

This JAL element has the following attributes:

Attribute

Value

Description

Performance Group from the JOB statement

This job descriptor returns a number in the range 1-999, representing the value coded for the PERFORM= keyword on the JOB statement.

Type

Range Definition Job Descriptor

Maximum Length

999

Valid values

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

Usage

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

For more information, see $JXPERFORM, $PERFORM, and SET PERFORM.

$JOBCPU

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

This JAL element has the following attributes:

Attribute

Value

Description

JCPU Time From the JOB statement

This descriptor represents the amount of CPU time specified in the TIME= parameter on the JOB statement.

Type

Range Definition Descriptor

Maximum Length

357912 minutes

Valid values

  • startThe starting point of a segment. The first starting point must be 0, but can be omitted if desired.
    Starting points are specified as mmmmmm:ss, where, mmmmmm ranges from 0 through 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.
  • nameThe Property Name assigned to a segment of the range. Each Property Name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a Property Name for ranges you wish to ignore.

Usage

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

Example
$JOBCPU   NO_CPU,0:01,JOB_TIME

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

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

$JOBID

$JOBID

This JAL 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 Length

8 characters

Valid values

Is a valid insert in a MSGDEF statement.

It prints the JES2 job identifier.

Usage

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

For more information, see $JOBNUMBER.

$JOBNAME | $JOBN

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

This JAL 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 Length

8 characters

Valid values

  • patternThis is a hard-coded string. It can be 1-8 alphabetic, numeric, or national (#, @, $) characters, the first of which must be alphabetic or national. It can also include the wildcard characters ‘?’ and ‘*’.
  • %patidThe name of a pattern created with the PATTERNDEF statement.
  • table-idIdentifies a specific table and indicates which subtable is to be searched.

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

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

Usage

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

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

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

$JOBNUMBER | $JOBNUM

$JOBNUMBER
or
$JOBNUM

This JAL element has the following attributes:

Attribute

Value

Description

JES2 Job Number

This is an execution time Display Variable. It allows you to display the JES2 job number.

Type

Display Variable.

Maximum Length

5 characters

Valid values

Is a valid insert in a MSGDEF statement. It prints the JES2 job number.

Usage

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

For more information, see $JOBID.

JSS RECALL

JSS RECALL ALL | DASD | TAPE [MAX_WAIT(mmm) | DELAY_FOR(mmm)][LIMIT(nnn)]
or
JSS RECALL NO [DELAY_FOR(mmm)]

This JAL element has the following attributes:

Attribute

Value

Description

Request DFSMShsm Recall

Specifies whether  ThruPut Manager can initiate recalls for data sets that have been migrated to archival storage by DFSMShsm. This statement is ignored if the job does not refer to a migrated data set.

Type

Action Statement

Valid values

  • RECALLIndicates that if there are any DFSMShsm migrated data sets, a DFSMShsm recall is to be initiated.
  • NOIndicates that no DFSMShsm recall is to be initiated. This keyword is mutually exclusive with ALL, DASD, TAPE, and MAX_WAIT.
  • ALLSpecifies that a DFSMShsm recall is to be initiated for all migrated data sets, regardless of their location. This keyword is mutually exclusive with NO, DASD, and TAPE.
  • DASDSpecifies that a DFSMShsm recall is to be initiated only for data sets whose catalog entry indicates that they have been migrated to DASD. This keyword is mutually exclusive with NO, ALL, and TAPE.
  • TAPESpecifies that a DFSMShsm recall is to be initiated only for data sets whose catalog entry indicates that they have been migrated to tape. This keyword is mutually exclusive with NO, ALL, and DASD.
  • DELAY_FOR(mmm)Indicates that the job is to be placed in JSS hold, DFSMShsm category, and will remain there until the specified number of minutes have expired. This delay takes effect only if there are data sets to be recalled. This keyword is mutually exclusive with MAX_WAIT.
    • mmmA number from the range 1-999, indicating how many minutes to delay before automatically releasing the job.
  • LIMIT(nnn)Specifies an upper limit that is put on the number of data sets to be recalled.
    • nnnA number from the range 1-999, indicating the maximum number of data sets to be recalled.
  • MAX_WAIT(mmm)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 sets have been recalled, or after the specified time has expired regardless of whether the data set recalls have completed. This keyword is mutually exclusive with NO and DELAY_FOR.
    • mmmA 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 JAL. When JAL 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.

The status of the recall can be displayed using the JAL execution time variable $JXRECALL.

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

For more information, see $HRECALL, $HRECALL_DASD, $HRECALL_TAPE, and $JXRECALL.

JSS STAGE

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

This JAL 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 values

  • 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 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:
    • YESRequests staging for all the vendor’s virtual volumes that need to be staged.
    • NORequests that none of the vendor’s virtual volumes be staged. This can be used to undo the effect of a previous JSS STAGE statement.
  • LIMIT(mmm)Specifies an upper limit that is put on the number of data sets to be staged.
  • mmmA number from the range 1 through 999, indicating the maximum number of data sets to be staged.
  • 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.
  • (nnn)Number of minutes from 1 through 999.

For more information, see $JXSTAGE_STORAGETEK, $VOL_VTS_STK, $VOL_VTS_STK_NOTRESIDENT, and $VOL_VTS_STK_RESIDENT.

$JTS_DATE

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

This JAL 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 Length

9999/366 expressed as year/Julian date.

Valid values

  • yyyy/dddThe 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:
    • yyyyThe year.
    • dddThe Julian date, including leading zeros.
  • nameThe Property Name assigned to a segment of the range. Each Property Name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a Property Name for ranges you wish to ignore.

Usage

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

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

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_HOLD_FOR

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

This JAL element has the following attributes:

Attribute

Value

Description

UCS ONLY. Difference Between the Time Specified on the JTS JECL //*JTS HOLD_UNTIL Statement and the Current Time.

This descriptor represents the difference between JTS “hold until” time specified for the job and the current time.

Type

Range Definition Descriptor

Maximum Length

23:59 expressed as hours:minutes

Valid values

  • hh:mmThe 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:
    • hhThe hour, using the 24 hour clock.
    • mmThe minute (0-59).
  • nameThe Property Name assigned to a segment of the range. Each Property Name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a Property Name for ranges you wish to ignore.

Usage

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

Example
$JTS_HOLD_FOR NO_JTS_HOLD,0:01,SMALL,5,MED,23:59,DAYS

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

For more information, see JTS_TIME.

JTS HOLD_UNTIL

This JAL element has the following attributes:

Attribute

Value

Description

Hold the job until a specified date & time.

Type

Action statement

This action statement allows you to hold a job till a specific time.

Example
JTS HOLD_UNTIL DATE(TODAY+7)       
JTS HOLD_UNTIL DATE(2022.364)      
JTS HOLD_UNTIL TIME(NOW+5)         
JTS HOLD_UNTIL TIME(23:59)         
JTS HOLD_UNTIL MORNING             
JTS HOLD_UNTIL AFTERNOON           

JTS HOLD_UNTIL TONIGHT             

or

JTS HOLD_UNTIL RESET

The keywords can be combined as, JTS HOLD_UNTIL DATE(TODAY+7) TIME(10:00).

The exact times for MORNING, AFTERNOON and TONIGHT are defined by the JTS OPTIONS sysparm statement or the JTS SET operator command.

JTS HOLD_UNTIL RESET will remove any previous HOLD_UNTIL added by JAL.

$JTS_TIME

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

This JAL element has the following attributes:

Attribute

Value

Description

UCS ONLY. JTS “Hold Until” Time

This Descriptor represents the JTS “hold until” time specified for the job.

Type

Range Definition Descriptor

Maximum Length

23:59 expressed as hours:minutes

Valid values

  • hh:mmThe 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:
    • hhThe hour, using the 24 hour clock.
    • mmThe minute (0-59).
  • nameThe Property Name assigned to a segment of the range. Each Property Name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a Property Name for ranges you wish to ignore.

Usage

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

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

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

For more information, see $JTS_DATE.

$JXARRIVAL

$JXARRIVAL

This JAL element has the following attributes:

Attribute

Value

Description

Display Arrival Time Setback Setting

This is a JAL execution time Display Variable. It allows you to display the value of a previously executed SET ARRIVAL_TIME statement.

If no SET ARRIVAL_TIME statement has been executed, the initial value for ARRIVAL_TIME is ‘0’.

Type

Display Variable

Maximum Length

3 characters

Valid values

This is a valid insert in a MSGDEF statement.

If a SET ARRIVAL_TIME statement has been executed, the value that was set is printed.

If no SET ARRIVAL_TIME statement has been executed, ‘0’ is printed.

Usage

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

For more information, see SET ARRIVAL_TIME.

$JXCATALOG_LOOKUP

$JXCATALOG_LOOKUP

This JAL element has the following attributes:

Attribute

Value

Description

Display CATALOG_LOOKUP Setting

This is a JAL execution time Display Variable. It allows you to display the value of a previously executed SET CATALOG_LOOKUP statement.

If no SET CATALOG_LOOKUP statement has been executed, the initial value for CATALOG_ LOOKUP is ‘NO’.

Type

Display Variable

Maximum Length

20 characters

Valid values

This is a valid insert in a MSGDEF statement.

If a SET CATALOG_LOOKUP statement has been executed, ‘YES’ is printed.

If no SET CATALOG_LOOKUP statement has been executed, ‘NO’ is printed.

Usage

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

For more information, see SET CATALOG_LOOKUP.

$JXCLASS | $JXCL

$JXCLASS

This JAL element has the following attributes:

Attribute

Value

Description

Display Execution Class Setting

This is a JAL execution time Display Variable. It allows you to display the value of a previously executed SET CLASS statement.

If no SET CLASS has been executed, the initial value for the CLASS keyword is the job submission class.

Type

Display Variable

Maximum Length

8 character

Valid value

This is a valid insert in a MSGDEF statement.

It prints a one character class, representing either:

  • The class assigned with a previously executed SET CLASS statement.
  • If no SET CLASS statement has been executed, then the job submission class.

Usage

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

For more information, see SET CLASS.

$JXCPUCAP

$JXCPUCAP

This JAL element has the following attributes:

Attribute

Value

Description

Display CPUCAP Setting

This is a JAL execution time Display Variable. It allows you to display the value of a previously executed SET CPUCAP statement.

If no SET CPUCAP statement has been executed, the initial value for the CPUCAP keyword is ‘NO’.

Type

Display Variable

Maximum Length

9 characters

Valid value

This is a valid insert in a MSGDEF statement.

If a SET CPUCAP statement is run, it prints a character string of the form mmmmmm:ss. The letter m represents minutes. The letter s represents seconds.

If no SET CPUCAP statement is run, it prints the character string ‘NO’.

Usage

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

For more information, see SET CPUCAP.

$JXDBS_PRIORITY

$JXDBS_PRIORITY

This JAL element has the following attributes:

Attribute

Value

Description

Display DBS Priority

This is a JAL execution time Display Variable. It allows you to display the DBS Priority that is assigned to the job.

The DBS Priority does not apply if the job is managed by SLM.

If no DBS SET PRIORITY statement has been executed, the default value for the PRIORITY keyword is MEDIUM.

Type

Display Variable

Maximum Length

6 characters

Valid values

This is a valid insert in a MSGDEF statement.

  • LOWIf a DBS SET PRIORITY(LOW) statement has been executed, ‘LOW’ is printed.
  • MEDIUMIf no DBS SET PRIORITY statement has been executed, or a DBS SET PRIORITY(MEDIUM) statement has been executed, ‘MEDIUM’ is printed.
  • HIGHIf a DBS SET PRIORITY(HIGH) statement has been executed, ‘HIGH’ is printed.

Usage

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

For more information, see DBS SET.

$JXDBS_WORKGROUP

$JXDBS_WORKGROUP

This JAL element has the following attributes:

Attribute

Value

Description

Display DBS Work Group

This is a JAL execution time Display Variable. It allows you to display the DBS Work Group to which the job has been assigned.

If no DBS SET WORKGROUP(name) statement has been executed, the value is the default Work Group that was set for the active Policy in the DBS Configuration dialog.

Type

Display Variable

Maximum Length

8 characters

Valid value

This is a valid insert in a MSGDEF statement.

If a DBS SET WORKGROUP(name) statement has been executed, the Work Group name is printed.

If no DBS SET WORKGROUP(name) statement has been executed, the default Work Group that was set for the active Policy in the DBS Configuration dialog is printed.

If the ACTIVE Policy is not using Work Groups, ‘********’ is printed.

Usage

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

For more information, see DBS SET.

$JXDCS_DR

$JXDCS_DR(YES | NO)

This JAL element has the following attributes:

Attribute

Value

Description

DCS ONLY. DCS data set Reservation Indicator

This Logic Variable allows you to determine whether a DCS SET statement has been executed.

This function call returns a TRUE/FALSE value depending on whether or not a DCS SET statement has been executed.

Type

Logic Variable

Maximum Value

Not applicable

Valid values

  • YESIf $JXDCS_DR returns a TRUE value, a DCS SET has been executed.
  • NOIf $JXDCS_DR returns a TRUE value, a DCS SET has not been executed.

Usage

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

Example

IF ($JXDCS_DR(YES))
  ...

For more information, see DCS SET.

$JXFACTOR

$JXFACTOR

This JAL element has the following attributes:

Attribute

Value

Description

Display Selected Factor Set

This is a JAL execution time Display Variable. It allows you to display the number used to select the normalization factor for JOB and STEP CPU time, as specified by a previous SET NORMALIZE statement.

Type

Display Variable

Maximum Length

1 character

Valid value

This is a valid insert in a MSGDEF statement.

If a SET NORMALIZE(YES) statement has been executed, the single digit number used to select the normalization factor is displayed.

If no SET NORMALIZE statement has been executed or a SET NORMALIZE(NO) statement has been executed, this Variable has no meaning but it will display 0.

Usage

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

For more information, see $JXNORM and SET NORMALIZE.

$JXFAIL

$JXFAIL(YES | NO)

This JAL element has the following attributes:

Attribute

Value

Description

Test for Job Fail Request

This Logic Variable allows you to determine if a request has been made by a DAL RETURN statement to fail the job at the end of JAL processing.

This function call returns a TRUE/FALSE value depending on whether or not an RETURN FAIL statement has been executed by DAL to have the job failed at the end of JAL processing.

Type

Logic Variable

Maximum Value

Not applicable

Valid values

  • NOA value of TRUE is returned if DAL has not requested that the job be failed.
  • YESA 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 JAL Logic statements, and also as an insert in message definition statements.

$JX_GDGBIAS

$JX_GDGBIAS

This JAL element has the following attributes:

Attribute

Value

Description

Display GDGBIAS value for job

This is a JAL execution time Display Variable. It allows you to display the value of how the job is to process GDGs.

Type

Display variable

Maximum Value

4 characters

Valid value

This is a valid insert in a MSGDEF statement.

$JXJBANY

$JXJBANY(YES | NO)

This JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. JBS ADD BIND Indicator

This Logic Variable allows you to determine if at least one JBS ADD BIND statement has been executed without an intervening JBS DELETE BIND statement.

This function call returns a TRUE/FALSE value depending on whether or not there is at least one JBS ADD BIND active for the job.

Type

Logic Variable

Maximum Value

Not applicable

Valid values

  • YESIf $JXJBANY returns a TRUE value, at least one JBS ADD BIND is active for the job.
  • NOIf $JXJBANY returns a TRUE value, no JBS ADD BIND is active for the job.

Usage

You can use this variable in JAL 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(YES | NO)

This JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. Maximum JBS ADD BIND Indicator

This Logic Variable allows you to determine if you have reached the maximum number of JBS ADD BIND requests allowed in JAL. The number is 24.

This function call returns a TRUE/FALSE value depending on whether or not the maximum of 24 JBS ADD BIND requests has been reached.

Type

Logic Variable

Maximum Value

Not applicable

Valid values

  • YESIf $JXJBMAX returns a TRUE value, there are 24 JBS ADD BIND requests active for this job. You cannot make additional successful JBS ADD BIND requests.
  • NOIf $JXJBMAX returns a TRUE value, you can make at least one more JBS ADD BIND request.

Usage

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

Example

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

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

$JXJBSYSAFF

$JXJBSYSAFF

This JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. Display Execution System Affinity

This is a JAL execution time Display Variable. It allows you to display the execution affinity.

If no JBS SET SYSAFF statement has been executed, the default is the job submission affinity.

Type

Display Variable

Maximum Length

36 characters

Valid value

This is a valid insert in a MSGDEF statement.

The print format is one of the following two forms:

  • A list of systems: (SYS1,SYS2,..).
  • ‘ANY’.

Usage

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

For more information, see JBS SET SYSAFF.

$JXJBS_BIND_FROM_SAC

$JXJBS_BIND_FROM_SAC(YES | NO)

This JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. JBS BIND From SAC Indicator

This Logic Variable allows you to determine if at least one JBS BIND has been added because of the Software Access Control (SAC) table.

This function call returns a TRUE/FALSE value depending on whether or not there is at least one JBS BIND active for the job that was set using the SAC table.

Type

Logic Variable

Maximum Value

Not applicable

Valid values

  • YESIf $JXJBS_BIND_FROM_SAC returns a TRUE value, at least one BIND request from SAC has been added to the job.
  • NOIf $JXJBS_BIND_FROM_SAC returns a TRUE value, no BIND request from SAC has been added to the job.

Usage

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

Example

IF ($JXJBS_BIND_FROM_SAC(YES))
...

For more information, see JBS BIND.

$JXJCBAT

$JXJCBAT(YES | NO)

This JAL element has the following attributes:

Attribute

Value

Description

JBS ONLY. JCS SET BATCH Indicator

This Logic Variable allows you to determine whether a JCS SET BATCH statement has been executed.

This function call returns a TRUE/FALSE value depending on whether or not a JCS SET BATCH statement has been executed.

Type

Logic Variable

Maximum Value

Not applicable

Valid values

  • YESIf $JXJCBAT returns a TRUE value, a JCS SET BATCH has been executed.
  • NOIf $JXJCBAT returns a TRUE value, a JCS SET BATCH has not been executed.

Usage

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

Example

IF ($JXJCBAT(YES))
  ...

For more information, see $JCBATCH, $JCBATCH#, $JCS_BATCH_ID, and JCS SET BATCH.

$JXJES2HOLD

$JXJES2HOLD

This JAL element has the following attributes: 

Attribute

Value

Description

Display JES2 HOLD Status

This is a JAL execution time Display Variable. It allows you to display the JES2 HOLD status of a job.

If no SET JES2_HOLD statement has been executed, the initial value for the HOLD keyword is ‘NO’.

Type

Display Variable

Maximum Length

3 characters

Valid value

This is a valid insert in a MSGDEF statement.

If a SET JES2_HOLD(YES) statement has been executed, ‘YES’ is printed.

If no SET JES2_HOLD statement has been executed, or a SET JES2_HOLD(NO) statement has been executed, ‘NO’ is printed.

Usage

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

For more information, see SET JES2_HOLD.

$JXJLANY

$JXJLANY(YES | NO)

This JAL element has the following attributes: 

Attribute

Value

Description

JBS ONLY. JLS ADD LIMIT Indicator

This Logic Variable allows you to determine if at least one JLS ADD LIMIT statement has been executed without an intervening JLS DELETE LIMIT statement.

This function call returns a TRUE/FALSE value depending on whether or not there is at least one JLS ADD LIMIT active for the job.

Type

Logic Variable

Maximum Value

Not applicable

Valid value

  • YESIf $JXJLANY returns a TRUE value, at least one JLS ADD LIMIT is active for the job.
  • NOIf $JXJLANY returns a TRUE value, no JLS ADD LIMIT is active for the job.

Usage

You can use this variable in JAL 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, and $JXJLMAX.

$JXJLMAX

$JXJLMAX(YES | NO)

This JAL element has the following attributes: 

Attribute

Value

Description

JBS ONLY. Maximum JLS ADD LIMIT Indicator

This Logic Variable allows you to determine if you have reached the maximum number of JLS ADD LIMIT requests allowed in JAL. The number is 24.

This function call returns a TRUE/FALSE value depending on whether or not you have reached the maximum of 24 JLS ADD LIMIT requests allowed.

Type

Logic Variable

Maximum Value

Not applicable

Valid value

  • YESIf $JXJLMAX returns a TRUE value, there are 24 JLS ADD LIMIT requests active for this job. You cannot make additional successful JBS ADD LIMIT requests.
  • NOIf $JXJLMAX returns a TRUE value, you can make at least one more JLS ADD LIMIT request.

Usage

You can use this variable in JAL 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, and $JXJLANY.

$JXLABEL

$JXLABEL

This JAL element has the following attributes: 

Attribute

Value

Description

Display LABEL Setting

This is a JAL execution time Display Variable. It allows you to display the value of a previously executed SET LABEL statement.

If no SET LABEL statement has been executed, asterisks are printed.

Type

Display Variable

Maximum Length

20 characters

Valid value

This is a valid insert in a MSGDEF statement.

If a SET LABEL statement has been executed, the 20-character label is printed.

If no SET LABEL statement has been executed, 8 asterisks are printed.

Usage

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

For more information, see SET LABEL.

$JXMHS_HOLD

$JXMHS_HOLD(YES | NO)

This JAL element has the following attributes: 

Attribute

Value

Description

MHS HOLD Status Indicator

This Logic Variable allows you to determine if at least one MHS ADD statement has been executed without an intervening MHS DELETE statement.

This function call returns a TRUE/FALSE value depending on whether or not there is at least one MHS ADD applied to the job.

Type

Logic Variable

Maximum Length

Not applicable

Valid values

  • YESIf $JXMHS_HOLD returns a TRUE value, at least one MHS ADD has been applied to the job.
  • NOIf $JXMHS_HOLD returns a TRUE value, no MHS ADD has been applied to the job.

Usage

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

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

$JXMHS_VOL_EXEMPT

$JXMHS_VOL_EXEMPT

This JAL element has the following attributes: 

Attribute

Value

Description

Display MHS_VOL EXEMPT Setting

This is a JAL execution time Display Variable. It allows you to display the value of a previously executed MHS_VOL SET EXEMPT statement.

If no MHS_VOL SET EXEMPT statement has been executed, the initial value for MHS_VOL EXEMPT status is ‘NO’.

Type

Display Variable

Maximum Length

3 characters

Valid values

This is a valid insert in a MSGDEF statement.

  • YESIf an MHS_VOL SET EXEMPT statement has been executed, ‘YES’ is printed.
  • NOIf no MHS_VOL SET EXEMPT statement has been executed, ‘NO’ is printed.

Usage

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

For more information, see MHS_VOL SET EXEMPT.

$JXMSGCLASS

$JXMSGCLASS

This JAL element has the following attributes: 

Attribute

Value

Description

Display MSGCLASS Setting

This is a JAL execution time Display Variable. It allows you to display the current value of the MSGCLASS keyword from the JOB statement.

If no SOS SET MSGCLASS statement has been executed, the initial value is the MSGCLASS at job submission.

Type

Display Variable

Maximum Length

8 character

Valid value

This is a valid insert in a MSGDEF statement. It prints a one character class, representing:

  • The class assigned with a previously executed SOS SET MSGCLASS statement.
  • If no SOS SET MSGCLASS statement has been executed, then the MSGCLASS at job submission.

Usage

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

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

$JXNORM

$JXNORM

This JAL element has the following attributes: 

Attribute

Value

Description

Display Normalization Status

This is a JAL execution time Display Variable. It allows you to display whether or not CPU normalization has been requested.

If no SET NORMALIZE statement has been executed, the initial value for the NORMALIZE keyword is ‘NO’.

Type

Display Variable

Maximum Length

3 characters

Valid value

This is a valid insert in a MSGDEF statement.

If a SET NORMALIZE(YES) statement has been executed, ‘YES’ is printed.

If no SET NORMALIZE statement has been executed, or a SET NORMALIZE(NO) statement has been executed, ‘NO’ is printed.

Usage

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

$JXNORMALIZE is an alias for $JXNORM.

$JXNOTIFY

$JXNOTIFY

This JAL element has the following attributes: 

Attribute

Value

Description

Display NOTIFY UserID

This is a JAL execution time Display Variable. It allows you to display the value of a previously executed SET NOTIFY statement.

If no SET NOTIFY has been executed, the initial value for the NOTIFY keyword is the userid of the submitter on the submitting node.

Type

Display Variable

Maximum Length

16 characters

Valid value

This is a valid insert in a MSGDEF statement.

If a SET NOTIFY statement has been executed, it prints the user ID, or the nodename.userid, or the nodename for the job, depending on which form was used in the SET NOTIFY statement.

If no SET NOTIFY statement has been executed, it prints the user ID, or the nodename.userid, or the nodename, or asterisks, depending on what was specified for the NOTIFY keyword on the JOB statement.

Usage

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

For more information, see $NOTIFY and SET NOTIFY.

$JXPERFORM

$JXPERFORM

This JAL element has the following attributes: 

Attribute

Value

Description

Display Performance Group Setting

This is a JAL execution time Display Variable. It allows you to display whether or not a SET PERFORM statement has been executed.

If no SET PERFORM statement has been executed, the initial value for the PERFORM keyword is ‘NO’.

Type

Display Variable

Maximum Length

3 characters

Valid value

This is a valid insert in a MSGDEF statement.

If a SET PERFORM(nnn) statement has been executed, ‘nnn’ is printed, representing the performance group requested.

If no SET PERFORM statement has been executed, or a SET PERFORM(NO) statement has been executed, ‘NO’ is printed.

Usage

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

For more information, see $JOB_PERFORM, $PERFORM, and SET PERFORM.

$JXPRIORITY

$JXPRIORITY

This JAL element has the following attributes: 

Attribute

Value

Description

Display Job Priority

This is a JAL execution time Display Variable. It allows you to display the job priority.

If no SET PRIORITY statement has been executed, the initial value for the PRIORITY keyword is the job submission priority.

Type

Display Variable

Maximum Length

2 characters

Valid value

This is a valid insert in a MSGDEF statement.

The job priority is printed. It is either from a SET PRIORITY statement or the initial value.

Usage

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

For more information, see SET PRIORITY.

$JXPR is an alias for $JXPRIORITY.

$JXRECALL

$JXRECALL

This JAL element has the following attributes: 

Attribute

Value

Description

Display DFSMShsm Recall Status

This is a JAL execution time Display Variable. It allows you to display the status of a requested DFSMShsm RECALL.

If no JSS RECALL statement has been executed, the initial value for the RECALL keyword is ‘NO’.

Type

Display Variable

Maximum Length

4 characters

Valid value

This is a valid insert in a MSGDEF statement.

  • NOIf no JSS RECALL statement has been executed, or a JSS RECALL NO statement has been executed, ‘NO’ is printed.
  • ALLIf JSS RECALL ALL was specified, ‘ALL’ is printed.
  • DASDIf JSS RECALL DASD was specified, ‘DASD’ is printed.
  • TAPEIf JSS RECALL TAPE was specified, ‘TAPE’ is printed.

Usage

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

For more information, see $HRECALL, $HRECALL_DASD, $HRECALL_TAPE, and JSS RECALL.

$JXSCHENV

$JXSCHENV

This JAL element has the following attributes: 

Attribute

Value

Description

Display Scheduling Environment

This is a JAL execution time Display Variable. It allows you to display the value of a previously executed SET SCHENV statement.

If no SET SCHENV has been executed, the value for $JXSCHENV is the scheduling environment of the job at submission time.

Type

Display Variable

Maximum Length

16 characters

Valid value

This is a valid insert in a MSGDEF statement.

It prints a 1through16 character scheduling environment, representing either:

  • The scheduling environment assigned with a previously executed SET SCHENV statement.
  • If no SET SCHENV statement has been executed, then the scheduling environment of the job at submission.

Usage

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

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

$JXSERVICE_CLASS

$JXSERVICE_CLASS

This JAL element has the following attributes: 

Attribute

Value

Description

Display Service Class

This is a JAL execution time Display Variable. It allows you to display the value of a previously executed SET SERVICE_CLASS statement.

If no SET SERVICE_CLASS has been executed, the value for $JXSERVICE_CLASS is the WLM service class of the job at submission time.

Type

Display Variable

Maximum Length

8 characters

Valid value

This is a valid insert in a MSGDEF statement.

It prints a 1through16 character scheduling environment, representing either:

  • The scheduling environment assigned with a previously executed SET SERVICE_ CLASS statement.
  • If no SET SERVICE_CLASS statement has been executed, then the WLM service class of the job at submission.

Usage

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

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

$JXSLM_CONTROL_CENTER

$JXSLM_CONTROL_CENTER

This JAL element has the following attributes: 

Attribute

Value

Description

Display SLM CONTROL CENTER for a Job

This is a JAL execution time Display Variable. It allows you to display the SLM CONTROL CENTER for the job.

Type

Display Variable

Maximum Length

8 characters

Valid value

This is a valid insert in a MSGDEF statement.

Usage

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

For more information, see SLM SET CONTROL_CENTER.

$JXSLM_JOB_IMPORTANCE

$JXSLM_JOB_IMPORTANCE

This JAL element has the following attributes: 

Attribute

Value

Description

Display SLM Job Importance for a Job

This is a JAL execution time Display Variable. It allows you to display the SLM Job Importance for the job.

Type

Display Variable

Maximum Length

1 character

Valid value

This is a valid insert in a MSGDEF statement.

If no SLM SET JOB_IMPORTANCE statement has been executed, the default Job Importance of 4 is displayed.

Usage

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

For more information, see SLM SET JOB_IMPORTANCE.

The SLM Policy determines whether Job Importance is in effect for the Service Group to which the job has been assigned.

$JXSLM_MANAGED

$JXSLM_MANAGED

This JAL element has the following attributes: 

Attribute

Value

Description

Display SLM-managed Status

This is a JAL execution time Display Variable. It allows you to display whether or not the job is SLM-managed.

Type

Display Variable

Maximum Length

3 characters

Valid values

$JXSLM_MANAGED

This is a valid insert in a MSGDEF statement.

  • YESIf an SLM SET MANAGED(YES) statement has been executed, ‘YES’ is printed.
  • NO—If no SLM SET MANAGED(YES) statement has been executed, or an SLM SET MANAGED(NO) statement has been executed, ‘NO’ is printed.

Usage

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

For more information, see SLM SET MANAGED.

This Display Variable is relevant only in a Fast Path implementation.

$JXSLM_SERVICE

$JXSLM_SERVICE

This JAL element has the following attributes: 

Attribute

Value

Description

Display SLM Service for a Job

This is a JAL execution time Display Variable. It allows you to display the SLM Service that a job will receive.

Type

Display Variable

Maximum Length

14 characters

Valid values

This is a valid insert in a MSGDEF statement. The following are the valid values:

  • GENERAL
  • PRODUCTION
  • ON_DEMAND

Usage

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

$JXSTAGE_STORAGETEK

$JXSTAGE_STORAGETEK

This JAL element has the following attributes: 

Attribute

Value

Description

Display StorageTek Virtual Volume Staging Status

This is a JAL execution time display variable. It allows you to display whether or not a JSS STAGE request has been issued for StorageTek virtual volumes.

If no JSS STAGE statement has been executed for StorageTek virtual Volumes, the value of $JXSTAGE_ STORAGETEK is ‘NO’.

Type

Display Variable

Maximum Length

3 characters

This is a valid insert in a MSGDEF statement.

If a JSS STAGE statement has been executed for StorageTek virtual volumes, ‘YES’ is printed.

If no JSS STAGE statement for StorageTek virtual volumes has been executed, or a JSS STAGE STORAGETEK(NO) statement has been executed, ‘NO’ is printed.

Usage

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

For more information, see JSS STAGE.

$LAST_DAY_OF_MONTH

$LAST_DAY_OF_MONTH(YES | NO)

This JAL element has the following attributes: 

Attribute

Value

Description

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 values

  • YESToday is the last day of the month.
  • NOToday is not the last day of the month.

Usage

You can use this variable in JAL Logic statements.

Example
$LAST_DAY_OF_MONTH(YES)

$LINES

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

This JAL 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 values

  • startThe starting point of a segment. The first starting point must be 0, but can be omitted if desired. Starting points are specified in thousands of lines as 1-6 decimal digits.
  • nameThe Property Name assigned to a segment of the range. Each Property Name must be unique and can consist of 1 through 24 alphabetic, numeric, national (#,@,$), or underscore (_) characters. Note that the first character of each name cannot be a dollar sign ($) or underscore (_). You can code the single character dollar sign ($) in place of a Property Name for ranges you wish to ignore.

Usage

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


Example
$LINES   FEW_LINES,1000,MANY_LINES

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

$LIST Descriptors

This JAL element has the following attributes: 

Attribute

Value

Description

Display Values for Selected Descriptors

These Display Variables allow you to insert selected job information into messages. The Display Variable names and descriptions are included in the Table of Display Variables below.

Type

Display Variable

Maximum Value

Not applicable

You can use only one of these variables in a particular MSGDEF statement, but you can repeat it multiple times to indicate how many volumes or agents to display in a single line. The message is issued as many times as necessary to display all volumes or agents in the list. The volumes or agents displayed reflect the status at the time the message is issued.

Descriptor Name

Description

Length

See Also

Comp.

$LIST_JBACT 

Lists active JBS Binding Agents.

17

JBS

$LIST_JBDEACT

Lists JBS Binding Agents that have been deactivated.

17

JBS

$LIST_JBS_ADD

Lists JBS Binding Agents that have been added.

17

JBS

$LIST_JBS_ADD_LAST

Lists the contents of the latest JBS ADD BIND. (See Notes.)

71

JBS

$LIST_JBS_BIND

Lists JBS Binding Agents.

17

JBS

$LIST_JBS_JECL

Lists JBS Binding Agents from JECL.

17

N/A

JBS

$LIST_JBS_JECL_PROC

Lists JBS Binding Agents from JECL in cataloged procedures.

17

N/A

JBS

$LIST_JBS_NEEDS

Lists in a message the requested JBS Environment.

16

JBS

$LIST_JBS_SET

Lists in a message the states that have been set.

17

JBS

$LIST_JLS_ADD

Lists JLS Binding Agents that have been added.

17

JBS

$LIST_JLS_ADD_LAST

Lists the contents of the latest JLS ADD LIMIT.
(See Notes.)

71

JBS

$LIST_JLS_ENQ

Lists JLS Limiting Agent ENQ references.

17

JBS

$LIST_JLS_JECL

Lists JLS Limiting Agents from JECL.

17

N/A

JBS

$LIST_JLS_JECL_PROC

Lists JLS Limiting Agents from JECL IN cataloged procedures.

17

N/A

JBS

$LIST_JLS_LIMIT

Lists JLS Limiting Agent references.

17

JBS

$LIST_PROC_LIBRARY

Lists procedure library name

44

DAL descriptor $JCL_PROC_LIBRARY

Base

$LIST_PROC_NAME

Lists procedure name

8

DAL descriptor

$JCL_PROC_ NAME

Base

$LIST_PROC_TYPE

Lists procedure type. It can be one of the following: INSTREAM, PRIVATE, SYSTEM.

8

DAL descriptor

$JCL_PROC_ TYPE

Base

$LIST_TAPEVOLS 

Lists non-scratch tape volumes (cartridges and reels) required by the job.

6

Base

$LIST_VOL_AUTO

Lists non-scratch automated volumes required by the job.

6

Base

$LIST_VOL_CART_ALL

Lists non-scratch cartridge volumes (manual and automated) required by the job.

6

Base

$LIST_VOL_DISK

Lists DASD volumes required by the job.

6

Base

$LIST_VOL_MANUAL

Lists manual non-scratch volumes required by the job.

6

Base

$LIST_VOL_REEL

Lists non-scratch non-cartridge volumes required by the job.

6

Base

$LIST_VOL_TO_EJECT

Lists non-scratch cartridge volumes required by the job that are within the automated system but are required in non-automated drives.

6

Base

$LIST_VOL_TO_ENTER

Lists non-scratch cartridge volumes required by the job that are outside the automated system but are to be treated as automated.

6

Base

$LIST_VOL_VTS

Lists virtual volumes required by the job.

6

Base

Usage

You can use these variables only as inserts in message definition statements.

Example

These Variables can be used to enumerate the volumes or Agents associated with a job. Typical usage would be:

$TAPEVOLS 0,$,1,TAPES
...
MSGDEF TAPELIST1 (‘Tape volumes for this job:’)
MSGDEF TAPELIST2 (‘ ‘,$LIST_TAPEVOLS,’ ‘,$LIST_TAPEVOLS,’ ‘, +
                $LIST_TAPEVOLS,’ ‘,$LIST_TAPEVOLS,’ ‘, +
                $LIST_TAPEVOLS,’ ‘,$LIST_TAPEVOLS)
...
IF (TAPES)
  WTU TAPELIST1 /* Print title line */
  WTU TAPELIST2 /* Display all tapes in 6 columns */
...

Important

If the resulting line is completely empty, it is not displayed.

The $LIST_JBS_ADD_LAST and $LIST_JLS_ADD_LAST Variables display the entire contents of the last ADD statement as a single string regardless of the number of Agents ADDed. Specifying these Variables more than once in a MSGDEF is therefore redundant.

$LPAR _NAME

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

— standard pattern/%patid/table-id information —

This JAL element has the following attributes:

Attribute

Value

Description

Hardware LPAR name

This descriptor represents the LAPR name defined by the HMC.

This variable will be "VM" if the LPAR is on a virtual machine.

Type

Character string descriptor

Maximum Value

8 characters

 

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