JCL-specific environment variables

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

CTM_SPACE [2]

Enables you to change the default MFBSI behavior for handling spaces in AutoEdit variable values to mimic the z/OS behavior.

Syntax

CTM_SPACE={[ON|YES]|[OFF|NO]}

Parameters

ON|YES: Handle spaces using the MFBSI behavior, meaning allow embedded spaces in CTM variables.
OFF|NO: Handle spaces using the z/OS behavior, meaning do not allow embedded spaces in CTM variables.

Default

CTM_SPACE=ON

Comments

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.

Syntax

ES_ALLOC_EXPAND=value
export ES_ALLOC_EXPAND

Values

Y Expands an environment variable used to specify an allocation path.

N Do not expand the variable used in the path.

Default

The default value is Y.

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.

Syntax

ES_ALLOC_OVERRIDE=rules-file
export ES_ALLOC_OVERRIDE

Values

rules-file The file path and name of the dataset rules file.

ES_CAT_RETRY_COUNT

Determines the number of attempts made to open a catalog file that has produced an error when the initial attempt to open it was made.

Syntax

ES_CAT_RETRY_COUNT=n

Parameter

n: The number of attempts made to open a catalog file.

Properties

Default:

ES_CAT_RETRY_COUNT=0

Comments

Use this variable in conjunction with the ES_CAT_RETRY_WAIT variable, which determines how long to wait in between each attempt.

Take care when setting these variables as they could impact the time taken to report an error and therefore will delay processing of a job whilst the checks take place. These variables can be useful if you experience file access problems (for example, network connection drop-outs) that only last a second or two, so that it gives the system a chance to recover, before aborting.

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.

Syntax

ES_CAT_RETRY_WAIT=n

Parameter

n: The number of seconds to wait between attempts made to open a catalog file.

Properties

Default:

ES_CAT_RETRY_WAIT=0

Comments

Use this variable in conjunction with the ES_CAT_RETRY_COUNT variable, which determines how many attempts to make to open a catalog file that initially failed to open.

ES_DSENQSHR

Enable and configure handling of the DSENQSHR keyword when it is specified on the JCL job card, and when it is not specified on the job card.

Syntax

ES_DSENQSHR={ALLOW|AUTO|DISALLOW}

Parameters

ALLOW: For JCL jobs that have the DSENQSHR keyword specified on the JCL job card, sets DSENQSHR to the value specified on the job card. For jobs that do not have the DSENQSHR keyword specified on the JCL job card, sets DSENQSHR=ALLOW for each of those jobs.
AUTO: Use the value specified on the JCL Job card, which sets ES_DSENQSHR to ALLOW when that value is either ALLOW or USEJC, and DISALLOW otherwise.
DISALLOW: For jobs that do not have the DSENQSHR keyword specified on the JCL job card, sets DSENQSHR=DISALLOW for each of those jobs.

Properties

Default:

ES_CAT_RETRY_WAIT=ES_DSENQSHR=DISALLOW

Comments

When ES_DSENQSHR is not set, the value of DSENQSHR on the JCL job card is used. In this case, if DSENQSHR is set to USEJC on the job card, ES_DSENQSHR is set to DISALLOW.

When DSENQSHR is allowed on a job, exclusive dataset locks are downgraded to SHARED after performing the last step that requires an exclusive lock.

Exclusive locks resulting from a dynamic exclusive enque (for example an IDCAMS DELETE operation) are maintained as exclusive until the end of the job regardless of the DSENQSHR setting.

Use VSAM Shareoptions with VSAM datasets. You can enable these using the ES_SHAREOPT=Y environment variable.

ES_IEBGEN_TO_ICEGEN

Determines enablement of VSAM copy using the MFGENER utility.

Syntax

ES_IEBGEN_TO_ICEGEN={Y|N}

Parameters

Y: Enables VSAM copy using the MFGENER utility.
N: Disables VSAM copy using the MFGENER utility.

Properties

Default:

ES_IEBGEN_TO_ICEGEN=N

ES_JES_BYTES

Maximum number of bytes to output in a job before taking the action specified by cancelling the job, cancelling the job and dumping memory contents, or issuing a warning message.

Syntax

ES_JES_BYTES=(number[,{WARNING|CANCEL|DUMP}])

Parameters

number: Maximum number of bytes in thousands. The range is from 0-99999999.
WARNING: Issue a warning when the specified maximum number of bytes is reached.
CANCEL: Cancel the job when the specified maximum number of bytes is reached.
DUMP: Cancel the job and dump the memory contents when the specified maximum number of bytes is reached.

Properties

Default:

None

Example

ES_JES_BYTES=(100,DUMP)

Each line is assumed to hold 132 bytes; therefore the job is automatically cancelled at 100000/132 lines, and the memory contents are dumped.

ES_JES_CARDS

Maximum number of cards to output in a job before taking the action specified by cancelling the job, cancelling the job and dumping memory contents, or issuing a warning message.

