Environment variables in alphabetical order

A B C D E F G H I J K L M
N O PP Q R S T U V W X Y Z

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.

Restriction: This topic applies to UNIX environments only.

Syntax

CASRDO44_NEWSUB=value
export CASRDO44_NEWSUB
Values
  • 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.

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

Windows:
SET CASSPOOL_LOCK_RETRY_COUNT=count
UNIX:
CASSPOOL_LOCK_RETRY_COUNT=count
export CASSPOOL_LOCK_RETRY_COUNT

Values

count The number of retries made to obtain a record lock.

Default

If not specified, this variable defaults to 20.

CCITIMEOUT

Allows the specification, in tenths of seconds, of the maximum time out period that will be used with any LSC style application, such as Drag and Drop, SourceConnect, or the Monitor. The maximum value that can be used is 2,147,483,647.

Syntax

Windows:
SET CCITIMEOUT=value
UNIX:
CCITIMEOUT=value}
export CCITIMEOUT

Default

The default is 1200 (2 minutes).

Example
This example sets the value to 4 minutes:
SET CCITIMEOUT=2400 
CCIERRLOG
Specifies the output location and filename of ccierr.log content which 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.
CCITCP2
Instead of using the CCI Configuration Utility to set the TCP address of the machine running the CCITCP2 registration daemon the environment variable "CCITCP2" can be used instead. This may be useful if you need different processes on the same machine to contact different registration daemons.

Syntax

Windows:
set CCITCP2=hostname
UNIX:
CCITCP2=hostname
export CCITCP2

Parameters

hostname is the TCP hostname or dotted decimal IP address of the machine running the CCITCP2 daemon you wish to contact from that session.

Comments

The environment variable value will always take precedence over any value set using the Configuration Utility. To restore a process to using the value set by the Configuration Utility simply set the environment variable to an empty string, such as

set CCITCP2=

Alternatively, if this environment variable is set system-wide (by creating a system variable in the system environment settings, or by using a CONFIG.SYS file) then this value will always take precedence over any value set using the Configuration Utility.

CCITCP2_PORT
The port that is being used for the registration process.

Syntax

Windows:
set CCITCP2_PORT=port
UNIX:
CCITCP2_PORT=port
export CCITCP2_PORT
Parameters
  • port The port on which the CCITCP2 registration program operates.
CCITCPS
To start a CCI server on a fixed port, you can associate the Server Name with the port value by using the CCITCPS_ environment variable instead of appending the information on the Server Name itself.

Syntax

Windows:
set CCITCPS_old_server_name=[new_server_name,]{MFNODE=node_name | MFPORT=port_number | MFNODE=node_name, MFPORT=port_number}
UNIX:
CCITCPS_old_server_name=[new_server_name,]{MFNODE=node_name | MFPORT=port_number | MFNODE=node_name, MFPORT=port_number}
export CCITCPS

Parameters

  • old_server_name is the name of the CCI server in upper case.
  • new_server_name is the new name to use for the CCI server. If you do not specify a value for new_server_name the server name stays as old_server_name.
  • port_number is the fixed TCP port to use
  • node_name is the network node to use

Note that this will only work if the server application process is started in the same session or process that has this environment variable set.

Example

Windows:
set CCITCPS_server_name=MFPORT:3000
UNIX:
set CCITCPS_MY_SERVER_NAME=MFPORT:3000
export CCITCPS_MY_SERVER_NAME
CCITCPT

If a client is known to be trying to connect to a server with Server Name server_name, and the TCP address and port (e.g. 3000) that the server is using is known, then the client can be made to connect directly to it by setting this environment variable.

Syntax

CCITCPT_server_name=MFNODE:server_hostname,MFPORT:port_number

Note that this can be used instead of setting the client Machine Name value. This is useful if the Machine Name value the client specifies cannot be altered by an application defined method.

Parameters

  • server_name The server to which the client is trying to connect.
  • server_hostname The TCP address.
  • port_number The TCP post number.

Example

CCITCPT_server1=MFNODE:server2,MFPORT:3000
CCITRACE

You can specify the type of information that will be recorded by CCI tracing. To do this, configure the CCITRACE environment variable as follows:

CCITRACE=options

where any, or all, of the following options can be specified with a preceding / or -:

F
Logs the details of CCI API calls to the trace file. The default is OFF, unless any other trace option is specified, in which case it is ON.
P
Logs the details of protocol-level calls to the trace file. The default is OFF. If this flag is OFF, then only the details of the CCI user-level API will be traced. If this flag is ON, the level of function tracing might be greatly increased.
D
Logs the contents of all buffers passed to and from the CCI functions. The default is OFF.
Warning: This type of tracing might not produce the desired results if the application has been coded to prohibit data tracing.

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 will take precedence.

CICS_SIT
The name of the SIT used by the region.
Values
  • The name of the SIT that the region uses.
COB_LIVE_RECORD
Specifies the path and/or filename prefix for the live recording (.mfr) file created by the Live Recorder feature.
Restriction: This environment variable applies to UNIX environments only.
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.
Restriction: This environment variable applies to UNIX environments only.
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
Restriction: This environment variable applies to UNIX environments only.

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. Animator can update the session file to record information held between sessions. The .aif file contains details of breakpoints and monitors.

Syntax

COBAIF=pathname
export COBAIF

Parameters

  • A list of search directories, each item separated by a colon. The path where the .aif files are located.

Comments

If the .aif file is not found in the directory specified, a search is made of the directories specified by the COBIDY environment variable. If the file is still not found, the current directory is searched.

If an .aif file does not exist, Animator creates it as follows:

  • If COBAIF is set, the .aif file is created in the first directory specified by COBAIF
  • If COBAIF is not set, the .aif file is created in the directory specified in the environment variable COBIDY from which the program .idy file was loaded
  • If COBAIF and COBIDY are not set, or if the first directory specified by COBIDY is not found, the .aif file is created in the current directory
COBAIFNAME
Restriction: This environment variable applies to UNIX environments only.

Specifies the basename of the Animator session file (.aif ) for the program being animated. The .aif file contains details of breakpoints and monitors.

Syntax

COBAIFNAME=basename
export COBAIFNAME

Parameters

  • Basename The basename of the .aif files.

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 basename you specify overrides the application name as the basename of the .aif file.

COBANIMOPT
Restriction: This environment variable applies to UNIX environments only.

Specifies additional directives to be used by Character Animator.

Syntax

COBANIMOPT=directive-list
export COBANIMOPT

Parameters

  • directive-list A directive, or list of directives. Must not be a filename.

Comments

When you invoke Character Animator, it first reads the directives you have specified in COBANIMOPT and then uses any directives you specify in the command line (which might override some of the directives you set in COBANIMOPT).

Example

COBANIMOPT="MIXEDLANGDEBUG MULTITHREAD"
export COBANIMOPT
COBANIMSRV
Restriction: This environment variable applies to UNIX environments only.

Identifies which COBOL program a waiting Character Animator process should attach to.

Syntax

COBANIMSRV=progid
export COBANIMSRV

Parameters

  • progid An identifier that is used to identify the program to which Character Animator will attach.

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
Restriction: This environment variable applies to UNIX environments only.

Specifies non-standard behavior for HIGHLIGHT and LOWLIGHT clauses used with ACCEPT and DISPLAY statements. It provides compatibility with earlier COBOL products. You should avoid using it wherever possible as support might be discontinued at some future date.

Syntax

COBATTR=n
export COBATTR

Parameters

n A value in the range 0 through 7. It can be one of the following values, or a cumulative value; for example, specifying a value of 6 would result in the behavior described for values 4 and 2.

  • 0

    Provides standard, default behavior.

    When a COBOL program displays text subject to a HIGHLIGHT or LOWLIGHT clause, the run-time system uses respectively the bold or dim mode specified in the terminfo entry for the terminal. If the bold or dim mode is not specified, then the HIGHLIGHT or LOWLIGHT clause respectively has no effect.

  • 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

    As for 1 and 2 above

  • 4

    Provides compatibility with default behavior of products before COBOL version 3.2.

    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
export COBATTR
COBCONFIG

Specifies a run-time configuration file that tailors the run-time configurable options in some way.

Syntax

Windows:
SET COBCONFIG=pathname
UNIX:
COBCONFIG=pathname
export COBCONFIG

Parameters

  • pathname The name of the COBOL configuration file that tailors the run-time system

Comments

If $COBCONFIG is not set then the file $COBDIR/etc/cobconfig is searched for instead.

Example

UNIX:
COBCONFIG=/home/mydir/cobconfig
export COBCONFIG
Windows:
SET COBCONFIG=/home/mydir/cobconfig
COBCONFIGJVM
Specifies a Java properties file that tailors the run-time configurable options for Java Virtual Machine applications. Use this instead of COBCONFIG in COBOL applications intended for use on a Java Virtual Machine.

Values

  • The location of a properties file.
COBCONFIG.BLOCK
The location of the application configuration file.
COBCPY

Specifies the directory or directories that the Compiler and Animator should search for copyfiles.

Syntax

Windows:
SET COBCPY=pathname[:pathname]...
UNIX:
COBCPY=pathname[:pathname]...
export COBCPY

Parameters

  • pathname

    A directory that the Compiler and Animator are to search when looking for copyfiles. When more than one pathname is present, a null pathname represents the current working directory.

Example

Windows:
SET COBCPY=/home/group/sharedcopy::mydir/mycpy
UNIX:
COBCPY=/home/group/sharedcopy::mydir/mycpy
export COBCPY

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

COBDATA
Specifies one or more locations, separated by ; (Windows) or : (UNIX), in which to search for data files at run time. As long as the file assignment does not contain a sub-path (that is, a string containing \ or /) then the file assignment is appended to each location specified by COBDATA in order to locate the file.
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.

Specifies the directory or directories that the run-time system is to search for data files. 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.

Syntax

UNIX:
COBDATA=pathname[:pathname]...
export COBDATA
Windows:
COBDATA=pathname[:pathname]...
Parameters
  • A list of search directories, each item separated by a semicolon (Windows) or colon (UNIX). The run-time system is to search these when looking for application data files. When more than one pathname is present, a null pathname represents the current working directory.

Comments

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

UNIX:
COBDATA=:demo:/home/data:progs
export COBDATA
Windows:
SET COBDATA=:demo:/home/data:progs

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.

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 %ProgramFiles(x86)%\Micro Focus\Enterprise Developer (Windows) or /opt/microfocus/EnterpriseDeveloper (UNIX).
Comments

On Windows platforms, the Micro Focus COBOL system is normally installed in the default COBOL system directory and so does not require COBDIR to be set. COBDIR only needs to be set when your COBOL system has been installed in a different directory such as when more than one version of the COBOL system is available at the same time.

Examples

Windows platforms:

This example causes the compiler to search the directory C:\products\cobse20 for the Micro Focus COBOL system software:

COBDIR=C:\products\cobse20

UNIX platforms:

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

COBDIR=/home/products/cobse20
COBIDY
Restriction: This environment variable applies to UNIX environments only.

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. Animator can update the information file to record information held between sessions.

Syntax

COBIDY=pathname
export COBIDY
Parameters
  • pathname A list of search directories, each item separated by a colon.
COBJIT_ECLIPSE
Enables just-in-time debugging in the Eclipse IDE for the session or opens the Eclipse workspace only as just-in-time debugging starts.
Syntax
COBJIT_ECLIPSE={true|workspace}
Parameters
true
Launch the Eclipse IDE with just-in-time debugging for the session.
workspace
Launch the Eclipse IDE workspace only as just-in-time debugging starts.
Default
Not set. The Eclipse IDE is not launched for JIT debugging.
COBJVM

Specifies which Java Virtual Machine (JVM) to load.

Syntax
Windows:
SET COBJVM=platform_nnn
UNIX:
COBJVM=platform_nnn
export COBJVM

Parameters

platform_nnn where

platform is a threecharacter code that indicates the platform on which you are running Server Express, for example:
  • ibm IBM AIX
  • unx SCO UnixWare
  • sun Oracle SPARC
nnn indicates the version of the JVM, for example:
  • 122 Version 1.2.2
  • 130 Version 1.3.0

Comments

You might need to set COBJVM if you are developing distributed applications with both COBOL and Java components.

Example

Windows:
SET COBJVM=ibm_122
UNIX:
COBJVM=ibm_122
export COBJVM
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.

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.

Syntax

Windows:
SET COBKEYTIMEOUT=n
UNIX:
COBKEYTIMEOUT=n
export COBKEYTIMEOUT

Parameters

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

COBLANG
The language environment in which your COBOL program runs.
Values
  • A COBOL language environment (LE) value.
COBLPFORM
This configuration variable is used to define and print to printer channels C01-C12. Specify the line numbers for each channel with the COBLPFORM configuration variable. Null entries are ignored. Those channels that have line number zero, function-names S01-S052, CSP, or are undefined, are set to line 1.

Example 1:

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

In this example C01 equals 1, C02 equals 3, and so on.

Example 2:

COBLPFORM :3::5: :9

In this example, C01 equals 3, C02 equals 5, C03 equals 1, and C04 equals 9. You can specify only a single line number for each channel.

In example 2 above, channels C05 - C12 are undefined. If a print statement specifies channel C05 - C12, the line is printed at line 1. In addition, in the example shown, C03 equals 1 because its value is a space and therefore undefined.

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.

COBMAINSTACK
Note: This variable applies to native COBOL applications on UNIX, and Enterprise Server on both Windows and UNIX.

This variable is used to specify the size of the main stack.

Syntax

Windows:
SET COBMAINSTACK=n
UNIX:
COBMAINSTACK=n
export COBMAINSTACK

Parameters

n - The size, in bytes, of the stack.

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=mode;
export COBMODE

Parameters

mode = 32 or 64.

Example

COBMODE=32;
export COBMODE
COBOPT
Restriction: This environment variable applies to UNIX environments only.
Specifies user default options to the Cob utility.

Syntax

COBOPT="[set environment-variable=value]
[options] ...
[cobextn: .ext [.ext] ... ]"
export COBOPT

