Environment variables in alphabetical order

Tip: For information about how and where to set environment variables for Enterprise Server, see Setting Environment Variables, To set environment variables from ESCWA, and To set environment variables from the command line.
A B C D E F G H I J K L M
N O P Q R S T U V W X Y Z

A

AUTOCAT_IMP

Name of an input file name for automated catalog import using MFA Data Access Services.
AUTOCAT_IMP=[path-name/]file-name}
Parameters
path-name
The full path to the location of the automatic catalog file name.
file-name
The name of the automated catalog import file.
Default
Not set.

C

CAS_SRV_CANCEL

Determines the cancel regime for service modules loaded by a SEP: the regime affects the request handler upon completion of the service module invocation.
Syntax
CAS_SRV_CANCEL={P|L|N|D}
Parameters
P
Physical cancel.
L
Logical cancel.
N
No cancel.
D
Deferred cancel.
Default
CAS_SRV_CANCEL=P
Comments
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.
Example
CAS_SRV_CANCEL=L

CASRDO44_NEWSUB

Enables access to JCL files held on the local machine on which the browser is running, and prevents submitting local JCL through ESCWA or ESMAC.
Syntax
CASRDO44_NEWSUB={ON|OFF}
Parameters
ON
Access JCL files on the local machine on which the browser is running.
OFF
Access JCL files from the machine running the enterprise server.
Default
CASRDO44_NEWSUB=ON
Comments
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.

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.
Syntax
CASSPOOL_LOCK_RETRY_COUNT=retry-count
Parameter
retry-count
The number of retries made to obtain a record lock.
Default
CASSPOOL_LOCK_RETRY_COUNT=20

CCIERRLOG

Specifies the location of and filename for CCI error log output.
Syntax
CCIERRLOG=path-name/file-name}
Parameters
path-name
The full path to the output location.
file-name
The name of the output file.
Default
Not set. The default path is the working directory of the application calling CCI, and the default filename is ccierr.log.
Comments
The CCI error log tracks first-instance errors reported from the operating systems. CCIERRLOG overrides any entries found in CCI.INI, where the syntax and content is explained in detail. See CCI.INI - The CCI Configuration File for more information.

CCITCP2

Sets the TCP address of the machine running the MFDS (formerly CCITCP2) registration daemon.
Syntax
CCITCP2=host-name
Parameter
host-name
The TCP host name, IPv4 address, or IPv6 address of the machine running the MFDS daemon you want to contact from the session.
Default
Not set. The local system is used.
Comments
Use this environment variable to set the TCP address of the machine running the MFDS registration daemon, which holds the registration of the service you are contacting, or will hold the registration of the service you are starting.

CCITCP2_PORT

Sets the port used for the MFDS registration process.
Syntax
CCITCP2_PORT=port-number
Parameter
port-number
The number of the port on which the MFDS service is listening.
Default
Not set. Uses the port specified by the mfcobol service name in /etc/services. If not found there, uses the official Micro Focus directory port, which is 86.

CCITCPS_service-name

Associates the name of a service being registered with a different service name, one or more ports, and/or one or more network interfaces.
Syntax
CCITCPS_old-service-name=[new-service-name],
   {MFNODE:node-name | MFPORT:port-number | 
    MFNODE:node-name, MFPORT:port-number}
Parameters
old-service-name
The name of the CCI server. On UNIX platforms, this must be in upper case.
new-service-name
The new name to use for the CCI server. If omitted, the old-service-name is used.
node-name
The host name or IP address on which to listen for connections.
port-number
The TCP port on which to listen for connections.
Default
Not set. A port is assigned by the operating system, and the server listens on all available network interfaces.
Comments
CCITCPS is set in the environment of a CCI server process, and changes how it listens for connections and how its service name is registered.
Example
CCITCPS_MYSERVICE=,MFPORT:3000

CCITCPT_service-name

Specifies the host, and/or port for a client to use when connecting to a service.
Syntax
CCITCPT_serice-name=[unused], MFNODE:node-name, MFPORT:port-number
Parameters
service-name
The name of the CCI service to which the client is to connect. On UNIX platforms, this must be in upper case.
unused
The parameter before the comma is not used with CCITCPT, but supported for consistency with CCITCPS.
node-name
The host name or IP address to connect.
port-number
The TCP port to connect.
Default
Not set. The client attempts to look the service up in the MFDS directory.
Comments
Use this environment variable to instruct a CCI client to connect directly to the specified host and port rather than querying MFDS for the location of the named service.
Example
CCITCPT_MYSERVICE=,MFNODE:localhst.MFPORT:3000

CCITIMEOUT

Sets a maximum time-out period used with non-data connect applications.
Syntax
CCITIMEOUT=wait-time
Parameter
wait-time
The number of seconds to wait before timing out times 10, up to a maximum value of 2,147,483,647.
Default
CCITIMEOUT=1200

(2 minutes)

Comments
Use this variable with non-data connect applications such as Drag and Drop, SourceConnect, and the Monitor.
Example
This example sets the wait time to 4 minutes:
CCITIMEOUT=2400 

CCITRACE

Specifies the type of information to record using CCI tracing.
Syntax
CCITRACE={/|-}{F|P|D}[...]
Parameters
/
Turns on the specified option.
-
Turns off the specified option.
F
Logs the details of CCI API calls to CTF. This option is implied when either P or D is specified. You can override this using -F.
P
When turned on, logs the details of protocol-level calls to CTF, which could greatly increase function tracing. When not set, only the details of the CCI user-level API are traced.
D
Logs the contents of all buffers passed to and from the CCI functions.
Warning: Setting this option might not produce the desired results if the application has been coded to prohibit data tracing.
Default
Not set. CCI tracing is controlled via the ctf.cfg and CCI.INI trace options.
Comments
The ctf.cfg and the CCI.INI file ([ccitrace_base] section) can also be used to control trace options, but any values specified by the CCITRACE environment variable take precedence. For details, see Tracing Options for CTF.CFG and CCI.INI - The CCI Configuration File.
Example
CCITRACE=/F/D

CICS_SIT

The name of the SIT used by the enterprise server region.
Syntax
CICS_SIT=sit-name
Parameter
sit-name
The name of the CICS SIT to use for the enterprise server region.
Default
Not set. The CICS SIT specified in ESCWA is used.

CCITCPS_service-name

Associates the name of a service being registered with a different service name, one or more ports, and/or one or more network interfaces.
Syntax
CCITCPS_old-service-name=[new-service-name],
   {MFNODE:node-name | MFPORT:port-number | 
    MFNODE:node-name, MFPORT:port-number}
Parameters
old-service-name
The name of the CCI server. On UNIX platforms, this must be in upper case.
new-service-name
The new name to use for the CCI server. If omitted, the old-service-name is used.
node-name
The host name or IP address on which to listen for connections.
port-number
The TCP port on which to listen for connections.
Default
Not set. A port is assigned by the operating system, and the server listens on all available network interfaces.
Comments
CCITCPS is set in the environment of a CCI server process, and changes how it listens for connections and how its service name is registered.
Example
CCITCPS_MYSERVICE=,MFPORT:3000

COB_LIVE_RECORD

Specifies the path and/or filename prefix for the live recording (.mfr) file created by the Live Recorder feature.
Syntax
COB_LIVE_RECORD=[path-name/]file-prefix
Parameters
path-name
The full path to the location of the .mfr file.
file-prefix
The name of the file prefix, consisting of all characters before the dot (.) and file extension.
Default
The default path is the output directory defined in your COBOL properties. No default file prefix is provided.
Comments
The live recording file must be replayed on the same operating system as it was created.

Animator can update the information file to record information held between sessions.

COB_LIVE_RECORD_SIZE

Specifies the amount of memory that can be used to store events written to the live recording file.
Syntax
COB_LIVE_RECORD_SIZE=mem-size
Parameter
mem-size
The amount of memory in megabytes (MB) to allocate for events written to the recording file. The range of valid values starts at 67, and extends to a value dependant on your available memory, bitism, etc.
Note: This is not the actual size of the live recording file that is stored on disk, as the event log is compressed when writing to the file.
Default
COB_LIVE_RECORD_SIZE=268
Comments
Setting COB_LIVE_RECORD_SIZE could improve performance during recording.

When the limit is reached, the buffer is cycled so that the oldest events are removed to make space for the most recent events.

An adequate range for 32-bit systems is between 500 and 1000.

You might need to experiment to determine the most optimal setting

Example
COB_LIVE_RECORD_SIZE=756

COBAIF

Specifies the directory path that Animator is to search for the session (.aif) file for the program being animated, if it is not found in the same directory as the information (.idy) file.
Syntax
COBAIF=path-name[:path-name[...]]
Parameter
path-name
The name of a path in which to search for .aif files.
Default
Not set. Enterprise Server searches for the .aif file in the directory or directories specified by the COBIDY environment variable, if set, and if COBIDY is not set or the .aif file is not found, searches the current directory. If still not found, Enterprise Server creates the .aif file in the first directory specified by the COBIDY environment variable, when set. If COBIDY is not set, then Enterprise Server creates the .aif file in the current directory.
Comments
When COBAIF is set, the search sequence is first - the directory or directories specified by COBAIF; second - the directory or directories specified by COBIDY; and third - the current directory. Enterprise Server uses the first .aif found. If not found, Enterprise Server creates an .aif file in the first directory specified by COBAIF.

Animator can update the session file to record information held between sessions.

The .aif file contains details of breakpoints and monitors.

COBAIFNAME

Specifies the base name of the Animator session file (.aif) for the program being animated.
Syntax
COBAIFNAME=base-name
Parameter
base-name
The base name of the .aif files.
Default
Not set.
Comments
You need to specify this environment variable if you are starting Animator using COBSW=+A and you want to save breakpoints for subsequent animation sessions. You can also specify it if you are starting Animator using the command anim; in this case the base name you specify overrides the application name as the basename of the .aif file.

The .aif file contains details of breakpoints and monitors.

COBANIMOPT

Specifies additional directives to be used by Character Animator.
Syntax
COBANIMOPT=directive-name[:directive-name[...]]
Parameter
directive-name
A directive to use with Character Animator. Must not be a file name.
Default
Not set. Character Animator runs with directives specified on the command line only.
Comments
When you invoke Character Animator, it first reads the directives you have specified in COBANIMOPT and then uses any directives you specify on the command line, with the possibility that command-line directives override directives specified by COBANIMOPT.
Example
COBANIMOPT=MIXEDLANGDEBUG:MULTITHREAD

COBANIMSRV

Attaches Character Animator to a running COBOL program.
Syntax
COBANIMSRV=prog-id
Parameter
prog-id
An identifier used to identify the program to which Character Animator attaches.
Default
Not set.
Comments
This environment variable is particularly useful for starting cross-session debugging.
Example
In one console session:
export COBANIMSRV=myid

myid is now a unique identifier that you can use to match Character Animator to a program. Type the command to start Character Animator:

cobanimsrv

The Character Animator waits for a COBOL program to start that has a matching identifier. In another console session:

export COBANIMSRV=myid
cobrun prog1.int

When prog1.int starts, the unique identifier myid matches that of Character Animator; therefore, Character Animator attaches to this process. In console session 1, the Character Animator main screen is displayed and the cursor placed on the first line of prog1.int.

COB_LIVE_RECORD_SIZE

Specifies the amount of memory that can be used to store events written to the live recording file.
Syntax
COB_LIVE_RECORD_SIZE=mem-size
Parameter
mem-size
The amount of memory in megabytes (MB) to allocate for events written to the recording file. The range of valid values starts at 67, and extends to a value dependant on your available memory, bitism, etc.
Note: This is not the actual size of the live recording file that is stored on disk, as the event log is compressed when writing to the file.
Default
COB_LIVE_RECORD_SIZE=268
Comments
Setting COB_LIVE_RECORD_SIZE could improve performance during recording.

When the limit is reached, the buffer is cycled so that the oldest events are removed to make space for the most recent events.

An adequate range for 32-bit systems is between 500 and 1000.

You might need to experiment to determine the most optimal setting

Example
COB_LIVE_RECORD_SIZE=756

COBAIFNAME

Specifies the base name of the Animator session file (.aif) for the program being animated.
Syntax
COBAIFNAME=base-name
Parameter
base-name
The base name of the .aif files.
Default
Not set.
Comments
You need to specify this environment variable if you are starting Animator using COBSW=+A and you want to save breakpoints for subsequent animation sessions. You can also specify it if you are starting Animator using the command anim; in this case the base name you specify overrides the application name as the basename of the .aif file.

The .aif file contains details of breakpoints and monitors.

COBANIMOPT

Specifies additional directives to be used by Character Animator.
Syntax
COBANIMOPT=directive-name[:directive-name[...]]
Parameter
directive-name
A directive to use with Character Animator. Must not be a file name.
Default
Not set. Character Animator runs with directives specified on the command line only.
Comments
When you invoke Character Animator, it first reads the directives you have specified in COBANIMOPT and then uses any directives you specify on the command line, with the possibility that command-line directives override directives specified by COBANIMOPT.
Example
COBANIMOPT=MIXEDLANGDEBUG:MULTITHREAD

COBAIF

Specifies the directory path that Animator is to search for the session (.aif) file for the program being animated, if it is not found in the same directory as the information (.idy) file.
Syntax
COBAIF=path-name[:path-name[...]]
Parameter
path-name
The name of a path in which to search for .aif files.
Default
Not set. Enterprise Server searches for the .aif file in the directory or directories specified by the COBIDY environment variable, if set, and if COBIDY is not set or the .aif file is not found, searches the current directory. If still not found, Enterprise Server creates the .aif file in the first directory specified by the COBIDY environment variable, when set. If COBIDY is not set, then Enterprise Server creates the .aif file in the current directory.
Comments
When COBAIF is set, the search sequence is first - the directory or directories specified by COBAIF; second - the directory or directories specified by COBIDY; and third - the current directory. Enterprise Server uses the first .aif found. If not found, Enterprise Server creates an .aif file in the first directory specified by COBAIF.

Animator can update the session file to record information held between sessions.

The .aif file contains details of breakpoints and monitors.

COBANIMSRV

Attaches Character Animator to a running COBOL program.
Syntax
COBANIMSRV=prog-id
Parameter
prog-id
An identifier used to identify the program to which Character Animator attaches.
Default
Not set.
Comments
This environment variable is particularly useful for starting cross-session debugging.
Example
In one console session:
export COBANIMSRV=myid

myid is now a unique identifier that you can use to match Character Animator to a program. Type the command to start Character Animator:

cobanimsrv

The Character Animator waits for a COBOL program to start that has a matching identifier. In another console session:

export COBANIMSRV=myid
cobrun prog1.int

When prog1.int starts, the unique identifier myid matches that of Character Animator; therefore, Character Animator attaches to this process. In console session 1, the Character Animator main screen is displayed and the cursor placed on the first line of prog1.int.

COBATTR

Specifies non-standard behavior for HIGHLIGHT and LOWLIGHT clauses used with ACCEPT and DISPLAY statements, providing compatibility with earlier COBOL products.
CAUTION:
Avoid using COBATTR when possible as support is likely to be discontinued at some future date.
Syntax
COBATTR={0|1|2|3|4|5|6|7}
Parameters
0
Provides standard, default behavior.
1
When a COBOL program displays text subject to a HIGHLIGHT clause, the run-time system uses the bold mode. The run-time system uses the default mode for normal text. Specifying dim mode in the terminfo entry for the terminal has no affect. The LOWLIGHT clause has no effect.
2
High and low intensity space characters are not assumed to be the same as normal mode space characters.
3
Behavior is a combination of parameters 1 and 2.
4
Provides compatibility with default behavior of products before COBOL version 3.2.
5
Behavior is a combination of parameters 4 and 1.
6
Behavior is a combination of parameters 4 and 2.
7
Behavior is a combination of parameters 1, 2, and 4.
Default
COBATTR=0
Comments
When a COBOL program displays text subject to a HIGHLIGHT clause, the effect depends on whether the dim mode is specified in the terminfo entry for the terminal. If dim mode is specified, then the run-time system uses the default mode for highlighted text and the dim mode for normal text. If the dim mode is not specified, then the run-time system uses the bold mode for highlighted text and default mode for normal text. The LOWLIGHT clause has no effect, giving the same appearance as normal text.
Example
COBATTR=1

COBCCSIDDIR

Specifies the location where the translation tables are installed for a deployed application that uses CCSID translation tables.
Syntax
COBCCSIDDIR=base-dir
Parameter
base-dir
The base directory containing sub-directories for each translation table.
Default
Not set. CCSID tables are installed by default in the $COBDIR directory.

COBCONFIG

Specifies a run-time configuration file that tailors run-time configurable options in some way.
Syntax
COBCONFIG=path-name
Parameter
path-name
The directory that contains the COBOL configuration file, which tailors the run-time system.
Default
Not set. Enterprise Server searches for the file in $COBDIR/etc/cobconfig.
Example
COBCONFIG=/home/mydir/cobconfig

COBCONFIGJVM

Specifies a Java properties file that tailors the run-time configurable options for Java Virtual Machine applications.
Syntax
COBCONFIGJVM=path-name
Parameter
path-name
The location of a Java properties file.
Default
Not set.
Comments
Use this instead of COBCONFIG in COBOL applications intended for use on a Java Virtual Machine.

COBCONFIG.BLOCK

The location of the application configuration file.
Syntax
COBCONFIG.BLOCK=path
Parameter
path
The full path to the location of the application configuration file.
Default
Not set.

COBCPY

Specifies the directory or directories that the Compiler and Animator should search for copybook files.
Syntax
COBCPY=path-name[[:path-name][...]]
Parameter
path-name
The full path to a directory that the Compiler and Animator are to search when looking for copybook files. When more than one path-name is present, a null path-name represents the current working directory.
Default
COBCPY=%COBCPY%;C:\Program Files (x86)\Micro Focus\Enterprise Developer\cpylib;
   C:\Program Files (x86)\Micro Focus\Enterprise Developer\cpylib\basecl;
   C:\Program Files (x86)\Micro Focus\Enterprise Developer\cpylibguicl;
   C:\Program Files (x86)\Micro Focus\Enterprise Developer\cpylibolecl
Example

The following causes the Compiler to search for a copybook in /home/group/sharedcopy, then in the current directory, and finally in ./mydir/mycpy until either the copybook is found or it can be considered not found.

COBCPY=/home/group/sharedcopy:.:mydir/mycpy

COBDATA

Specifies the directory or directories that the run-time system is to search for data files.
Syntax
COBDATA=path-name[[:path-name][...]]
Parameter
path-name
The full path to a directory for the run-time system to search for application data files. When more than one path-name is present, a null path-name represents the current working directory.
Default
Not set. The run-time searches the current working directory.
Comments
his environment variable is set in the system registry. You can change the values using the SET command, but values you set are only added to the values already set in the registry.

COBDATA provides you with the facility to map data files globally, thus enabling you to put working data files in a directory whose name is not known until run time.

COBDATA affects the compiler and other utilities. During compilation, for example, program source is regarded as a data file by the compiler. If you intend to use any COBOL development system utilities, we recommend that the COBDATA value starts with a colon (:).

COBDATA is considered set if there is an environment variable of this name in your environment space, and its value is non-empty.