Syntax

ES_JES_CARDS=(number[,{WARNING|CANCEL|DUMP}])

Parameters

number: Maximum number of cards. The range is from 0-99999999.
WARNING: Issue a warning when the specified maximum number of cards is reached.
CANCEL: Cancel the job when the specified maximum number of cards is reached.
DUMP: Cancel the job and dump the memory contents when the specified maximum number of cards is reached.

Properties

Default:

None

Example

ES_JES_CARDS=(30,WARNING)

Each card is assumed to hold 25 lines; therefore at 750 lines (25×30) a warning message is issued the job continues.

ES_JES_CONSOLE_MESSAGES

Determines whether to lodge CASMG0001I messages in the splmsg.dat list for a job.

Syntax

ES_JES_CONSOLE_MESSAGES={Y|N}

Parameters

Y: Lodges CASMG0001I messages in the splmsg.dat list for a job.
N: Does not lodge CASMG0001I messages in the splmsg.dat list for a job.

Properties

Default:

ES_JES_CONSOLE_MESSAGES=Y

Comments

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

There is a way to work around this, if your program outputs a lot of messages. You can set ES_JES_CONSOLE_MESSAGES=N in order to avoid storing the messages in splmsg.dat. Whatever this setting, the CASMG0001I messages will still be included in the JESYSMSG for the job.

There is also a Job statement extension so that this can be configured on a job by job basis - see the line below. See JOB Statement Extensions for more details.

//*MFE:%CONSOLE_MSGS=Y|N

ES_JES_DELAY_MEM_ENQ

Determines whether to delays the exclusive enque of a new (not previously existing) PDS member until the file is opened.

Syntax

ES_JES_DELAY_MEM_ENQ={Y|N}

Parameters

Y: Delay the exclusive enque of a new (not previously existing) PDS member until the file is opened.
N: Do not delay the exclusive enque of a new (not previously existing) PDS member until the file is opened.

Properties

Default:

ES_JES_DELAY_MEM_ENQ=N

Comments

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_DISABLE_RESTART_FLUSH

Indicates whether jobs in a specific enterprise server region are moved from the Active queue to the Complete queue when the region is restarted.

Syntax

ES_JES_DISABLE_RESTART_FLUSH={Y|N}

Parameters

Y: Move jobs in the region from the Active queue to the Complete queue when the region is restarted.
N: Do not move jobs in the region from the Active queue to the Complete queue when the region is restarted.

Properties

Default:

None

ES_JES_ENFORCE_EXPIRE_DATE

Determines whether or not to check the expiration date when deleting a catalogued dataset, and if expired, delete the dataset.

Note: Use the PURGE keyword to delete non-expired datasets.

Syntax

ES_JES_ENFORCE_EXPIRE_DATE={Y|N}

Parameters

Y: Check the expiry date and delete expired datasets.
N: Do not check the expiration date.

Properties

Default:

ES_JES_ENFORCE_EXPIRE_DATE=Y

ES_JES_FREE_SSTM_SYSOUT

Determines whether to free the memory assigned to store details about each CICS spool file that you create using the CICS Spool Write API's, once the spool file has been created.

This helps avoid problems with receiving 'out of memory' errors, when creating multiple new files.

Warning: Setting the variable also removes the tracking information about the file which means that the file's status (SPOOLED) no longer appears in the JESYSMSG for the SSTM job.

Syntax

ES_JES_FREE_SSTM_SYSOUT={Y|N}

Parameters

Y: Free the memory assigned to store details about each CICS spool file.
N: Do not free the memory assigned to store details about each CICS spool file.

ES_JES_HIGHER_SECURITY_LEVEL

Determines which programs are loaded based on checks made against the list of SYS1.LNKLIB entries.

Syntax

ES_JES_HIGHER_SECURITY_LEVEL={0|[1|NONE][2|BASIC][3|WARN][4|ENHANCED]}

Parameters

0: The behavior is unchanged with regard to JES enhanced security.
1|NONE: A value of 1 or NONE is the equivalent of not setting the value and maintains the behaviour of earlier versions of Enterprise Server. With a setting of 1 or no setting at all, warning messages about the number of SYS1.LNKLIB entries might be issued if none have been defined (JES000067W) and messages about programs not being loaded from certain locations (JES000069W) are also given. In addition, messages JCLCM0260W and JCLCM0308W might also be issued.

2|BASIC: A level of BASIC or 2 causes programs to be loaded from the list of SYS1.LNKLIB entries, STEPLIB, and JOBLIB locations. Programs in other locations are not loaded. The loading of programs from dynamic PDSs is also entirely disabled.

3|WARN: A level of WARN or 3 causes checks to be made against the PROGRAM and the PHYSFILE security classes. The PHYSFILE check is to make sure the PHYSFILE resource class is implemented. If these checks fail, a warning message (JCLCM0262W, JCLCM0263W or JCLCM0266W) is issued.