or

COBOPT=[pathname/]filename
export COBOPT
Parameters
  • environment-variable Any one of the environment variables supported by the COBOL system and listed in this appendix.
  • value The value to which you want to set the specified environment variable.
  • options One or more cob command line options. See the chapter COBOL System Interface (cob) for details on the format of cob options.
  • .ext A filename extension that, in addition to the standard ones of .cob, .CBL, or .cbl, denotes a file that Cob should treat as a COBOL source file. The extension must begin with a period, and if more than one is specified on one line then they must be separated by a space or tab character. You can use more than one cobextn line.
  • pathname The directory that the COBOL system is to search for an options file.
  • filename The name of a file containing cob options.

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

Comments

COBOPT can either contain options that supplement or override the system default options defined in $COBDIR/etc/cobopt, or it can specify the path of a file that contains such options. 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 the chapter COBOL System Interface (cob).

Examples

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

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

COBOPT=temp/options

Specifies that cob options are contained in the file options in the directory temp.

COBPATH

Specifies the directory or directories that the run-time system is to search for dynamically loadable .int and .gnt files, or callable shared objects.

Syntax

Windows:
SET COBPATH=pathname[:pathname]...
UNIX:
COBPATH=pathname[:pathname]...
export COBPATH

Parameters

pathname A list of search directories, each item separated by a semicolon (Windows) or colon (UNIX), that the run-time system is to search for a dynamically loadable program (.int, .gnt or callable shared object) file. When more than one pathname is specified, a null pathname represents the current working directory.

Example

Windows:
SET COBPATH=u:/home/mydir/srclib:otherlib
UNIX:
COBPATH=u:/home/mydir/srclib:otherlib
export COBPATH
COBPRFDIR
Location of .ipf files created by programs compiled with the PROFILE compiler directive.
Values
  • A list of search directories, each item separated by a semicolon (Windows) or colon (UNIX).
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

Windows:
SET COBPRINTER=command-line
UNIX:
COBPRINTER=command-line
export COBPRINTER

Parameters

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

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

Windows:
SET COBPRINTER="myspooler -a $TMPDIR\spoolfile"
UNIX:
COBPRINTER="myspooler -a $TMPDIR/spoolfile"
export COBPRINTER
COBSES

Specifies the UNIX Session Recorder functions to perform.

Syntax

COBSES={option[filename]}...
export COBSES
Parameters

option can be one or more of the following:

  • -a Include keystrokes made to and screen output from the Animator
  • -f filename Play back recording in fast forward mode
  • -p filename Play back recording in filename at normal speed
  • -r filename Record keystrokes
  • -s filename Record screen output
  • -t terminal number Indicate terminal number for multi-user screen recordings

These flags are all case sensitive. Also, you cannot combine the -r flag with either -f or -p.

Note: You must unset COBSES when you have finished using the UNIX Session Recorder, or it will interfere 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

Windows:
SET COBSW=[+/-}s...
UNIX:
COBSW=[+/-}s...
export COBSW
Parameters

A list of the run-time switches to set or unset.

  • + sets a switch.
  • - un-sets a switch.

Example

Windows:
SET COBSW=+0+D
UNIX:
COBSW=+0+D
export COBSW

This enables run-time switch 0 and the ANSI COBOL debug switch.

COBTERMINFO
Restriction: This environment variable applies to UNIX environments only.
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. This enables COBOL applications to use different terminfo settings to those used by non-COBOL applications, such as vi, when using the same terminal.
Syntax
COBTERMINFO=pathname[:pathname]...
export COBTERMINFO

Parameters

pathname A list of search directories, each item separated by a colon, that identify a terminfo database containing terminal settings tailored for COBOL applications. A null pathname represents the current working directory.

Comments

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.

If COBTERMINFO is not set, the run-time system acts as if it had been set to $COBDIR/terminfo.

Micro Focus recommend 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
export COBTERMINFO
CODEWATCH_SRCPATH
The location of source files for the debugger to use if none are found in directories specified when invoking CodeWatch
Values
  • A list of search directories, each item separated by a semicolon (Windows) or colon (UNIX).
CODEWATCH_STBPATH
The location of STB files for the debugger to use if none are found in directories specified when invoking CodeWatch.
Values
  • A list of search directories, each item separated by a semicolon (Windows) or colon (UNIX).
COLUMNS
Restriction: This environment variable applies to UNIX environments only.

Specifies the column width of the terminal screen or window, overriding the specified terminal default.

Syntax

COLUMNS=n
export COLUMNS

Parameters

n The width of the terminal screen or window, in column positions.

Comments

The default, when COLUMNS is unset or null, is to use 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. 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
export COLUMNS
CTM_SPACE [2]
Enables you to change the default MFBSI behavior for handling spaces in AutoEdit variable values to mimic the z/OS behavior.
Syntax
CTM_SPACE={[ON|YES]|[OFF|NO]}
Parameters
ON|YES
Handle spaces using the MFBSI behavior, meaning allow embedded spaces in CTM variables.
OFF|NO
Handle spaces using the z/OS behavior, meaning do not allow embedded spaces in CTM variables.
Default
CTM_SPACE=ON
Comments
Control-M (CTM) for z/OS does not support embedded spaces in variable values. The default CTM behavior of MFBSI supports spaces, and in the case of AutoEdit variable values, removes the spaces and assigns the rest of the value to the variable. To mimic the z/OS behavior for handling spaces in AutoEdit variables, set CTM_SPACE=OFF.

D

DB2DBDFT
The default database for the DB2 SQL precompiler to process SQL statements against.

Values

  • The location and name of the default database.
DBG_MVSPSKEL
The skeleton JCL for debugging.

E

ENTRYNAMEMAP
Specifies the locations of entry name map files to be used.

Syntax

Windows:
SET ENTRYNAMEMAP={filename|directory}; ...
UNIX:
ENTRYNAMEMAP={filename|directory}; ...
export ENTRYNAMEMAP

Parameters

filename An entry map file.

directory A directory containing an entry name map file. The name of the entry name map file must be mfentmap.dat.

Comments

You must set the entry_name_mapper tunable to enable entry point mapper support.

If ENTRYNAMEMAP is not set, the run-time system searches for an entry name map file called mfentmap.dat in each folder specified by the COBDIR environment variable.

If the run-time system finds more than one entry name map file and 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
When this environment variable is set to Y or y, the extended color attribute set to low-values will not to be sent to the 3270 emulator. This fixes an IBM issues related to Personal Communications (PCOM) which is described at http://www-01.ibm.com/support/docview.wss?uid=swg21461404.

Syntax

ES_3270_REMOVE_NULL_COLOR_ATTRIB=value

Values

  • Y|y

Default

The default screen size is used.

ES_ABORT_PLTPI_ERROR
Enables the user to set the error on which to abort PLTPI processing, bypassing the prompt.
Syntax
UNIX:
ES_ABORT_PLTPI_ERROR=xx
Windows:
ES_ABORT_PLTPI_ERROR=xx
Values

Values for xx can be:

  • YN - Abort on PGMIDERR
  • NY - Abort on ABEND
  • YY - Abort on PGMIDERR or ABEND

Comments

By default, 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. Set ES_ABORT_PLTPI_ERROR to bypass the prompt and automatically abort the initialization as dictated by the value provided.

ES_ACBLIB
Specifies the locations of the IMS ACB files.

Syntax