The full mapping order for files is:

  1. Any dd_ environment mappings
  2. Any ASSIGN TO EXTERNAL mappings
  3. Any COBDATA environment variable mappings

For multiple directory paths specified either in the COBDATA environment variable or a dd_ environment variable, the system searches the first directory specified followed by a slash (/) as a prefix to the user name.

If the filename is not found, or is not readable, the search continues with the next directory until the final directory has been searched. If no file is found, the first directory is used if a file is to be created.

Any dd_ and COBDATA mappings are ignored for any filename that starts with a hyphen () or a slash (/). In addition, it is illegal to have a hyphen in an environment variable name.

When using this facility, you should not use a filename that starts with "COB... "(these are reserved for the COBOL system).

You can use the COBDATA environment variable for files open in any mode (including OUTPUT) and for fixed or variable length files. If you are using indexed files, both the data and index files must be in the same directory.

The COBDATA environment variable affects file deletes, using the rules given here, as well as file opens.

If you intend to use COBOL development system programs, we recommend that you first unset COBDATA, as many of these programs open data files and are thus affected by the value of COBDATA. If you have to set COBDATA, you should include the paths :$COBDIR/dynload/helptbox.lbr and :$COBDIR/dynload/check.lbr at the beginning of the COBDATA value. If you want to see the Animator Help pages, also include COBDIR/dynload/advanim.lbr.

Note: Users modernizing RM/COBOL or ACUCOBOL-GT legacy code can use a sub-path in the file assignment, but only by compiling with the relevant DIALECT or IDXFORMAT values for the respective File Handling systems; setting these values in the File Handling configuration file is not sufficient to achieve this.
Example

The following causes COBDATA to be set to instruct the run-time system to search for data files in the current directory, then in the directory ./demo, then in the directory /home/data and finally in ./progs.

COBDATA=:demo:/home/data:progs

COBDIR

Specifies the directory where Enterprise Server is installed. Many system components and utilities require and use this information.
Syntax
COBDIR=path-name
Parameter
path-name
The directory that contains the required Micro Focus COBOL system software.
Default
Not set. The default path is $COBDIR.
Example

This example causes the compiler to search the directory /home/products/cobse20 for the Micro Focus COBOL system software.

COBDIR=/home/products/cobse20

COBIDY

Specifies the directory that Animator is to search for the information (.idy) file for the program being animated if it is not found in the same directory as the intermediate code (.int) file.
Syntax
COBIDY=path-name[:path-name[...]]
Parameter
path-name
A directory where .idy files can be found by the Animator.
Default
Not set. Animator searches the current working directory.
Comments
Animator can update the information file to record information held between sessions.

COBJVM

Specifies which Java Virtual Machine (JVM) to load.
Syntax
COBJVM=platform_nnn
Parameters
platform
A three-character code that indicates the platform on which you are running Enterprise Server. The following are valid codes:
Code Description
ibm IBM AIX
unx SCO UnixWare
sun Oracle SPARC
nnn
The three-digit version of the JVM.
Default
Not set.
Comments
You might need to set COBJVM if you are developing distributed applications with both COBOL and Java components.
Example
COBJVM=ibm_122

COBKEYTIMEOUT

Specifies the maximum elapsed time, in tenths of a second, for the connected terminal to transmit any valid escape sequence to the run-time system.
Syntax
COBKEYTIMEOUT=trans-time
Parameter
trans-time
A number in the range 1 through 126 that represents the maximum elapsed time required for a terminal to transmit any valid escape sequence to the run-time system over the line or network connection.
Default
Not set.
Comments
On encountering a lone Escape character, the run-time system waits n tenths of a second before assuming that the character does not introduce an escape sequence.

The run-time system calculates an appropriate default value for n from the baud rate of the terminal.

When a terminal key is depressed, the terminal might send in response a single character or a group of characters to the run-time system. Typically, such a group of characters starts with an escape character and the group of characters is known as an escape sequence. A terminal might send an escape sequence for one depression of a function key. It might also send the same sequence of characters for a depression of the Escape key followed by the depression of one or more alphabetic or numeric data keys. The only difference apparent to the run-time system is the interval between the arrival of each character; the user cannot type as fast as the escape sequence is generated by the terminal.

If a terminal is connected over a network that sends the characters to the run-time system in discrete packets, then the network can alter the intervals between each character arriving at the run-time system. COBKEYTIMEOUT is available to help compensate for typical network delays so the run-time system identifies escape sequences correctly.

COBLANG

Sets the language environment in which your COBOL program runs.
Syntax
COBLANG=LE-option
Parameter
LE-option
A COBOL language environment (LE) option.
Default
Not set.

COBLPFORM

Used to define and print to printer channels C01-C12.
Syntax
COBLPFORM line-number[[:line-number][...]]
Parameter
line-number
A single line number of a channel. Null entries are ignored. Those channels that have line number zero, function-names S01-S052, CSP, or are undefined, are set to line 1.
Default
Not set.
Comments
Any WRITE BEFORE/AFTER PAGE statements cause positioning to be at line 1. Each line advance increases the line number by one. A request to skip to a line number less than or equal to the current line causes a new page to begin. The appropriate number of line feeds are then generated.
Examples

In the following example, C01 equals 1, C02 equals 3, and so on:

COBLPFORM 1:3:5:7:9:11:13:15:17:19:21:23

In this next example, C01 equals 3, C02 equals 5, C03 equals 1, and C04 equals 9. C03 equals 1 because its value is a space and therefore undefined, and channels C05 - C12 are also undefined:

COBLPFORM :3::5: :9
Note: If a print statement specifies channel C05 - C12, the line is printed at line 1.

COBMAINSTACK

Specifies the size of the main stack.
Note: This variable applies to native COBOL applications on UNIX, and Enterprise Server on both Windows and UNIX.
Syntax
COBMAINSTACK=stack-size
Parameters
stack-size
The size of the main stack in bytes.
Default
Not set.
Comments
The main stack size defaults to three times the size of a threaded stack. The size of a threaded stack is either specified when the stack is created (using CBL_THREAD_CREATE), or it defaults to 160KB for a 32-bit application or 320KB for a 64-bit application.

You might need to set COBMAINSTACK in any of the following circumstances:

  • If you are deploying native OO COBOL Enterprise JavaBeans (EJBs) to WebSphere on the AIX platform.
  • If you are using the multi-threaded run-time system.
  • If you have IF STATEMENTS with a very large number of ELSE clauses.
  • If you have a large amount of local-storage data.

COBMODE

Describes whether to start the server in 32-bit or 64-bit mode.
Syntax
COBMODE={32|64};
Parameters
32|64
Specify the bitness you want to use when starting the server.
Default
None
Example
COBMODE=32;

COBOPT

Sets cob command options that either supplement or override those defined in $COBOPT/etc/cobopt, or specifies the path and file name of a file that contains such options.
Syntax
COBOPT="[set environment-variable=parameter]
[option[...]]
[[cobextn: .ext [.ext]][...]]"

or

COBOPT=[path-name/]file-name
Parameters
environment-variable
Any one environment variable supported by Enterprise Server.
parameter
A parameter used by the specified environment variable.
option
A cob command-line directive. See Compiler Directives for details.
ext
A filename extension that, in addition to the standard ones of .cob, .CBL, or .cbl, denotes a file that the compiler should treat as a COBOL source file. If more than one is specified on one line then they must be separated by a space or tab character.
Default
Not set. Uses options defined in $COBOPT/etc/cobopt.
Comments
The options can extend over more than one line and each line must have the same format as described for the file $COBDIR/etc/cobopt in cobopt File.

If a line does not begin with one of the identifiers set or cobextn: then it is taken as an options line.

Examples
These examples assume you are setting COBOPT at a command prompt.

This example enables ANSI 85 standard COBOL syntax and sets COBCPY to the specified list of paths.

COBOPT="CANS85
set COBCPY=$COBDIR/srclib/:$HOME/mylib:"
export COBOPT

This next example specifies that cob options are contained in the file options in the temp directory:

export COBOPT=temp/options

COBPATH

Specifies the directory or directories that the run-time system searches for dynamically loadable .int and .gnt files, or callable shared objects.
Syntax
COBPATH=path-name[:path[...]]
Parameter
path-name
The full or relative path to a directory for the run-time system to search for a dynamically loadable program (.int, .gnt or callable shared object) file.
Default
None. Dynamically set based on enterprise server region configuration.
Comments
his environment variable is set in the system registry. You can change the values using the SET command, but values you set are only added to the values already set in the registry.

When more than one path-name is specified, a null path name represents the current working directory.

Example
COBPATH=/home/mydir/srclib:otherlib

COBPRFDIR

Location of .ipf files created by programs compiled with the PROFILE compiler directive.
Syntax
COBPRFDIR=path-name[[:path-name][...]]
Parameter
path-name
The full path of a directory to search.
Default
Not set. .ipf files are created in and expected to be in the current working directory.

COBPRINTER

Specifies the name of a print spooler that is to receive, via its standard input stream (stdin), output from any DISPLAY UPON PRINTER statement.
Syntax
COBPRINTER="command-line"
Parameter
command-line
A command line supported by your system and that can be executed by the system shell. Typically, it is simply the name of a print spooler or other executable, but if the shell is escaped when setting the value then any command-line arguments can be used.
Default
Not set.
Comments
Each DISPLAY UPON PRINTER statement executed by your COBOL program causes a new invocation of command-line. Each invocation receives the data referenced in the DISPLAY statement, and is followed by a system end-of-file condition.
Example
COBPRINTER="myspooler -a $TMPDIR/spoolfile"

COBSES

Specifies the UNIX Session Recorder functions to perform.
Syntax
COBSES={option}[[:option][...]]
Parameters
option
One or more of the following, all of which are case sensitive:
-a Include keystrokes made to and screen output from the Animator
-f file-name Play back recording in file-name in fast forward mode
-p file-name Play back recording in file-name at normal speed
-r file-name1 Record keystrokes in file-name
-s file-name Record screen output in file-name
-t terminal-number Terminal number for multi-user screen recordings
1 Do not combine with either -f or -p.
file-name
The name of the recording file.
terminal-number
The terminal number for multi-user screen recordings.
Default
Not set.
Comments
You must unset COBSES when you have finished using the UNIX Session Recorder, or it interferes with the running of your COBOL programs. To do this, set COBSES to spaces, then export this setting to the shell.

COBSW

Specifies the run-time system switch settings for the run-time system to observe when running an application.
Syntax
COBSW={+|-}switch[...]
Parameters
+
Sets the switch.
-
Unsets the switch.
switch
A run-time switch. See Run-time Switches for details.
Default
COBSW=-A
Example
This example enables run-time switch 0 and the ANSI COBOL debug switch:
COBSW=+0+D

COBTERMINFO

Specifies the directory or directories to be searched by the run-time system for a terminfo database of terminal information tailored to the needs of COBOL applications.
Syntax
COBTERMINFO=path-name[[:path-name][...]]
Parameter
path-name
A search directory that identifies a terminfo database containing terminal settings tailored for COBOL applications.
Default
COBTERMINFO=$COBDIR/terminfo
Comments
When set, COBTERMINFO enables COBOL applications to use different terminfo settings to those used by non-COBOL applications, such as vi, when using the same terminal.

The COBOL system takes the value of the standard UNIX environment variable TERM as the name of the terminal in use. It uses this to search for the appropriate terminal information in a terminfo database. The run-time system first searches the databases identified in COBTERMINFO and then, if the terminal information is not found it searches the database identified in the standard UNIX environment variable TERMINFO.

Micro Focus recommends that the first directory listed in COBTERMINFO is $COBDIR/terminfo so that the terminfo database supplied with this COBOL system is found first. For commonly used terminals, this terminfo contains settings that are fuller and more appropriate to COBOL than those normally available in the UNIX system terminfo database.

When debugging using Animator, COBTERMINFO must be set to $COBDIR/terminfo.

COBTERMINFO can also be used to identify a terminfo database that is portable between UNIX systems. Such a database conforms to the standard UNIX database format but does not include any supplementary, UNIX implementation-dependent terminal information. Many UNIX system terminfo databases are not portable because they include such supplementary information. The COBOL system ignores any such nonportable details.

Example
COBTERMINFO=$COBDIR/terminfo:/home/mydir/terms

CODEWATCH_SRCPATH

The location of source files for the debugger to use if none are found in directories specified when invoking CodeWatch.
Syntax
CODEWATCH_SRCPATH=path-name[[:path-name][...]]
Parameter
path-name
The full path of a directory to search.
Default
Not set.

CODEWATCH_STBPATH

The location of STB files for the debugger to use if none are found in directories specified when invoking CodeWatch.
Syntax
CODEWATCH_STBPATH=path-name[[:path-name][...]]
Parameter
path-name
The full path of a directory to search.
Default
Not set.

COLUMNS

Specifies the column width of the terminal screen or window, overriding the specified terminal default.
Syntax
COLUMNS=number-of-columns
Parameter
number-of-columns
Specifies the width of the terminal screen or window as represented by the number of columns that display.
Default
Not set. Uses the cols value defined in the specified terminal's terminfo entry, or the current width of the terminal window if you are using an X terminal. See System Terminfo for additional details.
Comments
The terminal type is specified using the standard UNIX environment variable, TERM.

On non-windowing environments, where the terminal screen area cannot be resized, the COLUMNS values does not need to be set. Terminals that can switch into a wide mode (usually from 80 through 132 columns) have a terminal name ending in "w" and these are automatically supported, without the need to set COLUMNS.

In windowing environments, where the size of windows can be changed, the initial size of the window is used in preference to the cols value in terminfo. When the window is resized, the new size is reread. If the new size is greater than the initial size then the extra columns might not be used.

If you want to use the full width of the window you might need to set COLUMNS to the current column width of the window on some platforms.

Using COLUMNS values that do not correspond to the actual width of the window produces unexpected results.

Example
COLUMNS=100

CTM_SPACE

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.

D

DB2DBDFT

The default database against which the DB2 SQL preprocessor processes SQL statements.
Syntax
DB2DBDFT=path-name/database-name
Parameters
path-name
The location of the default database.
database-name
The name of the default database.
Default
Not set. Uses the database name specified in the project.

DBG_MVSPSKEL

The skeleton JCL for debugging.

E

ENTRYNAMEMAP

Specifies the locations of entry-name map files to use.
Important: You must set the entry_point_mapper tunable to enable entry-point mapper support. See entry_point_mapper for details.
Syntax
ENTRYNAMEMAP={file-name|directory}[:...]
Parameters
file-name
The name of the entry-name map file.
directory
A directory containing an entry-name map file. The name of the entry-name map file must be mfentmap.dat.
Default
Not set. The run-time system searches for an entry-name map file called mfentmap.dat in each directory specified by the COBDIR environment variable.
Comments
If the run-time system finds more than one entry-name map file, and the same entry point is defined differently in different files, precedence is given to the definition in the entry-name map file that was found first. To change the order in which the run-time system finds entry name map files you need to change the order in which the files appear in the COBDIR or ENTRYNAMEMAP environment variable paths.

ES_3270_REMOVE_NULL_COLOR_ATTRIB

Sets the extended color attribute to low-values and does not send it to the 3270 emulator.
Syntax
ES_3270_REMOVE_NULL_COLOR_ATTRIB=Y
Parameter
Y
Sets the extended color attribute to low-values and does not send it to the 3270 emulator.
Default
Not set. Enterprise Server uses the default screen size.
Comments
This fixes an IBM issue related to Personal Communications (PCOM) which is described at http://www-01.ibm.com/support/docview.wss?uid=swg21461404.

ES_ABORT_PLTPI_ERROR

Enables the user to set the error on which to abort PLTPI processing, bypassing the prompt.
Syntax
ES_ABORT_PLTPI_ERROR={YN|NY|YY}
Parameters
YN
Abort on PGMIDERR.
NY
Abort on ABEND.
YY
Abort on PGMIDERR or ABEND.
Default
Not set. When an error occurs during PLTPI processing, mainframe CICS enterprise servers display a prompt that enables the user to cancel the startup or ignore the error.
Comments
Set ES_ABORT_PLTPI_ERROR to bypass the prompt and automatically abort the initialization as dictated by the value provided.

ES_ACBLIB

Specifies the location of the IMS ACB files.
Syntax
ES_ACBLIB=path-name
Parameter
path-name
The path location of the IMS ACB files.
Default
Not set. ACB files are assumed to be in the project directory.

ES_ALLOC_EXPAND

Expands an environment variable when used to specify an allocation path, or overrides this behavior.
Syntax
ES_ALLOC_EXPAND={Y|N}
Parameters
Y
Expand the environment variable used to specify an allocation path.
N
Do not expand the variable used in the path.
Default
ES_ALLOC_EXPAND=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=path-name/rules-file
Parameters
path-name
The full path to the dataset rules file.
rules-file
The name of the dataset rules file.
Default
Not set.

ES_CAS_API

Indicates whether casout or cassub is executed by a call and not from the command line.
Syntax
ES_CAS_API=ON
Parameter
ON
The utility is invoked by a call, and messages are not sent to the console or command line.
Default
Not set. Utilities are executed from the command line, and messages are logged.

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=attempt-count
Parameter
attempt-count
The number of attempts made to open a catalog file.
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=wait-time
Parameter
wait-time
The number of seconds to wait between attempts made to open a catalog file.
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.

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_CERT_REG

Specifies the directory in which the cascertreg user certificate utility should store its registrations.
Syntax
ES_CERT_REG=path-name
Parameter
path-name
Full path to the directory where registrations are stored.
Default
None; however, if omitted, you must specify the directory using the cascertreg command.

ES_CESN_NO_OS390

Overrides the default CESN transaction and the IMS sign-on screen response behavior for invalid user credentials.
Syntax
CESN_NO_OS390=ON
Parameter
ON
Override the default CESN transaction and IMS sign-on screen response behavior for invalid credentials, and instead produce an invalid credential message.
Default
Not set. CESN transaction and IMS sign-on screen response is Your userid is invalid or Your password is invalid.
Comments
This environment variable is considered to be turned on when set to any value, including ON.

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.

ES_CICS_SINGLE

Configures CICS so that a user can only log on once when the enterprise server region is running in a PAC with CICS enabled.
Syntax
ES_CICS_SINGLE={Y|N}
Parameters
Y
A user can only log on once.
N
The same user may sign on to multiple terminals with CICS.
Default
ES_CICS_SINGLE=Y
Comments
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.

ES_CLASS_XCMD

Controls the CICS CMD resource class.
Syntax
ES_CLASS_XCMD={YES|NO|class-name}
Parameters
YES
CICS CMD is the default CMD class.
NO
Security for CMDs is bypassed.
class-name
The name of a class to override the default CMD CICSCMD class.
Default
ES_CLASS_XCMD=YES
Comments
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.

ES_CLASS_XDCT

Controls the CICS DCT resource class.
Syntax
ES_CLASS_XDCT={YES|NO|class-name}
Parameters
YES
DCICSDCT is the default DCT class.
NO
Security for DCTs is bypassed.
class-name
The name of a class to override the default DCT DCICSDCT class.
Default
ES_CLASS_XDCT=YES
Comments
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.

ES_CLASS_XFCT

