JCL-specific environment variables

This topic lists environment variables related to configuring the JCL environment.

Variable Description
CASRDO44_NEWSUB Enables access to JCL files held on the local machine on which the browser is running. 
CASRDO44_NEWSUB=OFF
CASSPOOL_LOCK_RETRY_COUNT If errors are experienced by the spool module, the number of times it retries to obtain a record lock can be adjusted using this environment variable. The default value is 20. 
CASSPOOL_LOCK_RETRY_COUNT=
						num-retries
CTM_SPACE[21] Control-M (CTM) for z/OS does not support embedded spaces in variable values. The default CTM behavior of MFBSI supports spaces, and in the case of AutoEdit variable values, removes the spaces and assigns the rest of the value to the variable. To mimic the z/OS behavior for handling spaces in AutoEdit variables, set CTM_SPACE=OFF.
ES_ALLOC_EXPAND The default value is Y, which expands an environment variable when used to specify an allocation path. Set to N to override this behavior, which is to not expand the variable used in the path. 
ES_ALLOC_EXPAND=Y|N
ES_ALLOC_OVERRIDE The location of a file containing rules that determine where new data sets are created. This applies only to JES and batch files, and not CICS, IMS, or Web services files. 
ES_ALLOC_OVERRIDE=
						rules-file
ES_CAT_RETRY_COUNT Determines the amount of attempts made to open a catalog file that has produced an error when the initial attempt to open it was made. 
ES_CAT_RETRY_COUNT=n

Default is ES_CAT_RETRY_COUNT=0.

ES_CAT_RETRY_WAIT Determines the amount of time (in seconds) to wait between attempts made to open a catalog file that has produced an error when the initial attempt to open it was made. 
ES_CAT_RETRY_WAIT=n

Default is ES_CAT_RETRY_WAIT=0.

ES_IEBGEN_TO_ICEGEN[16] Enables VSAM copy using the MFGENER utility.

Default is ES_IEBGEN_TO_ICEGEN=N.

ES_JESYSMSG_OUTPUT The status of the system messages spool files (JESYSMSG) is set to Output, rather than Out Hold. 
ES_JESYSMSG_OUTPUT=Y|N
ES_JESYSMSG_RESTRICTED When the status of the system message spool files are set to Output, by using ES_JESYSMSG_OUTPUT, you can hold back spool files based on their class, by using ES_JESYSMSG_RESTRICTED. 
ES_JESYSMSG_RESTRICTED=
						class-name/number

To specify multiple class names or numbers, enter them as a string; for example, ABC123 for classes A, B, C, 1, 2, & 3.

ES_JES_BYTES Maximum number of bytes to output in a job before taking the action specified (either cancelling the job, cancelling the job and dumping memory contents, or issuing a warning message). 
ES_JES_BYTES=
						NUMBER
						| (NUMBER,WARNING | CANCEL | DUMP)
ES_JES_CARDS Maximum number of cards to output in a job before taking the action specified (either cancelling the job, cancelling the job and dumping memory contents, or issuing a warning message). 
ES_JES_CARDS=
						NUMBER
						| (NUMBER,WARNING | CANCEL | DUMP)
ES_JES_CONSOLE_MESSAGES CASMG0001I messages are produced when a program running in a JCL job does 'display upon console'. These messages, along with others, are lodged in the splmsg.dat file and, when the job information is displayed in ESCWA/ESMAC these messages are also shown.
There is a limit of 65535 messages per job. If that limit is exceeded the last messages sent will overwrite the last message already lodged in splmsg.dat. If your program outputs a lot of messages you can avoid having them stored in splmsg by setting ES_JES_CONSOLE_MESSAGES=N. Whatever this setting, the CASMG0001I messages will still be included in the JESYSMSG for the job. 
ES_JES_CONSOLE_MESSAGES=Y|N
There is also a Job statement extension so that this can be configured on a job by job basis. 
//*MFE:%CONSOLE_MSGS=Y|N
ES_JES_DELAY_MEM_ENQ Delays the exclusive enque of a new (not previously existing) PDS member until the file is opened. PDS members are given an exclusive enque at step start.

When used with existing PDS members, the program abends with code S213 when it attempts to access a file and cannot get the exclusive enque. 