Windows:
SET ES_ACBLIB={pathname
UNIX:
ES_ACBLIB={pathname
export ES_ACBLIB

Values

pathname The path location of the IMS ACB files.

Default

If this variable is not set the ACB files are assumed to be in the project directory.

ES_ALLOC_EXPAND
The default value is Y, which expands an environment variable when used to specify an allocation path. Set to N to override this behavior, which is to not expand the variable used in the path.

Syntax

Windows:
SET ES_ALLOC_EXPAND=value
UNIX:
ES_ALLOC_EXPAND=value
export ES_ALLOC_EXPAND

Values

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

N Do not expand the variable used in the path.

Default

The default value is Y.

ES_ALLOC_OVERRIDE
The location of a file containing rules that determine where new data sets are created. This applies only to JES and batch files, and not CICS, IMS, or Web services files.

Syntax

Windows:
SET ES_ALLOC_OVERRIDE=rules-file
UNIX:
ES_ALLOC_OVERRIDE=rules-file
export ES_ALLOC_OVERRIDE

Values

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

ES_CAS_API
Restriction: This environment variable applies to UNIX environments only.
Indicates whether casout or cassub has been executed by a call and not from the command line.
Syntax
UNIX:
ES_CAS_API=value
export ES_CAS_API
Windows:
SET ES_CAS_API=value
Values
  • ON The utility has been invoked by a call, and messages will not be sent to the console or command line.
Default

The utility will attempt to log messages.

ES_CAT_RETRY_COUNT
Determines the number of attempts made to open a catalog file that has produced an error when the initial attempt to open it was made.
Syntax
ES_CAT_RETRY_COUNT=n
Parameter
n
The number of attempts made to open a catalog file.
Properties
Default: ES_CAT_RETRY_COUNT=0
Comments
Use this variable in conjunction with the ES_CAT_RETRY_WAIT variable, which determines how long to wait in between each attempt.

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

ES_CAT_RETRY_WAIT
Determines the amount of time (in seconds) to wait between attempts made to open a catalog file that has produced an error when the initial attempt to open it was made.
Syntax
ES_CAT_RETRY_WAIT=n
Parameter
n
The number of seconds to wait between attempts made to open a catalog file.
Properties
Default: ES_CAT_RETRY_WAIT=0
Comments

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

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
UNIX:
ES_CERT_REG=pathname
export ES_CERT_REG
Windows:
SET ES_CERT_REG=pathname
Values

pathname Pathname of the directory where registrations are stored.

Default

By default no directory is specified. In this case it must be specified on the cascertreg command.

ES_CICS_SINGLE
Configures CICS so that a user can only log on once.

Syntax

UNIX:
ES_CICS_SINGLE=value
export ES_CICS_SINGLE
Windows:
SET ES_CICS_SINGLE=value
Values
  • Y|y A user can only log on once.
Default
Not set: A user can log on multiple times.
Note: Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.
Note: If an enterprise server region is running in a PAC with the CICS features enabled, then single signon will be enforced for CICS. If you want to change the behavior then set ES_CICS_SINGLE=N to enable the same user to signon to multiple terminals for CICS.
ES_CLASS_XPCT
Controls the CICS PCT resource class.
Syntax
UNIX:
ES_CLASS_XPCT=value
export ES_CLASS_XPCT
Windows:
ES_CLASS_XPCT=value
Values
  • Yes: ACICSPCT is the default PCT class
  • No: Security for PCTs will be bypassed
  • classname: Overrides the default PCT class ACICSPCT with Aclassname
Default
ACICSPCT is the default PCT class.
Note: Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.
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_XCMD
Controls the CICS CMD resource class.
Syntax
UNIX:
ES_CLASS_XCMD=value
export ES_CLASS_XCMD
Windows:
ES_CLASS_XCMD=value
Values
  • Yes: CICS CMD is the default CMD class
  • No: Security for CMDs will be bypassed
  • classname: Overrides the default CMD class CICSCMD with Cclassname
Default
CICS CMD is the default CMD class.
Note: Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.
ES_CLASS_XDCT
Controls the CICS DCT resource class.
Syntax
UNIX:
ES_CLASS_XDCT=value
export ES_CLASS_XDCT
Windows:
ES_CLASS_XDCT=value
Values
  • Yes: DCICSDCT is the default DCT class
  • No: Security for DCTs will be bypassed
  • classname: Overrides the default DCT class DCICSDCT with Dclassname
Default
DCICSDCT is the default DCT class.
Note: Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.
ES_CLASS_XFCT
Controls the CICS FCT resource class.
Syntax
UNIX:
ES_CLASS_XFCT=value
export ES_CLASS_XFCT
Windows:
ES_CLASS_XFCT=value
Values
  • Yes: FCICSFCT is the default FCT class
  • No: Security for FCTs will be bypassed
  • classname: Overrides the default PCT class FCICSFCT with Fclassname
Default
FCICSFCT is the default FCT class.
Note: Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.
ES_CLASS_XJCT
Controls the CICS JCT resource class.
Syntax
UNIX:
ES_CLASS_XJCT=value
export ES_CLASS_XJCT
Windows:
ES_CLASS_XJCT=value
Values
  • Yes: JCICSJCT is the default JCT class
  • No: Security for JCTs will be bypassed
  • classname: Overrides the default JCT class JCICSJCT with Jclassname
Default
JCICSJCT is the default JCT class.
Note: Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.
ES_CLASS_XPPT
Controls the CICS PPT resource class.
Syntax
UNIX:
ES_CLASS_XPPT=value
export ES_CLASS_XPPT
Windows:
ES_CLASS_XPPT=value
Values
  • Yes: MCICSPPT is the default PPT class
  • No: Security for PPTs will be bypassed
  • classname: Overrides the default PPT class MCICSPPT with Mclassname
Default
MCICSPPT is the default PPT class.
Note: Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.
ES_CLASS_XPSB
Controls the CICS PSB resource class.
Syntax
UNIX:
ES_CLASS_XPSB=value
export ES_CLASS_XPSB
Windows:
ES_CLASS_XPSB=value
Values
  • Yes: PCICSPSB is the default PSB class
  • No: Security for PSBs will be bypassed
  • classname: Overrides the default PSB class PCICSPSB with Pclassname
Default
PCICSPSB is the default PSB class.
Note: Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.
ES_CLASS_XRES
Controls the CICS DOCTEMPLATE resource class.
Syntax
UNIX:
ES_CLASS_XRES=value
export ES_CLASS_XRES
Windows:
ES_CLASS_XRES=value
Values
  • Yes: RCICSRES is the default RES class
  • No: Security for DOCTEMPLATEs will be bypassed
  • classname: Overrides the default RES class RCISRES with Rclassname
Default
RCISRES is the default RES class.
Note: Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.
ES_CLASS_XTST
Controls the CICS TST resource class.
Syntax
UNIX:
ES_CLASS_XTST=value
export ES_CLASS_XTST
Windows:
ES_CLASS_XTST=value
Values
  • Yes: SCITST is the default TST class
  • No: Security for TSTs will be bypassed
  • classname: Overrides the default TST class SCITST with Sclassname
Default
SCITST is the default RES class.
Note: Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.
ES_CLASS_XTRAN
Controls the CICS TRAN resource class.
Syntax
UNIX:
ES_CLASS_XTRAN=value
export ES_CLASS_XTRAN
Windows:
ES_CLASS_XTRAN=value
Values
  • Yes: TCICSTRN is the default TRAN class
  • No: Security for TRANs will be bypassed
  • classname: Overrides the default TRAN class TCICSTRN with Tclassname
Default
TCICSTRN is the default TRAN class.
Note: Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.
ES_CLUSTER
Identifies a region as participating in an Enterprise Server Cluster. Mandatory for all regions in a cluster.
Syntax
UNIX:
ES_CLUSTER=ON
export ES_CLUSTER
Windows:
ES_CLUSTER=ON
Values
  • Any
Default
If this is not set, the region will not participate in an Enterprise Server Cluster.
ES_CLUSTER_ISC_TRACE
Enables tracing on the Enterprise Server Cluster ISC listeners.
Syntax
UNIX:
ES_CLUSTER_ISC_TRACE=value
export ES_CLUSTER_ISC_TRACE
Windows:
ES_CLUSTER_ISC_TRACE=value
Values
  • Any
Default
If this is not set, there is no tracing of Enterprise Server Cluster ISC listeners.
ES_CLUSTER_LISTENER_PORT_TO_USE
This variable enables you to use a specific port for a listener of the cluster.
Syntax
UNIX:
ES_CLUSTER_LISTENER_PORT_TO_USE=port
export ES_CLUSTER_LISTENER_PORT_TO_USE
Windows:
ES_CLUSTER_LISTENER_PORT_TO_USE=port
Values
  • port A port number
Default
If this is not set, ES Cluster listeners will use ephemeral ports.
ES_CONSOLE_LOG (deprecated)
Restriction: This environment variable applies to Windows environments only.
Sends console messages to the Windows Event Log.
Note: ES_CONSOLE_LOG is deprecated, and provided for backward compatibility only. We recommend that you use MFDS configuration options instead.
Syntax
ES_CONSOLE_LOG=port
export ES_CONSOLE_LOG
Values

Can be any combination of the following:

  • I - Send informational messages to the Windows Event Log.
  • W - Send warning messages to the Windows Event Log.
  • E - Send error messages to the Windows Event Log.
  • S - Send severe messages to the Windows Event Log.
Default
If this is not set, console messages are not sent to the Windows Event Log.
ES_CSKL_NO_MSG_CONSOLE
Stops CSKL writing messages to console.log
Syntax
UNIX:
ES_CSKL_NO_MSG_CONSOLE=value
export ES_CSKL_NO_MSG_CONSOLE
Windows:
ES_CSKL_NO_MSG_CONSOLE=value
Note: Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.
Values
  • Any - CSKL messages are not written to the console log.
Default
If this is not set, CSKL messages are written to the console log.
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 Native Database File Handling and Enterprise Server Region Database Management for more information.

Syntax

UNIX:
ES_DB_FH=value
export ES_DB_FH
Windows:
SET ES_DB_FH=value

Values

  • Y|y|true - file handling is directed through the Micro Focus Database File Handler (MFDBFH).
  • N|n|false - database file handler support is disabled.

Default

Database file handler support is disabled.

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

Specify the name of the database server to be used for region database operations.

There also needs to be a corresponding <server> entry for the database server within the configuration file specified by the MFDBFH_CONFIG environment variable. <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

UNIX:
ES_DB_SERVER=server-instance
export ES_DB_SERVER
Windows:
SET ES_DB_SERVER=server-instance

Values

server-instance is the name of a valid database server instance. For example, set ES_DB_SERVER=MYSERVER.

Default

Not set.

Example

Using the example above, you would be required to have something similar to that below in your database configuration file:

<?xml version="1.0" encoding="utf-8"?> 
<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>
Note: Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.
ES_DDBG_PORT_RANGE
A range of ports to use for dynamic debugging.
You specify a range of port numbers using either a hyphen or a comma.

If you use a hyphen, the values you specify are the start and the end of the port range, and the second port number must be greater than the first.

If you specify a comma, the values you specify are the start of the port range and the number of ports available from the start of the range.

Syntax
UNIX:
ES_DDBG_PORT_RANGE=value
export ES_DDBG_PORT_RANGE
Windows:
ES_DDBG_PORT_RANGE=value
Values
  • low_port-high_port

    or

  • low_port,number_of_ports
Default
If this is not set, dynamic debugging will use random ports.

Examples

The following definition specifies that ports 8001 through 8040 are to be used:

ES_DDBG_PORT_RANGE=8001-8040

The following definition specifies the same ports but using a different format:

ES_DDBG_PORT_RANGE=8001,40
Note: Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.
ES_ESM_DISABLE_DFLTUSER_ESMAC
Allows you to disable the default ESMAC user in order to increase the security of your server. Disables the DEFAULT button on the logon screen and forces users to always enter a valid userid and password.

Syntax

UNIX:
ES_ESM_DISABLE_DFLTUSER_ESMAC=value
export ES_ESM_DISABLE_DFLTUSER_ESMAC
Windows:
ES_ESM_DISABLE_DFLTUSER_ESMAC=value

Values

  • Y|y - Default ESMAC user is disabled.

Default

Default ESMAC user is not disabled.

Note: Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.
ES_DISABLE_DFLTUSR_SIGNON
Disables the default user ("mfuser") signon when invoking ES Monitor & Control (ESMAC).
Syntax
UNIX:
ES_DISABLE_DFLTUSR_SIGNON=value
export ES_DISABLE_DFLTUSR_SIGNON
Windows:
ES_DISABLE_DFLTUSR_SIGNON=value
Values
  • Y or y Having logged on to ES administration via your MFDS internal security account, you no longer receive the auto logon as "mfuser" when accessing ESMAC.
Default
If this is not set, mfuser will be used as the default user to sign in to ESMAC.
Note: Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.
ES_DFS3650
The default transaction to execute or MOD file to be displayed after successfully signing on to IMS. You specify these by setting environment variables prior to the start of the region: ES_DFS3650 - set to MOD if a MOD file is to be sent, or TRX if a TRANSACTION is to be executed. 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.
Syntax
UNIX:
ES_DFS3650=value
export ES_DFS3650
Windows:
ES_DFS3650=value
Values
  • MOD - ES_MOD3650 needs to be set to the name of the MOD you want to display
  • TRX - ES_TRX3650 needs to be set to the name of the transaction
Default
No default transaction or MOD.
ES_DSENQSHR
Enable and configure handling of the DSENQSHR keyword when it is specified on the JCL job card, and when it is not specified on the job card.
Syntax
ES_DSENQSHR={ALLOW|AUTO|DISALLOW}
Parameters
ALLOW
For JCL jobs that have the DSENQSHR keyword specified on the JCL job card, sets DSENQSHR to the value specified on the job card. For jobs that do not have the DSENQSHR keyword specified on the JCL job card, sets DSENQSHR=ALLOW for each of those jobs.
AUTO
Use the value specified on the JCL Job card, which sets ES_DSENQSHR to ALLOW when that value is either ALLOW or USEJC, and DISALLOW otherwise.
DISALLOW
For jobs that do not have the DSENQSHR keyword specified on the JCL job card, sets DSENQSHR=DISALLOW for each of those jobs.
Properties
Default: ES_CAT_RETRY_WAIT=ES_DSENQSHR=DISALLOW
Comments
When ES_DSENQSHR is not set, the value of DSENQSHR on the JCL job card is used. In this case, if DSENQSHR is set to USEJC on the job card, ES_DSENQSHR is set to DISALLOW.

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

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

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

ES_ECI_MAX_RESP
Specifies the maximum expected response size (in bytes) to use when using Micro Focus ECI support to invoke CICS programs. 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.
Syntax
UNIX:
ES_ECI_MAX_RESP=value
export ES_ECI_MAX_RESP
Windows:
ES_ECI_MAX_RESP=value
Values
  • Maximum value is 16777215.
Default
If this is not set, the maximum expected response size is calculated dynamically by multiplying the size of the TIOA by 2.
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
UNIX:
ES_ESM_CMDSEC=value
export ES_ESM_CMDSEC
Windows:
ES_ESM_CMDSEC=value
Values
  • YES - CICS overrides the CMDSEC option, and always calls its command security checking routine to issue the appropriate call to the SAF interface
Default
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 single attempt ESM authentication. You use the environment variable with a format ES_ESM_IDPW_CASE=xy, where "x" is the folding option for user ID, and "y" the option for password.
Syntax
UNIX:
ES_ESM_IDPW_CASE=xy
export ES_ESM_IDPW_CASE
Windows:
ES_ESM_IDPW_CASE=xy
Values

Values for both x and y are:

  • U - Always upper case.
  • L - Always lower case.
  • M - Mixed case and case sensitive

Default

Legacy behavior.

Comments

When this environment variable is set, Enterprise Server will only make one attempt to identify a user presenting the user ID and password as is (M), folded to uppercase (U) or folded to lower case (L). If this environment variable is not set, the legacy Enterprise Server behavior will be used.

For the legacy behavior for CICS, the User ID and the password are used as supplied possibly filtered by the uppercase 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 uppercase and used again. If this fails as well, both the user ID and the password are folded to uppercase and then used.

Example

ES_ESM_IDPW_CASE=UM - a single authentication is tried with the user ID folded to uppercase, and the password used as-is.

ES_ESM_PLTPISEC
The level of security checking for PLTPI processing.
Syntax
UNIX:
ES_ESM_PLTPISEC=value
export ES_ESM_PLTPISEC
Windows:
ES_ESM_PLTPISEC=value
Values
  • NONE - You do not want any security checking on PLT initialization programs.
  • CMDSEC - You want CICS to perform command security checking only.
  • RESSEC - You want CICS to perform resource security checking only.
  • ALL - You want CICS to perform both command and resource security checking.

Default

NONE

ES_ESM_PLTPIUSR
The user id under which PLT programs run during CICS initialization.
Syntax
UNIX:
ES_ESM_PLTPIUSR=userid
export ES_ESM_PLTPIUSR
Windows:
ES_ESM_PLTPIUSR=userid
Values
  • userid - The userid that CICS is to use for security checking for PLT programs that run during CICS initialization.
ES_ESM_RCF
Determines how RACF is used for command authorization
Syntax
UNIX:
ES_ESM_RCF=value
export ES_ESM_RCF
Windows:
ES_ESM_RCF=value
Values:
  • A Includes options T, C, and S.
  • C Specifies that RACF is to be used for ETO terminal command authorization.
  • N Specifies that no sign-on, transaction, or command authorization is to be performed by RACF.
  • S Specifies that RACF is to be used for static and ETO terminal command authorization. Includes option C.
  • T Specifies that RACF is to be used for sign-on and transaction authorization.
  • Y Includes options T and C.
Default
N
ES_ESM_RESSEC
Indicates whether CICS processing honors the RLS security setting specified on a transaction definition (PCT).
Syntax
UNIX:
ES_ESM_RESSEC=value
export ES_ESM_RESSEC
Windows:
ES_ESM_RESSEC=value
Values:
  • ALWAYS - CICS processing always performs resource level security checking irrespective of the RLS security setting on the transaction definition.
Default
If this is not set, the RLS security setting of a transaction will be 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 prefixes the resource names when making security queries.
Syntax
UNIX:
ES_ESM_SECPRFX=value
export ES_ESM_SECPRFX
Windows:
ES_ESM_SECPRFX=value
Values
  • NO - No prefixes are used.
  • YES - Resource names are prefixed with the CICS region user ID.
  • prefix - A string to be used as the prefix for resource names. It can be 1 to 8 upper case alphanumeric characters and it must start with an alphabetic character.
Default
NO
Note: The environment variable ES_ESM_SECPRFX is only applied to CICS classes.
ES_ESM_XUSER
Indicates whether CICS processing performs surrogate user checks.
Syntax
UNIX:
ES_ESM_XUSER=value
export ES_ESM_XUSER
Windows:
ES_ESM_XUSER=value
Values
  • NO - No surrogate user checking is performed.
  • YES - Perform surrogate user checking wherever such checks are permitted.
Default
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
UNIX:
ES_ESMAC_DISP_MAX_OVERRIDE=value
export ES_ESMAC_DISP_MAX_OVERRIDE
Windows:
ES_ESMAC_DISP_MAX_OVERRIDE=value
Value
  • An integer number denoting how many lines to display. The maximum number is 99999.
Default
10000
Note: Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.
ES_EUSA_SIZE
Sets the size of the extended user storage area, allowing large memory allocations to be set using the GETMAIN SHARED command. Set this variable to a numeric value representing the number of MB.
Syntax
UNIX:
ES_EUSA_SIZE=number
export ES_EUSA_SIZE
Windows:
ES_EUSA_SIZE=number
Values
  • Number of MB for the extended user storage area.
Default
16 MB
ES_GLM
If this variable is set, it identifies the region as an Enterprise Server Cluster Global Lock Manager (GLM).
Syntax
UNIX:
ES_GLM=value
export ES_GLM
Windows:
ES_GLM=value
Values
  • Any value sets the variable.
Default
If this variable is not set, the region is not a Global Lock Manager (GLM).
ES_GLM_TIMEOUT
The duration in which a submit request to an Enterprise Server Cluster Global Lock Manager (GLM) can be retried before disabling the connection permanently.
Values
  • n seconds.

This variable only applies to the region within an Enterprise Server Cluster designated as the GLM.

Syntax
UNIX:
ES_GLM_TIMEOUT=seconds
export ES_GLM_TIMEOUT
Windows:
ES_GLM_TIMEOUT=secnds
Values
  • The number of seconds within which a request can be retried..
Default
120 seconds.
Comments
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 may need to set this variable to indicate which hostname MFCS should use.
Syntax
UNIX:
ES_HOSTNAME_TO_USE=hostname
export ES_HOSTNAME_TO_USE
Windows:
ES_HOSTNAME_TO_USE=hostname
Values
  • The relevant hostname.
ES_HSF_CFG
Enables you to configure a number of additional fields to appear in the HSF record displayed in the .csv file (cashsf-a.csv or cashsf-b.csv).

Syntax

Windows:
SET ES_HSF_CFG=cfg-options
UNIX:
ES_HSF_CFG=cfg-options
export ES_HSF_CFG

Parameters

Define cfg-options using the following syntax:
field_name=value;[field_name=value;]...
using the following values:
Field name Range Default
CUSTOM 0-5 0
CICSF 0-20 5
TSQ 0-20 5
TDQ 0-20 5
Note: If a field is not explicitly set, or the value specified is out of range, the default value for the field is used.

For example: ES_HSF_CFG=CUSTOM=2;CICSF=10;TSQ=32 generates 2 custom fields, 10 CICS file fields, 5 TSQ fields and 5 TDQ fields.

Custom fields are written to using the ES_WRITE_CUSTOM_HSF library routine.

ES_IEBGEN_TO_ICEGEN
Determines enablement of VSAM copy using the MFGENER utility.
Syntax
ES_IEBGEN_TO_ICEGEN={Y|N}
Parameters
Y
Enables VSAM copy using the MFGENER utility.
N
Disables VSAM copy using the MFGENER utility.
Properties
Default: ES_IEBGEN_TO_ICEGEN=N
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

Windows:
SET ES_IMS_CANCEL_MODE=<cancel-mode>
UNIX:
ES_IMS_CANCEL_MODE=<cancel-mode>
export ES_IMS_CANCEL_MODE

Values

Permissible values for <cancel-mode> are:
  • 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.
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
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
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.
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[8]
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
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
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}
Parameters
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.
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=;32;2;N;
ES_IMS_MESGQ=IMSMESGQ.dat;4;2;Y;4
Comments
CAUTION:
Manually set this variable only when advised to do so by Customer Care.
ES_IMS_DISPLAY_NEW
Changes the timestamp format for /DISPLAY output from the outdated MM/DD/YYYY HH:MM:SS style for z/OS systems to the current z/OS system style, YYDDD/HHMMSS.
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_MFS_OPT2_LEGACY[1]
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.
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
Specifies a list of descriptors that predefine destinations for one of three types: IMS Connect (IMSCON), the MQ-IMS Bridge (MQ), and 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.
[;...]
Separate a list of multiple destination descriptors with a semi-colon.
Properties
Default: None
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. Set the variable to one of the following:
D
If the main program is a PL/I program, PCB addresses are converted from a direct to an indirect addressing technique.
Y
Always converts address as long as the PSB language is PL/I.
N
Never converts addresses.
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.
ES_IMS_TLOG_FLUSH
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.
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.
Properties
Default: None
Example
ES_JES_BYTES=(100,DUMP)

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

ES_JES_CARDS
Maximum number of cards to output in a job before taking the action specified by cancelling the job, cancelling the job and dumping memory contents, or issuing a warning message.
Syntax
ES_JES_CARDS=(number[,{WARNING|CANCEL|DUMP}])
Parameters
number
Maximum number of cards. The range is from 0-99999999.
WARNING
Issue a warning when the specified maximum number of cards is reached.
CANCEL
Cancel the job when the specified maximum number of cards is reached.
DUMP
Cancel the job and dump the memory contents when the specified maximum number of cards is reached.
Properties
Default: None
Example
ES_JES_CARDS=(30,WARNING)

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

ES_JES_CONSOLE_MESSAGES
Determines whether to lodge CASMG0001I messages in the splmsg.dat list for a job.
Syntax
ES_JES_CONSOLE_MESSAGES={Y|N}
Parameters
Y
Lodges CASMG0001I messages in the splmsg.dat list for a job.
N
Does not lodge CASMG0001I messages in the splmsg.dat list for a job.
Properties
Default: ES_JES_CONSOLE_MESSAGES=Y
Comments
CASMG0001I messages are produced when a program running in a JCL job does 'display upon console'. These messages, along with others, are lodged in the splmsg.dat file. When the job information is displayed in ESCWA/ESMAC, these messages are also shown.

There is a limit of 65535 messages per job. If that limit is exceeded, the last messages sent will overwrite the last message already lodged in splmsg.dat.

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

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

//*MFE:%CONSOLE_MSGS=Y|N
ES_JES_DELAY_MEM_ENQ
Determines whether to delays the exclusive enque of a new (not previously existing) PDS member until the file is opened.
Syntax
ES_JES_DELAY_MEM_ENQ={Y|N}
Parameters
Y
Delay the exclusive enque of a new (not previously existing) PDS member until the file is opened.
N
Do not delay the exclusive enque of a new (not previously existing) PDS member until the file is opened.
Properties
Default: ES_JES_DELAY_MEM_ENQ=N
Comments
PDS members are given an exclusive enque at step start.

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

ES_JES_DISABLE_RESTART_FLUSH
Indicates whether jobs in a specific enterprise server region are moved from the Active queue to the Complete queue when the region is restarted.
Syntax
ES_JES_DISABLE_RESTART_FLUSH={Y|N}
Parameters
Y
Move jobs in the region from the Active queue to the Complete queue when the region is restarted.
N
Do not move jobs in the region from the Active queue to the Complete queue when the region is restarted.
Properties
Default: None
ES_JES_ENFORCE_EXPIRE_DATE
Restriction: This environment variable applies to UNIX environments only.

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

Note: Use the PURGE keyword to delete non-expired datasets.
Syntax
ES_JES_ENFORCE_EXPIRE_DATE={Y|N}
Parameters
Y
Check the expiry date and delete expired datasets.
N
Do not check the expiration date.
Properties
Default: ES_JES_ENFORCE_EXPIRE_DATE=Y
ES_JES_FREE_SSTM_SYSOUT
Determines whether to free the memory assigned to store details about each CICS spool file that you create using the CICS Spool Write API's, once the spool file has been created.

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

Warning: Setting the variable also removes the tracking information about the file which means that the file's status (SPOOLED) no longer appears in the JESYSMSG for the SSTM job.
Syntax
ES_JES_FREE_SSTM_SYSOUT={Y|N}
Parameters
Y
Free the memory assigned to store details about each CICS spool file.
N
Do not free the memory assigned to store details about each CICS spool file.
ES_JES_HIGHER_SECURITY_LEVEL
Determines which programs are loaded based on checks made against the list of SYS1.LNKLIB entries.
Syntax
ES_JES_HIGHER_SECURITY_LEVEL={0|[1|NONE][2|BASIC][3|WARN][4|ENHANCED]}
Parameters
0
Suppresses the JCLCM0305I informational message when no program is found in a private or system library.
1|NONE
A value of 1 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 may be issued if none have been defined (JES000067W) and messages about programs not being loaded from certain locations (JES000069W) will also be given.
2|BASIC
A level of BASIC or 2 causes programs to be loaded from the list of SYS1.LNKLIB entries, STEPLIB, and JOBLIB locations. Programs in other locations are not loaded. The loading of programs from dynamic PDSs is also entirely disabled.
3|WARN
A level of WARN or 3 causes checks to be made against the PROGRAM and the PHYSFILE security classes. The PHYSFILE check is to make sure the PHYSFILE resource class is implemented. If these checks fail, a warning message (JCLCM0262W, JCLCM0263W or JCLCM0266W) is issued.
4|ENHANCED
A level of ENHANCED or 4 will cause the same PROGRAM and PHYSFILE checks to be made but if they fail then the job will abend with an S913 security error and a suitable message will be issued to indicate the failure.
Properties
Default: ES_JES_HIGHER_SECURITY_LEVEL=1
ES_JES_LEVEL
Sets the default JCL type on the JES Control page.
Syntax
UNIX:
ES_JES_LEVEL={VSE|JES2|JES3}
export ES_JES_LEVEL
Windows:
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.
Properties
Default: ES_JES_LEVEL=JES2
ES_JES_LINES
Maximum number of lines to output in a job before taking the action specified by cancelling the job, cancelling the job and dumping memory contents, or issuing a warning message.
Syntax
ES_JES_LINES=(number[,{WARNING|CANCEL|DUMP}])
Parameters
number
Maximum number of lines in thousands. The range is from 0-99999999.
WARNING
Issue a warning when the specified maximum number of lines is reached.
CANCEL
Cancel the job when the specified maximum number of lines is reached.
DUMP
Cancel the job and dump the memory contents when the specified maximum number of lines is reached.
Properties
Default: None
Example
ES_JES_LINES=(100,CANCEL)
Each card is assumed to hold 25 lines; therefore at 750 lines (25×30) a warning message is issued the job continues. Limit the number of lines output to 100000. When this limit is reached cancel the job. This results in an S722 Output limit exceeded system abend code being produced.
ES_JES_LISTCAT_YMD
Restriction: This environment variable applies to UNIX environments only.
Determines the date format used in the HISTORY report generated when the IDCAMS LISTCAT command specifies the ALL parameter.
Syntax
ES_JES_LISTCAT_YMD={Y|N}
Parameters
Y
Show the CREATED, CHANGED and EXPIRE date in YYYYMMDD format.
N
Show the CREATED, CHANGED and EXPIRE date in YYYY.ddd format.
ES_JES_OUTLIM
Maximum number of lines to output to a particular dataset before calling the user exit, processing any global limits, and then cancelling the job.
Syntax
ES_JES_OUTLIM=(number[,{WARNING|CANCEL|DUMP}])
Parameters
number
Maximum number of lines of output before taking action. The range is from 1-16777215.
WARNING
Issue a warning when the specified maximum number of lines of output is reached.
CANCEL
Cancel the job when the specified maximum number of lines of output is reached.
DUMP
Cancel the job and dump the memory contents when the specified maximum number of lines of output is reached.
Properties
Default: None
Example
ES_JES_OUTLIM=5000
A warning is issued when 5000 lines of output is exceeded.
ES_JES_OUTLIM=(1000,CANCEL)
Comments
Individual OUTLIM values can be set on each SYSOUT dataset. For example,//SYSPRINT DD SYSOUT=*,OUTLIM=500.
ES_JES_PAGES
Maximum number of pages to output in a job before taking the action specified by cancelling the job, cancelling the job and dumping memory contents, or issuing a warning message.
Syntax
ES_JES_PAGES=(number[,{WARNING|CANCEL|DUMP}])
Parameters
number
Maximum number of pages. The range is from 0-99999999.
WARNING
Issue a warning when the specified maximum number of pages is reached.
CANCEL
Cancel the job when the specified maximum number of pages is reached.
DUMP
Cancel the job and dump the memory contents when the specified maximum number of pages is reached.
Properties
Default: None
Example
ES_JES_PAGES=10
Each page is assumed to hold 60 lines; therefore when 600 lines (60×10) have been processed, a warning is issued and the job continues.
ES_JES_PARM_INIT_LOW
Determines whether the parameter string passed to a program executed by JCL is initialized to low-values or to spaces.
Syntax
ES_JES_PARM_INIT_LOW={Y|N}
Parameters
Y
Initialize the parameter string to low-values.
N
Initialize the parameter string to spaces.
Properties
Default: ES_JES_PARM_INIT_LOW=N
ES_JES_RESTART
Determines whether JCL restart processing is enabled.
Syntax
ES_JES_RESTART={Y|N}
Parameters
Y
Enables JCL restart processing.
N
Disables JCL restart processing.
Properties
Default: ES_JES_RESTART=N
ES_JES_SORT_SPOOL_BY
Specifies which column is initially used to sort the spool records in casrdo41.
Syntax
ES_JES_SORT_SPOOL_BY={JOBNAME|SUBDATE|JOBUSER}
Parameters
JOBNAME
Sort by job name.
SUBDATE
Sort by sub date.
JOBUSER
Sort by job user.
Properties
Default: None
ES_JES_SPOOL_ORDER
The order in which the spool list is displayed when you first open ESMAC.
Syntax
UNIX:
ES_JES_SPOOL_ORDER=value
export ES_JES_SPOOL_ORDER
Windows:
ES_JES_SPOOL_ORDER=value
Values
  • 1 - Displays the list in descending order by JOBID. Any other value displays it in ascending order.

Default
By default the list is displayed in ascending order by JOBID.
ES_JESYSMSG_OUTPUT
The status of the system messages spool files (JESYSMSG) is set to Output, rather than Out Hold.
Syntax
Windows:
ES_JESYSMSG_OUTPUT={Y|N}
UNIX:
ES_JESYSMSG_OUTPUT=={Y|N}
export ES_JESYSMSG_OUTPUT
Parameters
Y
All job messages will have the status as Output, but will only actually print (either physically or logically) if the MSGCLASS of the job matches one of the sysout classes defined to an active printer.
N
Messages are set to Out Hold
Properties
Default: ES_JESYSMSG_OUTPUT=N
ES_JESYSMSG_RESTRICTED
Holds back spool files based on their class when the status of the system message spool files are set to Output.
Syntax
ES_JESYSMSG_RESTRICTED={class-name|class-number}[class-name|class-number][...]]
Parameters
class-name
The name of a class.
number
A number representing the class.
Properties
Default: ES_JESYSMSG_RESTRICTED=N
Example
The following:
ES_JESYSMSG_RESTRICTED=ABC123
Specifies classes A, B, C, 1, 2, and 3.
Comments
All job messages have an Output status, but print either physically or logically only when the MSGCLASS of the job matches one of the sysout classes defined to an active printer.
ES_LE370_SUPPORT
Enables support for Language Environment (LE) in CICS applications
Syntax
UNIX:
ES_LE370_SUPPORT=value
export ES_LE370_SUPPORT
Windows:
ES_LE370_SUPPORT=value
Values
  • Y|y Enables LE support.