Controls the CICS FCT resource class.
Syntax
ES_CLASS_XFCT={YES|NO|class-name}
Parameters
YES
FCICSFCT is the default FCT class.
NO
Security for FCTs is bypassed.
class-name
The name of a class to override the default PCT FCICSFCT class.
Default
ES_CLASS_XFCT=YES
Comments
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.

ES_CLASS_XJCT

Controls the CICS JCT resource class.
Syntax
ES_CLASS_XJCT={YES|NO|class-name}
Parameters
YES
JCICSJCT is the default JCT class.
NO
Security for JCTs is bypassed.
class-name
The name of a class to override the default JCT JCICSJCT class.
Default
ES_CLASS_XJCT=YES
Comments
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.

ES_CLASS_XPCT

Controls the CICS PCT resource class.
Syntax
ES_CLASS_XPCT={YES|NO|class-name
Parameters
YES
ACICSPCT is the default PCT class.
NO
Security for PCTs is bypassed.
class-name
The name of a class to override the default PCT ACICSPCT class.
Default
ES_CLASS_XPCT=YES
Comments
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.

ES_CLASS_XPPT

Controls the CICS PPT resource class.
Syntax
ES_CLASS_XPPT={YES|NO|class-name}
Parameters
YES
MCICSPPT is the default PPT class.
NO
Security for PPTs is bypassed.
class-name
The name of a class to override the default PPT MCICSPPT class.
Default
ES_CLASS_XPPT=YES
Comments
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.

ES_CLASS_XPSB

Controls the CICS PSB resource class.
Syntax
ES_CLASS_XPSB={YES|NO|class-name}
Parameters
YES
PCICSPSB is the default PSB class.
NO
Security for PSBs is bypassed.
class-name
The name of a class to override the default PSB PCICSPSB class.
Default
ES_CLASS_XPSB=YES
Comments
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.

ES_CLASS_XRES

Controls the CICS DOCTEMPLATE resource class.
Syntax
ES_CLASS_XRES={YES|NO|class-name}
Parameters
YES
RCICSRES is the default RES class.
NO
Security for DOCTEMPLATEs is bypassed.
class-name
The name of a class to override the default RES RCISRES class.
Default
ES_CLASS_XRES=YES
Comments
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.

ES_CLASS_XTRAN

Controls the CICS TRAN resource class.
Syntax
ES_CLASS_XTRAN={YES|NO|class-name}
Parameters
YES
TCICSTRN is the default TRAN class.
NO
Security for TRANs is bypassed.
class-name
The name of a class to override the default TRAN TCICSTRN class.
Default
ES_CLASS_XTRAN=YES
Comments
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.

ES_CLASS_XTST

Controls the CICS TST resource class.
Syntax
ES_CLASS_XTST={YES|NO|class-name}
Parameters
YES
SCITST is the default TST class.
NO
Security for TSTs is bypassed.
class-name
The name of a class to override the default TST SCITST class.
Default
ES_CLASS_XTST=YES
Comments
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.

ES_CLUSTER

Identifies a region as participating in an Enterprise Server cluster.
Syntax
ES_CLUSTER=ON
Parameter
ON
Sets the region to participate in an Enterprise Server cluster.
Default
Not set. The enterprise server region does not participate in an Enterprise Server cluster.
Comments
Mandatory for all enterprise server regions in a cluster.

ES_CLUSTER_ISC_TRACE

Enables tracing on the Enterprise Server cluster ISC listeners.
Syntax
ES_CLUSTER_ISC_TRACE=ON
Parameter
ON
Tracing of ISC listeners for an Enterprise Server cluster is enabled.
Default
Not set. Enterprise Server cluster ISC listeners are not traced.

ES_CLUSTER_LISTENER_PORT_TO_USE

Sets a specific port for an Enterprise Server cluster listener.
Syntax
ES_CLUSTER_LISTENER_PORT_TO_USE=port-number
Parameter
port-number
The port number to assign to a cluster listener.
Default
Not set. The Enterprise Server cluster listener uses an ephemeral port.

ES_CLUSTER_SYSTEM_DIR (deprecated)

Sets the system directory for an Enterprise Server cluster listener.
Note: ES_CLUSTER_SYSTEM_DIR is deprecated, and provided for backward compatibility only.
Syntax
ES_CLUSTER_LISTENER_PORT_TO_USE=path-name
Parameter
path-name
The full path to the cluster system directory.
Default
ES_CLUSTER_SYSTEM_DIR=

ES_CSKL_NO_MSG_CONSOLE

Stops the EZ Sockets CICS listener (CSKL) from writing messages to console.log.
Syntax
ES_CSKL_NO_MSG_CONSOLE=ON
Parameter
ON
CSKL does not write message to console.log.
Default
Not set. CSKL writes messages to console.log.
Comments
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.

ES_CWS_WSBIND_COMP

Enables support for CICS applications that use COMP declarations.
Syntax
ES_CWS_WSBIND_COMP={Y|N}
Parameters
Y
Enables support for COMP declarations in CICS applications.
N
Support for COMP declarations is disabled for CICS applications.
Default
ES_CWS_WSBIND_COMP=N

ES_DB_FH

Enables or disables database file handler support. This is required if your data files are stored in a datastore, or your enterprise server region stores some of its resources in a database; see Micro Focus Database File Handler and Enterprise Server Region Database Management for more information.
Syntax
ES_DB_FH={[Y|true]|[N|false]}
Parameters
Y|true
Use the Micro Focus Database File Handler (MFDBFH) to direct file handling.
N|false
Disable database file handling.
Default
ES_DB_FH=N
Comments
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.

ES_DB_SERVER

Specify the name of the database server to be used for region database operations.
Important: The configuration file specified by the MFDBFH_CONFIG environment variable must contain a corresponding <server> entry for the database server. <dsn> entries for the region, cross-region, and master databases must also be specified in the configuration file to enable use of region database operations.
Syntax
ES_DB_SERVER=server-instance
Parameter
server-instance
The name of a valid database server instance.
Default
Not set.
Comments
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.
Example
ES_DB_SERVER=MYSERVER

In this example, your database configuration file would need to contain something similar to the following:

<datastores usevault="false">
   <server name="MYSERVER" type="sqlserver" access="odbc"> 
       <dsn name="SS.MYMASTER" type="database" dbname="master"/> 
       <dsn name="SS.CAS.ESDEMO" type="region.cas" region="ESDEMO" 
          feature="all"/> 
       <dsn name="SS.CAS.CROSSREGION" type="crossregion.cas"/>
   </server> 
</datastores>

ES_DDBG_PORT_RANGE

A range of ports to use for dynamic debugging.
Syntax
ES_DDBG_PORT_RANGE={starting-port-number-ending-port-number |
   starting-port-number,number-of-ports
Parameters
starting-port-number
A port number that represents the start of the range.
ending-port-number
A port number that represents the end of the range. This number must be greater than the value of starting-port-number. All available ports within the range are used.
number-of-ports
The total number of ports. The ports used include those available, starting with the starting-port-number port and continuing with ports greater than the starting-port-number port, up to the total number specified.
Default
Not set. Dynamic debugging uses random ports.
Comments
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.
Examples
The following specifies that all available ports from 8001 through 8040 are to be used:
ES_DDBG_PORT_RANGE=8001-8040

The following specifies using the next 40 available ports with a port number higher than the starting port number:

ES_DDBG_PORT_RANGE=8001,40

ES_DFS3650

Specifies the default transaction to execute or the MOD file display after successfully signing onto IMS.
Syntax
ES_DFS3650={MOD|TRX}
Parameters
MOD
Set ES_MOD3650 to the name of the MOD you want to display.
TRX
Set ES_TRX3650 to the name of the transaction.
Default
Not set. No transaction or MOD executes after successfully signing onto IMS.
Comments
If you set to MOD, ES_MOD3650 needs to be set to the name of the MOD you want to display. If you set to TRX, ES_TRX3650 needs to be set to the name of the transaction.

ES_DISABLE_DFLTUSR_SIGNON

Disables the default user (mfuser) signon when invoking ES Monitor & Control (ESMAC).
Syntax
ES_DISABLE_DFLTUSR_SIGNON=Y
Parameter
Y
Disables the mfuser auto-logon after starting Enterprise Server administration via your MFDS internal security account.
Default
Not set. mfuser is signed in to ESMAC.
Comments
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.

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

When the job card does not specify the DSHQSHR keyword or when the job card sets DSENQSHR to USEJC:

ES_CAT_RETRY_WAIT=ES_DSENQSHR=DISALLOW

When the job card specifies the DSENQSHR keyword, the value of DSENQSHR is used.

Comments
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 Share options with VSAM datasets. You can enable these by setting the ES_SHAREOPT environment variable to Y.

ES_ECI_MAX_RESP

Specifies the maximum expected response size to use when using Micro Focus ECI support to invoke CICS programs.
Syntax
ES_ECI_MAX_RESP=resp-size
Parameter
resp-size
A decimal from 1 to 16777215 representing the maximum expected response size in bytes.
Default
Not set. The maximum expected response size is calculated dynamically by multiplying the size of the TIOA by 2.
Comments
You need to use this environment variable when the amount of data returned from the CICS programs is approximately more than twice the size of the input data, which is sometimes the case when using channels and containers where the back-end program creates or enlarges containers.

ES_EMP_EXIT_n

ES_EMP_EXIT_n
Specifies the number of Event Manager user exits for the region.
ES_EMP_EXIT_n=batch-component
Parameters
n
A single digit ranging from 1 through 9, depending on the number of Event Manager user exits for the region.
Note: This must be set to 1 when mfbsiemx is the only Event Manager user exit for the region.
batch-component
An event manager component. See Components for details.
Note: On UNIX platforms, batch-component must be in lower case.
Default
Not set.
Comments
You must set ES_EMP_EXIT once for each Event Manager used in the region.

When setting ES_EMP_EXIT multiple times, they must be set in numerical order.

Example
ES_EMP_EXIT_1=mfbsiemx
ES_EMP_EXIT_2=mfmonemx
ES_EMP_EXIT_3=...

ES_ESM_DISABLE_DFLTUSER_ESMAC

Allows you to disable the default ESMAC user to increase the security of your server.
Syntax
ES_ESM_DISABLE_DFLTUSER_ESMAC=Y
Parameter
Y
Disables the default ESMAC user, disables the DEFAULT button on the logon screen, and forces users to always enter a valid user ID and password.
Default
Not set. The ESMAC user is enabled.
Comments
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.

ES_ELAPSED_DISPATCH_SECONDS

Specifies how frequently casmgr checks for Jobs in the waiting state and then starts them.
Syntax
ES_ELAPSED_DISPATCH_SECONDS=wait-time
Parameter
wait-time
The number of seconds that casmgr waits before checking for Jobs in the waiting state and then starting them.
Default
ES_ELAPSED_DISPATCH_SECONDS=5

ES_ESM_CMDSEC

Indicates whether CICS processing honors the CMDSEC option specified on a transaction's PLT definition.
Syntax
ES_ESM_CMDSEC=YES
Parameter
YES
CICS overrides the CMDSEC option, and always calls its command security checking routine to issue the appropriate call to the SAF interface.
Default
Not set. CICS honors the CMDSEC option defined in a transaction's resource definition. CICS calls its command security checking routine only when CMDSEC(YES) is specified in a transaction resource definition.

ES_ESM_IDPW_CASE

Forces the case of user ID and password for a single attempt ESM authentication.
Syntax
ES_ESM_IDPW_CASE=xy
Parameters
x
Specifies the case for the user ID. Use one of the following:
U All upper case
L All lower case
M Mixed case and case-sensitive
y
Specifies the case for the password. Use one of the following:
U All upper case
L All lower case
M Mixed case and case-sensitive
Default
Not set. Uses legacy behavior.
Comments
When this environment variable is set, Enterprise Server makes only one attempt to identify a user presenting the user ID and password as is (M), folded to upper case (U), or folded to lower case (L).

For the legacy behavior for CICS, the user ID and the password are used as supplied possibly filtered by the upper-case translation configuration of the sign-on transaction.

For ESMAC and IMS, the legacy behavior is that, first, the user ID and password are used as supplied. If the authentication fails, the user ID is folded to upper case and used again. If this fails as well, both the user ID and the password are folded to upper case and then used.

Example
This example tries a single authentication with the user ID folded to upper case, and the password used as-is:
ES_ESM_IDPW_CASE=UM

ES_ESM_PLTPISEC

The level of security checking for PLTPI processing.
Syntax
ES_ESM_PLTPISEC={NONE|CMDSEC|RESSEC|ALL}
Parameters
NONE
No security checking is performed on PLT initialization programs.
CMDSEC
CICS performs command security checking only.
RESSEC
CICS performs resource security checking only.
ALL
CICS performs both command and resource security checking.
Default
ES_ESM_PLTPISEC=NONE

ES_ESM_PLTPIUSR

Specifies the user ID under which PLT programs run during CICS initialization.
Syntax
ES_ESM_PLTPIUSR=userid
Parameter
userid
The user ID for CICS to use for security checking for PLT programs that run during CICS initialization.
Default
Not set. The user specified when starting the CICS-enabled enterprise server region is used.
Comments

The user ID specified must have appropriate authorization to access all the resources used by the programs as determined by the ES_ESM_PLTPISEC environment variable.

ES_ESM_RCF

Determines how RACF is used for command authorization.
Syntax
ES_ESM_RCF={A|C|N|S|T|Y}
Parameters
A
A combination of options T, C, and S.
C
Use RACF for ETO terminal command authorization.
N
RACF does not perform sign-on, transaction, or command authorization.
S
Use RACF for static and ETO terminal command authorization. Includes option C.
T
Use RACF for sign-on and transaction authorization.
Y
A combination of options T and C.
Default
ES_ESM_RCF=N

ES_ESM_RESSEC

Indicates whether CICS processing honors the RLS security setting specified on a transaction definition (PCT).
Syntax
ES_ESM_RESSEC=ALWAYS
Parameter
ALWAYS
CICS processing always performs resource level security checking irrespective of the RLS security setting on the transaction definition.
Default
Not set. The RLS security setting of a transaction is honored. That is, resource-level security checking is performed only when the RLS security checkbox is marked in the PCT definition.

ES_ESM_SECPRFX

Indicates whether CICS processing adds a prefix to resource names when making security queries.
Syntax
ES_ESM_SECPRFX={NO|YES|prefix}
Parameters
NO
Use no prefixes.
YES
Uses prefix resource names with the CICS region user ID.
prefix
Define a prefix for resource names as an alphanumeric string that starts with an alphabetic character, and is one to eight upper-case characters in total.
Default
ES_ESM_SECPRFX=NO
Comments
This environment variable is applied only to CICS classes.

ES_ESM_XUSER

Indicates whether CICS processing performs surrogate user checks.
Syntax
ES_ESM_XUSER={NO|YES}
Parameters
NO
No surrogate user checking is performed.
YES
Perform surrogate user checking wherever such checks are permitted.
Default
ES_ESM_XUSER=YES

ES_ESMAC_DISP_MAX_OVERRIDE

Limits the number of lines shown when viewing an individual catalog entry in the ESMAC catalog view or when viewing a SYSOUT file from the job list view.
Syntax
ES_ESMAC_DISP_MAX_OVERRIDE=value
Parameter
value
An integer denoting the number of lines to display to a maximum of 99999.
Default
ES_ESMAC_DISP_MAX_OVERRIDE=1000
Comments
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.

ES_EUSA_SIZE

Sets the size of the extended user storage area, allowing large memory allocations to be set using the GETMAIN SHARED command.
Syntax
ES_EUSA_SIZE=number
Parameter
number
A numeric value representing the number of MB to allocate for the extended user storage area.
Default
ES_EUSA_SIZE=16

ES_EZASOKET_SUPPORT (deprecated)

Switches on EZASOKET support.
Note: ES_EZASOKET_SUPPORT is deprecated, and provided for backward compatibility only. We recommend that you configure EZASOKET using ESCWA instead.
Syntax
ES_EZASOKET_SUPPORT=Y
Parameter
Y
Turns on EZASOCKET support.
Default
Not set. EZASOCKET is not supported.
Comments
Parameter value is not case sensitive.

ES_GLM

If this variable is set, it identifies the region as an Enterprise Server cluster Global Lock Manager (GLM).
Syntax
ES_GLM=ON
Parameter
ON
Identify the region as a GLM.
Default
Not set. The region is not identified as a GLM.
Comments
This environment variable is considered to be turned on when set to any value, including ON.

ES_GLM_TIMEOUT

Sets the amount of time that can pass while a submit request to an Enterprise Server cluster Global Lock Manager (GLM) is retried and before permanently disabling the connection.
Syntax
ES_GLM_TIMEOUT=number
Parameter
number
The number of seconds during which a retry is attempted and before disabling the connection.
Default
ES_GLM_TIMEOUT=120
Comments
This variable only applies to the region within an Enterprise Server cluster designated as the GLM.

ES_HARD_KILL_PROCESS

Enables you to modify how Enterprise Server kills a process.
Syntax
ES_HARD_KILL_PROCESS={Y|N}
Parameters
Y
Issue a hard kill after a soft kill when the soft kill fails.
N
No hard kill is attempted after the soft kill.
Default
ES_HARD_KILL_PROCESS=Y
Comments
This variable only applies to the region within an Enterprise Server cluster designated as the Global Lock Manager (GLM).

ES_HOSTNAME_TO_USE

In an Enterprise Server Cluster, if a machine uses more than one network card, you might need to set this variable to identify the host MFCS should use.
Syntax
ES_HOSTNAME_TO_USE=host-name
Parameter
host-name
The host name that matches the network card you want to use.
Default
Not set. MFCS uses the local host.

ES_HSF_CFG

Enables you to configure a number of additional fields to appear in the HSF record displayed in the cashsf-a.csv or cashsf-b.csv file.
Syntax
ES_HSF_CFG=cfg-option=value[:[cfg-option=value][...]]
Parameters
cfg-option=value
One or more of the following option/value pairs:
cfg-option value range
CUSTOM 0-5
CICSF 0-20
TSQ 0-20
TDQ 0-20
Default
ES_HSF_CFG=CUSTOM=0;CICSF=5;TSQ=5;TDQ=5
Comments
If a field is not explicitly set, or the value specified is out of range, the default value for the field is used.

The ES_WRITE_CUSTOM_HSF library routine writes to the custom fields.

Example
The following generates two custom fields, ten CICS file fields, five TSQ fields, and five TDQ fields.
ES_HSF_CFG=CUSTOM=2:CICSF=10:TSQ=5:TDQ=5

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.
Default
ES_IEBGEN_TO_ICEGEN=N

ES_IMS_APARM_DLI

Determines whether APARMs use ASCII and a positional parameter set to 19 when obtained from EBCDIC applications, or use EBCDIC and a positional parameter set to 20 when obtained from EBCDIC applications.
Syntax
ES_IMS_APARM_DLI={Yes|1}
Parameters
Yes|1
Sets the APARM positional parameter for DLI to 19.
Default
Not set. The default behavior sets the APARM positional parameter for DLI to 20.
Comment
The APARM positional parameter for BMP applications remains at 19 regardless of the ES_IMS_APARM_DLI setting.

ES_IMS_BASIC_CHKP_OPT

Enables a basic checkpoint call to process as if a SYNC call had been issued.
Syntax
ES_IMS_BASIC_CHKP_OPT={0|1}
Parameters
1
Checkpoint calls process as a SYNC call.
0
Checkpoint calls process normally.
Default
ES_IMS_BASIC_CHKP_OPT=0

ES_IMS_BYPASS_OTMA_DEST_RES

By default, a CHNG call issued from an OTMA- or IMS Connect-submitted transaction assumes that the destination is the OTMA client.
Syntax
ES_IMS_BYPASS_OTMA_DEST_RES={Y|N}
Parameters
Y
The destination is the OTMA client.
N
Assumes a non-OTMA client.
Default
ES_IMS_BYPASS_OTMA_DEST_RES=N
Comments
In some circumstances, the behavior of assuming a non-OTMA client is desirable.
Example
ES_IMS_BYPASS_OTMA_DEST_RES=Y

ES_IMS_CANCEL_MODE

Controls the caching of IMS binaries.
Syntax
ES_IMS_CANCEL_MODE={P|L|D}
Parameters
P
Performs a physical cancel; every transaction will have new-copy behavior. This option is the default behavior, but is the poorest performing of the options.
L
Performs a logical cancel. This gives the best performance of the options, but can only be used it there is only one DLITCBL entry point in an MPR.
D
Performs a deferred cancel, which will yield the same behavior as a logical cancel when the MPR services the same MPP back-to-back. It will behave as P (physical cancel) when the transaction changes.
Default
ES_IMS_CANCEL_MODE=P

ES_IMS_CLIENTID_LTERM

Sets LTERM to the client ID instead of the port ID.
Syntax
ES_IMS_CLIENTID_LTERM={Y|N}
Parameters
Y
Sets LTERM to the client-ID instead of the port-ID.
N
Sets LTERM to the client ID when commit-mode is zero, and to the port-ID when commit-mode is one.
Default
ES_IMS_CLIENTID_LTERM=N
Comments
By default, an IMS Connect request sets LTERM (if not explicitly overridden) to the client-ID when commit-mode is zero, and to the port-ID when commit-mode is one.

ES_IMS_CONFIG

The IMS TM parameters.

ES_IMS_DB_COMMIT_FLUSH

Enables you to force the flushing of database buffers to disk on COMMIT only.
Syntax
ES_IMS_DB_COMMIT_FLUSH={0|1}
Parameters
0
Forces the flushing of database buffers to disk on CLOSE only.
1
Forces the flushing of database buffers to disk on COMMIT only.
Default
ES_IMS_DB_COMMIT_FLUSH=0

ES_IMS_DB_TLOG_WRITETHRU

Enables you to force the flushing of TLOG buffers to disk on all database I/O.
Syntax
ES_IMS_DB_TLOG_WRITETHRU={0|1}
Parameters
0
Forces the flushing of TLOG buffers to disk on COMMIT only.
1
Forces the flushing of TLOG buffers to disk on all database I/O.
Default
ES_IMS_DB_TLOG_WRITETHRU=0

ES_IMS_DEADLOCK_WAIT

Sets the time to wait before checking for a deadlock.
Syntax
ES_IMS_DEADLOCK_WAIT=wait-time
Parameter
wait-time
Time in milliseconds to wait before checking for a deadlock.
Default
ES_IMS_DEADLOCK_WAIT=1000

(1 second)

ES_IMS_DIAGNOSE

Marks IMS TM as diagnose mode only for IMSMSGQ.
Syntax
ES_IMS_DIAGNOSE={Y|N}
Parameter
Y
The Transaction Manager (TM) works in diagnostic mode only, and no activity key points are written to the message queue.
N
Transaction Manager writes activity key points to the message queue.
Default
ES_IMS_DIAGNOSE=N
Comments
CAUTION:
Do not set ES_IMS_DIAGNOSE=Y unless advised to do so by OpenText Support for Micro Focus Products.

ES_IMS_DOSVS_PCB

Emulates DOS/VSE PCB address alignment for EXEC DLI programs.

ES_IMS_DUMP_ON_DEADLOCK

Creates a system dump when a deadlock is detected.

ES_IMS_DUMP_ON_TIMEOUT

Creates a system dump when a lock timeout occurs.

ES_IMS_EXITPATH

The location of the DFSNDMX0.cbl exit routine program and its compiled code, which contains segment, field, and/or print exits.
Syntax
ES_IMS_EXITPATH=path-name
Parameter
path-name
The full path to the directory that contains the DFSNDMX0.cbl exit routine program and its compiled code.
Default
Not set.

ES_IMS_FORCE_SIGNON

Enables a user to force a sign-on to IMS on the current terminal and sign off from other terminals.

ES_IMS_GOTO_CICS_ON_SIGNOFF

Sets the behavior after logging off or timing out to return to CICS.
Syntax
ES_IMS_GOTO_CICS_ON_SIGNOFF=
Parameter
Returns to CICS after logging off or timing out.
Default
Returns to the IMS sign-on screen after logging off or timing out.

ES_IMS_IBMPLATFORM

Sets the emulation for the IMS run-time.
Syntax
ES_IMS_IBMPLATFORM={M|D}
Parameter
M
Sets the IMS run time to MVS.
D
Sets the IMS run time to DOSVS.
Default
ES_IMS_IBMPLATFORM=M
Comment
This variable rarely requires a change from the default, even for the majority of DOSVS users.

ES_IMS_IMSID

Allows the user to specify the IMS System ID returned to the AIBTDLI INQY ENVIRON call.

ES_IMS_INQY_OTMA

Returns TPIPE, MBR, SYNC, and MSYNC to an INQY call.

ES_IMS_INQY_UNKNOWN

Allows the user to specify the IMS System ID returned to the AIBTDLI INQY ENVIRON call.

ES_IMS_IRLM

Enables Internal Lock Resource Manager (IRLM) locking.
Syntax
ES_IMS_IRLM={0|1}
Parameters
0
Disables IRLM locking.
1
Enables IRLM locking.
Default
ES_IMS_IRLM=0
Comments
IRLM locking more closely parallels mainframe IMS database DB locking behavior, reducing data constraint and potential for deadlock.

ES_IMS_LINKAGE_NULL

When an IMS program passes more linkage addresses than there are PCBs in the PSB, sets each extraneous linkage address to a value of NULL.
Syntax
ES_IMS_LINKAGE_NULL={Y|N}
Parameter
Y
Sets each extraneous linkage address to a value of NULL.
N
Extraneous linkage addresses are invalid.
Default
ES_IMS_LINKAGE_NULL=N

ES_IMS_JES_DIRTY_ABEND

Determines whether IMS marks a JES container as dirty when an IMS application abends or is aborted.
Syntax
ES_IMS_JES_DIRTY_ABEND={Y|N}
Parameter
Y
IMS marks a JES container as dirty when an IMS application abends or is aborted.
N
Disables the IMS behavior of marking a JES container as dirty when an IMS application abends or is aborted.
Default
ES_IMS_JES_DIRTY_ABEND=Y

ES_IMS_LOCALDLI (deprecated)

Determines whether batch program execution processes all IMS DB calls entirely in the JES initiator.
Syntax
ES_IMS_LOCALDLI=1
Parameter
1
Directs batch program execution to process all IMS DB calls entirely in the JES initiator.
Disables the IMS behavior of marking a JES container as dirty when an IMS application abends or is aborted.
Default
ES_IMS_LOCALDLI=1
Comments
Deprecated. See IMS Database Locking.

Processing IMS DB calls in the JES initiator can significantly improve performance.

Stop all IMS DB control processes accessed from the batch program before execution because they become exclusively owned by JES until the program completes.

ES_IMS_LOCK_RETRY_DELAY

Sets the wait time for retrying an IMS DB lock.
Syntax
ES_IMS_LOCK_RETRY_DELAY=wait-time
Parameter
wait-time
The amount of time in milliseconds to delay retrying the IMS DB lock.
Default
ES_IMS_LOCK_RETRY_DELAY=5

ES_IMS_LOCK_TIMEOUT

Sets the time duration during which IMS DB control continues to retry a locked record before timing out
Syntax
ES_IMS_LOCK_TIMEOUT={0|wait-time}
Parameter
0
Sets an indefinite wait time.
wait-time
A number from 1 through 65525 that represents the number of seconds during which IMS DB control continues to retry a locked record before timing out.
Default
ES_IMS_LOCK_TIMEOUT=30

ES_IMS_LTERM_PREFIX

Sets an LTERM prefix alternative to the default (OTMA) to use when the ES_IMS_SINGLE environment variable is set to N.
Syntax
ES_IMS_LTERM_PREFIX=prefix
Parameter
prefix
A one- to four-character string to use as the LTERM prefix when the ES_IMS_SINGLE environment variable is set to N.
Default
ES_IMS_LTERM_PREFIX=OTMA
Comments
Enterprise Server pads the value specified with numeric digits up to eight characters, enabling the LTERM pool to be expanded from 9999 up to 999999. The pool size is dictated by the number of characters used in the specified prefix. For example, the LTERM pool size for a four-character prefix is 9999; for a three-character prefix is 99999; and so on.

Using an alternative prefix to OTMA enables you to exercise control over name conflicts.

The default setting of this environment variable suggests that the LTERMS apply only to OTMA clients; however, this is not the case. LTERMS can also be applied to second and subsequent 3270 user connections.

ES_IMS_LU_LTERM

Determines the value of the LTERM literal returned by the MFS system.
Syntax
ES_IMS_LU_LTERM={Y|N}
Parameters
Y
Returns the LU name.
N
Returns the user ID.
Default
ES_IMS_LU_LTERM=

ES_IMS_MESGQ

Sets the configuration for the IMS TM message queue. The ES_IMS_MESGQ environment variable is generated and set automatically by Enterprise Server, and is reserved.
Syntax
ES_IMS_MESGQ=[ds-file-name;]max-blocks;buffer-count;start-control;[cushion-size]
Parameters
ds-file-name
An alternative data store file to the default, which is IMSMESGQ.dat.
max-blocks
Data store size limit represented as the number of 64K blocks. Default is 4.
buffer-count
The number of 64K buffers to allocate. Default is 2.
start-control
A flag that sets the start behavior as follows:
Y Cold start the resource definitions. Default.
S Cold start the statistics and resource state information.
Q Cold start the data store (system cold start).
cushion-size
The size of the cushion to be reserved for graceful lack-of-space behavior, represented as a number from 0 to 255. The specified number represents 32 times the actual percentage of max-blocks reserved for emergency use. The default is 4 (a raw value of 128).
Default
ES_IMS_MESGQ=IMSMESGQ.dat;4;2;Y;4
Comments
CAUTION:
Manually set this variable only when advised to do so by OpenText Support for Micro Focus Products.

ES_IMS_DISPLAY_NEW

Changes the timestamp format for /DISPLAY output.
Syntax
ES_IMS_DISPLAY_NEW={Y|N}
Parameters
Y
Timestamp output follows the current z/OS system style, YYDDD/HHMMSS.
N
Timestamp output follows the old z/OS system style, MM/DD/YYYY HH:MM:SS.
Default
ES_IMS_DISPLAY_NEW=N

ES_IMS_MFS_OPT2_LEGACY

Configures MFS input type option 2 to behave the same as MFS input type option 1.
Syntax
ES_IMS_MFS_OPT2_LEGACY={Y|N}
Parameters
Y
Enables legacy MFS input type option 2 behavior.
N
MFS input type option 2 behavior is the same as MFS on z/OS mainframes.
Default
ES_IMS_MFS_OPT2_LEGACY=N

ES_IMS_OPEN_TIMEOUT

Defines the time period during which IMS retries the opening of a database file that is in use by another task.
Syntax
ES_IMS_OPEN_TIMEOUT=wait-time
Parameter
wait-time
The number of seconds IMS waits before making a subsequent attempt to open a database file that is in use by another task.
Default
ES_IMS_OPEN_TIMEOUT=30

ES_IMS_OTMA_DEST

Defines one or more destinations to which data is redirected for IMS Connect (IMSCON), the MQ-IMS Bridge (MQ), or the IMS print exit (NONOTMA).
Syntax
IMS Connect
ES_IMS_OTMA_DEST={LTERM-name,IMSCON}[;...]
MQ-IMS Bridge
ES_IMS_OTMA_DEST={LTERM-name,MQ,MQ-queue-manager-name,MQ-queue-name}[;...]
IMS Print Exit
IMS_OTMA_DEST={printer-name,NONOTMA,{LU1|LU3}}[;...]
Parameters
LTERM-name
A destination name specified as a literal value for a single destination, or specified using a literal value followed by one or more asterisks to represent a series of multiple destinations. For example, an LTERM-name of TERM*** creates 1000 LTERM destinations named TERM000 through TERM999. Use this method to avoid defining each destination separately.
MQ-queue-manager-name
The name of the MQ queue manager.
MQ-queue-name
The name of the MQ queue.
printer-name
The printer name.
Default
Not set.

ES_IMS_PATH

The location of compiled COBOL applications.
Syntax
ES_IMS_PATH=path-name
Parameter
path-name
The full path to the location of compiled COBOL applications.

ES_IMS_PLI_INDIRECT_PCBADDR

Determines whether the PL/I program converts the PCB address list from a direct to an indirect addressing technique.
Syntax
ES_IMS_PLI_INDIRECT_PCBADDR={Y|N}
Parameters
Y
Always converts address as long as the PSB language is PL/I.
N
Never converts addresses.
Default
Not set. When the main program is a PL/I program, PCB addresses are converted from a direct to an indirect addressing technique.

ES_IMS_RCLASS

Creates a set of newly-named IMS security resource classes, appending a value to the default character of each resource class.
Syntax
ES_IMS_RCLASS=value
Parameters
value
Up to seven alphabetic characters.
Default
Not set. No new resource classes are created.
Comments
Create theses custom-named classes if you are using the same ESM active directory with two Enterprise Server systems and your security needs to differ for each.

See Resource Classes for IMS Security for the names of the resource classes created if this variable is not set.

ES_IMS_RELEASE

Specifies the IMS Release returned to the AIBTDLI INQY ENVIRON call.

ES_IMS_REGION

Allows the user to specify the IMS Region returned to the AIBTDLI INQY ENVIRON call.

ES_IMS_ROLLBACK

Enables automatic Backward Recovery; enabled by default.

ES_IMS_ROLLFORWARD

Enables or disables Forward Recovery logging.
Syntax
ES_IMS_ROLLFORWARD={Y|N}
Parameters
Y
Enables forward recovery logging.
N
Disables forward recovery logging.
Default
ES_IMS_ROLLFORWARD=N

ES_IMS_SINGLE

Enables or disables functionality that allows a single user to sign on to multiple LUs simultaneously.
Syntax
ES_IMS_SINGLE={Y|N}
Parameters
Y
Disables multiple sign-on functionality.
N
When ES_IMS_SINGLE is set to N, and a user attempts to sign on to an LU using a sign-on that is currently active at another LU, IMS Transaction Manager (TM) assigns a temporary LTERM to the user and LU using a name constructed from the ES_IMS_LTERM_PREFIX setting followed by a numerical value totalling eight characters (see IMS_LTERM_PREFIX for details). The temporary LTERM is the destination for the user and LU irrespective of activity at other LUs controlled by the user. When a user disconnects from an LU that is served by a temporary LTERM, the LTERM is returned to the temporary pool for reuse.

Also when ES_IMS_SINGLE is set to N, the execution of /dis USER all returns a sub-list for each user that shows all active connections. These connections persist throughout a session, and are dynamically recreated during a warm start. See IMS Control for details.

Default
ES_IMS_SINGLE=Y
Comments
No KEYPOINT activity is associated with the use of ES_IMS_SINGLE.

If an enterprise server region is running in a PAC with the IMS features enabled, then single signon will be enforced for IMS. If you want to change the behavior then set ES_IMS_SINGLE=N to enable the same user to signon to multiple terminals for IMS.

ES_IMS_SPARSE_EXIT_LANG

Specifies the language for IMS DB secondary index sparse routines.
Syntax
ES_IMS_SPARSE_EXIT_LANG=C
Parameter
C
Sets the language for IMS DB secondary index sparse routines to COBOL.
Default
Not set. Sparse exits are disabled.

ES_IMS_SUPPORT

Enables IMS support.

ES_IMS_TLOG_COMPRESS

Determines whether Backward Recovery TLOG files are compressed or not compressed.
Syntax
ES_IMS_TLOG_COMPRESS={0|1}
Parameters
0
Disables compression of the Backward Recovery TLOG file. When not compressed, the file contains only the information required to recover databases.
1
The Backward Recovery TLOG file is compressed. Enterprise Server reclaims space in the file when information becomes obsolete.
Default
ES_IMS_TLOG_COMPRESS=1

ES_IMS_TLOG_FLUSH (deprecated)

Determines whether the frequent flushing of TLOG and database buffers to disk is forced.
Attention: This environment variable is deprecated and provided for backward compatibility only. Use ES_IMS_DB_TLOG_WRITETHRU to flush TLOG buffers and ES_IMS_DB_COMMIT_FLUSH to flush database buffers.
Syntax
ES_IMS_TLOG_FLUSH={0|1}
Parameters
0
Does not flush TLOG and database buffers to disk.
1
Forces the frequent flushing of TLOG and database buffers to disk.
Default
ES_IMS_TLOG_FLUSH=0
Comments
Depending upon the number of database updates, the frequency of commits, and other computer activity, use of ES_IMS_TLOG_FLUSH could result in significant performance degradation.

ES_IMS_TLOG_MAXSIZE

Specifies the maximum size of the IMS DB transaction logging file.
Syntax
ES_IMS_TLOG_MAXSIZE=hex-value
Parameter
hex-value
A hexadecimal value that represents the maximum size for the transaction logging file in bytes.
Default
ES_IMS_TLOG_MAXSIZE=h"FFF00000"

(4GB)

ES_IMS_TLOG_PATH

The location of IMS DB transaction logging (TLOG) files.
Syntax
ES_IMS_TLOG_PATH=path-name
Parameter
path-name
The full path to the location where TLOG files are stored.
Default
Not set. Uses the Enterprise Server system directory.
Comments
Once created, you can move log files, but do not rename them. Before attempting to recover a database, all log files must reside in the directory specified by ES_IMS_TLOG_PATH.

ES_IMS_TLOG_THRESHOLD

Sets the threshold size of the IMS DB transaction logging file. When the threshold is reached, the current TLOG file is closed and a new TLOG file created for subsequent transactions.
Syntax
ES_IMS_TLOG_THRESHOLD=hex-value
Parameter
hex-value
A hexadecimal value that represents the threshold size for the transaction logging file in bytes.
Default
ES_IMS_TLOG_THRESHOLD=h"7FFFFFFF"

(2GB)

ES_IMSCFG

The location of the IMSCONFG.DAT IMS configuration file.
Syntax
ES_IMSCFG=path-name
Parameters
path-name
The full path to the location of the IMSCONFG.DAT file.
Default
Not set.

ES_IMSDAT

The location of IMS DB data files.
Syntax
ES_IMSDAT=path-name
Parameters
path-name
The full path to the directory that stores IMS DB data files.
Default
Not set. Uses the current working directory.

ES_IMSLIB through ES_IMSLIB25

ES_IMSLIB specifies the location of DBDGEN2.DAT, DBDGEN2F.DAT and PSBGEN3.DAT files. You can use this same variable with a sequential number appended to search additional locations.
Syntax
ES_IMSLIB[1...25]=path-name
Parameters
path-name
The full path to the location of DBDGEN2.DAT, DBDGEN2F.DAT and PSBGEN3.DAT files.
Default
Not set. Looks for the .DAT files in the current working directory.
Comments
You may specify up to 25 locations.
Example
ES_IMSLIB=$BASEPATH\ED_SETS\IMSLIB		      /*sets the first location for IMSLIB objects */
ES_IMSLIB2=$BASEPATH \ED_SETS_SYS\IMSLIB  /* sets the next location to search */
ES_IMSLIB3=$BASEPATH \ED_SETS_QA\IMSLIB		 /* and the next */
ES_IMSLIB4=$BASEPATH \ED_SETS_PROD\IMSLIB	/* etc. */

ES_INQFILE_RETURN

Modifies EXEC CICS INQUIRE FILE behavior for cataloged files.
Syntax
ES_INQFILE_RETURN={DSN|PCN}
Parameters
DSN
The DSN is returned. For an alternative file, the BASEDSNAME is the DSNAME of the BASE file.
PCN
The PC name of the file (truncated at 44 characters) is returned if the file is open, or if FCT fix-up has been performed. Otherwise, the dataset name is returned.
Default
ES_INQFILE_RETURN=PCN

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.
Default
Not set.
Example
In this example, 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_BYTES=(100,DUMP)

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.
Default
Not set.
Example
In this example, each card is assumed to hold 25 lines; therefore at 750 lines (25×30) a warning message is issued the job continues.
ES_JES_CARDS=(30,WARNING)

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.
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.
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.
Default
ES_JES_DISABLE_RESTART_FLUSH=N

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.

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.
Default
ES_JES_ENFORCE_EXPIRE_DATE=Y
Comments
Use the PURGE keyword to delete non-expired datasets.

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 APIs, once the spool file has been created.
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.
Default
ES_JES_FREE_SSTM_SYSOUT=N
Comments

Setting ES_JES_FREE_SSTM_SYSOUT=Y helps to avoid problems with receiving out of memory errors when creating multiple new files.

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

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.
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}
Parameters
VSE
Default JCL type of VSE.
JES2
Default JCL type of JES2.
JES3
Default JCL type of JES3.
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.
Default
Not set.
Example
In the following example, each card is assumed to hold 25 lines; therefore at 750 lines (25×30) a warning message is issued and the job continues. Limit the number of lines output to 100000. When this limit is reached, cancel the job. This produces an S722 Output limit exceeded system abend code:
ES_JES_LINES=(100,CANCEL)

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.
Default
ES_JES_LISTCAT_YMD=N

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=(max-lines[,{WARNING|CANCEL|DUMP}])
Parameters
max-lines
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.
Default
Not set.
Example
A warning is issued when 5000 lines of output is exceeded:
ES_JES_OUTLIM=5000

The job is canceled when 1000 lines of output are reached.

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.
Default
Not set. No limit to the number of pages output.
Example
In this example, 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_PAGES=10

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.
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.
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.
Default
Not set.

ES_JES_SPOOL_ORDER

The order in which the spool list is displayed when you first open ESMAC.
Syntax
ES_JES_SPOOL_ORDER=1
Parameter
1
Displays the list in descending order by JOBID.
Default
Not set. Displays the list 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}
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.
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.
Default
Not set.
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_KEEP_STDERR