ES_JES_DELAY_MEM_ENQ=Y|N

Default is N .

ES_JES_DISABLE_RESTART_FLUSH Indicates whether a region's jobs are moved from the Active queue to the Complete queue when a region is restarted. 
ES_JES_DISABLE_RESTART_FLUSH=Y|N
ES_JES_ENFORCE_EXPIRE_DATE (UNIX only) [2] Enables or disables the checking of the expiry date. 
ES_JES_ENFORCE_EXPIRE_DATE={Y|N}

Default is Y .

ES_JES_LEVEL Sets the default JCL type. 
ES_JES_LEVEL=JES2|JES3|VSE
ES_JES_LINES Maximum number of lines to output in a job before taking the action specified (either cancelling the job, cancelling the job and dumping memory contents, or issuing a warning message). 
ES_JES_LINES=
						NUMBER
						| (NUMBER,WARNING | CANCEL | DUMP)
ES_JES_LISTCAT_YMD (UNIX only) [2] Determines the date format used in the HISTORY report generated when the IDCAMS LISTCAT command specifies the ALL parameter. 
ES_JES_LISTCAT_YMD={Y|N}

Default is N .

ES_JES_OUTLIM 
ES_JES_OUTLINE=
						NUMBER
						| (NUMBER,WARNING | CANCEL | DUMP)
					
ES_JES_OUTLIM=5000
When the above is set, a warning will be issued when 5000 lines of output is exceeded. 
ES_JES_OUTLIM=(1000,CANCEL)
When the above is set, it causes a step to abend with an S722 abend code if the output limit of any SYSOUT dataset exceeds 1000 lines. Individual OUTLIM values can be set on each SYSOUT dataset. For example, //SYSPRINT DD SYSOUT=*,OUTLIM=500. If the output of SYSPRINT exceeds 500 lines and ES_JES_OUTLIM=(1000,CANCEL) then the step will be cancelled with an S722 abend code.
ES_JES_PAGES Maximum number of pages to output in a job before taking the action specified (either cancelling the job, cancelling the job and dumping memory contents, or issuing a warning message). 
ES_JES_PAGES=
						NUMBER
						| (NUMBER,WARNING | CANCEL | DUMP)
ES_JES_PARM_INIT_LOW When set to Y, the parameter string passed to a program executed by JCL is initialized to low-values. The default is N, which is to initialize it to spaces. 
ES_JES_PARM_INIT_LOW=Y|N
ES_JES_RESTART Enables JCL restart processing. 
ES_JES_RESTART=Y|N
ES_JES_SORT_SPOOL_BY Specifies which column is initially used to sort the spool records in casrdo41. 
ES_JES_SORT_SPOOL_BY=JOBNAME|SUBDATE|JOBUSER
Note: If any other value is specified, then the spool records are sorted based on the JOBNUMBER (JOBID).
ES_JES_SPOOL_ORDER The order in which the spool list is displayed when you first open ESMAC. 
ES_JES_SPOOL_ORDER=1|
						any
1
Spool list displayed in descending order.
any
Any value other than 1 displays the spool list in ascending order. This is the default.
ES_OPEN_CAT_ON_DEMAND Determines if additional catalogs (as specified using MFUSERCAT_NODE) are opened when the system starts, or only opened when required. 
ES_OPEN_CAT_ON_DEMAND=Y|N

Default is N .

ES_PL1_MFFH_JCL Enables you to run Open PL/I programs that access JCL data definitions. The default value is N. 
ES_PL1_MFFH_JCL=Y|N
ES_PROG_PATH Set ES_PROG_PATH=Y to display the program's load path in the JESYSMSG and SYSLOG datasets.
Note: This is only applicable for native enterprise server regions.
ES_OLD_DYN_PDS Determines the resulting behavior of dynamic PDS members when specified in a JCL DD statement. Set to Y to enable previous default behavior of creating the physical files and cataloging PDS members when specified in a JCL DD statement. Set to N (the default), the physical files are only created and cataloged when using a JCL utility or user program. 
ES_OLD_DYN_PDS=Y|N

Default is N .

ES_SAM_ESDS Under VSE, when this is set to Y, opening an OUTPUT of a reusable ESDS file resets the file when the DISP is not specified in the DLBL statement. 
ES_SAM_ESDS=Y|N
ES_SSTM_CICS Location of the JCL used to initialize the SSTM CICS environment. 
ES_SSTM_CICS=
						file-location