4|ENHANCED: A level of ENHANCED or 4 will cause the same PROGRAM and PHYSFILE checks to be made but if they fail then the job will abend with an S913 security error and a suitable message will be issued to indicate the failure.

Properties

Default:

ES_JES_HIGHER_SECURITY_LEVEL=1

ES_JES_LEVEL

Sets the default JCL type on the JES Control page.

Syntax

ES_JES_LEVEL={VSE|JES2|JES3}
export ES_JES_LEVEL

Parameters

VSE: Default JCL type of VSE.
JES2: Default JCL type of JES2.
JES3: Default JCL type of JES3.

Properties

Default:

ES_JES_LEVEL=JES2

ES_JES_LINES

Maximum number of lines to output in a job before taking the action specified by cancelling the job, cancelling the job and dumping memory contents, or issuing a warning message.

Syntax

ES_JES_LINES=(number[,{WARNING|CANCEL|DUMP}])

Parameters

number: Maximum number of lines in thousands. The range is from 0-99999999.
WARNING: Issue a warning when the specified maximum number of lines is reached.
CANCEL: Cancel the job when the specified maximum number of lines is reached.
DUMP: Cancel the job and dump the memory contents when the specified maximum number of lines is reached.

Properties

Default:

None

Example

ES_JES_LINES=(100,CANCEL)

Each card is assumed to hold 25 lines; therefore at 750 lines (25×30) a warning message is issued the job continues. Limit the number of lines output to 100000. When this limit is reached cancel the job. This results in an S722 Output limit exceeded system abend code being produced.

ES_JES_LISTCAT_YMD

Determines the date format used in the HISTORY report generated when the IDCAMS LISTCAT command specifies the ALL parameter.

Syntax

ES_JES_LISTCAT_YMD={Y|N}

Parameters

Y: Show the CREATED, CHANGED and EXPIRE date in YYYYMMDD format.
N: Show the CREATED, CHANGED and EXPIRE date in YYYY.ddd format.

ES_JES_OUTLIM

Maximum number of lines to output to a particular dataset before calling the user exit, processing any global limits, and then cancelling the job.

Syntax

ES_JES_OUTLIM=(number[,{WARNING|CANCEL|DUMP}])

Parameters

number: Maximum number of lines of output before taking action. The range is from 1-16777215.
WARNING: Issue a warning when the specified maximum number of lines of output is reached.
CANCEL: Cancel the job when the specified maximum number of lines of output is reached.
DUMP: Cancel the job and dump the memory contents when the specified maximum number of lines of output is reached.

Properties

Default:

None

Example

ES_JES_OUTLIM=5000

A warning is issued when 5000 lines of output is exceeded.

ES_JES_OUTLIM=(1000,CANCEL)

Comments

Individual OUTLIM values can be set on each SYSOUT dataset. For example,//SYSPRINT DD SYSOUT=*,OUTLIM=500.

ES_JES_PAGES

Maximum number of pages to output in a job before taking the action specified by cancelling the job, cancelling the job and dumping memory contents, or issuing a warning message.

Syntax

ES_JES_PAGES=(number[,{WARNING|CANCEL|DUMP}])

Parameters

number: Maximum number of pages. The range is from 0-99999999.
WARNING: Issue a warning when the specified maximum number of pages is reached.
CANCEL: Cancel the job when the specified maximum number of pages is reached.
DUMP: Cancel the job and dump the memory contents when the specified maximum number of pages is reached.

Properties

Default:

None

Example

ES_JES_PAGES=10

Each page is assumed to hold 60 lines; therefore when 600 lines (60×10) have been processed, a warning is issued and the job continues.

ES_JES_PARM_INIT_LOW

Determines whether the parameter string passed to a program executed by JCL is initialized to low-values or to spaces.

Syntax

ES_JES_PARM_INIT_LOW={Y|N}

Parameters

Y: Initialize the parameter string to low-values.
N: Initialize the parameter string to spaces.

Properties

Default:

ES_JES_PARM_INIT_LOW=N

ES_JES_RESTART

Determines whether JCL restart processing is enabled.

Syntax

ES_JES_RESTART={Y|N}

Parameters

Y: Enables JCL restart processing.
N: Disables JCL restart processing.

Properties

Default:

ES_JES_RESTART=N

ES_JES_SORT_SPOOL_BY

Specifies which column is initially used to sort the spool records in casrdo41.

Syntax

ES_JES_SORT_SPOOL_BY={JOBNAME|SUBDATE|JOBUSER}

Parameters

JOBNAME: Sort by job name.
SUBDATE: Sort by sub date.
JOBUSER: Sort by job user.

Properties

Default:

None

ES_JES_SPOOL_ORDER

The order in which the spool list is displayed when you first open ESMAC.

Syntax

ES_JES_SPOOL_ORDER=value
export ES_JES_SPOOL_ORDER

Values

1 - Displays the list in descending order by JOBID. Any other value displays it in ascending order.