Enables you to redirect stderr to a file in your workarea.
Syntax
ES_KEEP_STDERR=any-value
Parameters
Not applicable.
Default
No default.
Comments
The file created in the workarea will take the form stderr.PID.

ES_LE370_SUPPORT

Enables support for Language Environment (LE) in CICS applications
Syntax
ES_LE370_SUPPORT=Y
Parameter
Y
Enables LE support.
Default
Not set. LE support is not enabled.
Comments
Parameter value is not case sensitive.

ES_LEGACY_ECI

Indicates that Enterprise Server must use Micro Focus ECI instead of IBM CTG.
Syntax
ES_LEGACY_ECI=Y
Parameter
Y
Micro Focus ECI is used.
Default
Not set. IBM CTG is used.
Comments
Parameter value is not case sensitive.

ES_LOCKDB

Specifies the region database that is to process resource locking (step- and system-scoped ENQs) for an enterprise server region within a cluster, where resources such as catalogs are deployed to a database.
Syntax
ES_LOCKDB=region-db
Parameter
region-db
The name of the region database responsible for processing step- and system-scoped ENQs.
Default
Not set.
Comments
This variable must be used in conjunction with ES_SERVER, in which ES_SERVER is set to the database server that houses the region database; see Resource Locking for more information.

ES_MAX_CATALOG_LINES