ES_SSTM_IMS Location of the JCL used to initialize the SSTM IMS environment. 
ES_SSTM_IMS=
						file-location
ES_SSTM_JOB_FLUSH_ACTIVE By default, this is set to N.

When set to Y, causes a CICS SSTM job to be removed from the Active queue when the region shuts down.

ES_SYSOUT_HOLD Sysout held classes. 
ES_SYSOUT_HOLD=???
ES_USR_DFLT_JES Allows you to override the default user when no user is logged on for JES authentication. 
ES_USR_DFLT_JES=Y|N???
GDG_RESTART_UCC11_ONLY Determines when GDG restart information should be written.
Y
GDG restart information is written, but only when ES_JES_RESTART=Y and MF_UCC11 is set (Y, YA, or M). This is the default.
N
GDG restart information is written even if MF_UCC11=N or is not set. (ES_JES_RESTART=Y must still be set.) 
GDG_RESTART_UCC11_ONLY=Y|N
JES_PRINT_SPOOL_MSG Specifies the disposition of the spool data set printing message (JES000029I ). 
JES_PRINT_SPOOL_MSG=CONSOLE|LOG|SILENT
CONSOLE
The console.log file (default).
LOG
A special log file named PRNT_SPL_MSG_YYYY_MM_DD.DAT where YYYY_MM_DD is the current date. This file resides in the same directory as the spool files, and a new file is created every day.
SILENT
No messages. Use this option with caution, as you will have no audit log of your spool data sets.
Note: This environment variable is introduced for high print load users, where print messages to the console impact system performance.
JCLTEMP_DIR Enables you to specify a separate location for the JCLTEMP directory. Defaults to the directory specified by MFBSI_DIR.
MF_ALIAS Specifies program aliases. Each set (pair) is 16 characters long - 8 characters for the program-name, and 8 characters for the alias. You can specify up to 10 pairs. This list is searched first and thus can potentially override the built-in list. If not found, the built-in alias table is searched.

An entry shorter than 8 characters must have trailing spaces extending its length to 8 characters. 

MF_ALIAS=
						program-name1
						alias1
						[
						program-name2
						alias2
						] ...[
						program-name10
						alias10
						]
MF_CHARSET Specifies which character set an enterprise server is to use. 
MF_CHARSET=A|E|ASCII|EBCDIC

The default value is ASCII.

MF_DUPJOBS Enables jobs with identical names to run. 
MF_DUPJOBS=Y|N

The default value is N.

MF_FALLTHRUCHECK Specifies that MSS is to check that the main COBOL program ends by executing a GOBACK or STOP RUN. 
MF_FALLTHRUCHECK=Y|N

The default value is Y.

MF_IKJEFT_KEEP_MAX[17] Determines whether IKJEFT01 uses the last return code from a command or the highest return code of all commands executed as the step COND CODE.
Syntax 
MF_IKJEFT_KEEP_MAX={Y|N}
Parameters
Y
IKJEFT01 uses the highest return code of all commands executed as the step COND CODE.
N
IKJEFT01 uses the last return code from a command as the step COND CODE.
Properties
Default: MF_IKJEFT_KEEP_MAX=N
MF_JESPWR_EXIT Used to pass JES2 and VSE PWR statements to the user exit MFJESPWR. If this environment variable is set, the JCL execution engine will call the exit program, MFJESPWR, whenever a JES2 or VSE PWR statement is encountered. It passes the contents of the JCL record plus Job and Job Step information. A sample MFJESPWR.cbl is included with the product. 
MF_JESPWR_EXIT= Y|N

The default value is N.

MF_JCL_AUDIT Specifies that the audit log records audit information when a catalog entry is deleted. 
MF_JCL_AUDIT=DLET|DLEJ|DLET,DLEJ
DLET
Logs audit information each time an ESMAC/CAS utility deletes a catalog entry.
DLEJ
Logs audit information each time a step in a JCL job deletes a catalog entry.
DLET,DLEJ
Logs audit information each time either an ESMAC/CAS utility or a JCL job step deletes a catalog entry.

The default is that this is not set.