Default

By default the list is displayed in ascending order by JOBID.

ES_JESYSMSG_OUTPUT

The status of the system messages spool files (JESYSMSG) is set to Output, rather than Out Hold.

Syntax

ES_JESYSMSG_OUTPUT=={Y|N}
export ES_JESYSMSG_OUTPUT

Parameters

Y: All job messages will have the status as Output, but will only actually print (either physically or logically) if the MSGCLASS of the job matches one of the sysout classes defined to an active printer.
N: Messages are set to Out Hold

Properties

Default:

ES_JESYSMSG_OUTPUT=N

ES_JESYSMSG_RESTRICTED

Holds back spool files based on their class when the status of the system message spool files are set to Output.

Syntax

ES_JESYSMSG_RESTRICTED={class-name|class-number}[class-name|class-number][...]]

Parameters

class-name: The name of a class.
number: A number representing the class.

Properties

Default:

ES_JESYSMSG_RESTRICTED=N

Example

The following:

ES_JESYSMSG_RESTRICTED=ABC123

Specifies classes A, B, C, 1, 2, and 3.

Comments

All job messages have an Output status, but print either physically or logically only when the MSGCLASS of the job matches one of the sysout classes defined to an active printer.

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.

Syntax

ES_OPEN_CAT_ON_DEMAND={Y|N}

Parameters

Y: When the enterprise server region starts, no attempt is made to open the catalogs specified in MFUSERCAT_NODE. Only the system catalog is opened initially, and the other nodes are opened when required.
N: When the enterprise server region starts, all nodes are opened.

Properties

Default:

ES_OPEN_CAT_ON_DEMAND=N

Comments

When ES_OPEN_CAT_ON_DEMAND=N is set and there is a problem opening any of the nodes specified in MFUSERCAT_NODE, the JES system will not start.

ES_PL1_MFFH_JCL

Enables you to run Open PL/I programs that access JCL data definitions.

Syntax

ES_PL1_MFFH_JCL=Y|N
export ES_PL1_MFFH_JCL

Values

Y You can run Open PL/I programs that access JCL data definitions.

N Open PL/I programs cannot access JCL data definitions.

Default

The default value is N.

ES_OLD_DYN_PDS

Determines the resulting behavior of dynamic PDS members when specified in a JCL DD statement.

Values

Y Enables previous default behavior of cataloging and creating the physical files for dynamic PDS when referenced in a JCL DD statement.

N Physical files for dynamic PDS members are only created and cataloged when created using the JCL utility or by a user program.

Default

The default value is N.

ES_PROG_PATH

Determines whether to display the program's load path in the JESYSMSG and SYSLOG datasets.

Note: Applies to native enterprise server regions only.

Syntax

ES_PROG_PATH={Y|N}

Parameters

Y: Display the program's load path in the JESYSMSG and SYSLOG datasets.
N: Do not display the program's load path in the JESYSMSG and SYSLOG datasets.

Properties

Default:

None

ES_SAM_ESDS

Under VSE and when opening the OUTPUT of a reusable ESDS file, determines whether the file is reset when the DISP is not specified in the DLBL statement.

Syntax

ES_SAM_ESDS={Y|N}

Parameters

Y: File is reset.
N: File is not reset.

Properties

Default:

None

ES_SSTM_CICS

Location of the JCL used to initialize the SSTM CICS environment.

Syntax

ES_SSTM_CICS=file-location

Parameters

file-location: The full path to the location of the JCL used to initialize the SSTM CICS environment.

Properties

Default:

None

ES_SSTM_IMS

Location of the JCL used to initialize the SSTM IMS environment.

Syntax

ES_SSTM_IMS=file-location

Parameters

file-location: The full path to the location of the JCL used to initialize the SSTM IMS environment.

Properties

Default:

None

ES_SSTM_JOB_FLUSH_ACTIVE

Determines whether a CICS SSTM job is removed from the Active queue when the region shuts down.

Syntax

ES_SSTM_JOB_FLUSH_ACTIVE =file-location

Parameters

Y: Remove the CICS SSTM job from the Active queue.
N: Do not remove the CICS SSTM job from the Active queue.

Properties

Default:

ES_SSTM_JOB_FLUSH_ACTIVE=N

ES_SYSOUT_HOLD

Determines whether the status of the SYSOUT files are set to Out Hold.

Syntax

ES_SYSOUT_HOLD={Y|N}

Parameters

Y: The status of the SYSOUT files are set to Out Hold.
N: The status of the SYSOUT files are not set to Out Hold.

Properties

Default:

None

ES_USR_DFLT_JES

Allows you to override the default user when no user is logged on for JES authentication.

Syntax

ES_USR_DFLT_JES=user
export ES_USR_DFLT_JES

Values

user The deafult user name.

Default

JESUSER

Note: Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

JES_PRINT_SPOOL_MSG

Specifies the disposition of the spool data set printing message (JES000029I).