Default
By default LE support is not enabled.
ES_LEGACY_ECI
Indicates that Enterprise Server must use Micro Focus ECI instead of IBM CTG.
Syntax
UNIX:
ES_LEGACY_ECI=value
export ES_LEGACY_ECI
Windows:
ES_LEGACY_ECI=value
Values
  • Y|y Micro Focus ECI is used.
Default
By default IBM CTG is used.
ES_LOCKDB

Specifies the region database that is to process resource locking (step- and system-scoped ENQs) for an enterprise server within a cluster, where resources (such as spool queues and catalogs) are deployed to a database.

Syntax

UNIX:
ES_LOCKDB=region-db
export ES_LOCKDB
Windows:
SET ES_LOCKDB=region-db

Parameters

region-db
region-db is the name of the region database responsible for processing step- and system-scoped ENQs.
ES_MAX_CATALOG_LINES
Restricts the number of entries displayed in ESMAC catalog view.
Syntax
UNIX:
ES_MAX_CATALOG_LINES=number
export ES_MAX_CATALOG_LINES
Windows:
ES_MAX_CATALOG_LINES=number
Values
  • number The number of lines to display. The maximum is 99999.
Default
The default is 5000.
Note: Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.
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.
Note: Note that memory strategy can also be set via the memory_strategy run-time tunable.
ES_MFASM_SUPPORT
Enables Assembler support when running CICS server regions.
Syntax
UNIX:
ES_MFASM_SUPPORT=value
export ES_MFASM_SUPPORT
Windows:
ES_MFASM_SUPPORT=value
Values
  • Y|y

    Assembler supported for CICS server regions.

  • N|n

    No Assembler supported for CICS server regions.