MF_JES_ABEND_CAF_COMMIT Specify the outcome when a non-zero return code is received from the commit at the end of a DSNAL or IKJEFT** unit of work. 
MF_JES_ABEND_CAF_COMMIT=YES|NO|
						rtn-code
YES
an abend (S482) is generated.
NO
an abend is not generated.
rtn-code
a numeric value (up to 3 digits) to be used as the return code.

The default is YES.

MF_LEX_API [24] Specifies whether the JES configuration uses single or multiple LEX files, and enables JES configuration to specify subdirectories for LEX files as necessary. 
MF_LEX_API={1|2|D}|1D|2D|D
1
Use multiple LEX files.
2
Use a single LEX file. Disk-based access only.
D
Use directories to store LEX files.

The default is 1.

Important: Do mix these settings in a Region/PAC. They must be consistent for all.
MF_MFA Specifies what data set catalogs are to be searched. 
MF_MFA=ALL|RJSE
  • ALL - Search for data sets first in the local catalog, and if not found, on the mainframe (default).
  • RJSE - Search for data sets in the local catalog only. No mainframe is performed.
MF_MVSJOB
Sets the number at which a job starts and finishes. 
MF_MVSJOB=
							<lower value>
							{-|+}
							<upper value>
Where:
<lower value>
Number at which a job starts. Contains 7 digits - for example, 0000001
-
Sets the values but only on the first startup of the region.
+
Reset the values to these new ones each time the region is started.
<upper value>
Upper job number. Contains 7 digits - for example, 9999999
For example: 
set MF_MVSJOB=0000010+0000100
This resets the values to start with job number 10 and run through to job number 100. When the upper limit has been reached you receive a message: 
All job numbers in the range 0000010:0000100 are in use
At this point you need to remove some jobs from the spool - you can use the spool housekeeping functions to do this.

This environment variable can be used to enable a 7-digit Job number limit. If the <upper value> mentioned is greater than 99999, then 6+ digit job number support is enabled. The maximum value that can be set is 9999999.

Tip: To revert to 5-digit job number support, set MF_MVSJOB= <low number> + <high number> , where high number is less than 0099999, and ensuring that the + sign is used to separate the low and high values.

If a value set using this variable is not valid, the default values of <0001000>{-|+}<0099999> are set.

MF_MVSP0034_LIMIT Specifies the number of records in each exported catalog XML document. 
MF_MVSP0034_LIMIT=limit

Where limit is a one to six digit number between 1 and 999999.

If unset, then all records are written to the catalog export XML file.

MF_NODD Specifies what action MSS is to take at run time if a job step uses a file that has not been allocated. 
MF_NODD=A|R
A
Abend the program. This is the default.
R
Returns file status 3/5.
MF_PCRENAME_LAX

When an MVS data set is renamed, the associated physical file is normally renamed only if it is in the Default Allocation data set location. 

MF_PCRENAME_LAX=Y|N|D
Y
Enable physical files in other locations to be renamed if the cataloged name is changed.
N
Only physical files in the default allocation data set location are renamed. This is the default value.
D
Indicates that a new directory structure and filename will be constructed, and the existing file moved to that location.
MF_RCCF Enables Remote Job Step Execution (RJSE). 
MF_RCCF=DELETEJOB|KEEPJOB
MF_SMS Enables support for SMS data classes. SMS is IBM's Storage Management Subsystem. MSS provides emulation for SMS data classes only. To enable DATACLAS support this variable needs to be set ON in addition to setting MFUSERCAT_NODE=SYSMFE1. 
MF_SMS=ON|OFF

The default value is OFF.

MF_SPOOL_HK_TESTDATE Overrides the normal date for the spool housekeeping. 
MF_SPOOL_HK_TESTDATE=YYYYMMDD
MF_UCC11
Note: This environment variable works independently of the JCL RESTART parameter.
Enables emulation of UCC11, a third party add-on to the mainframe that affects data set disposition processing. 
MF_UCC11=Y|YA|M|MA|MR|N
Y
When restarting a job with DISP=(NEW,CATLG), it will not result in job failure caused by the data set already being cataloged.
YA
When running a job with DISP=(NEW,CATLG), it will not result in job failure caused by the data set already being cataloged.
M, MA, MR
When restarting a job any data set that has an inital disposition of NEW is changed to MOD. Therefore, data will be appended to the data set if it already exists.
N