Restricts the number of entries displayed in ESMAC catalog view.
Syntax
ES_MAX_CATALOG_LINES=number
Parameter
number
The number of lines to display up to a maximum of 99999.
Default
ES_MAX_CATALOG_LINES=5000
Comments
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.

ES_MAX_HTTP_OUT

Specifies the maximum size of the HTTP response sent by Enterprise Server.
Syntax
ES_MAX_HTTP_OUT=value
Parameter
value
A number representing the maximum size of the HTTP response in bytes.
Default
ES_MAX_HTTP_OUT=
Comments
In earlier releases, the size of the HTTP response was controlled by the HTTP Out field on the ESCWA ES Control page.

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.

ES_MEM_STRATEGY

Selects the types of memory processes supported.
Comments
Memory strategy can also be set via the memory_strategy run-time tunable.

ES_MFDS_ADDRESS

Specifies the server address is used by casstart when the /m parameter is not provided.

ES_MFSLIB

The location of the control blocks generated by the MFS generation program.
Syntax
ES_MFSLIB=path-name
Parameter
path-name
The path to the MFS directory.
Default
ES_MFSLIB=$COBDIR/etc/ims

ES_MOD3650

Replaces the default MOD file displayed after a successful sign-on to IMS. See ES_DFS3650 for further details.
Syntax
ES_MOD3650=file-name
Parameter
file-name
The name of the replacement default MOD file.

ES_MQ_1PC