Default
By default Assembler support is not enabled.
Specifies the server address is used by casstart when the /m parameter is not provided.
Syntax
Parameters
Default
Comments
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
Windows:
ES_MFSLIB=%ProgramFiles(x86)%\Micro Focus\Enterprise Developer\etc\ims
UNIX:
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
Parameters
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 Customer Care.
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.
Restriction: This environment variable applies to UNIX environments only.
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.
Restriction: This environment variable applies to UNIX environments only.
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
Restriction: This environment variable applies to UNIX environments only.
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
Restriction: This environment variable applies to UNIX environments only.
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.
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.

Values

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

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

Default

The default value is N.

ES_OLD_SEC_TSTD
Prevents security being enforced for TS or TD queues that are not declared in the security repository.
Syntax
UNIX:
ES_OLD_SEC_TSTD=value
export ES_OLD_SEC_TSTD
Windows:
SET ES_OLD_SEC_TSTD=value
Values
  • Any value.
Default
By default security is enforced for TS or TD queues that are not declared in the security repository.
ES_OPEN_CAT_ON_DEMAND
Determines if additional catalogs (as specified using MFUSERCAT_NODE) are opened when the system starts, or only opened when required.
Syntax
ES_OPEN_CAT_ON_DEMAND={Y|N}
Parameters
Y
When the enterprise server region starts, no attempt is made to open the catalogs specified in MFUSERCAT_NODE. Only the system catalog is opened initially, and the other nodes are opened when required.
N
When the enterprise server region starts, all nodes are opened.
Properties
Default: ES_OPEN_CAT_ON_DEMAND=N
Comments
When ES_OPEN_CAT_ON_DEMAND=N is set and there is a problem opening any of the nodes specified in MFUSERCAT_NODE, the JES system will not start.
ES_OLD_DYN_PDS
Determines the resulting behavior of dynamic PDS members when specified in a JCL DD statement.

Values

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

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

Default

The default value is N.

ES_OTMA_TIMEOUT
The time in seconds that an OTMA client should wait for an answer. The default value is 120.
Syntax
UNIX:
ES_OTMA_TIMEOUT=seconds
export ES_OTMA_TIMEOUT
Windows:
SET ES_OTMA_TIMEOUT=seconds
Values
  • seconds - The number of seconds to wait. The maximum is 43199.
Default
120 seconds.
ES_PL1_MFFH_JCL
Enables you to run Open PL/I programs that access JCL data definitions.
Syntax
Windows:
ES_PL1_MFFH_JCL=Y|N
UNIX:
ES_PL1_MFFH_JCL=Y|N
export ES_PL1_MFFH_JCL
Values

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

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

Default

The default value is N.

ES_PRODUCTION
Prevents the initiation of a debugging session from the IDE.
ES_PROG_PATH
Determines whether to display the program's load path in the JESYSMSG and SYSLOG datasets.
Note: Applies to native enterprise server regions only.
Syntax
ES_PROG_PATH={Y|N}
Parameters
Y
Display the program's load path in the JESYSMSG and SYSLOG datasets.
N
Do not display the program's load path in the JESYSMSG and SYSLOG datasets.
Properties
Default: None
ES_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).
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. The timeout in fileshare also needs to be set to 0 using /t 0 in the fileshare configuration file.

Syntax

UNIX:
ES_RLS_FILE_SUPPORT=value
export ES_RLS_FILE_SUPPORT
Windows:
SET ES_RLS_FILE_SUPPORT=value

Values

  • Y|y - Stops dirty records being returned when a record is locked by another process.

Default

RLS file support is off.

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.
Default
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.
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.
Properties
Default: None
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 the period of inactivity to be controlled.

Syntax

UNIX:
ES_SEP_DORMANT_TIME=seconds
export ES_SEP_DORMANT_TIME
Windows:
ES_SEP_DORMANT_TIME=seconds

Values

  • seconds Number of seconds' inactivity.

Default

Transient SEPs are terminated after 2 seconds of inactivity.

Note: Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.
ES_SERVER
The default server name (used if no -r switch is specified on casstart or casstop).

Syntax

UNIX:
ES_SERVER=name
export ES_SERVER
Windows:
ES_SERVER=name

Values

  • name The server name.

Default

ESDEMO/ESDEMO64

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_SSTM_CICS
Location of the JCL used to initialize the SSTM CICS environment.
Syntax
ES_SSTM_CICS=file-location
Parameters
file-location
The full path to the location of the JCL used to initialize the SSTM CICS environment.
Properties
Default: None
ES_SSTM_IMS
Location of the JCL used to initialize the SSTM IMS environment.
Syntax
ES_SSTM_IMS=file-location
Parameters
file-location
The full path to the location of the JCL used to initialize the SSTM IMS environment.
Properties
Default: None
ES_SSTM_JOB_FLUSH_ACTIVE
Determines whether a CICS SSTM job is removed from the Active queue when the region shuts down.
Syntax
ES_SSTM_JOB_FLUSH_ACTIVE =file-location
Parameters
Y
Remove the CICS SSTM job from the Active queue.
N
Do not remove the CICS SSTM job from the Active queue.
Properties
Default: ES_SSTM_JOB_FLUSH_ACTIVE=N
ES_SURROGATE_JOB_USER
Associates a user ID with a job when submitting the job for processing through the internal reader from CICS.

Syntax

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

Any value - The user ID that started the ES region is used in the job submission.

Default

By default, the CICS default user CICSUSER, or as specified by ES_USR_DFLT_CICS, is used in the job submission.

ES_SYSOUT_HOLD
Determines whether the status of the SYSOUT files are set to Out Hold.
Syntax
ES_SYSOUT_HOLD={Y|N}
Parameters
Y
The status of the SYSOUT files are set to Out Hold.
N
The status of the SYSOUT files are not set to Out Hold.
Properties
Default: None
ES_TMC_AGGREGATE
Controls the performance environment for IMS TM data stores.

Syntax

UNIX:
ES_TMC_AGGREGATE={[,N|,D]|nnn,Y}
export ES_TMC_AGGREGATE
Windows:
SET ES_TMC_AGGREGATE={[,N|,D]|nnn,Y}

Values

,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 ESMAC. 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.
Note: To avoid unpredictable results when using this setting, we highly recommend that you also set the static options as follows on the Administration Server > Properties > MSS > IMS > TM > General tab:
  • Set Cold start to Everything (queue)
  • Check Persist

See Server Instance Properties: MSS IMS TM General for details.

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.
  • Generally, when the message queue resides on a higher performance I/O subsystem such as one using SSDs, a smaller value, e.g. 1 or 2, produces the best results. A value of 10 or higher seldom improves performance.

Default

,N

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

Syntax

UNIX:
ES_TN2370_FORCE_ALT=value
export ES_TN2370_FORCE_ALT
Windows:
SET ES_TN2370_FORCE_ALT=value

Values

  • Any value

Default

The default screen size is used.

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

UNIX:
ES_TN3270_MODEL_LOG=value
export ES_TN3270_MODEL_LOG
Windows:
SET ES_TN3270_MODEL_LOG=value

Values

  • Y|y - Model names are written to TSQ TN32MODL.

Default

Model names are not logged.

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_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_USR_DFLT_CICS
Allows you to override the default user when no user is logged on for CICS authentication.

Syntax

UNIX:
ES_USR_DFLT_CICS=user
export ES_USR_DFLT_CICS
Windows:
SET ES_USR_DFLT_CICS=user

Values

  • user - the default user name.

Default

CICSUSER

Note: Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.
ES_USR_DFLT_ESMAC
Allows you to override the default user when no user is logged on for ESMAC authentication.

Syntax

UNIX:
ES_USR_DFLT_ESMAC=user
export ES_USR_DFLT_ESMAC
Windows:
SET ES_USR_DFLT_ESMAC=user

Values

  • user - the default user name.

Default

mfuser

Note: Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.
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_JES
Allows you to override the default user when no user is logged on for JES authentication.

Syntax

UNIX:
ES_USR_DFLT_JES=user
export ES_USR_DFLT_JES
Windows:
SET ES_USR_DFLT_JES=user

Values

  • user The deafult user name.

Default

JESUSER

Note: Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.
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
Configures the XA reconnect process to operate in a multi-attempt mode.
Note: 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.

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

UNIX:
ES_XA_LOG_SUPPRESS=value
export ES_XA_LOG_SUPPRESS
Windows:
ES_XA_LOG_SUPPRESS=value

Values

  • Y|y - XA logging is suppressed.

Default

By default no value is specified and XA logging is not suppressed.

Note: Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.
ES_XA_RECONNECT
Configures the XA reconnect process to operate in a single-attempt mode
Syntax
Windows:
ES_XA_RECONNECT=Y,wait-time[,retry_count]
UNIX:
ES_XA_RECONNECT=Y,wait-time[,retry_count]
export ES_XA_RECONNECT
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.
Properties
Default: None
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
UNIX:
ES_ZOS_SYSPRINT_DCB=value
export ES_ZOS_SYSPRINT_DCB
Windows:
ES_ZOS_SYSPRINT_DCB=value
Values
  • Y|N - Set to Y to enable MFJAMS SYSPRINT to use the same DCB attributes as the IDCAMS SYSPRINT.
Default
ES_ZOS_SYSPRINT_DCB=N
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.
ES_EZASOKET_SUPPORT=Y
Parameter
Y
Turns on EZASOCKET support.
Default
Not set. EZASOCKET is not supported.
Comments
Parameter value is not case sensitive.
EXTFH
Specifies a configuration file for the Callable File Handler.

Syntax

Windows:
SET EXTFH=filename.cfg
UNIX:
EXTFH=filename.cfg
export EXTFH

Parameters

filename.cfg The name of the configuration file.

Example

Windows:
SET EXTFH=/home/mydir/myconfig.cfg
UNIX:
EXTFH=/home/mydir/myconfig.cfg
export EXTFH

F

FHREDIR
Specifies a configuration file to be used by the Fileshare Client.

Syntax

Windows:
SET FHREDIR=filename.cfg
UNIX:
FHREDIR=filename.cfg
export FHREDIR

Parameters

filename.cfg The name of the configuration file.

Example

Windows:
SET FHREDIR=/home/mydir/myconfig.cfg
UNIX:
FHREDIR=/home/mydir/myconfig.cfg
export FHREDIR
FS

Specifies a configuration file to be used by the Fileshare Server.

Syntax

Windows:
SET FS=filename.cfg
UNIX:
FS=filename.cfg
export FS

Parameters

filename.cfg The name of the configuration file.

Example

Windows:
SET FS=myconfig.cfg
UNIX:
FS=myconfig.cfg
export FS
FSCOMMS
Specifies that the Fileshare system is to run in single user mode.

Syntax

Windows:
SET FSCOMMS="\$local"
UNIX:
FSCOMMS="\$local"
export FSCOMMS

Parameters

"\$local" Run the Fileshare System in single 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
Windows: 
			 SET GDG_RESTART_UCC11_ONLY={Y|N}
UNIX: 
			 SET GDG_RESTART_UCC11_ONLY={Y|N}
export GDG_RESTART_UCC11_ONLY
Parameters
Y
GDG restart information is written, but only when ES_JES_RESTART=Y and MF_UCC11 is set (Y, YA, or M).
N
GDG restart information is written even if MF_UCC11=N or is not set. (ES_JES_RESTART=Y must still be set.)
Properties
Default: SET GDG_RESTART_UCC11_ONLY=Y

H

HCOBND (deprecated)
Specifies a directory to be used for bind files generated by the DB2 External Compiler Module (ECM).
Note: 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

Windows:
SET HCOBND=pathname
Windows:
HCOBND=pathname
export HCOBND

Parameters

pathname The directory that the DB2 ECM is to use to store bind files.

Example

Windows:
SET HCOBND=d:\mydir\binds
UNIX:
SET HCOBND=/mydir/binds
export HCOBND

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.

I

IBM_DBG_LANG
The language the IBM PL/I debugger should use.
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.
JCLTEMP_DIR [6]
Enables you to specify a separate location for the JCLTEMP directory.
Syntax
JCLTEMP_DIR=path
Parameter
path
The full or relative path to the location of your JCLTEMP directory.
Default
Not set. Uses the directory specified by MFBSI_DIR.
JES_PRINT_SPOOL_MSG
Specifies the disposition of the spool data set printing message (JES000029I).
Note: This environment variable is intended for high print load users, where print messages to the console impact system performance.
Syntax
JES_PRINT_SPOOL_MSG={CONSOLE|LOG|SILENT}
Parameters
CONSOLE
The console.log file.
LOG
A special log file named PRNT_SPL_MSG_YYYY_MM_DD.DAT where YYYY_MM_DD is the current date. This file resides in the same directory as the spool files, and a new file is created every day.
SILENT
No messages. Use this option with caution, as you will have no audit log of your spool data sets.
Properties
Default: JES_PRINT_SPOOL_MSG=CONSOLE