Note: This environment variable is intended for high print load users, where print messages to the console impact system performance.

Syntax

JES_PRINT_SPOOL_MSG={CONSOLE|LOG|SILENT}

Parameters

CONSOLE: The console.log file.
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.

Properties

Default:

JES_PRINT_SPOOL_MSG=CONSOLE

GDG_RESTART_UCC11_ONLY

Determines when GDG restart information should be written.

Syntax

SET GDG_RESTART_UCC11_ONLY={Y|N}
export GDG_RESTART_UCC11_ONLY

Parameters

Y: GDG restart information is written, but only when ES_JES_RESTART=Y and MF_UCC11 is set (Y, YA, or M).
N: GDG restart information is written even if MF_UCC11=N or is not set. (ES_JES_RESTART=Y must still be set.)

Properties

Default:

SET GDG_RESTART_UCC11_ONLY=Y

JCLTEMP_DIR [6]

Enables you to specify a separate location for the JCLTEMP directory.

Syntax

JCLTEMP_DIR=path

Parameter

path: The full or relative path to the location of your JCLTEMP directory.

Default

Not set. Uses the directory specified by MFBSI_DIR.

MF_ALIAS

Specifies program aliases.

Note: You can alias any program other than IEFBR14, which is always processed as IEFBR14.

Syntax

MF_ALIAS=program-name1 alias1 [program-name2 alias2]...[program-name10 alias10]

Parameters

program-name1...10: An eight-character program name.
Important: A program name shorter than eight characters must have trailing spaces extending its length to eight characters.
alias1...10: An eight-character alias.
Important: An alias shorter than eight characters must have trailing spaces extending its length to eight characters.

Comments

Each program-name/alias pair is 16 characters long — eight characters for the program-name, and eight characters for the alias. You can specify up to 10 pairs.

program-name/alias pairs are searched first in the order in which they appear and thus can potentially override the built-in list. If not found, the built-in alias table is searched.

Example

MF_ALIAS=IKJEFT1BIDAEFT01MYPROG  THEIRPRG

adds:

Program-name	Alias
IKJEFT1B	IDAEFT01
MYPROG	THEIRPRG

MF_CHARSET

Specifies which character set an enterprise server is to use.

Syntax

MF_CHARSET={[A|ASCII]|[E|EBCDIC]}

Parameters

A|ASCII: Use the ASCII character set.
E|EBCDIC: Use the EBCDIC character set.

Properties

Default:

MF_CHARSET= ASCII

MF_DUPJOBS

Specifies whether jobs with duplicate names are allowed to run in parallel.

Syntax

MF_DUPJOBS={Y|N}

Parameters

Y: Jobs with duplicate names are allowed to run in parallel.
N: Jobs with duplicate names are not allowed to run in parallel.

Properties

Default:

MF_DUPJOBS=N

MF_FALLTHRUCHECK

Specifies whether MSS is to check that the main COBOL program ends by executing a GOBACK or STOP RUN.

Syntax

MF_FALLTHRUCHECK={Y|N}

Parameters

Y: Check that the main COBOL program ends by executing a GOBACK or STOP RUN.
Y: Do not check that the main COBOL program ends by executing a GOBACK or STOP RUN.

Properties

Default:

MF_FALLTHRUCHECK=Y

Comments

If MF_FALLTHRUCHECK is set to Y and the check fails, MSS issues this message:

JCLCM0213S Main pgm xxxxxxxx did not issue GOBACK or STOP RUN.

MF_IKJEFT_KEEP_MAX

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_JCL_AUDIT

Syntax

MF_JCL_AUDIT={DLET|DLEJ|DLET,DLEJ}

Parameters

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.

Properties

Default:

None

Comments

The information recorded in the log is:

The user who deleted the catalog entry
The group to which the user belongs
Whether the catalog entry was deleted by an ESMAC user or a JCL job step
The name of the deleted catalog entry
Whether the standard delete operation or the JCL delete operation was performed

Example

The following is an example of the audit event passed to SYSLOG:

mf.jcl 35500 5:5 [timeQuality tzKnown="1" isSynced="0"][origin ip="127.0.0.1" enterpriseID="********.5043" 
software="Micro Focus Auditing" swVersion="API ver 1.2.2 syslog ver 1.0.0"][meta 
sequenceId="88"][MFAuditPropertyList@5043 SYSTEM="AUDIT   "] userid=SYSAD    groupid=SYSADM 
  jobnum=0000000 jobname=ESMAC    dsname=MFI01.ANF.TEST1                         
     member=         api=MVSCATIO apifunc=DLET

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.

Syntax

MF_JES_ABEND_CAF_COMMIT=value
export MF_JES_ABEND_CAF_COMMIT

Value

value can be one of:

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.

Default

Yes.

MF_JESPWR_EXIT

MF_JESPWR_EXIT is used to pass JES2 and VSE PWR statements to a 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.

Syntax

MF_JESPWR_EXIT=Y