MF_UCC11 is not set so a data set with an initial disposition of NEW may cause an error when restarting the job if the data set already exists.

The setting of the MF_UCC11 value can be made on a job-by-job basis using either the JCL user exit, MFJUXIT, or the Advanced Restart Functionality.

MF_UCC11_DYNCLEAN When UCC11 emulation is enabled, MF_UCC11=Y or YA, set this environment variable in order to control whether dynamically allocated datasets (such as using SVC99) are cleaned when a job is restarted. 
MF_UCC11_DYNCLEAN=Y|N
Y
Default. When a job is restarted, any dynamically allocated datasets will be removed and replaced.
N
Prevents the cleaning of dynamically allocated datasets when restarting a job.
MF_USESCA7 Specifies that MSS accepts CA7 Scheduler control statements as comments rather than diagnosing them as errors. CA7 Scheduler control statements begin with # in column 1. 
MF_USESCA7=ON|OFF

The default value is OFF.

MFALLOC_DEF_VB_PCFILE When set to Y (the default), a new PS VB file that is created without an LRECL setting (or set to 0), is defined in the catalog as a VB file with default settings of minimum length = 0, and maximum length = 32760. Alternatively, set this variable to 'N' to ensure that the file is not created in these circumstances. 
MFALLOC_DEF_VB_PCFILE=Y|N
MFALLOC_PCFILE When set to Y, which is the default, it will cause a catalogued file to be created if DSORG=PS is provided in the DCB parameters. 
MFALLOC_PCFILE=Y|N
MFCATMNTUE Specifies the name of the MFCATMNT user exit program if not compiled to the default name of MFCATMNTUE. 
MFCATMNTUE=
						program-name

The default value is MFCATMNTUE.

MFJ_ALL_STEP_CHECK

The default behavior of this product is to not check COND CODES from steps prior to a restart step. This means that the steps after the restart step that have conditions that refer to any steps prior to the restart step might run. Micro Focus recommends that you review and test the behavior before restarting the jobs.

Set this variable to Y to prevent steps after a restart step that have conditions that refer to any steps prior to the restart from running. 

MFJ_ALL_STEP_CHECK=N|Y
MFJ_PTPCH_CODESET For use when an extended Japanese code set other than 9122 is being used. This will cause MFJPTPCH to check the same hexadecimal character value as with code set 9122 to decide if a character is printable or not. The only permissible value is EXTJ: 
MFJ_PTPCH_CODESET=EXTJ
MFJ_REPORT_DATE_CHANGE Records the date stamps in the JESYSMSG job log of when a job started, and any data changes during execution. 
MFJ_REPORT_DATE_CHANGE=Y|N

The default is Y. When set to N, switches off the data stamps in the log.

MFJ_REPRO_EMPTY Enables or disables the ability for the IDCAMS REPRO action to copy from a pristine VSAM file. 
MFJ_REPRO_EMPTY=Y|N

When set to Y, the resulting file will be empty.

The default value is N, which will produce a JCLAM0150S error when attempted.

MFJSENGINE

Specifies which sort engine the utility MFJSORT is to emulate. 

MFJSENGINE=DFSORT|SYNCSORT

The default value is DFSORT.

MFJ_INPUTDS_ERROR When set to N, will cause IEBDG, IEBGENER, IEBCOMPR, and DFSORT and ICETOOL emulation to treat missing input files as though they were present but empty. 
MFJ_INPUTDS_ERROR=Y|N

The default value is Y.

MFJ_STRICT_CASE When set to Y, will cause MVSCATIO to honor the case of physical file names passed by the catalog API, and other utilities such as MFCATXML and MVSPCRN. When set to N, all physical file names will be folded into upper case. 
MFJ_STRICT_CASE=Y|N

The default is N.

MFJFAXIT Specifies the user exit program that enables file action notifications. This user exit is called by the JCL engine whenever a JCL file is opened OUTPUT, I-O, or EXTEND, or when it is copied or renamed by the JCL engine. See User Exit for File Action Notifications for more information.

A sample user exit program ( MFJFAXIT.cbl ) is provided with your product, and is located in the src\enterpriseserver\exits sub-directory of your product install directory. 