L

LANG
Restriction: This environment variable applies to UNIX environments only.
Specifies the locale.

Syntax

LANG=language[_territory[.codepage]]
export LANG
Parameters
  • language The language in which your program is to run.
  • _ (underscore) The delimiter for language and territory, if territory is specified.
  • territory The country in which your program is to run.
  • . (period) The delimiter for territory and codepage, if codepage is specified.
  • codepage The character set to use for your program.

Example

LANG=fr_FR
export LANG
LD_LIBRARY_PATH
Restriction: This environment variable applies to UNIX environments 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. If you have installed the product to a directory other than the default one, you must set this variable to 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.

Syntax

LD_LIBRARY_PATH=pathname[:pathname]...
export LD_LIBRARY_PATH
Parameters

pathname A path or a list of paths, each separated by a colon (:).

Comments

The list of directories must include $COBDIR/lib. The COBDIR environment variable is described earlier.

This environment variable is a system environment variable; see your UNIX documentation for more information.

Example

LD_LIBRARY_PATH=$COBDIR/lib:/home/mydir/myapp:$LD_LIBRARY_PATH
export LD_LIBRARY_PATH
LIB
The location of the DB2 LIB directory.
LIBLIST
Restriction: This environment variable applies to UNIX environments only.
Reserved for use by Micro Focus. Use only if directed by Micro Focus Technical Support.
LIBPATH
Restriction: This environment variable applies to UNIX environments only.
Specifies the directory or directories for the UNIX system, Cob and the run-time system to search for shared libraries and callable shared objects. It is only available on AIX-based systems. If you have installed the product to a directory other than the default one, you must set this variable to 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.

Syntax

LIBPATH=pathname[:pathname]...
export LIBPATH

Parameters

pathname A directory to search for shared libraries.

Example

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

M

MAINFRAME_FLOATING_POINT
Specifies the format to use for floating point data items. Possible formats are IBM hexadecimal and IEEE.

Syntax

Windows:
SET MAINFRAME_FLOATING_POINT=fpstatus
UNIX:
MAINFRAME_FLOATING_POINT=fpstatus
export MAINFRAME_FLOATING_POINT

Parameters

fpstatus Which format to use for floating point data items. This must be one of:

  • true Specifies that IBM hexadecimal format floating point data items are to be used.
  • false Specifies that IEEE format floating point data items are to be used.

Setting MAINFRAME_FLOATING_POINT to anything other than true has the same effect as setting it to false.

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.
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 (ASCII or EBCDIC).
MF_CBLQDA
Determines if QSAM files are dynamically allocated when processing an OPEN I-O or OPEN EXTEND statement for an optional file (that is, a file opened using the SELECT OPTIONAL syntax in the FILE-CONTROL paragraph) or a file opened for OUTPUT (regardless of whether it is optional or not). Permissible values are OFF and ON; the default is OFF, which specifies that dynamic allocation is not permitted.
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.
Note: 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.
Properties
Default: MF_DUPJOBS=N
MF_IKJEFT_KEEP_MAX
Determines whether IKJEFT01 uses the last return code from a command or the highest return code of all commands executed as the step COND CODE.
Syntax
MF_IKJEFT_KEEP_MAX={Y|N}
Parameters
Y
IKJEFT01 uses the highest return code of all commands executed as the step COND CODE.
N
IKJEFT01 uses the last return code from a command as the step COND CODE.
Properties
Default: MF_IKJEFT_KEEP_MAX=N
MF_FALLTHRUCHECK
Specifies whether MSS is to check that the main COBOL program ends by executing a GOBACK or STOP RUN.
Syntax
MF_FALLTHRUCHECK={Y|N}
Parameters
Y
Check that the main COBOL program ends by executing a GOBACK or STOP RUN.
Y
Do not check that the main COBOL program ends by executing a GOBACK or STOP RUN.
Properties
Default: MF_FALLTHRUCHECK=Y
Comments
If MF_FALLTHRUCHECK is set to Y and the check fails, MSS issues this message:
JCLCM0213S Main pgm xxxxxxxx did not issue GOBACK or STOP RUN. 
MF_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
UNIX:
MF_JES_ABEND_CAF_COMMIT=value
export MF_JES_ABEND_CAF_COMMIT
Windows:
MF_JES_ABEND_CAF_COMMIT=value
Value

value can be one of:

  • Yes - an abend (S482) is generated.

  • No - an abend is not generated.
  • rtn-code - a numeric value (up to 3 digits) to be used as the return code.
Default
Yes.
MF_JCL_AUDIT
Syntax
MF_JCL_AUDIT={DLET|DLEJ|DLET,DLEJ}
Parameters
DLET
Logs audit information each time an ESMAC/CAS utility deletes a catalog entry
DLEJ
Logs audit information each time a step in a JCL job deletes a catalog entry
DLET,DLEJ
Logs audit information each time either an ESMAC/CAS utility or a JCL job step deletes a catalog entry.
Properties
Default: None
Comments
The information recorded in the log is:
  • The user who deleted the catalog entry
  • The group to which the user belongs
  • Whether the catalog entry was deleted by an ESMAC user or a JCL job step
  • The name of the deleted catalog entry
  • Whether the standard delete operation or the JCL delete operation was performed
Example
The following is an example of the audit event passed to SYSLOG:
mf.jcl 35500 5:5 [timeQuality tzKnown="1" isSynced="0"][origin ip="127.0.0.1" enterpriseID="********.5043" 
software="Micro Focus Auditing" swVersion="API ver 1.2.2 syslog ver 1.0.0"][meta 
sequenceId="88"][MFAuditPropertyList@5043 SYSTEM="AUDIT   "] userid=SYSAD    groupid=SYSADM 
  jobnum=0000000 jobname=ESMAC    dsname=MFI01.ANF.TEST1                         
     member=         api=MVSCATIO apifunc=DLET 
MF_JESPWR_EXIT
MF_JESPWR_EXIT is used to pass JES2 and VSE PWR statements to a user exit, MFJESPWR. If this environment variable is set the JCL execution engine will call the exit program, MFJESPWR, whenever a JES2 or VSE PWR statement is encountered. It passes the contents of the JCL record plus Job and Job Step information . A sample MFJESPWR.cbl is included with the product.
Syntax
MF_JESPWR_EXIT=Y
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 [7]
Specifies whether the JES configuration uses single or multiple LEX files, and enables JES configuration to specify subdirectories for LEX files as necessary.
Syntax
MF_LEX_API={1|2|D}|1D|2D
Parameters
1
Use multiple LEX files.
2
Use a single LEX file. Disk-based access only.
D
Use directories to store LEX files.
Default
MF_LEX_API=1
Comments
Do mix these settings in a Region/PAC. They must be consistent for all.
MF_MFA
Specifies what data set catalogs are to be searched.
Syntax
MF_MFA={ALL|RJSE}
Parameters
ALL
Search for data sets first in the local catalog, and if not found, on the mainframe.
RJSE
Search for data sets in the local catalog only. No mainframe search is performed.
Properties
Default: MF_MFA= ALL
MF_MVSJOB
Sets the number at which a job starts and finishes.
Syntax
MF_MVSJOB=lower value{-|+}upper value
						
Parameters
lower value
Number at which a job starts. Contains seven digits - for example, 0000001.
+
Reset the values to these new ones each time the region is started.
-
Sets the values but only on the first startup of the region.
upper value
Upper job number. Contains seven digits - for example, 9999999.
Properties
Default: None*
* If a value set using this variable is not valid, the default values of <0001000>{-|+}<0099999> are set.
Comments

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

Tip: To revert to five-digit job number support, set:
 MF_MVSJOB=low number + high number

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

Example
set MF_MVSJOB=0000010+0000100

Resets the values to start with job number 10 and run through to job number 100. When the upper limit has been reached you receive a message:

All job numbers in the range 0000010:0000100 are in use

At this point you need to remove some jobs from the spool - you can use the spool housekeeping functions to do this.

MF_MVSP0034_LIMIT
Specifies the number of records in each exported catalog XML document.
Syntax
MF_MVSP0034_LIMIT=limit
Parameter
limit
A one- to six-digit number between 1 and 999999.
Properties
Default: None*
* If unset, then all records are written to the catalog export XML file.
MF_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.
Properties
Default: MF_NODD=A
MF_PCRENAME_LAX
Determines whether physical files in other locations can be renamed if the cataloged name is changed.
Syntax
MF_PCRENAME_LAX={Y|N|D}
Parameters
Y
Enables physical files in other locations to be renamed if the cataloged name is changed.
N
When an MVS dataset is renamed, the associated physical file is normally renamed only if it is stored in a subdirectory of the of the catalog file location.
D
Creates a new directory structure and filename, and moves the existing file to the new location.
Properties
Default: MF_PCRENAME_LAX=N
MF_RCCF
Determines whether to enable or disable Job Step Execution (RJSE).
Syntax
MF_RCCF={DELETEJOB|KEEPJOB}
Parameters
DELETEJOB
Disables RJSE.
KEEPJOB
Enables RJSE.
Properties
Default: MF_RCCF=DELETEJOB
MF_ROOT_CERT
Enables the MF Directory Server process and any client applications to pick up the value of the root certificate file.
MF_SMS
Enables support for IBM Storage Management Subsystem (SMS) data classes.
Syntax
MF_SMS={ON|OFF}
Parameters
ON
Turns on support for SMS data classes.
OFF
Turns off support for SMS data classes.
Properties
Default: MF_SMS=OFF
Comments
MSS provides emulation for SMS data classes only.

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

MF_SPOOL_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

Windows:
SET MF_SPOOL_ARCHIVE_LOC=file-location
UNIX:
MF_SPOOL_ARCHIVE_LOC=file-location
export MF_SPOOL_ARCHIVE_LOC

Values

file-location The file location.

MF_SPOOL_HK_LEX_SCAN

Determines if the MFELX* files associated with a job are also deleted when spool housekeeping is run.

Syntax

Windows:
SET MF_SPOOL_HK_LEX_SCAN=Y|N
UNIX:
MF_SPOOL_HK_LEX_SCAN=Y|N
export MF_SPOOL_HK_LEX_SCAN

Values

Y The files are deleted.

N The files are not deleted.

Default

The default is 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

Windows:
SET MF_SPOOL_HK_OUTPRTC=value
UNIX:
MF_SPOOL_HK_OUTPRT=value
export MF_SPOOL_HK_OUTPRTC

Values

Y Files from the Complete queue are deleted.

NFiles from the Complete queue are not deleted.

Default

The default is Y.

MF_SPOOL_HK_TESTDATE
Overrides the normal date for the spool housekeeping.

Syntax

Windows:
MF_SPOOL_HK_TESTDATE=YYYYMMDD
UNIX:
MF_SPOOL_HK_TESTDATEC=YYYYMMDD
export MF_SPOOL_HK_TESTDATEC

Values

YYYYMMDD The date which is to override the normal date.

Default

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

MF_SPOOL_HK_WRITE_PROFILES
Determines the creation of profile files (.PRO files) when a data set is archived.

Syntax

Windows:
SET MF_SPOOL_HK_WRITE_PROFILES=Y|N
UNIX:
MF_SPOOL_HK_WRITE_PROFILES=Y|N
export MF_SPOOL_HK_WRITE_PROFILES

Values

Y Profile files are created.

N Profile files are not created.

Default

The default is 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.
Properties
Default: MF_UCC11=N
MF_UCC11_DYNCLEAN
When MF_UCC11 is enabled, controls whether dynamically allocated datasets (such as using SVC99) are cleaned when a job is restarted.
Syntax
MF_UCC11_DYNCLEAN={Y|N}
Parameters
Y
When a job is restarted, any dynamically allocated datasets are removed and replaced.
N
Prevents the cleaning of dynamically allocated datasets when restarting a job.
Properties
Default: MF_UCC11_DYNCLEAN=Y
Dependencies
Valid only when MF_UCC11=Y or YA.
MF_USESCA5
Specifies that the server should use version 5 of the Open Service Component Architecture.
Values:
  • ON (Default)
  • OFF
MF_USESCA7
Determines whether MSS accepts CA7 Scheduler control statements as comments rather than diagnosing them as errors.
Syntax
MF_USESCA7={ON|OFF}
Parameters
ON
Accepts CA7 Scheduler control statements as comments.
OFF
Diagnoses CA7 Scheduler control statements as errors.
Properties
Default: MF_USESCA7=ON
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
Windows:
MFACCCGI_CHARSET=windows-1252
UNIX:
MFACCCGI_CHARSET=iso-8859-1
MFALLOC_DEF_VB_PCFILE
Determines whether a new PSVB file is defined in the catalog.
Syntax
MFALLOC_DEF_VB_PCFILE={Y|N}
Parameters
Y
A new PS VB file is defined in the catalog as a VB file with default settings of minimum length = 0, and maximum length = 32760.
N
Do not create a new PS VB file.
Properties
Default: MFALLOC_DEF_VB_PCFILE=Y
Dependencies
Valid only when LRECL is not set or is set to 0 (zero).
MFALLOC_LOC
The default allocated data set location.
For a database-hosted data set location, you need to include the full SQL URL, for example, set MFALLOC_LOC=sql://localhost/JCLTEST?folder=/JCLDEMO/data
MFALLOC_PROP
Rules for generated PC dataset names on allocation (that is, the default catalog PC DSN format).
MFAUDIT_LOGS
The location of audit files.
MFCATMNTUE

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

Syntax

UNIX:
MFCATMNTUE=program-name
export MFCATMNTUE
Windows:
SET MFCATMNTUE=program-name

Values

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

Default