MF_LEX_API [7]

Specifies whether the JES configuration uses single or multiple LEX files, and enables JES configuration to specify subdirectories for LEX files as necessary.

Syntax

MF_LEX_API={1|2|D}|1D|2D

Parameters

1: Use multiple LEX files.
2: Use a single LEX file. Disk-based access only.
D: Use directories to store LEX files.

Default

MF_LEX_API=1

Comments

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.

Syntax

MF_MFA={ALL|RJSE}

Parameters

ALL: Search for data sets first in the local catalog, and if not found, on the mainframe.
RJSE: Search for data sets in the local catalog only. No mainframe search is performed.

Properties

Default:

MF_MFA= ALL

MF_MVSJOB

Sets the number at which a job starts and finishes.

Syntax

MF_MVSJOB=lower value{-|+}upper value

Parameters

lower value: Number at which a job starts. Contains seven digits - for example, 0000001.
+: Reset the values to these new ones each time the region is started.
-: Sets the values but only on the first startup of the region.
upper value: Upper job number. Contains seven digits - for example, 9999999.

Properties

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

Comments

This environment variable can be used to enable a seven-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 five-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.

Example

set MF_MVSJOB=0000010+0000100

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.

MF_MVSP0034_LIMIT

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

Syntax

MF_MVSP0034_LIMIT=limit

Parameter

limit: A one- to six-digit number between 1 and 999999.

Properties

Default:	None*
* 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.

Syntax

MF_NODD={A|R}

Parameters

A: Abend the program
R: Return the file status 3/5.

Properties

Default:

MF_NODD=A

MF_PCRENAME_LAX

Determines whether physical files in other locations can be renamed if the cataloged name is changed.

Syntax

MF_PCRENAME_LAX={Y|N|D}

Parameters

Y: Enables physical files in other locations to be renamed if the cataloged name is changed.
N: When an MVS dataset is renamed, the associated physical file is normally renamed only if it is stored in a subdirectory of the of the catalog file location.
D: Creates a new directory structure and filename, and moves the existing file to the new location.

Properties

Default:

MF_PCRENAME_LAX=N

MF_RCCF

Determines whether to enable or disable Job Step Execution (RJSE).

Syntax

MF_RCCF={DELETEJOB|KEEPJOB}

Parameters

DELETEJOB: Disables RJSE.
KEEPJOB: Enables RJSE.

Properties

Default:

MF_RCCF=DELETEJOB

MF_SMS

Enables support for IBM Storage Management Subsystem (SMS) data classes.

Syntax

MF_SMS={ON|OFF}

Parameters

ON: Turns on support for SMS data classes.
OFF: Turns off support for SMS data classes.

Properties

Default:

MF_SMS=OFF

Comments

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_SPOOL_HK_TESTDATE

Overrides the normal date for the spool housekeeping.

Syntax

MF_SPOOL_HK_TESTDATEC=YYYYMMDD
export MF_SPOOL_HK_TESTDATEC

Values

YYYYMMDD The date which is to override the normal date.

Default

If this variable is not set, the normal date for the spool housekeeping is used.

MF_UCC11

Configures emulation of UCC11, which is the JCL job restart functionality.

Syntax

MF_UCC11={Y|YA|M|MA|MR|N}

Parameters

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 might cause an error when restarting the job if the data set already exists.

Properties

Default:

MF_UCC11=N

MF_UCC11_DYNCLEAN

When MF_UCC11 is enabled, controls whether dynamically allocated datasets (such as using SVC99) are cleaned when a job is restarted.

Syntax

MF_UCC11_DYNCLEAN={Y|N}

Parameters

Y: When a job is restarted, any dynamically allocated datasets are removed and replaced.
N: Prevents the cleaning of dynamically allocated datasets when restarting a job.

Properties

Default:

MF_UCC11_DYNCLEAN=Y

Dependencies

Valid only when MF_UCC11=Y or YA.

MF_USESCA7

Determines whether MSS accepts CA7 Scheduler control statements as comments rather than diagnosing them as errors.

Syntax

MF_USESCA7={ON|OFF}

Parameters

ON: Accepts CA7 Scheduler control statements as comments.
OFF: Diagnoses CA7 Scheduler control statements as errors.

Properties

Default:

MF_USESCA7=ON

MFALLOC_DEF_VB_PCFILE

Determines whether a new PSVB file is defined in the catalog.

Syntax

MFALLOC_DEF_VB_PCFILE={Y|N}

Parameters

Y: A new PS VB file is defined in the catalog as a VB file with default settings of minimum length = 0, and maximum length = 32760.
N: Do not create a new PS VB file.

Properties

Default:

MFALLOC_DEF_VB_PCFILE=Y

Dependencies

Valid only when LRECL is not set or is set to 0 (zero).

MFALLOC_PCFILE

Determines whether a catalogued file is created when DSORG=PS is provided in the DCB parameters.

Syntax

MFALLOC_PCFILE={Y|N}