Indicates whether the IBM WebSphere MQ switch module ESMQXA operate in one-phase commit mode.
CAUTION:
Set this environment variable only when advised to do so by OpenText Support for Micro Focus Products.
Syntax
ES_MQ_1PC={[Y|y|Yes|T|True]|[N|n|No|F|False}
Parameters
Y|y|Yes|T|True
The ESMQXA switch module operates in one-phase commit mode.
N|n|No|F|False
The ESMQXA switch module operates in two-phase commit mode.
Default
ES_MQ_1PC=F

ES_MQ_LIB

The full name including the path of the IBM WebSphere MQ client or server library. This should only be required if MQ was NOT installed in the default location.
Syntax
ES_MQ_LIB=path-name/library-name
Parameters
path-name
The full path to the library location.
library-name
The name of the library file.
Default
Not set. Enterprise Server looks for library files in the default location for your platform.
Comments
In AIX environments the library is an object inside a shared object. For example:
ES_MQ_LIB="/usr/mqm/lib64/libmqmxa64.a(libmqm64.o)"

ES_MQ_LIB_T

For threaded environments, the full path to and file name of the IBM WebSphere MQ client or server library. Required only when WebSphere MQ was not installed in the default location.
Syntax
ES_MQ_LIB_T=path-name/library-name
Parameters
path-name
The full path to the threaded library location.
library-name
The name of the threaded library file.
Default
Not set. Enterprise Server looks for threaded library files in the default location for your platform.

ES_MQ_LIB_XA

The full path to and file name of the IBM WebSphere MQ XA library. Required only when WebSphere MQ was not installed in the default location
Syntax
ES_MQ_LIB_XA=path-name/library-name
Parameters
path-name
The full path to the library location.
library-name
The name of the library file.
Default
Not set. Enterprise Server looks for library files in the default location for your platform.
Comments
In AIX environments, the library is an object inside a shared object. For example:
ES_MQ_LIB_XA="/usr/mqm/lib64/libmqmxa64.a(libmqm64.o)"

ES_MQ_LIB_XA_T

The full path to and file name of the IBM WebSphere MQ XA library for threaded environments. Required only when WebSphere MQ was not installed in the default location
Syntax
ES_MQ_LIB_XA_T=path-name/library-name
Parameters
path-name
The full path to the threaded library location.
library-name
The name of the threaded library file.
Default
Not set. Enterprise Server looks for threaded library files in the default location for your platform.

ES_MQ_LISTENER (deprecated)

Defines one or more WebSphere MQ listeners.
Note: ES_MQ_LISTENER is deprecated, and provided for backward compatibility only. We recommend that you configure MQ listeners in ESCWA. See MQ Listeners for details.
Syntax
ES_MQ_LISTENER={queue-manager-name,queue-name,listener-name}
[[,queue-manager-name,queue-name,listener-name][...]]
Parameters
queue-manager-name,queue-name,listener-name
Characteristics of the listener being defined.
Default
Not set. Uses MQ listeners as defined in ESCWA, or, if not defined in ESCWA, no WebSphere MQ listeners are defined.

ES_MQ_XA

The type of XA structure to use for the two-phase commit XA switch module.
Syntax
ES_MQ_XA={D|S}
Parameters
D
Use a dynamic XA structure
S
Use a static XA structure.
Default
ES_MQ_XA=D

ES_OLD_DYN_PDS

Determines the resulting behavior of dynamic PDS members when specified in a JCL DD statement.
Syntax
ES_OLD_DYN_PDS={Y|N}
Parameters
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
ES_OLD_DYN_PDS=N

ES_OLD_SEC_TSTD

Prevents security being enforced for TS or TD queues that are not declared in the security repository.
Syntax
ES_OLD_SEC_TSTD=ON
Parameter
ON
Prevents security being enforced for TS or TD queues that are not declared in the security repository.
Default
Not set. security is enforced for TS or TD queues that are not declared in the security repository.
Comments
This environment variable is considered to be turned on when set to any value, including ON.

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

The time in seconds that an OTMA client should wait for an answer.
Syntax
ES_OTMA_TIMEOUT=wait-time
Parameter
wait-time
The number of seconds to wait. The maximum is 43199.
Default
ES_OTMA_TIMEOUT=120

(2 minutes)

ES_PAC_NO_GLOBAL_LOG

Stops the messages in the console.log from being stored in the PAC Scale-out Repository (PSOR) CasPacLog.
Syntax
ES_PAC_NO_GLOBAL_LOG={Y|N}
Parameters
Y
Prevents console.log messages for PAC member regions from being stored in the PSOR.
N
console.log messages for PAC member regions are stored in the PSOR.
Default
ES_PAC_NO_GLOBAL_LOG=N
Comments
You can set ES_PAC_NO_GLOBAL_LOG=Y to improve performance if you are not monitoring messages from the PSOR.

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.

ES_PL1_MFFH_JCL

Enables you to run Open PL/I programs that access JCL data definitions.
Syntax
ES_PL1_MFFH_JCL={Y|N}
Parameters
Y
You can run Open PL/I programs that access JCL data definitions.
N
Open PL/I programs cannot access JCL data definitions.
Default
ES_PL1_MFFH_JCL=N

ES_PRODUCTION

Prevents the initiation of a debugging session from the IDE.
Comments
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.

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.
Default
Not set.

ES_RDO_MAX_RESOURCES

Specifies the maximum number of records for CICS resource types that display in Enterprise Server Common Web Administration (ESCWA) or Enterprise Server Monitor and Control (ESMAC).
Comments
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.

ES_RLS_FILE_SUPPORT

If a record is locked because a program is doing a read for update, and the application needs to ensure that no other program can access that record, you can set this environment variable to avoid returning a dirty record until the program holding the lock has completed.
Syntax
ES_RLS_FILE_SUPPORT=Y
Parameter
Y
Stops dirty records being returned when a record is locked by another process.
Default
Not set. Dirty records are returned.
Comments
The timeout in fileshare also needs to be set to 0 using /t 0 in the fileshare configuration file. See Using a Fileshare Configuration File for details.

Parameter values are not case sensitive.

ES_RTLS_CERT_AUTH_FILEPATH

The absolute path to the certificate authority file used for a TLS-enabled Redis SOR.
Syntax
ES_RTLS_CERT_AUTH_FILEPATH=path-name
Parameter
path-name
The full path to the certificate authority file used for a TLS-enabled Redis SOR.

ES_RTLS_CERT_FILEPATH

Absolute file path to the certificate file used for a TLS-enabled Redis SOR.
Syntax
ES_RTLS_CERT_FILEPATH=path-name
Parameter
path-name
The full path to the certificate file used for a TLS-enabled Redis SOR
Default
Not set.

ES_RTLS_PRIVATE_KEY_FILEPATH

Absolute file path to the private key file used for a TLS-enabled Redis SOR.
Syntax
ES_RTLS_PRIVATE_KEY_FILEPATH=path-name
Parameter
path-name
The full path to the private key file used for a TLS-enabled Redis SOR.
Default
Not set.

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.
Default
Not set.

ES_SEP_DORMANT_TIME

Allows override of Transient SEP dormant time. Rather than automatically terminating transient SEPs on completion of a stateful request, the server manager allows a period of inactivity before scheduling their termination. This allows new requests to re-use the SEP rather than starting a new instance. This environment variable allows you to control the period of inactivity.
Syntax
ES_SEP_DORMANT_TIME=wait-time
Parameter
wait-time
The number of seconds that the Transient SEP is inactive.
Default
ES_SEP_DORMANT_TIME=2
Comments
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.

ES_SERVER

The default server name used if no -r switch is specified on casstart or casstop.
Syntax
ES_SERVER=server-name
Parameter
server-name
The server name.
Defaults
32-bit
ES_SERVER=ESDEMO
64-bit
ES_SERVER=ESDEMO64

ES_SNATRC_DIR

Specifies the location of the SNA traces written by the z/OS communication manager.
Syntax
ES_SNATRC_DIR=path-name
Parameter
path-name
The full path to the location of SNA traces.
Default
Not set.
Comments
You must set this environment variable before you start the region to ensure that the SNA trace files are written to a valid directory.

This directory is then used to set up the SNA environment variables SNAMSG and SNATRC to appropriate values.

ES_SCALE_OUT_REPOS_n

Specifies connection information for either Redis or Oracle Coherence data stores used by enterprise server regions that are part of a PAC.
Syntax
ES_SCALE_OUT_REPOS_n=sor-name=sor-Type,
   {redis-connection-details|oracle-connection-details}##[TMP#][models]
Parameters
n
Represents the SOR number. Valid values are 1 through 9.
sor-name
The name of the SOR. No spaces are allowed. In the context of using Redis, the SOR name is used to retrieve the Redis master from Redis.
sor-type
This is the type of data store. Valid values are:
redis Regular connection to a Redis data store
redis_TLS TLS -enabled connection to a Redis data store
coherence Oracle Coherence connection to an Oracle data store
redis-connection-details
One or more host and port name pairs used for Redis connections as follows:
host-name:port-name[,host-name:port-name[...]]
host-name The machine name or IP address of the host system where data stores are location
port-name The port used to make the connection to the host specified by the corresponding host-name
oracle-connection-details
[userid@][path-name|URL][config-file]
   [,java-property[[=java-property-value]][…]]##[TMP#]
   [={TS=ts-model[:ts-model]|TD=td-model[:td-model]}]
   [[#{TS=ts-model[:ts-model]|TD=td-model[:td-model]}]][...]]
userid@ The user ID to use when Oracle Coherence security is enabled.
path-name The path to the configuration file represented by config-file. If omitted, defaults to the current working directory.
URL A URL that contains the configuration content.
config-file The name of the cache configuration file. If omitted, defaults to mfes-cache-config.xml.
java-property The name of a Java property to set to the specified java-property-value, or is clear if java-property-value is unspecified.
java-property-value The value of the property specified by java-property.
# Delimiter character.
TMP Indicates that this PSOR stores active resources.
TS Indicates temporary storage resource type.
TD Indicates transient data resource type.
ts-model An identifier for the corresponding TS consisting of either a character string no more than four bytes in length.1
td-model An identifier for the corresponding TD consisting of a character string no more than 16 bytes in length.1
1 You may use the * wildcard character to represent any string, and the + character to represent any single character. Identifiers of a size smaller than the byte limit are automatically padded using + characters to extend the length to the limit.
Default
None. You must set ES_SCALE_OUT_REPOS_n for all enterprise server regions that are part of a PAC.
Comments
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.
Examples
See PAC and SOR Environment Variables.

ES_SOR_RETRIES

Sets the number of attempts to access records in the PSOR before stopping.
Syntax
ES_SOR_RETRIES=integer
Parameter
integer
An integer value ranging from 1 through 1000 that represents the number of attempts to access records in the PSOR before stopping.
Default
ES_SOR_RETRIES=10
Comments
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.

ES_SSTM_CICS

Location of the JCL used to initialize the SSTM CICS environment.
Syntax
ES_SSTM_CICS=file-location
Parameter
file-location
The full path to the location of the SSTMCICS.JCL file used to initialize the SSTM CICS environment.
Default
Not set.

ES_SSTM_IMS

Location of the JCL used to initialize the SSTM IMS environment.
Syntax
ES_SSTM_IMS=file-location
Parameter
file-location
The full path to the location of the JCL used to initialize the SSTM IMS environment.
Default
Not set.

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 ={Y|N}
Parameters
Y
Remove the CICS SSTM job from the Active queue.
N
Do not remove the CICS SSTM job from the Active queue.
Default
ES_SSTM_JOB_FLUSH_ACTIVE=N

ES_SURROGATE_JOB_USER

Associates a user ID with a job when submitting the job for processing through the internal reader from CICS.
Syntax
ES_SURROGATE_JOB_USER=ON
Parameter
ON
The user ID that started the enterprise server region is used in the job submission.
Default
Not set. The CICS default user CICSUSER, or as specified by ES_USR_DFLT_CICS, is used in the job submission.
Comments
This environment variable is considered to be turned on when set to any value, including ON.

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.

ES_SYSOUT_HOLD

Determines which SYSOUT files are sent to the Complete queue with an Out Hold status.
Syntax
ES_SYSOUT_HOLD={msg-class}[msg-class[...]]
Parameter
msg-class
A message class to send to the Complete queue with an Out Hold status.
Default
Not set. No specific message classes are sent to the Complete queue with an Out Hold status.
Example
Message classes A and B are sent to the Complete queue with an Out Hold status:
ES_SYSOUT_HOLD=AB

ES_TEST_TRANCLASS

Activates transaction class support.
Syntax
ES_TEST_TRANCLASS={Y|N}
Parameters
Y
Activate transaction class support.
N
Do not activate transaction class support.
Default
ES_TEST_TRANCLASS=N
Comments
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.

ES_TMC_AGGREGATE

Initializes performance settings for the IMS message queue, and enables dynamic performance tuning. Specifically, its twofold purpose is to:
  • Specify, at startup, either the default or an alternative method for flushing operating system buffers to disk.
  • Enable you to dynamically change the flushing method and apply it to the message queue without having to restart the enterprise server region.
Syntax
ES_TMC_AGGREGATE={[,N|,D]|nnn,Y}
Parameters
,N
Sets the default behavior, which is to unilaterally flush operating system buffers to your physical disk at each key transactional point. While this does not change the method used by default at startup, it does enable dynamic modification via ESCWA. Once set, you can then test the effect of various non-default settings by altering them dynamically.
,D
Disables the transactional flushing of operating system buffers to disk. This option can significantly enhance message queue performance; however, it is at the expense of the transactional integrity of the message queue in the event of a system failure.
Notes: To avoid unpredictable results when using this setting, Micro Focus recommends that you also set the static options as follows on ESCWA. Select enterprise server region you require, click IMS > Configuration and then click the TM tab:
  • Set the Cold start list to Everything.
  • Check Persist.

See Server Instance Properties: MSS IMS TM General for more information.

nnn,Y
Enables the aggregated transactional flushing of operating system buffers to disk where nnn represents an interval of time, in milliseconds, during which additional buffers are allowed to accumulate before flushing. Valid values are 0 through 255.

Once a thread reaches a key transactional point and requests a flush, TM waits the specified interval to accumulate subsequent threads that also request a flush. At the end of the interval, one flush is performed for all accumulated requests, thus potentially improving performance by reducing the number of flush commands issued to the operating system.

Note: Threads requesting a flush wait until the flush is confirmed.

Typically, when the message queue resides on a higher performance I/O subsystem such as one using SSDs, a smaller value, for example 1 or 2, produces the best results. A value of 10 or higher seldom improves performance.

Default
ES_TMC_AGGREGATE=,N

ES_TN3270_FORCE_ALT

Enables you to use a screen size other than the default when using a TN3270 terminal emulator.
Syntax
ES_TN2370_FORCE_ALT=ON
Parameter
ON
Enables alternative screen size.
Default
Not set. The default screen size is used.
Comments
This environment variable is considered to be turned on when set to any value, including ON.

ES_TN3270_MODEL_LOG

Writes the TN3270 emulator's model name to a temporary storage queue named TN32MODL that can be viewed using the CEBR transaction.
Syntax
ES_TN3270_MODEL_LOG=Y
Parameter
Y
Model names are written to TSQ TN32MODL.
Default
Not set. Model names are not logged.

ES_TRANCLASS_CWI

For CICS Web Services, enables the prioritizing and limiting of Web requests in a TRANCLASS-enabled region.
Syntax
ES_TRANCLASS_CWI={TCPIPSERVICE|URIMAP}
Parameters
TCPIPSERVICE
Prioritize and limit TCPIPSERVICE transactions.
URIMAP
Prioritize and limit URIMAP transactions.
Default
ES_TRANCLASS_CWI=TCPIPSERVICE
Comments
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.

ES_TRX3650

The default transaction to run after a successful sign-on to IMS. See ES_DFS3650 for further details.
Syntax
ES_TRX3650=transaction
Parameter
transaction
The default transaction to run.
Default
Not set.

ES_TSC_AGGREGATE

Controls the performance environment for CICS TS/TD data stores.
Syntax
ES_TSC_AGGREGATE=wait-time,{Y|N|D}
Parameters
wait-time
The time in milliseconds to wait for additional flush requests to accumulate.
Y
Use aggregate data store flush-buffers-to-disk operations
N
Do not aggregate
D
Disable flush operations.

ES_USR_DFLT_CICS

Allows you to override the default user when no user is logged on for CICS authentication.
Syntax
ES_USR_DFLT_CICS=userid
Parameter
userid
An alternative default user name.
Default
ES_USR_DFLT_CICS=CICSUSER
Comments
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.

ES_USR_DFLT_ESMAC

Allows you to override the default user when no user is logged on for ESMAC authentication.
Syntax
ES_USR_DFLT_ESMAC=userid
Parameter
userid
The default user name.
Default
ES_USR_DFLT_ESMAC=MFUSER
Comments
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.

ES_USR_DFLT_IMS

Allows you to override the default user when no user is logged on for IMS authentication.
Syntax
ES_USR_DFLT_IMS=user-id
Parameter
user-id
The user name to override the default.
Default
ES_USR_DFLT_IMS=IMSUSER
Comments
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.

ES_USR_DFLT_JCL

Enables you to override the default user when no user is logged on for JCL authentication.
Syntax
ES_USR_DFLT_JCL=userid
Parameter
userid
The default user name.
Default
ES_USR_DFLT_JCL=JESUSER
Comments
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.

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=userid
Parameter
userid
The default user name.
Default
ES_USR_DFLT_JES=JESUSER
Comments
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.

ES_WORKING_MODE

The bitism of the server, 32- or 64-bit.
Syntax
ES_WORKING_MODE={32|64}
Parameters
32
Indicates that the server runs in 32-bit mode.
64
Indicates that the server runs in 64-bit mode.
Default
ES_WORKING_MODE=64
Comments
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.

ES_WS_RUNAWAY_TIMEOUT

Time that the client waits for a response from the Web service. Valid values are 0 to 65535 seconds.
Syntax
ES_WS_RUNAWAY_TIMEOUT=wait-time
Parameter
wait-time
Time in seconds that the client waits for a response from the Web service. Valid range is 0 through 65535.
Default
Not set.

ES_XA_%xaname%_OPTIONS

When set with ES_XA_RECONNECT=Y, configures the XA reconnect process to operate in a multi-attempt mode.
Syntax
ES_XA_%xaname%_OPTIONS={reconnect_attempts,wait-time|EX}
Parameters
%xaname%
The name of the RM as specified in MFDS or ESCWA.
reconnect_attempts
The number of reconnect attempts to the target RM. Maximum is 9999.
wait-time
The number of seconds to delay between each attempt.
EX
Exclude the target RM from XA reconnect processing.
Default
Not set.
Comments
ES_XA_%xaname%_OPTIONS must be set along with ES_XA_RECONNECT=Y.

You might need to set ES_XA_%xaname%_OPTIONS multiple times — once for each RM that you require to operate in a multiple-attempt mode.

Examples
Specify that an XA reconnect processing attempts to reconnect to MQPROD 100 times and waiting for 10 seconds between each reconnect attempt:
ES_XA_MQPROD_OPTIONS=100,10

Specify that the XA reconnect processing is to exclude MQPROD from the XA reconnect processing:

ES_XA_MQPROD_OPTIONS=EX

ES_XA_ABEND

Recycles non-batch SEPs when a severe error is returned by an xa-start by an Oracle switch.
Syntax
ES_XA_ABEND=RECYCLE
Parameter
RECYCLE
Recycles non-batch SEPs when a severe error is returned by an xa-start by an Oracle switch.
Default
Not set. Non-batch SEPs are not recycled.

ES_XA_LOG_SUPPRESS

Suppresses XA logging and the recovery of in-doubt XA transactions.
Syntax
ES_XA_LOG_SUPPRESS=Y
Parameter
Y
Default
Not set. XA logging is not suppressed.
Comments
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.

Parameter value is not case sensitive.

ES_XA_RECONNECT

Configures the XA reconnect process to operate in a single-attempt mode.
Syntax
ES_XA_RECONNECT=Y,wait-time[,retry_count]
Parameters
Y
Enables the reconnect process.
wait-time
The number of seconds to delay before triggering the XA recovery transaction after a two-phase commit failure and between each reschedule of the XA recovery transaction if the syncpoint phase 2 returns an RC 04. Maximum is 300.
retry_count
The number of recovery retries to attempt when the XA commit or rollback executed by the XA recovery transaction returns an RC-04. Default is 5.
Default
Not set. XA reconnect operates in multi-attempt mode.
Comments
In case of failure, the following messages are sent to the console:
CASXO0054W XA recovery error RC=4 on commit in-doubt transaction RM: RM01 RC:  00004 XID: MF_CAS  DEMOMYREG           000000***********000010000000**        0000

When the maximum number of retries is reached, the following message is sent to the console:

CASXO0055S XA MAX recovery attempts, manually commit in-doubt transaction RM: RM01 RC:  00004 XID: MF_CAS  DEMOMYREG       000000***********000010000000**        0000
Example
ES_XA_RECONNECT=Y,120,4

ES_ZOS_SYSPRINT_DCB

Enables MFJAMS SYSPRINT to have the same DCB attributes as the IDCAMS SYSPRINT.
Syntax
ES_ZOS_SYSPRINT_DCB={Y|N}
Parameters
Y
Enable MFJAMS SYSPRINT to use the same DCB attributes as the IDCAMS SYSPRINT.
N
MFJAMS SYSPRINT is not enabled to use the same DCB attributes as the IDCAMS SYSPRINT.
Default
ES_ZOS_SYSPRINT_DCB=N

EXTFH

Specifies a configuration file for the Callable File Handler.
Syntax
EXTFH=file-name.cfg
Parameter
file-name
The prefix name of the configuration (.cfg) file.
Default
Not set. The default configuration file name prefix is extfh.
Example
EXTFH=/home/mydir/myconfig.cfg

F

FHREDIR

Specifies a configuration file to be used by the Fileshare Client.
Syntax
FHREDIR=[path-name/]prefix.cfg}
Parameters
path-name
The full path to the location of the Fileshare Client configuration file.
prefix
The prefix name of the configuration (.cfg) file.
Default
Not set. Uses the fhredir.cfg file in the current working directory.
Example
FHREDIR=/home/mydir/myconfig.cfg

FS

Specifies a configuration file to be used by the Fileshare Server.
Syntax
FS=file-name.cfg
Parameter
file-name
The prefix name of the configuration (.cfg) file.
Default
FS=fs.cfg
Example
FS=myfsconf.cfg

FSCOMMS

Specifies that the Fileshare system is to run in single user mode.
Syntax
FSCOMMS="\$local"
Parameter
$local
Run the Fileshare System in single user mode.
Default
Not set. Fileshare system runs in multi-user mode.

G

GDG.RECALL

Controls the recall of HSM archived datasets when accessing mainframe GDGs using MFA Data Access Services.

GDG_RESTART_UCC11_ONLY

Determines when GDG restart information should be written.
Syntax
GDG_RESTART_UCC11_ONLY={Y|N}
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.)
Default
GDG_RESTART_UCC11_ONLY=Y

H

HCOBND (deprecated)

Specifies a directory to be used for bind files generated by the DB2 External Compiler Module (ECM).
Attention: HCOBND is deprecated and provided for backward compatibility only. We recommend that you use either the BIND or the BINDDIR compiler directive option instead.
Syntax
HCOBND=path-name
Parameter
path-name
The directory that the DB2 ECM is to use to store bind files.
Default
Not set. Looks only in the current working directory for bind files generated by the DB2 ECM.
Comments
The DB2 ECM uses the specified directory until the variable is unset or reset to a different directory. The DB2 Compiler directive option BIND overrides this environment variable.
Example
HCOBND=/mydir/binds

HOST_DISP

Determines whether JCL DISP is honored for DELETE on mainframe resident datasets.
Syntax
HOST_DISP={ON|OFF}
Parameters
ON
JCL DISP is honored for DELETE.
OFF
JCL DISP is not honored for DELETE.
Default
HOST_DISP=OFF

HOST_NEW

Determines whether JCL looks on the host for new datasets that are not cataloged locally.
Syntax
HOST_NEW={ON|OFF}
Parameters
ON
JCL looks on the host for new datasets not cataloged locally.
OFF
JCL does not look on the host for new datasets not cataloged locally.
Default
HOST_DISP=OFF

I

ICONN1

Controls the client TCP connection status of an IMS Connect emulator.

IMSCPY

The location of copybook files for DBDGEN, PSBGEN and MFSGEN utilities.
Syntax
IMSCPY=path-name
Parameter
path-name
The full path to the location of compiled COBOL applications.

ISPPROF

The location of ISPF dialog profiles.

J

JAVA_HOME

Specifies the location of the JDK.
Syntax
JAVA_HOME=path-name
Parameter
path-name
The full path to the location of the JAVA_HOME location.

JCLTEMP_DIR

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.

JES_PRINT_SPOOL_MSG

Specifies the disposition of the spool data set printing message (JES000029I).
Syntax
JES_PRINT_SPOOL_MSG={CONSOLE|LOG|SILENT}
Parameters
CONSOLE
Send spool data to the console.log file.
LOG
Send spool data to 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 it specifies that no audit log of your spool data sets is created.
Default
JES_PRINT_SPOOL_MSG=CONSOLE
Comments
This environment variable is intended for high-print-load users, meaning that a high number of print requests are sent to the console. This could affect system performance.

L

LANG

Specifies the locale.
Syntax
LANG=unix-language[_territory[.code-page]]
Parameters
unix-language
The spoken/written language in which your program is to run. This determines which message catalog is open so that if an error occurs, the error message is output in the selected language. unix-language can take any of the following values:
Value Language
en_US US English
en_GB UK English
jp_JP Japanese (EUC encoding)
jp_JP.sjis Japanese (Shift-JIS encoding)
jp_JP.utf8 Japanese (UTF8 encoding)
territory
The country in which your program is to run.
code-page
The character set code to use for your program.
Default
Not set.
Example
LANG=fr_FR

LD_LIBRARY_PATH

Specifies the directory or directories for the UNIX system, cob command, and the run-time system to search for shared libraries and callable shared objects.
Syntax
LD_LIBRARY_PATH={$COBDIR/lib|path-name}[:path-name[...]]
Parameter
path-name
The full path to a directory to search.
Default
Not set. Looks in the current working directory only.
Comments
This environment variable is a system environment variable; see your UNIX documentation for more information.

If you have installed the product to a directory other than the default, you must set this variable, and include $COBDIR/lib on all platforms except AIX (which uses LIBPATH). It should also include any directories that contain callable shared objects used by your application.

If you have installed the product in the default directory (/opt/microfocus/EnterpriseDeveloper), you do not need to set this variable.

Example
LD_LIBRARY_PATH=$COBDIR/lib:/home/mydir/myapp:$LD_LIBRARY_PATH

LIB

The location of the DB2 LIB directory.
Syntax
LIB=path-name
Parameter
path-name
The path to your Windows SDK LIB directory (x86) containing .lib files such as odbc32.lib.
Comments
his environment variable is set in the system registry. You can change the values using the SET command, but values you set are only added to the values already set in the registry.

LIBPATH

On AIX platforms only, specifies the directory or directories for the UNIX system, cob command, and the run-time system to search for shared libraries and callable shared objects.
Syntax
LIBPATH={$COBDIR/lib|path-name}[:path-name[...]]
Parameter
path-name
The full path to a directory to search.
Default
Not set. Looks in the current working directory only.
Comments
If you have installed the product on an AIX platform and to a directory other than the default, you must set this variable, and include $COBDIR/lib. It should also include any directories that contain callable shared objects used by your application.

If you have installed the product in the default directory (/opt/microfocus/EnterpriseDeveloper), you do not need to set this variable.

Example
LIBPATH=$COBDIR/lib:/lib:/usr/lib

LINES

Specifies the depth of the terminal screen or window, overriding the specified terminal default.
Syntax
LINES=line-depth
Parameter
line-depth
The depth of the terminal screen or window, in lines.
Default
Uses the lines value as defined in the specified terminal's terminfo entry, or the current depth of the terminal window if you are using X windows.
Note: The terminal type is specified via the standard UNIX environment variable, TERM.
Comments
On non-windowing environments, where the terminal screen area cannot be resized, the LINES values does not need to be set.

In windowing environments, where the size of windows can be changed, the initial size of the window is used in preference to the lines value in terminfo. When the window is resized, the new size is reread. If the new size is greater than the initial size then the extra lines might not be used.

If you want to use the full depth of the window you might need to set LINES to the current depth of the window on some platforms.

Using LINES values that do not correspond to the actual depth of the window produces unexpected results.

Example
LINES=50

M

MAINFRAME_FLOATING_POINT

Specifies the format to use for floating point data items. Possible formats are IBM hexadecimal and IEEE.
Syntax
MAINFRAME_FLOATING_POINT={true|false}
Parameters
true
Use IBM hexadecimal-format floating-point data items.
false
Use IEEE-format floating-point data items.
Default
MAINFRAME_FLOATING_POINT=false
Comments
The setting of this environment variable can be overridden by the NATIVE-FLOATING-POINT directive.

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.
Default
Not set.
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_AMODE31ONLY

Indicates that all programs are AMODE(31).

MF_CHARSET

Specifies the system character set.
Syntax
MF_CHARSET={{A|ASCII}|{E|EBCDIC}}
Parameters
A|ASCII
Use the ASCII character set.
E|EBCDIC
Use the EBCDIC character set.
Default
MF_CHARSET=A

MF_CBLQDA

Determines if QSAM files are dynamically allocated
Syntax
MF_CBLQDA={ON|OFF}
Parameters
ON
Dynamically allocate QUSAM files when processing an OPEN I-O or OPEN EXTEND statement for an optional file (i.e., a file opened using the SELECT OPTIONAL syntax in the FILE-CONTROL paragraph) or a file opened for OUTPUT, whether it is optional or not.
OFF
Dynamic allocation is not permitted.
Default
MF_CBLQDA=OFF
Comments
This is an emulation of the CBLQDA Language Environment (LE) run-time option.

When set to ON, and your JCL contains a misspelled or no DD statement for the file being opened, a temporary file is created as a result of the OPEN statement, and then deleted after the program has run. For optional files opened for I-O or for EXTEND, you receive a return code of 05; for files opened for OUTPUT, you receive a return code of 00.

This variable has no effect on VSAM applications or the JCL utility programs.

For programs that use ESDS files and have this variable set ON, ensure that FILETYPE is set to 15 or 16; otherwise these files will be affected by the variable, and treated as QSAM files.

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.
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.
N
Do not check that the main COBOL program ends by executing a GOBACK or STOP RUN.
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.
Default
MF_IKJEFT_KEEP_MAX=N

MF_JCL_AUDIT

Specifies that audit information is written to the audit log when a catalog entry is deleted.
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.
Default
Not set.
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

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={Yes|No|return-code}
Parameters
Yes
Generates an S482 abend.
No
Does not generate an abend.
return-code
A numeric value up to three digits to be used as the return code.
Default
MF_JES_ABEND_CAF_COMMIT=Yes

MF_JESPWR_EXIT

Passes JES2 and VSE PWR statements to the MFJESPWR user exit.
Syntax
MF_JESPWR_EXIT=Y
Parameter
Y
Pass JES2 and VSE PWR statements to the MFJESPWR user exit.
Default
Not set.
Comments
When set, the JCL execution engine calls the MFJESPWR exit program 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_LE_CBLOPTS

Specifies whether classic COBOL style options are in effect.
Syntax
MF_LE_CBLOPTS={Y|N}
Parameters
Y
Enables classic COBOL style options.
N
Disables classic COBOL style options.
Default
MF_LE_CBLOPTS=N
Comments
When disabled, or when the dialect is ENTCOBOL, or when the language is not COBOL, PARM syntax is of the following form:
[run-time-options] [/program-options];

Otherwise, the syntax is of the form:

[program-options] [/run-time-options]

MF_LEX_API

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|D
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.
Example
This example sets the JES configuration to use a single LEX file stored in directories.
MF_LEX_API=2D

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.
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.
Default
MF_MVSJOB=0001000+0099999
Comments

This environment variable can be used to enable a seven-digit Job number limit. If the upper-value 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=lower-limit+upper-limit

Where upper-limit is less than 0099999, and ensuring that the + sign is used to separate the low and high values.

Example
Resets the values to start with job number 10 and run through to job number 100:
MF_MVSJOB=0000010+0000100

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.
Default
Not set. All records are written to the catalog export XML file

MF_NEWSPACE

Indicates whether SPACE is required for NEW datasets.

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.
Default
MF_NODD=A

MF_OPENLDAP_DEBUG

Enables you to set the LDAP_OPT_DEBUG_LEVEL value using decimal representation.
Syntax
MF_OPENLDAP_DEBUG=decimal_debug_value
Parameters
Sum the decimal debug values you require:
1
LDAP_DEBUG_TRACE
2
LDAP_DEBUG_PACKETS
4
LDAP_DEBUG_ARGS
8
LDAP_DEBUG_CONNS
16
LDAP_DEBUG_BER
32
LDAP_DEBUG_FILTER
64
LDAP_DEBUG_CONFIG
128
LDAP_DEBUG_ACL
256
LDAP_DEBUG_STATS
512
LDAP_DEBUG_STATS2
1024
LDAP_DEBUG_SHELL
2048
LDAP_DEBUG_PARSE
16384
LDAP_DEBUG_SYNC
32768
LDAP_DEBUG_NONE
-1
LDAP_DEBUG_ANY
Default
Not set.
Comments
For Enterprise Server processes, the ES_KEEP_STDERR environment variable must also be set.
Example
MF_OPENLDAP_DEBUG=16657

Sets LDAP_DEBUG_SYNC, LDAP_DEBUG_STATS, LDAP_DEBUG_BER, and LDAP_DEBUG_TRACE.

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
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.
Default
MF_RCCF=DELETEJOB

MF_ROOT_CERT

Enables the MF Directory Server process and any client applications to find the root certificate file.

MF_SET_USERID

Sets the default user ID.
Syntax
MF_SET_USERID=userid
Parameter
userid
The user ID to set as the default.
Default
Not set. The default user ID is mfuser.

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.
Default
MF_SMS=OFF
Comments
MSS provides emulation for SMS data classes only.

To enable DATACLAS support this variable needs to be ON in addition to setting MFUSERCAT_NODE=SYSMFE1.

MF_SPLJNO_LOCK

Determines whether job number acquisition is enqueued to reduce file and disk access or handled with file locks to improve performance when running JCL jobs on multiple processes.
Syntax
MF_SPLJNO_LOCK=Y
Parameter
Y
Enqueue job number acquisition.
Default
Not set. Job number acquisition is handled with file locks, which can improve performance when running JCL jobs on multiple processes.
Comments
The parameter value is not case sensitive.

Setting MF_SPLJNO_LOCK to no value or any value other than Y or y results in the default behavior.

MF_SPOOL_ARCHIVE_LOC

The base location for files archived as part of the spool housekeeping process, where the contents of the MVS SPOOL spool file are archived prior to deletion.
Syntax
MF_SPOOL_ARCHIVE_LOC=path-name
Parameter
path-name
The base location for files archived as part of the spool housekeeping process
Default
Not set.

MF_SPOOL_HK_LEX_SCAN

Determines if the MFELX* files associated with a job are also deleted when spool housekeeping is run.
Syntax
MF_SPOOL_HK_LEX_SCAN={Y|N}
Parameters
Y
The files are deleted.
N
The files are not deleted.
Default
MF_SPOOL_HK_LEX_SCAN=Y

MF_SPOOL_HK_OUTPRT

Determines if files from the Complete queue with a status of Output or Printed are also deleted when spool housekeeping is run.
Syntax
MF_SPOOL_HK_OUTPRTC={Y|N}
Parameters
Y
Files from the Complete queue are deleted.
N
Files from the Complete queue are not deleted.
Default
MF_SPOOL_HK_OUTPRT=Y

MF_SPOOL_HK_TESTDATE

Overrides the normal date for the spool housekeeping.
Syntax
MF_SPOOL_HK_TESTDATE=YYYYMMDD
Parameters
The following are used to represent the date used to override the normal date
YYYY
Four-digit year.
MM
Two-digit month.
DD
Two-digit day.
Default
Not set. Uses the normal date for the spool housekeeping.

MF_SPOOL_HK_WRITE_PROFILES

Determines the creation of profile files (.PRO files) when a data set is archived.
Syntax
MF_SPOOL_HK_WRITE_PROFILES={Y|N}
Parameters
Y
Profile files are created.
N
Profile files are not created.
Default
MF_SPOOL_HK_WRITE_PROFILES=Y

MF_SYSLOGDSN

The Syslog Dataset name.

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.
Default
MF_UCC11=N
Comments

This environment variable works independently of the JCL RESTART parameter.

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.

When set to Y or YA, if the job uses GDG data sets, the GDG generation is reset to the level used in the previous job, ensuring that the restart will automatically pick up the correct GDG generation.

GDG Restart information is usually only written when MF_UCC11=Y, YA or M and ES_JES_RESTART=Y. You can ensure that it is always written by setting ES_JES_RESTART=Y and GDG_RESTART_UCC11_ONLY=N - this will ensure that the restart information is available if a job is restarted at a later date.

When restarting a job with restart functionality enabled (that is, values Y, YA, or M), COND Code Processing and IF/THEN logic that is dependent upon COND codes from prior steps that are skipped by the RESTART, will work as expected with no changes to the JCL.

When set to YA or M and the disposition of the data set is DISP=NEW, if the DSORG of the data set is defined on the DD Card, it will be checked against the catalog record, if the latter exists. If there is a mismatch, or if the catalog record refers to a GDG base, the data set will not be replaced, and the JCLCM0200S error message is issued.

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.
Default
MF_UCC11_DYNCLEAN=Y
Comments
Depandancies are valid only when MF_UCC11=Y or YA.

MF_USESCA5

Specifies that the server should use version 5 of the Open Service Component Architecture (Open SCA).
Syntax
MF_USESCA5={ON|OFF}
Parameters
ON
The server uses version 5 of the Open SCA.
OFF
The server uses the default version of Open SCA.
Default
MF_USESCA5=ON

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.
Default
MF_USESCA7=ON

MFACCCGI_CHARSET

Specifies the charset used in the HTTP header returned by ESMAC.
Syntax
MFACCCGI_CHARSET=iana-string
Parameter
iana-string
An IANA-defined charset string. For a list of valid strings, see the Comments section in the CBL_CCSID_FROM_IANA topic.
Default
MFACCCGI_CHARSET=iso-8859-1

MFACLIENTINI

The complete path to the mfaclient.ini file, which contains mainframe logon credentials.
Restriction: This environment variable applies to Windows environments only.
Syntax
MFACLIENTINI=path-name
Parameter
path-name
The complete path to the mfaclient.ini file.
Default
Not set. Uses the default location of the mfaclient.ini file, which is %APPDATA%\micro focus.
Comments
Used by mfdasmx.

MFALLOC_DEF_VB_PCFILE

Determines whether a new PS VB 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.
Default
MFALLOC_DEF_VB_PCFILE=Y
Comments
Valid only when the LRECL mfims imsdbu directive is not set or is set to 0 (zero). See LRECL for details.

MFALLOC_LOC

The default allocated dataset location.
Syntax
MFALLOC_LOC={path-name|SQL-URL}
Parameters
path-name
The full path to the dataset location.
SQL-URL
For a database-hosted dataset, the SQL URL to that location.
Default
Not set.
Example
Set the default allocated dataset to the sql://localhost/JCLTEST?folder=/JCLDEMO/data location:
MFALLOC_LOC=sql://localhost/JCLTEST?folder=/JCLDEMO/data

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.
Default
MFALLOC_PCFILE=Y
Comments
Valid only when DSORG=PS is provided in the DCB parameters.

MFALLOC_PROP

Rules for generated PC dataset names on allocation (that is, the default catalog PC DSN format).

MFACLIENTINI

The complete path to the mfaclient.ini file, which contains mainframe logon credentials.
Restriction: This environment variable applies to Windows environments only.
Syntax
MFACLIENTINI=path-name
Parameter
path-name
The complete path to the mfaclient.ini file.
Default
Not set. Uses the default location of the mfaclient.ini file, which is %APPDATA%\micro focus.
Comments
Used by mfdasmx.

MFAIMBEDDEDHEX

Determines whether the COBOL run-time system properly handles hex values embedded in source code.
Syntax
MFAIMBEDDEDHEX=COBOL
Parameter
COBOL
Enables the COBOL run-time system to properly handle hex values embedded in source code, meaning that all translated hex values less than x'1f' have a null character inserted before the hex value.
Default
Not set. The COBOL run-time system does not handle embedded hex values.
Comments
When set, hex values are handled in the same manner as when using the MDECONV application. See Handling Embedded HEX Values for more information.

MFAMAXSENDLENGTH

Sets the maximum length of data that can be transmitted in a single communication packet to or from the mainframe.
Syntax
MFAMAXSENDLENGTH=max-data-length
Parameter
max-data-length
The number of bytes that represents the maximum length of data.
Default
Not set.
Comments
This is useful when there is a router that limits the transfer length of data to or from the mainframe, or when the allowable length of transferred data is restricted.

This setting does not affect the size of the file that can be transmitted, but only the size of each of the numerous data chunks that are transmitted to make up the entire file.

Example
MFAMAXSENDLENGTH=4000

MFASERV

Controls how Mainframe Access checks for a dataset name (DSN).
Syntax
MFASERV=ON
Parameter
ON
If a DSN is not found in the local catalog, then the catalog API calls MFA to check the mainframe for the DSN.
Default
Not set. The catalog API does not call MFA to check the mainframe for the DSN.

MFAUDIT_LOGS

The location of audit files.

MFBSI_DIR

Identifies the directory used by MFBSI to store MFBSIJCL log files, any semaphore files (JOBnnnnn.sem), and substituted JCL members.
Syntax
MFBSI_DIR=path-name
Parameter
path-name
The full path to the directory where MFBSI stores files.
Default
Not set.
Comments
For complete information about using MFBSI_DIR to configure your enterprise server region, see Configuring the Server.

MFCATMNTUE

Specifies the name of the MFCATMNT user exit program if not compiled to the default name of MFCATMNTUE.
Syntax
MFCATMNTUE=program-name
Parameter
program-name
Represents the name of the MFCATMNT user exit program if not compiled to the default name of MFCATMNTUE.
Default
Not set. User exit program is compiled using the default name of MFCATMNTUE.

MFCODESET

Specifies which translation tables to use.
Syntax
MFCODESET=country-code
Parameter
country-code
The country code required for translation. See Supported Country Codes for a list of countries and codes.
Default
Not set. Uses the country code returned from the CBL_GET_OS_INFO routine.

MFCODESET_DBCSDIR

The location of a set of mapping files (.E2A and .A2E files) required for an application to perform ASCII/EBCDIC conversions of certain double-byte character sets.
Syntax
MFCODESET_DBCSDIR=path-name
Parameter
path-name
The full path to the location of .E2A and .A2E files.
Default
Not set. The application looks in the $COBDIR/etc/codeset directory to locate the files required for the inbuilt support.
Comments
The support covers codesets 81, 82, 86, 886, and 941.

Certain deployed applications do not require a full Enterprise Server product to be available (for example, JVM COBOL applications, and native self-contained applications), and so cannot utilize the inbuilt translation support provided by a full product. In these cases, you must deploy the mapping files with the application, and use this variable to locate the files at run time. You only need to deploy the .E2A and .A2E files appropriate to the codeset(s) you require.

MFCROW_DISABLE

Turn off common directives, preventing compilers from using directives found in directives.mf files.
Note: This is a technology preview feature only. It is being made available to allow you to test and provide feedback on this new capability; however, this feature is not intended for production use and it is not supported as such.
Syntax
MFCROW_DISABLE={Y|N}
Parameters
Y
Compilers do not use directives in directives.mf files.
N
Compilers use directives in directives.mf files.
Default
MFCROW_DISABLE=N

MFCSCFG

Specifies a configuration file to be used by the Client/Server Binding client program.
Syntax
MFCSCFG=[path-name/]file-name
Parameters
path-name
The full path to the location of the configuration file.
file-name
The name of the configuration file.
Default
MFCSCFG=mfclisrv.cfg
The default path-name is the current working directory, and if not found, the default settings for the configuration entries are used.
Comments
The value of MFCSCFG is overridden by any value defined in the command line.
Example
MFCSCFG=/home/mydir/mfclisrv.cfg

MFDBFH_CONFIG

Specifies the location and the name of the configuration file that defines the database server instances and associated databases.
Syntax
MFDBFH_CONFIG=path-name/file-name
Parameters
path-name
The full path to the location of the configuration file.
file-name
The file name of the configuration file.
Default
Not set. Uses the mfdbfh.cfg file found in the current working directory.
Comments
You can also set MFDBFH_CONFIG as a system environment variable.

MFDBFH_GRANT_USER_PERMISSIONS

Grants execute privileges to specific users or roles, for types and procedures that are created when configuring an Oracle database for MFDBFH access.
Syntax
MFDBFH_GRANT_USER_PERMISSIONS={user|role}[{user|role}[...]]
Parameters
user
A user granted execute privileges for types and procedures created by MFDBFH.
role
A role granted execute privileges for types and procedures created by MFDBFH.
Default
Not set. Oracle default permissions are applied, which are to grant execute permissions to the schema owner of that type/procedure only.
Comments
This variable has no effect on permissions for any other database provider used with MFDBFH.

MFDBFH_RECORD_LOCKING

Specifies the type of record locking that it is to be used when the database file handler is in effect.

Syntax
MFDBFH_RECORD_LOCKING={table|database}
Parameters
table
A file's record locks are held in a seperate lock table. (When using this locking mode, the behavior of record locking COBOL file operations closely follows the same behavior when using Fileshare.)
database
The native record locking mechanism of the database engine is used to establish and test locks on the data file records. This method improves performance, but at the cost of the locking behavior not exactly matching that of traditional COBOL record locking; see Record Locking Strategies for more information.
Default
MFDBFH_RECORD_LOCKING=table

MFDBFH_SCRIPT_DIR

Specifies the location of the scripts and stored procedures required when the database file handler is in effect.
Syntax
MFDBFH_SCRIPT_DIR=path-name
Parameter
path-name
The full path to the directory containing the required resources.
Default
MFDBFH_SCRIPT_DIR=$COBDIR/etc/mfdbfh/scripts

MFDBFH_VAULT

Specifies the name of a secrets vault.
Syntax
MFDBFH_VAULT=vault-name
Parameter
vault-name
The name of a vault that is defined in the product's secrets.cfg file.
Default
Not set. Uses the default vault as defined in secrets.cfg.
Comments
For more information on secrets vaults, see Vault Facility.

MFE.FALLTHRUCHECK

Enables messages to be issued if the user program does not return from a main program via GOBACK or STOP RUN.

MFE.SMS

Enables SMS support.

MFEXTMAP

Location of a mapper file.

MFFTP_ASCII_CMD_XLATE

For EBCDIC datasets, translates from EBCDIC to ASCII using a PUT, and ASCII to EBCDIC using a GET.
Syntax
MFFTP_ASCII_CMD_XLATE={Y|N}
Parameters
Y
Converts from EBCDIC to ASCII in PUTs and from ASCII to EBCDIC in GETs, for files cataloged as EBCDIC when TYPE A or ASCII sub command is also issued.
N
Standard conversion.
Default
MFFTP_ASCII_CMD_XLATE=N

MFIMS_ACBDUMP_TIMESTAMP

Suppresses date/time stamp display in ACB report.

MFIMS_BMPCHKP

Returns a QC to a checkpoint call when it the call includes an IO area.

MFIMS_BTS

Configures Mainframe Express-format BTS tracing

MFIMS_DIBSTAT_CODES

Specifies additional DIBSTAT return codes to be returned to EXEC DLI program.

MFIMS_DLI_OPT

Specifies DL/I call optimization flags.

MFIMS_DIAG

Enables IMS BTS format diagnostic tracing.

MFIMS_FLUSHTRACE

Flushes BTS trace file to disk after every write.

MFIMS_FP_DA

Bypasses keycheck on IMS Fastpath DB delete.

MFIMS_LOADMVS

Disables load of MVS support for IMS application programs.

MFIMS_PCBCALL

Allows a standalone EXEC DLI program to issue a PCB call.

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.
N
Run the steps listed after a restart step that have conditions that refer to steps prior to the restart.
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.
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-name
Parameter
path-name
The full path to the alternative directory location in which to store JCL lexicographical files. The alternative directory location must be accessible by all enterprise server regions that both submit and run jobs.
Default
Not set.

MFJ_PTPCH_CODESET

When using a codeseet similar to but other than Japanese 9122, causes MFJPTPCH to match hexadecimal character values with those in Japanese code set 9122 to determine whether a character is printable or not.
Syntax
MFJ_PTPCH_CODESET=EXTJ
Parameter
EXTJ
MFJPTPCH attempts to match hexadecimal character values with those in Japanese code set 9122 to decide whether a character is printable or not.
Default
Not set. Hexadecimal character values are not evaluated for printability.
Comments
For use only when an extended Japanese code set other than 9122 is being used.

MFJ_REPORT_DATE_CHANGE_2

Determines whether date stamps are recorded in the JESYSMSG job log of when a is job started along with date changes date changes during execution.
Syntax
MFJ_REPORT_DATE_CHANGE={Y|N}
Parameters
Y
Date stamps are recorded in the JESYSMSG job log of when a is job started along with date changes during execution.
N
Switches off date stamps in the log.
Properties
MFJ_REPORT_DATE_CHANGE=Y

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
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 the mfcatxml utility for exporting and importing a catalog, and the mvspcrn utility for bulk updates.
Syntax
MFJ_STRICT_CASE={Y|N}
Parameters
Y
MVSCATIO honors the case of physical file names passed by the catalog API, and other utilities.
N
All physical file names are folded into upper case.
Default
MFJ_STRICT_CASE=N

MFJFAXIT

Specifies the user exit program that enables file action notifications.
Syntax
MFJFAXIT=path-name/file-name
Parameters
path-name
The full path to the location of the user exit program that enables file action notifications.
file-name
The name of the user exit program file.
Default
Not set. The MFJAXIT user exit is not enabled.
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 by default in the $COBDIR/src/enterpriseserver/exits directory.

MFJSABCODE

Determines the abend code issued when MFJSERET=ABEND is in effect.
Syntax
MFJSABCODE=abend-code
Parameter
abend-code
A decimal value between 1 and 99 representing the abend code to issue.
Default
Not set. When MFJSERET=ABEND is in effect, an abend S00D (decimal code 16) is issued when a Sort or Merge operation fails with an unrecoverable error. Otherwise, the program terminates with an unrecoverable error.
Comments
If a Sort or Merge operation fails with an unrecoverable error, it will abend with a code between S001 and S063.
Example
This example results in abend code S04D being issued:
MFJSABCODE=77

MFJSDCBOUTFIL

MFJSDCBOUTFIL
Determines whether the DCB's LRECL value is honored during an OUTFIL statement.
MFJSDCBOUTFIL={ON|OFF}
Parameters
ON
The LRECL specified in the DCB properties is used during an OUTFIL statement.
OFF
Emulates the ICE222A/ICE217A mainframe restriction.
Default
MFJSDCBOUTFIL=OFF
Comments
When MFJSDCBOUTFIL=ON is in effect, if the DCB LRECL value differs from that calculated by OUTFIL, records are either truncated or padded with space to match the DCB LRECL value.
Example
MFJSDCBOUTFIL=ON

MFJSENGINE

Specifies which sort engine the utility MFJSORT is to emulate.
Syntax
MFJSENGINE={DFSORT|SYNCSORT}
Parameters
DFSORT
MFJFSORT emulates the mainframe DSORT utility.
SYNCSORT
MFJFSORT emulates the SYNCSORT utility.
Default
MFJSENGINE=DFSORT

MFJSERET

Allows an unsuccessful operation to abend, but prevents this from terminating the program with an unrecoverable error.
Syntax
MFJSERET=ABEND
Parameter
ABEND
The operation will abend and its program will continue instead of terminating with an unrecoverable error (return code 16)
Default
Not set. An unsuccessful operation and its program terminate with an unrecoverable error (return code 16). See also MFJSABCODE.

MFJSSTRICTSORT

Enables or disables the following mainframe behavior:
  • All JCL statements must contain a SYSOUT parameter, otherwise they will abend.
  • Modification of a ZD number with value 0 through INREC or OUTREC processing now keeps its sign value.
  • Records that are shorter than the output file's LRECL will be padded with low-values instead of spaces.
  • Input RECFM is identical to the output RECFM or OUTFIL RECFM (unless FTOV or VTOF/CONVERT has been specified), otherwise it errors with return code 16.
Syntax
MFJSSTRICTSORT={ON|OFF}
Parameters
ON
Disables the mainframe behavior described above.
OFF
Enables the mainframe behavior described above.
Default
MFJSSTRICTSORT=OFF

MFJSTATS

For a COBOL sort not running under mainframe emulation, determines whether statistics are included in reports produced for the COBOL SORT operation.
Syntax
MFJSTATS={ON|OFF|switch}
Parameters
ON
Creates a report containing statistics for the SORT that is displayed to SYSOUT. If a report file already exists for a previous SORT, the new statistics are appended to the end of the previous one.
OFF
No statistics are included in the report.
switch
Switches the inclusion of statistics in the report to ON when set to OFF, and to OFF when set to ON.
Default
MFJSTATS=OFF
Comments
If you are performing a COBOL sort using mainframe emulation, you can create a statistics report by modifying the JCL statement.

MFJSWINDOW

Determines the sliding or fixed century window.
Syntax
MFJSWINDOW={sliding-century|fixed-century}
Parameters
0
A century window that starts with the current year.
sliding-century
A number from 1 through 100. This sets the century window based on the current year, determining the starting year by subtracting the number specified from the current year. If unchanged from year to year, the starting year slides forward each year.
fixed-century
A year from 1000 through 3000. This sets the century window to start on the year specified.
Defaults
When emulating DFSORT, a sliding window set to 80:
MFJSWINDOW=80

When emulating SYNCSORT:

MFJSWINDOW=0
Comments
You can use this environment variable instead of the Y2PAST sort option.

Use this environment variable for Y2K compatibility when two-digit year values are used.

Examples
In the year 2020, set a sliding window to start in 1990 and end in 2090:
MFJSWINDOW=30

In the year 2020, set a fixed window to start in 1990 and end in 2090:

MFJSWINDOW=1990

MFLECONFIG

Specifies a configuration file for Language Environment (LE) run-time options.
Syntax
MFLECONFIG=path-name/file-name
Parameters
path-name
The full path to the location of the ile containing the LE run-time options you want to use.
file-name
The name of the file containing the LE run-time options you want to use.
Default
Not set. No LE run-time options are used.

MFLOCKING

Enables Locking Support.

MFLOGDIR

Specifies a directory to be used by Client/Server Binding for log files.
Syntax
MFLOGDIR=path-name
Parameter
path-name
The full path to the location of log files.
Default
Not set.
Example
MFLOGDIR=/home/mydir/logs

MFP_RAISEERROR

Enables the PL/I run-time system to raise ERROR instead of SUBSCRIPTRANGE or STRINGRANGE in scenarios in which SUBSCRIPTRANGE or STRINGRANGE are appropriate. This mimics behavior available in previous versions.
Syntax
MFP_RAISEERROR={STRINGRANGE|SUBSCRIPTRANGE|STRINGRANGE;SUBSCRIPTRANGE}
Parameters
STRINGRANGE
Raises ERROR instead of STRINGRANGE, but not SUBSCRIPTRANGE.
SUBSCRIPTRANGE
Raises ERROR instead of SUBSCRIPTRANGE, but not STRINGRANGE.
STRINGRANGE;SUBSCRIPTRANGE
Raises ERROR instead of STRINGRANGE and SUBSCRIPTRANGE.
Default
Not set. STRINGRANGE and SUBSCRIPTRANGE are raised.

MFPLI_PRODUCT_DIR

The location of the Open PL/I installation. It is used to find files needed for compiling and linking.

MFPRELOAD_USE

Calls MFPRELOAD to improve performance.

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.
Default
MFREXX_CHARSET=E

MFREXX_CONCAT

Specifies one or more characters to be used for the CONCAT operator.
Syntax
MFREXX_CONCAT={"char-op"|char-hex}[{ |,}{"char-op"|char-hex}[...]]
Parameter
char-op
A character operator to use in addition to the default operator.
char-hex
A hexadecimal value that represents a character operator to use in addition to the default operator.
Default
Not set. The default character operator is ǁ.
Comments
Single quotes may be substituted for double quotes.

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.

Examples
Both examples set & (hex value 26) and # (hex value 23) as CONCAT operators in addition to ǁ:
MFREXX_CONCAT="&" 23
MFREXX_CONCAT=26,'#'

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.
Default
MFREXX_LSEQ_RECSIZE_MAX=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.
Default
MFREXX_NO_PROCESS_STDIN=N

MFREXX_NOT

Specifies one or more characters to be used for the NOT operator in addition to the default.
Syntax
MFREXX_NOT={"char-op"|char-hex}[{ |,}{"char-op"|char-hex}[...]]
Parameters
char-op
A character operator to use in addition to the default operator. Each additional character must be defined within single or double quotes.
char-hex
A hexadecimal value that represents a character operator to use in addition to the default operator.
Default
Not set. The default character operator is ¬.
Comments
Single quotes may be substituted for double quotes.

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.

Examples
Both examples set & (hex value 26) and # (hex value 23) to be used as NOT operators in addition to ¬:
MFREXX_NOT="&" 23
MFREXX_NOT=26,'#'

MFREXX_OR

Specifies one or more characters to be used for the OR operator in addition to the default.
Syntax
MFREXX_OR={"char-op"|char-hex}[{ |,}{"char-op"|char-hex}[...]]
Parameters
char-op
A character operator to use in addition to the default operator.
char-hex
A hexadecimal value that represents a character operator to use in addition to the default operator.
Default
Not set. The default character operator is |.
Comments
Single quotes may be substituted for double quotes.

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

Examples
Both examples set & (hex value 26) and # (hex value 23) to be used as OR operators in addition to |:
MFREXX_NOT="&" 23
MFREXX_NOT=26,'#'

MFSUB

Specifies whether to use SUBI or ASUBI.
Syntax
MFSUB={SUBI|ASUBI}

MFSYSCAT

The location and file name of the JES system catalog.
Syntax
MFSYSCAT={path-name/CATALOG.DAT|URL}
Parameters
path-name
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.
Default
Not set. Uses the location specified in the JES > Configuration > System Catalog field in ESCWA.
Comments
See the data category in The dbfhdeploy Command Line Utility for full notation details if specifying a database-hosted system catalog.
Examples
MFSYSCAT=/MY/CATALOG/FOLDER/CATALOG.DAT
MFSYSCAT=sql://localhost/JCLTEST/catalog.dat?folder=/JCLDEMO

MFSYSCATDIR

The location of the system catalog directory.

MFTRACE_ANNOTATIONS

The location of the trace files.

MFTRACE_CONFIG

The location of the CTF configuration file.
Syntax
MFTRACE_CONFIG=path-name/ctf.cfg
Parameter
path-name
The full path to the location of the ctf.cfg file.
Default
Not set.

MFTRACE_LOGS

The location in which to create CTF trace log files.
Syntax
MFTRACE_LOGS=path-name
Parameter
path-name
The full path to the directory used to store CTF trace log files.
Default
Not set. Uses the current working directory.

MFTSO_DEBUG

Controls the display of debug messages.

MFUSER

Enables you to change the user from the default User ID to an alternative ID.

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-name
Parameter
path-name
The full path to the location of the file specified by the MFUSERCAT_LOC environment variable.
Default
Not set. If the path is not specified in MFUSERCAT_LOC, the current working directory is used.
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.

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

MFUSERCAT_LOC

Specifies the location and name of each additional catalog, matching the values provided in the MFUSERCAT_NODE value.
Syntax
MFUSERCAT_LOC={[path-name\]file-name}[:{[path-name/]file-name}
Parameters
path-name
The full path to a catalog file.
file-name
The name of the catalog file.
Default
Not set. No file names or locations are provided for additional catalogs specified by MFUSERCAT_NODE.
Comments
Parameter values 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, including optional wildcards * for any number of characters and ? for a single character.
Default
Not set.
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 Support for Multiple Catalogs for more details). The physical file used for each catalog is stored in the environment variable MFUSERCAT_LOC.

The parameter specification is limited to 4096 characters.

In the parameter specification, you may optionally use the UNIX-style square bracket notation (part of the regular expression feature), to 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.

MQSERVER

The names of one or more minimal channels.
Syntax
MQSERVER=channel-name/transport-type/{machine-name|ip-address(port-number)}
   [,{machine-name|ip-address}(port-number)][...]]