MFCATMNTUE=MFCATMNTUE

MFCODESET
Specifies which translation tables to use.
Values
  • On UNIX platforms (requires Micro Focus Enterprise Developer UNIX Components):A pre-defined country code:
    Important: To specify a Euro codeset, meaning that it includes the Euro symbol (€), prefix an "E" to the appropriate country code listed below. A country code with no "E" prefix indicates a non-Euro code.

    Country Code

    (MFCODESET)

    EBCDIC CCSIDs Language
    AUTOMATIC

    AUTO

    Operating system default - sets country code based on CBL_GET_OS_INFO

    This setting is only applicable on Windows platforms.

    DEFAULT Set to 0437 (US English) on Windows, or 0081 (Japanese Katakana Extended) on Japanese Windows. Set to 0437 (US English) on UNIX.
    0031 37, 1140 Dutch
    0033 297, 1147 French
    0034 284, 1145 Spanish
    0039 280, 1144 Italian
    0043 273, 1141 German (Austrian)
    0044 285, 1146 UK English
    0045 277, 1142 Danish
    0046 278, 1143 Swedish
    0047 277, 1142 Norwegian
    0049 273, 1141 German
    0066 838 Thai Extended
    0081† 930 (290, 300) * Japanese Katakana Extended
    0082 933 (833, 834) *Korean
    0086 13676 (836, 837) *Simplified Chinese
    0351 37, 1140 Portuguese
    0358 278, 1143 Finnish
    0420 420 Arabic

    See Arabic Support Considerations below.

    0437 37, 1140 US English
    0500 500, 1148 International (Latin 1)
    0886 937 (37, 835) *Traditional Chinese
    0930 † 930 (290, 300) *Japanese Katakana Extended
    0939 † 939 (1027, 300) *Japanese Latin Extended
    9122 † 9122 (290, 300) *Japanese Katakana

    Character sets marked with an asterisk (*) are capable of mixed single-byte and double-byte character translation. EBCDIC CCSIDs in these rows indicate the mixed-byte CCSID first, followed by the single-byte, then double-byte Code Page Global Identifiers (CPGIDs) in parenthesis.

    Other EBCDIC CCSIDs in parentheses reflect a 'non-Euro, Euro' pair for appropriate country codes.

    For database applications using a DBMS server on Windows, use the table above.

    For Windows and UNIX database applications accessing a UNIX database created with single-byte character sets 819 or 923, use the following table:
    Country Code

    (MFCODESET)

    EBCDIC CCSIDs Languages
    1140 37,1140 Dutch US English Portuguese
    1141 273,1141 German (Austrian) German
    1142 277,1142 Danish Norwegian
    1143 278,1143 Swedish Finnish
    1144 280,1144 Italian
    1145 284,1145 Spanish
    1146 285,1146 UK English
    1147 297,1147 French
    1148 500,1148 International (Latin 1)
  • A code between 2000 and 9999 (except 9122) corresponds to a user-defined translation table. User-defined tables are created using the Codecomp utility.

On Windows platforms:

If you are not using UK or US language settings, you must also set the codepage in your PC environment settings:

  • Right click My Computer.
  • Select Properties.
  • Click Advanced system settings.
  • Click Environment Variables.
  • Under System Variables click New.
  • Enter MFCODESET as Variable name and XXXX as Variable value, where XXXX is your chosen codepage.
MFCODESET_DBCSDIR
Set this variable to 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.
If this variable is not set, the application looks in the etc/codeset sub-directory of the product installation directory to locate the files required for the inbuilt support. (The support covers codesets 81, 82, 86, 886, and 941.)
However, 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.
MFCSCFG
Specifies a configuration file to be used by the Client/Server Binding client program.

Syntax

Windows:
SET MFCSCFG=filename
UNIX:
MFCSCFG=filename
export MFCSCFG

Parameters

filename The name of the configuration file.

Example

Windows:
SET MFCSCFG=/home/mydir/mfclisrv.cfg
UNIX:
MFCSCFG=/home/mydir/mfclisrv.cfg
export MFCSCFG

Comments

The value of MFCSCFG is overridden by any value defined in the command line. If neither of the above yields a filename, the default filename mfclisrv.cfg is assumed, and is searched for in the current directory. If that in turn is not found, the default settings for the configuration entries are used.

MFDBFH_CONFIG

Specifies the location and the name of the configuration file that defines the database server instances and associated databases.

Syntax

UNIX:
MFDBFH_CONFIG=value
export MFDBFH_CONFIG
Windows:
SET MFDBFH_CONFIG=value

Values

value represents the full path and filename of your database configuration file.

Default

Not set.

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

UNIX:
MFDBFH_GRANT_USER_PERMISSIONS=value
export MFDBFH_GRANT_USER_PERMISSIONS
Windows:
MFDBFH_GRANT_USER_PERMISSIONS=value

Values

value is a space-separated list of users and/or roles that will be granted to execute privileges to the types and procedures created by MFDBFH.

Default

Not set.

Notes

If the variable is not specified, the Oracle default permissions are applied, which are to grant execute permissions to the schema owner of that type/procedure only.

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

UNIX:
MFDBFH_RECORD_LOCKING=table|database
export MFDBFH_RECORD_LOCKING
Windows:
SET 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
Note: If the value of this variable is set to anything other than 'database', this default is used.
MFDBFH_SCRIPT_DIR

Specifies the location of the scripts and stored procedures required when the database file handler is in effect.

Syntax

UNIX:
MFDBFH_SCRIPT_DIR=value
export MFDBFH_SCRIPT_DIR
Windows:
SET MFDBFH_SCRIPT_DIR=value

Values

value represents a path to the directory containing the required resources.

Default

value defaults to the \etc\mfdbfh\scripts sub directory of your product installation directory.

MFDBFH_VAULT
Specifies the name of a secrets vault (which must be defined in the product's secrets.cfg file). If this environment variable is not set, MFDBFH uses the default vault, as defined in secrets.cfg.

For more information on secrets vaults, see Vault Facility.

Syntax

UNIX:
MFDBFH_VAULT=value
export MFDBFH_VAULT
Windows:
SET MFDBFH_VAULT=value

Values

value represents the name of a vault.

Default

Not set.

MFCROW_DISABLE
Turn off common directives, preventing compilers from using directives found in directives.mf files.
Syntax
SET MFCROW_DISABLE={Y|N}
Parameters
Y
Compilers do not use directives in directives.mf files.
N
Compilers use directives in directives.mf files (default).
Enables SMS support.
Syntax
Parameters
Default
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.

Comments

When set to Y, must be used with TYPE A or ASCII sub command.

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.
Configures Mainframe Express-format BTS tracing
Syntax
Parameters
Default
Comments
Example
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.
Y
Run the steps listed after a restart step that have conditions that refer to steps prior to the restart.
Properties
Default: MFJ_ALL_STEP_CHECK=N
Comments
The default behavior of this product is to not check COND CODES from steps prior to a restart step. This means that the steps after the restart step that have conditions that refer to any steps prior to the restart step might run. This is a change of behavior from releases 4.0 Patch Update 1 and earlier when these steps would have not run. Micro Focus recommends that you review and test the behavior before restarting the jobs.

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

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

MFJ_INPUTDS_ERROR
Determines whether IEBDG, IEBGENER, IEBCOMPR, and DFSORT, and ICETOOL emulation treat missing input files as though they were present but empty.
Syntax
MFJ_INPUTDS_ERROR={Y|N}
Parameters
Y
Treats missing input files as missing.
N
Causes IEBDG, IEBGENER, IEBCOMPR, and DFSORT, and ICETOOL emulation to treat missing input files as though they were present but empty.
Properties
Default: MFJ_INPUTDS_ERROR=Y
MFJ_LEX_LOCATION
Specifies an alternative location for the storage of JCL lexigraphical files, which are created when a job is parsed, and are stored in the same directory as the job log by default.
Syntax
MFJ_LEX_LOCATION=path
Parameter
path
The full path to the alternative directory location in which to store JCL lexigraphical files. The alternative directory location must be accessible by all enterprise server regions that both submit and run jobs.
Properties
Default: None
MFJFAXIT
Specifies the user exit program that enables file action notifications.
Syntax
MFJFAXIT=path-and-file-name
					
Parameter
path-and-file-name
The full path and filename for the user exit program that enables file action notifications.
Properties
Default: None
Comments
This user exit is called by the JCL engine whenever a JCL file is opened OUTPUT, I-O, or EXTEND, or when it is copied or renamed by the JCL engine. See User Exit for File Action Notifications for more information.
Example
A sample user exit program (MFJFAXIT.cbl) is provided with your product, and is located in the src\enterpriseserver\exits sub-directory of your product install directory.
MFJ_PTPCH_CODESET
Causes MFJPTPCH to check the same hexadecimal character value as with Japanese code set 9122 to decide whether a character is printable or not.
Syntax
MFJ_PTPCH_CODESET=EXTJ
Parameter
EXTJ
MFJPTPCH checks the same hexadecimal character value as with Japanese code set 9122 to decide whether a character is printable or not.
Properties
Default: None
Dependencies
For use only when an extended Japanese code set other than 9122 is being used.
MFJ_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
Default: MFJ_REPRO_EMPTY=Y
MFJ_STRICT_CASE
Determines the case to be maintained for physical file names passed to MVSCATIO by the catalog API (and other utilities such as MFCATXML and MVSPCRN).
Syntax
Windows:
SET MFJ_STRICT_CASE=Y|N
UNIX:
SET MFJ_STRICT_CASE=Y|N
export MFJ_STRICT_CASE
Parameters
Y
MVSCATIO honors the case of physical file names passed by the catalog API, and other utilities such as MFCATXML and MVSPCRN.
N
All physical file names are folded into upper case.
Properties
Default: MFJ_STRICT_CASE=N
MFJSABCODE
Determines the abend (abnormal end) code issued when MFJSERET=ABEND is in effect. If a Sort or Merge operation fails with an unrecoverable error, it will abend with a code between S001 and S063.

Syntax

Windows:
SET MFJSABCODE=code
UNIX:
MFJSABCODE=code
export MFJSABCODE

Parameters

code A decimal value between 1 and 99 representing the abend code to be issued.

Any specified value outside of the range 1 to 99 will result in an abend code of S00D being issued.

Default

By default, this environment variable is not set. If so, and if MFJSERET=ABEND is in effect, an abend S00D (decimal code 16) is issued when a Sort or Merge operation fails with an unrecoverable error.

Example

MFJSABCODE=77

This example results in abend code S04D being issued.

MFJSENGINE
Specifies which sort engine the utility MFJSORT is to emulate.
Syntax
MFJSENGINE={DFSORT|SYNCSORT}
Parameters
DFSORT
MFJFSORT emulates the DSORT utility.
SYNCSORT
MFJFSORT emulates the SYNCSORT utility.
Properties
Default: MFJSENGINE=DFSORT
MFJSERET
If this environment variable is not set, an unsuccessful operation and its program will terminate with an unrecoverable error (return code 16). See also MFJSABCODE.

Syntax

Windows:
SET MFJSERET=ABEND
UNIX:
MFJSERET=ABEND
export MFJSERET

Parameters

ABEND The operation will abend and its program will continue instead of terminating with an unrecoverable error (return code 16)

Default

By default, this environment variable is not set.

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

Windows:
SET MFJSSTRICTSORT=ON|OFF
UNIX:
MFJSSTRICTSORT=ON|OFF
export MFJSSTRICTSORT

Default

The default is OFF.

Example

MFJSSTRICTSORT=ON
MFJSTATS

For a COBOL sort not running under mainframe emulation, setting the environment variable MFJSTATS to 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.

If you are performing a COBOL sort using mainframe emulation, you can create a statistics report by modifying the JCL statement.

Syntax

Windows:
SET MFJSTATS=switch
UNIX:
MFJSTATS=switch
export MFJSTATS

Parameters

switch Switches report creation ON or OFF. The default is OFF.

MFJSWINDOW

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

Syntax

Windows:
SET MFJSWINDOW=value
UNIX:
MFJSWINDOW=value
export MFJSWINDOW

Values

To set a sliding century window, set a value between 0 and 100. For example, a value of 80 would set a century window of 1931-2030 in 2011, 1932-2031 in 2012, and so on.

To set a fixed century window, set a value between 1000 and 3000. For example, a value of 1973 would set a century window of 1973-2072.

Default

The default is a sliding value of 80 when emulating DFSORT, and a default value of 0 when emulating SYNCSORT. A value of 0 equates to a century window, starting in the current year.

Comment

You can use this environment variable instead of the Y2PAST sort option.

Example

MFJSWINDOW=25
MFLECONFIG

Specifies a configuration file for Language Environment (LE) run-time options.

Syntax

Windows:
SET MFLECONFIG=filename
UNIX:
MFLECONFIG=filename
export MFLECONFIG

Parameters

filename The file containing the LE run-time options you want to use.

MFLOCKING
Enables Locking Support.
MFLOGDIR
Specifies a directory to be used by Client/Server Binding for log files.

Syntax

Windows:
SET MFLOGDIR=dirname
UNIX:
MFLOGDIR=dirname
export MFLOGDIR

Parameters

dirname The name of the directory for log files.

Example

Windows:
SET MFLOGDIR=/home/mydir/logs
UNIX:
MFLOGDIR=/home/mydir/logs
export MFLOGDIR
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}
Values
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
None. When 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.
Properties
Default: E
MFREXX_LSEQ_RECSIZE_MAX
Specifies the record length for the REXX EXECIO command when reading or writing a line sequential file that has been cataloged with a record length of zero.
Syntax
MFREXX_LSEQ_RECSIZE_MAX=rec-length
Parameter
rec-length
Record length to use. The minimum value you can specify is 255. Specifying an invalid value, or a value less than 255, results in the default value being used.
Properties
Default: 255
MFREXX_NO_PROCESS_STDIN
Determines whether to stop STDIN from being processed on an EXECIO command.
Syntax
MFREXX_NO_PROCESS_STDIN={Y|N}
Parameters
Y
Stops STDIN from being processed on an EXECIO command.
N
STDIN is processed on an EXECIO command.
Properties
Default: MFREXX_NO_PROCESS_STDIN=N
MFREXX_NOT
Specifies one or more characters to be used for the NOT operator in addition to REXX's default, which is "¬".
Syntax
MFREXX_NOT=char-spec
Parameter
char-spec
One or more characters for each operator; each character you specify is used in addition to the default operator. Each additional character must be defined within single or double quotes, or in hexadecimal. Separate multiple characters with a space or a comma.
Properties
Default: "¬"
Comments
Any error in the specification of the additional characters, including the specification of alphabetic or numeric characters, results in the environment variable being ignored.
MFREXX_OR
Specifies one or more characters to be used for the OR operator in addition to REXX's default, which is "|".
Syntax
MFREXX_OR=char-spec
Parameter
char-spec
One or more characters for each operator; each character you specify is used in addition to the default operator. Each additional character must be defined within single or double quotes, or in hexadecimal. Separate multiple characters with a space or a comma.
Properties
Default: "|"
Comments
Any error in the specification of the additional characters, including the specification of alphabetic or numeric characters, results in the environment variable being ignored.
MFRU_NOINHERIT
Note: This variable is only applicable to Windows environments.
Determines if processes are registered in shared memory during initialisation of the run-time system. COBRT105 errors can occur during initialisation if a very large number of COBOL processes are running and there are no available slots in the shared memory segment - setting this variable to Y or TRUE skips the registration process. However, when set to Y, various run-time settings (switches, shared memory, console window settings, etc...) are no longer inherited by any child processes.