Parameters

Y: A catalogued file is created when DSORG=PS is provided in the DCB parameters.
N: A catalogued file is not created.

Properties

Default:

MFALLOC_PCFILE=Y

Dependencies

Valid only when DSORG=PS is provided in the DCB parameters.

MFCATMNTUE

Specifies the name of the MFCATMNT user exit program if not compiled to the default name of MFCATMNTUE.

Syntax

MFCATMNTUE=program-name
export MFCATMNTUE

Values

program-name represents the name of the MFCATMNT user exit program if not compiled to the default name of MFCATMNTUE.

Default

MFCATMNTUE=MFCATMNTUE

MFJ_ALL_STEP_CHECK

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

Syntax

MFJ_ALL_STEP_CHECK={Y|N}

Parameters

Y: Do not run any steps after a restart step that have conditions that refer to any steps prior to the restart.
Y: Run the steps listed after a restart step that have conditions that refer to steps prior to the restart.

Properties

Default:

MFJ_ALL_STEP_CHECK=N

Comments

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. This is a change of behavior from releases 4.0 Patch Update 1 and earlier when these steps would have not 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.

The setting of MFJ_ALL_STEP_CHECK is bypassed if the Abend and Cond Code Recover option of the Advanced Restart Functionality is used.

MFJ_INPUTDS_ERROR

Determines whether IEBDG, IEBGENER, IEBCOMPR, and DFSORT, and ICETOOL emulation treat missing input files as though they were present but empty.

Syntax

MFJ_INPUTDS_ERROR={Y|N}

Parameters

Y: Treats missing input files as missing.
N: Causes IEBDG, IEBGENER, IEBCOMPR, and DFSORT, and ICETOOL emulation to treat missing input files as though they were present but empty.

Properties

Default:

MFJ_INPUTDS_ERROR=Y

MFJ_LEX_LOCATION

Specifies an alternative location for the storage of JCL lexigraphical files, which are created when a job is parsed, and are stored in the same directory as the job log by default.

Syntax

MFJ_LEX_LOCATION=path

Parameter

path: The full path to the alternative directory location in which to store JCL lexigraphical files. The alternative directory location must be accessible by all enterprise server regions that both submit and run jobs.

Properties

Default:

None

MFJ_PTPCH_CODESET

Causes MFJPTPCH to check the same hexadecimal character value as with Japanese code set 9122 to decide whether a character is printable or not.

Syntax

MFJ_PTPCH_CODESET=EXTJ

Parameter

EXTJ: MFJPTPCH checks the same hexadecimal character value as with Japanese code set 9122 to decide whether a character is printable or not.

Properties

Default:

None

Dependencies

For use only when an extended Japanese code set other than 9122 is being used.

MFJ_REPRO_EMPTY

Determines whether the IDCAMS REPRO action can copy from a pristine VSAM file.

Syntax

MFJ_REPRO_EMPTY={Y|N}

Parameters

Y: Enables the IDCAMS REPRO action to copy from a pristine VSAM file. The resulting file is empty.
N: Prevents the IDCAMS REPRO action from copying from a pristine VSAM file, and produces a JCLAM0150S error when attempted.

Properties

Default:

MFJ_REPRO_EMPTY=Y

MFJ_STRICT_CASE

Determines the case to be maintained for physical file names passed to MVSCATIO by the catalog API (and other utilities such as MFCATXML and MVSPCRN).

Syntax

SET MFJ_STRICT_CASE=Y|N
export MFJ_STRICT_CASE

Parameters

Y: MVSCATIO honors the case of physical file names passed by the catalog API, and other utilities such as MFCATXML and MVSPCRN.
N: All physical file names are folded into upper case.

Properties

Default:

MFJ_STRICT_CASE=N

MFJFAXIT

Specifies the user exit program that enables file action notifications.

Syntax

MFJFAXIT=path-and-file-name

Parameter

path-and-file-name: The full path and filename for the user exit program that enables file action notifications.

Properties

Default:

None

Comments

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.

Example

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.

MFJSENGINE

Specifies which sort engine the utility MFJSORT is to emulate.

Syntax

MFJSENGINE={DFSORT|SYNCSORT}

Parameters

DFSORT: MFJFSORT emulates the DSORT utility.
SYNCSORT: MFJFSORT emulates the SYNCSORT utility.

Properties

Default:

MFJSENGINE=DFSORT

MFREXX_CHARSET

Specifies the character set used by the REXX engine when working with hexadecimal strings or performing string comparisons.

Syntax

MFREXX_CHARSET={A|E}

Parameters

A: Use the ASCII character set.
E: Use the EBCDIC character set.

Properties

Default:

MFREXX_CONCAT

Specifies one or more characters to be used for the CONCAT operator in addition to REXX's default, which is "||".

Syntax

MFREXX_CONCAT=char-spec

Parameter

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.

Properties

Default:

"||"

Comments

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.

Syntax