Parameters
channel-name
The name of a channel as defined on the server.
transport-type
The communications protocol, which can be any of the following:
  • TCP
  • LU62
  • NETBIOS
  • SPX
machine-name
The name of the server machine.
ip-address
The machine IP address.
port-number
The number of the port used.
Comments
If you have defined MQ as an XA resource, then the values used in this environment variable must also be contained in the XA open string. See XAR for WebSphere MQ for more information.

This environment variable is IBM-defined, and more information may be found in the relevant IBM publication.

Examples
MQSERVER=CHANNEL3/TCP/QServer(1414)
MQSERVER=CHANNEL1/TCP/10.120.99.999(1414),10.120.98.888(1414)

MULTIMFENTMAP

Specifies whether special characters such as < and & are replaced with the equivalent HTML entities such as &lt; and &amp;.

N

NEWJCL

Controls ISPF skeleton JCL processing.

O

OOSW

OO run-time switches.

P

PATH

Specifies the directories to be searched by all UNIX programs, including the run-time system, when finding executables to be run.
Syntax
PATH=path-name[;[path-name][...]]
Parameter
path-name
The full or relative path to a directory to search for executables.
Default
None. Set at the system level.
Example
PATH=u:/home/mydir/srclib:otherlib

PROCLIB

Under a mainframe emulation, determines whether a status of 37 is returned.
Syntax
PROCLIB={ON|OFF}
Parameters
ON
Under a mainframe emulation, returns a file status of 37 when you open an existing VSAM file for OUTPUT and the file has or previously had some data written to it, or if the file format is different from the file on disk.
OFF
No file status is returned.
Default
PROCLIB=OFF