When the variable is not set (which is the default), the registration process is not skipped.

Syntax

SET MFRU_NOINHERIT=Y|TRUE

The default is that the variable is not set.

MFSUB
Specifies whether to use SUBI or ASUBI.
Values
  • SUBI
  • ASUBI
MFSYSCAT
The location and file name of the JES system catalog.
Syntax
Windows:
SET MFSYSCAT={path\CATALOG.DAT | URL}
UNIX:
export MFSYSCAT={path/CATALOG.DAT | URL}
Parameters
path
The full path to the location of the CATALOG.DAT file.
URL
For a database-hosted system catalog, the full SQL URL that points to the CATALOG.DAT file.
Properties
Default: None
Comments
See the data category in The dbfhdeploy Command Line Utility for full notation details if specifying a database-hosted system catalog.
Examples
Windows:
SET MFSYSCAT=C:\MY\CATALOG\FOLDER\CATALOG.DAT
UNIX:
export MFSYSCAT=/MY/CATALOG/FOLDER/CATALOG.DAT
Windows:
SET MFSYSCAT=sql://localhost/JCLTEST/catalog.dat?folder=/JCLDEMO
UNIX:
export 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.
MFTRACE_LOGS
The location of the CTF log files.
MFTSO_DEBUG
Controls the display of debug messages.
MFUSER
The default User 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-and-file-name
Parameter
path
The full path to the file specified by the MFUSERCAT_LOC environment variable.
Properties
Default: None
Dependency
Valid only when the value of MFUSERCAT_LOC is a file name only.
Comments
If multiple user catalog files are in the same location - for example, C:\USERCATALOGS or $$MYFILESHARE - use this environment variable to store that location. Then, you only need to specify the file name of the catalog in MFUSERCAT_LOC.
MFUSERCAT_LOC
Specifies the location and name of each additional catalog, matching the values provided in the MFUSERCAT_NODE value.
Syntax
MFUSERCAT_LOC=[path]file-name[;[path]file-name]][...]
Parameter
path
The full path to a file catalog file.
file-name
The name of the catalog file.
Properties
Default: None
Comments
Parameters are limited to a total of 4096 characters.

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

MFUSERCAT_NODE
Specifies additional SMS, SPOOL, and User catalogs.
Syntax
MFUSERCAT_NODE=node-name[,node-name][...]
Parameter
node-name
A user catalog or special node name.
Properties
Default: None
Comments
Use this variable to specify additional SMS, SPOOL and User catalogs. Up to 64 additional catalogs may be specified with semi-colon separated values (see Multiple Catalog Support for more details). The physical file used for each catalog is stored in the environment variable MFUSERCAT_LOC.

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

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

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

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

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.
Default
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)
MULTMFENTMAP
Specifies whether special characters such as < and & are replaced with the equivalent HTML entities (for example &lt; and &amp;).

O

OOSW
OO run-time switches.

P

PATH
Restriction: This environment variable applies to UNIX environments only.

Specifies the directories to be searched by all UNIX programs, including the run-time system, when finding executables to be run.

Syntax

PATH=pathname[:pathname]...
export PATH

Parameters

pathname A directory to search for executables.

Example

PATH=$COBDIR/bin:$PATH
export PATH
PROCLIB
When set to ON and under a mainframe emulation, a file status of 37 is returned 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. The default for this variable is OFF.

S

SORTCOMPRESS
Tells the system whether or not to execute a compression routine on each record to be sorted.

Syntax

Windows:
SET SORTCOMPRESS=n
UNIX:
SORTCOMPRESS=n
export SORTCOMPRESS

Parameters

n - An integer that indicates if compression is enabled or not. 0 (zero, the default) indicates not enabled; any positive integer indicates enabled. When enabled, it allows for run-length encoding of sort records, resulting in much better performance when records contain multiple repeated characters.

Comments

This variable is recommended if the sort records contain many single repeated characters, for example, multiple spaces, as it can be very effective in improving memory usage and therefore sort performance.

Example

Windows:
SET SORTCOMPRESS=5
UNIX:
SORTCOMPRESS=5
export SORTCOMPRESS
SORTEXITREENTRY
Determines whether E15 user exits will be called after the SORTIN data set has been exhausted. [9]
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
Activates a sortscheme. Use in conjunction with SORTSPACE for improved performance.

Syntax

Windows:
SET SORTSCHEME=1
UNIX:
SORTSCHEME=1
export SORTSCHEME
Values
  • SORTSCHEME=1 - this is the only valid value for the environment variable. See SORTSPACE for more information.
SORTSPACE
The amount of memory to be allocated to internal workspace for SORT operations. This can be specified in different formats: for example, you could specify 64M, 2G, and 1000000 to give sort memory areas of 64 Megabytes, 2 Gigabytes and 1000000 bytes respectively.

Syntax

Windows:
SET SORTSPACE=n[K|k|M|m|G|g]
UNIX:
SORTSPACE=n[K|k|M|m|G|g]
export SORTSPACE

Parameters

n[K|k|M|m|G|g The amount of memory to be allocated to internal workspace for SORT operations. K or k indicates kilobytes, M or m indicates megabytes and G or g indicates gigabytes. No letter indicates bytes. Defaults to 1 megabyte.

Comments

A larger value for SORTSPACE will generally result 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 will be degraded.

Example

Windows:
SET SORTSPACE=1024K
UNIX:
SORTSPACE=1024K
export SORTSPACE

SORTTEMPSPACE
Specifies the amount of memory to be allocated to temporary workspace for SORT operations.

Syntax

Windows:
SET SORTTEMPSPACE=n[K|k|M|m|G|g]
UNIX:
SORTTEMPSPACE=n[K|k|M|m|G|g]
export SORTTEMPSPACE

Parameters

n[K|k|M|m|G|g] The amount of memory to be allocated to temporary workspace for SORT operations. K or k indicates kilobytes, M or m indicates megabytes and G or g indicates gigabytes. No letter indicates bytes. 32 megabytes is the lowest amount of memory that can be allocated.

Comments

The memory allocation strategy used by SORT can be adjusted through use of SORTTEMPSPACE, which generally improves performance in systems suffering from memory fragmentation.

Example

Windows:
SET SORTTEMPSPACE=250MB
UNIX:
SORTTEMPSPACE=250MB
export SORTTEMPSPACE
SORTTYPE
Defines the sort type.

Syntax

Windows:
SET SORTTYPE=2
UNIX:
SORTTYPE=2
export SORTTYPE
Values
  • SORTTYPE=2 Forces SORT to use the file handler, so that format modifications are picked up from the extfh.cfg file.
  • Not setting this variable means that SORT will try to use CBL_ routines to read and write files to improve performance.
Note: 2 is the only valid value for this environment variable.
SPOOL_TIMEOUT
Enables greater control over record-lock retries by setting timeout and interval durations.
Syntax
SPOOL_TIMEOUT=timeout:interval
Parameters
timeout
The amount of time in milliseconds to continue to retry the lock before ceasing the attempt.
interval
The amount of time in milliseconds before initiating a new lock retry attempt.
Properties
Default: SPOOL_TIMEOUT=500:100
Comments
Set this environment variable to resolve reported record-locked messages, which, depending on hardware performance, can occur especially during shutdown of an enterprise server instance with an SSTM job.
SSTM_WC_REFRESH
Determines how often the write count for the SSTM job is updated in SYSOUT or SYSPRINT.
Syntax
SSTM_WC_REFRESH={0|value}
Parameter
0
The count is only updated when the file is closed.
value
A value between 1-65535 to indicate the number of writes at which the count is updated
Properties
Default: None
Comments
Any provided value outside of 0-65535 defaults to 65535.
STEPLIB
The path or paths to search for Loader input-load member .390 files.
Syntax
STEPLIB=path-name[;path-name[...]]
Parameter
path-name
The full path to a location containing input-load member .390 files.
Comments
.390 files must contain SYSLMOD.
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.
  • 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.

Properties:

Default: OFF
IDE equivalent: None
SYSIN
The path for macro input .MLC files.
Syntax
SYSIN=path-name
Parameter
path-name
The full path to the location that contains macro input .MLC files.
SYSLIST
The path for Assemble and Link listing files.
Syntax
SYSLIST=path-name
Parameter
path-name
The full path to the location that contains Assemble and Link listing files, including .MAT, .PRN, and .LST files.
SYSWORK
The path to Assemble, Link and Animator/370 work files.
Syntax
SYSWORK=path-name
Parameter
path-name
The full path to the location that contains Assemble, Link, and Animator/370 work files, including .BAL, and .IDF/.IDX files.
SYSPUNCH
The path to Assemble output files for PUNCH statements.
Syntax
SYSPUNCH=path-name
Parameter
path-name
The full path to the location that contains Assemble output files for PUNCH statements, including .PCH files.
SYSMPC
The path to Assemble input precompiled macros.
Syntax
SYSMPC=path-name
Parameter
path-name
The full path to the location that contains Assemble input precompiled macros, including .MPC.
SYSLIB
The paths for Assemble input macro and copy files.
Syntax
Windows:
SYSLIB=path-name[;path-name[...]]
UNIX:
SYSLIB=path-name[:path-name[...]]
Parameter
path-name
The full path to a location containing Assemble input macro and copy files, including .MAC and .CPY files.
SYSLIN
The path to Link input and Assemble output files.
Syntax
SYSLIN=path-name
Parameter
path-name
The path to Link input (.LIN) files and Assemble output (.OBJ) files.
SYSLMOD
The path for Link output load-member (.390) files.
Syntax
SYSLMOD=path-name
Parameter
path-name
The path to Link output load-member (.390) files.
SYSPARM
The path for the Macro input SYSPARM value.
Syntax
SYSPARM=path-name
Parameter
path-name
The path to the Macro input SYSPARM value.

T

TERM
Restriction: This environment variable applies to UNIX environments only.
Defines the type of terminal being used.

Syntax

TERM=name
export TERM

Parameters

name The name of the terminal in the terminfo database.

Example

TERM=at386
export TERM
TERMINFO
Restriction: This environment variable applies to UNIX environments only.

Specifies the directory to be searched by all UNIX programs, including the run-time system, for the UNIX system terminfo database.

Syntax

TERMINFO=pathname
export TERMINFO

Parameters

pathname The name of a 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
Restriction: This environment variable applies to UNIX environments only.
Specifies a directory in which to store temporary files in place of the UNIX system default.

Syntax

TMPDIR=pathname
export TMPDIR

Parameters

pathname The directory used by UNIX applications for any temporary work files. 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. If you do not specify a directory, the system default directory is used.

Comments

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. This can be a location on disk or a datastore location within a database. For database-hosted files, use the notation sql://host[/instance]/datastore[?folder=/path] - see The dbfhdeploy Command Line Utility for more information.
TXMAPP
The location of the BMS load module.
TXRDTP
The location of 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.
USER
Restriction: This environment variable applies to UNIX environments only.
Default user name.

U

USER
Restriction: This environment variable applies to UNIX environments only.
Default user name.
USSCONFIG
Use this variable to point to the location of the SSL cipher suite specification file(s) used by the CIPHERS attribute in the CICS URIMAP or TCPIPSERVICE resource.

The CIPHERS attribute in these CICS resources (which is for USAGE(CLIENT)) can be specified in one of the following ways:

  • A string of up to 56 hexadecimal digits that is interpreted as a list of up to 28 2-digit cipher suite codes.
  • The name of the SSL cipher suite specification file name can be up to 28 characters long including the extension which must be .xml. The file name can only contain the characters A-Z a-z 0-9 # - . @ _.
Syntax
UNIX:
USSCONFIG=/absolute/path/to/cipher/suite/specification/file(s)
export USSCONFIG
Windows:
SET USSCONFIG=/absolute/path/to/cipher/suite/specification/file(s)

V

VSE_STARTUP_CFG
The location of the VSE JCL configuration file.
Syntax
VSE_STARTUP_CFG=config-file
Parameter
config-file
The fully-qualified location and name of the configuration file to use.
Properties
Default: None

X

XFHLOG
Note: This variable is applicable to Windows platforms only.
Determines the location of the log file when the LOG option is active.

Syntax:

SET XFHLOG=DEFAULT

Parameters:

DEFAULT - generates the log file in the current directory.

Comments:

If the XFHLOG variable is not set, the log file is created in C:\ProgramData\Micro Focus\File Handler\[version-number].

where [version-number] represents the version of your Micro Focus product.

The effect of this variable can be overridden by the LOGFILENAME configuration option.