MFJFAXIT=
						<path-and-file-name-of-exit>
MFREXX_CHARSET Specifies the character set used by the REXX engine when working with hexadecimal strings or performing string comparisons. 
MFREXX_CHARSET=A|E
A
ASCII. This is the default value.
E
EBCDIC.
MFREXX_CONCAT Specifies one or more characters to be used for the CONCAT operator in addition to REXX's default, which is "||". 
MFREXX_CONCAT=char-spec

One or more characters for each operator; each character you specify is used in addition to the default operator. Each additional character must be defined within single or double quotes, or in hexadecimal. Separate multiple characters with a space or a comma.

Any error in the specification of the additional characters, including the specification of alphabetic or numeric characters, results in the environment variable being ignored.

MFREXX_LSEQ_RECSIZE_MAX Specifies the record length for the REXX EXECIO command when reading or writing a line sequential file that has been cataloged with a record length of zero. 
MFREXX_LSEQ_RECSIZE_MAX=rec-length
rec-length
Record length to use. The minimum value you can specify is 255. Specifying an invalid value, or a value less than 255, results in the default value (255) being used.
MFREXX_NO_PROCESS_STDIN [1] When set to "y" or "Y" this environment variable stops STDIN from being processed on an EXECIO command.
MFREXX_NOT Specifies one or more characters to be used for the NOT operator in addition to REXX's default, which is "¬". 
MFREXX_NOT=char-spec
char-spec
One or more characters for each operator; each character you specify is used in addition to the default operator. Each additional character must be defined within single or double quotes, or in hexadecimal. Separate multiple characters with a space or a comma.
Any error in the specification of the additional characters, including the specification of alphabetic or numeric characters, results in the environment variable being ignored.
MFREXX_OR One or more characters to be used for the OR operator in addition to REXX's default, which is "|". 
MFREXX_OR=char-spec
char-spec
One or more characters for each operator; each character you specify is used in addition to the default operator. Each additional character must be defined within single or double quotes, or in hexadecimal. Separate multiple characters with a space or a comma.
Any error in the specification of the additional characters, including the specification of alphabetic or numeric characters, results in the environment variable being ignored.
MFSYSCAT The location of the JES system catalog. 
MFSYSCAT=cat-file
cat-file
The fully-qualified location and name of the system catalog file to use.
For a database-hosted system catalog, you need to include the full SQL URL, for example, sql://localhost/JCLTEST/catalog.dat?folder=/JCLDEMO
See the data category in The dbfhdeploy Command Line Utility for full notation details if specifying a database-hosted system catalog.
MFUSERCAT_BASE_LOC If an entry in MFUSERCAT_LOC only specifies the file name of a user catalog rather than the full path and file name, use this environment variable to specify where these catalogs are located. 
MFUSERCAT_BASE_LOC=C:\User\catalogs
If multiple user catalog files are in the same location - for example, C:\USERCATALOGS or $$MYFILESHARE - use this environment variable to store that location. Then, you only need to specify the file name of the catalog in MFUSERCAT_LOC.
MFUSERCAT_LOC The location of the node(s) set in MFUSERCAT_NODE, separated by semi-colons if more than one is specified. 
MFUSERCAT_LOC=
						file-location(s)

This is not set by default.

MFUSERCAT_NODE Sets additional SMS, SPOOL and User catalogs. To enable support for the SMS entities DATACLAS and MGMTCLAS, this variable needs to be set in addition to setting MF_SMS=ON. 
MFUSERCAT_NODE=
						node

This is not set by default.

SSTM_WC_REFRESH Determines how often the write count for the SSTM job is updated in SYSOUT or SYSPRINT. You can set a value between 1-65535 to indicate the number of writes at which the count is updated. A value of 0 (zero) indicates that the count is only updated when the file is closed. Any other value smaller that 1 will default to 0, and any value larger than 65535 will default to 65535. 
SSTM_WC_REFRESH=
						write-count
VSE_STARTUP_CFG The location of the VSE JCL configuration file. 
VSE_STARTUP_CFG=config-file
config-file
The fully-qualified location and name of the configuration file to use.
Parent topic: Environment Variables by Groups
Related reference
JOB Statement Extensions