MFREXX_LSEQ_RECSIZE_MAX=rec-length

Parameter

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 being used.

Properties

Default:

255

MFREXX_NO_PROCESS_STDIN

Determines whether to stop STDIN from being processed on an EXECIO command.

Syntax

MFREXX_NO_PROCESS_STDIN={Y|N}

Parameters

Y: Stops STDIN from being processed on an EXECIO command.
N: STDIN is processed on an EXECIO command.

Properties

Default:

MFREXX_NO_PROCESS_STDIN=N

MFREXX_NOT

Specifies one or more characters to be used for the NOT operator in addition to REXX's default, which is "¬".

Syntax

MFREXX_NOT=char-spec

Parameter

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.

Properties

Default:

"¬"

Comments

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

Specifies one or more characters to be used for the OR operator in addition to REXX's default, which is "|".

Syntax

MFREXX_OR=char-spec

Parameter

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.

Properties

Default:

"|"

Comments

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 and file name of the JES system catalog.

Syntax

export MFSYSCAT={path/CATALOG.DAT | URL}

Parameters

path: The full path to the location of the CATALOG.DAT file.
URL: For a database-hosted system catalog, the full SQL URL that points to the CATALOG.DAT file.

Properties

Default:

None

Comments

See the data category in The dbfhdeploy Command Line Utility for full notation details if specifying a database-hosted system catalog.

Examples

export MFSYSCAT=/MY/CATALOG/FOLDER/CATALOG.DAT

export MFSYSCAT=sql://localhost/JCLTEST/catalog.dat?folder=/JCLDEMO

MFUSERCAT_BASE_LOC

If an entry in MFUSERCAT_LOC only specifies the file name of the user catalog rather than the full path and file name, use this environment variable to specify where these catalogs are located.

Syntax

MFUSERCAT_BASE_LOC=path-and-file-name

Parameter

path: The full path to the file specified by the MFUSERCAT_LOC environment variable.

Properties

Default:

None

Dependency

Valid only when the value of MFUSERCAT_LOC is a file name only.

Comments

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

Specifies the location and name of each additional catalog, matching the values provided in the MFUSERCAT_NODE value.

Syntax

MFUSERCAT_LOC=[path]file-name[;[path]file-name]][...]

Parameter

path: The full path to a file catalog file.
file-name: The name of the catalog file.

Properties

Default:

None

Comments

Parameters are limited to a total of 4096 characters.

If multiple catalog files are in the same location, you can use the environment variable MFUSERCAT_LOC to store that location. If you do this, you only need to specify the file name of each catalog file in MFUSERCAT_LOC.

MFUSERCAT_NODE

Specifies additional SMS, SPOOL, and User catalogs.

Syntax

MFUSERCAT_NODE=node-name[,node-name][...]

Parameter

node-name: A user catalog or special node name.

Properties

Default:

None

Comments

Use this variable to specify additional SMS, SPOOL and User catalogs. Up to 64 additional catalogs may be specified with semi-colon separated values (see Multiple Catalog Support for more details). The physical file used for each catalog is stored in the environment variable MFUSERCAT_LOC.

Each node can include wildcards. You can use * (for any number of characters) or ? (for a single character) in a node specification. You can also use the UNIX-style square bracket notation (part of the regular expression feature), where you specify a list of permissible characters at a particular point within the node specification; see Examples of Using Multiple Catalogs for more information.

To enable support for the SMS entities DATACLAS and MGMTCLAS, this variable needs to be set in addition to setting MF_SMS=ON.

Each node-name entry in MFUSERCAT_NODE must have a corresponding entry in MFUSERCAT_LOC.

Use the ES_OPEN_CAT_ON_DEMAND variable to determine if these catalogs are opened when the region starts, or only opened when they are required.

SPOOL_TIMEOUT

Enables greater control over record-lock retries by setting timeout and interval durations.

Syntax

SPOOL_TIMEOUT=timeout:interval

Parameters

timeout: The amount of time in milliseconds to continue to retry the lock before ceasing the attempt.
interval: The amount of time in milliseconds before initiating a new lock retry attempt.

Properties

Default:

SPOOL_TIMEOUT=500:100

Comments

Set this environment variable to resolve reported record-locked messages, which, depending on hardware performance, can occur especially during shutdown of an enterprise server instance with an SSTM job.

SSTM_WC_REFRESH

Determines how often the write count for the SSTM job is updated in SYSOUT or SYSPRINT.

Syntax

SSTM_WC_REFRESH={0|value}

Parameter

0: The count is only updated when the file is closed.
value: A value between 1-65535 to indicate the number of writes at which the count is updated

Properties

Default:

None

Comments

Any provided value outside of 0-65535 defaults to 65535.

VSE_STARTUP_CFG

The location of the VSE JCL configuration file.

Syntax

VSE_STARTUP_CFG=config-file

Parameter

config-file: The fully-qualified location and name of the configuration file to use.

Properties

Default:

None