S

SHOW_CATALOG_WAIT

Displays a message when the enterprise server is waiting for a response from the catalog server.
Default
Not set. No message is displayed when the enterprise server is waiting.

SORTCOMPRESS

Tells the system whether or not to execute a compression routine on each record to be sorted.
Syntax
SORTCOMPRESS={0|1}
Parameters
0
Disables compression.
1
Enables compression.
Default
SORTCOMPRESS=0
Comments
When compression is enabled, run-length encoding of sort records is enabled, resulting in much better performance when records contain multiple repeated characters.

Use this variable to improve memory usage and therefore sort performance when the sort records contain many single, repeated characters; for example, multiple spaces.

The behavior when set to any positive integer is equivalent to SORTCOMPRESS=1.

SORTEXITREENTRY

Determines whether E15 user exits will be called after the SORTIN data set has been exhausted. [1]
Syntax
SORTEXITREENTRY={ON|OFF}
Parameter
ON
Within Enterprise Server, MFJSORT will continue to call E15 user exit programs until a return code of 8 has been returned, even after the SORTIN data set has been fully read.
OFF
E15 user exit programs are not called once the SORTIN data set has been read.
Default
SORTEXITREENTRY=OFF

SORTSCHEME

Enables the SORTSPACE environment variable, which specifies an alternative memory allocation size for sort operations.
Syntax
SORTSCHEME=1
Parameter
1
Enables the SORTSPACE environment variable.
Default
Not set. The memory allocated for sort functions is 1 megabyte.

SORTSPACE

The amount of memory to be allocated to internal workspace for SORT operations, and the format for the allocated memory.
Important: To set SORTSPACE to a value other than the default, you must first enable it using the SORTSCHEME environment variable.
Syntax
SORTSPACE=memory-spec[K|M|G]
Parameter
memory-spec
A number that represents the amount of memory to allocate. When used without an optional parameter, this number represents memory in bytes; otherwise, it represents the units specified by an optional parameter.
K
memory-spec specifies memory allocation in kilobytes.
M
memory-spec specifies memory allocation in megabytes.
G
memory-spec specifies memory allocation in gigabytes.
Default
SORTSPACE=1M
Comments
A larger value for SORTSPACE generally results in a faster sort. However, if you specify a value that exceeds the capacity of main memory in your computer such that the operating system has to page memory in and out, performance is degraded.

Parameter values are not case sensitive.

Example
SORTSPACE=1024K

SORTTEMPSPACE

The amount of memory to be allocated to temporary workspace for SORT operations.
Syntax
SORTTEMPSPACE=memory-spec[K|M|G]
Parameters
Important: The value specified must be equivalent to 32M or greater, irrespective of the scheme used to specify the amount of memory.
memory-spec
A number that represents the amount of memory to allocate. When used without an optional parameter, this number represents memory in bytes; otherwise, it represents the units specified by an optional parameter.
K
memory-spec specifies memory allocation in kilobytes.
M
memory-spec specifies memory allocation in megabytes.
G
memory-spec specifies memory allocation in gigabytes.
Default
SORTTEMPSPACE=32M
Comments
Use this variable to adjust the memory allocation strategy used by SORT. This can generally improve performance in systems suffering from memory fragmentation.

Parameter values are not case sensitive.

Example
SORTTEMPSPACE=250M

SORTTYPE

Sets SORT operations to use the file handler.
Syntax
SORTTYPE=2
Parameter
2
Forces SORT to use the file handler, which picks up format modifications from the extfh.cfg file.
Default
Not set. SORT attempts to use CBL_ library routines to read and write files to improve performance.

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.
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|number-of-writes}
Parameters
0
The count is only updated when the file is closed.
number-of-writes
A value from 1 through 65535 to indicate the number of writes at which the count is updated.
Default
SSTM_WC_REFRESH=0
Comments
Any provided value outside of 0-65535 defaults to 65535.

STRICTVSAM

Specifies strict mainframe emulation during file processing of VSAM files.
Syntax
STRICTVSAM={ON|OFF}
Parameters
ON
File status 37 is returned when an existing VSAM file is opened for OUTPUT if the file has data or previously had data written to it, or the file is of a different format to the file on disk.
OFF
File status 0 is returned and a new file is created when an existing VSAM file is opened for OUTPUT.
Default
STRICTVSAM=OFF

T

TERM

Defines the type of terminal to use.
Syntax
TERM=term-type-name
Parameter
term-type-name
The name of a terminal type listed in the terminfo database.
Example
TERM=at386

TERMINFO

Specifies the directory to be searched by all UNIX programs, including the run-time system, for the UNIX system terminfo database.
Syntax
TERMINFO=path-name
Parameter
path-name
The full path to the directory that contains the UNIX system terminfo database.
Comments
The UNIX system terminfo database is used by all UNIX applications that need to use a terminal. However, COBOL applications tend to make much fuller and sophisticated use of the terminal and require a fuller terminfo description than is required by typical UNIX applications such as vi.

Some terminal capabilities, such as those set during the initialization of the terminal to control the use of function keys, commonly conflict with the needs of typical COBOL applications. In such cases, the terminal information required by COBOL can be stored in a separate terminfo database and referenced using COBTERMINFO.

TMPDIR

Specifies a directory in which to store temporary files instead of the UNIX system default.
Syntax
TMPDIR=path-name
Parameter
path-name
The full path to an alternative directory in which to store temporary work files.
Default
Not set. Temporary files are stored in the UNIX system default temporary directory.
Comments
Temporary work files can be created by COBOL utilities such as Cob or by the run-time system when it executes statements such as SORT.

You might need to use this environment variable if the run-time system needs to page data to disk when creating heaps or sorting.

TX_MQ_CONVERT

Sets the code set to overwrite the MQ Q manager CCSID. The value is used in the MD-codedcharsetid parameter.
Syntax
TX_MQ_CONVERT=codeset[,Force]
Parameters
codeset
The code that corresponds to that you want to use to overwrite MQ Q manager CCSID. See Installing CCSID translation tables for further details.
Force
Force the convert option for MQ even if the application does not set the option on the call.
Default
Not set. Enterprise Server uses the Q Manager CCSID.
Example
TX_MQ_CONVERT=037

To force the convert option for MQ even if the application does not set the option on the call, specify the code set followed by Force:

TX_MQ_CONVERT=037,Force

TX_MQTRACE

Enables tracing in dfh0mqis for WebSphere MQ calls.

TX_TN3270_FORCE_ALT

Enables you to use a screen size other than the default when using a TN3270 terminal emulator.

TXFILEP

The location of Micro Focus VSAM files.
Syntax
TXFILEP={path-name|datastore-location}
Parameters
path-name
The full path to the VSAM files on disk.
datastore-location
For database-hosted files, the location of the datastore containing the VSAM files. Use the notation described in the The dbfhdeploy Command Line Utility topic under Category > data.

TXMAPP

The location of the BMS load module.
Syntax
TXMAPP=path-name
Parameter
path-name
The full path to the location of the BMS load module.

TXRDTP

The location of MSS resource definition (RDO) files.
Syntax
TXRDTP=path-name
Parameter
path-name
The full path to the MSS resource definition (RDO) files.

TXTRANP

The location of the CICS application object files.
Syntax
TXTRANP=path-name
Parameter
path-name
The full path to the location of the CICS application object files.

U

USER

Specifies the default user name.

USSCONFIG

Points to the location of the SSL cipher suite specification file(s) used by the CIPHERS attribute in the CICS URIMAP or TCPIPSERVICE resource.
Syntax
USSCONFIG=cipher-path
Parameter
cipher-path
The absolute path to the cipher suite specification file or files.
Comments
For details about ciphers and cipher files, see the Security Attributes > Ciphers section of the Universal Resource Identifier Map topic.

V

VSE_STARTUP_CFG

The location of the VSE JCL configuration file.
Syntax
VSE_STARTUP_CFG=[path-name/]file-name}
Parameters
path-name
The full path to the location of the VSE JCL configuration file. When not specified, Enterprise Server looks for the file in the current working directory.
file-name
The name of the VSE JCL configuration file.
Default
Not set. You must explicitly set VSE_STARTUP_CFG to use VSE JCL support. See VSE JCL Support for details.