Environment variables in alphabetical order

C

CASRDO44_NEWSUB
Category: General
Enables access to JCL files held on the local machine on which the browser is running.

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
Category: JES
If errors are experienced by the spool module, the number of times it retries to obtain a record lock can be adjusted using this environment variable.

Syntax

CASSPOOL_LOCK_RETRY_COUNT=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

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

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

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

CCITCPS_server_name=port
export CCITCPS

Parameters

  • server_name is the name of the CCI server
  • port is the fixed TCP post 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

set CCITCPS_server_name=MFPORT:3000
export CCITCPS
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
Part of the process to enable CCI tracing is to specify the degree of information that will be traced, which can be done by setting the CCITRACE environment variable as follows:

Syntax

CCITRACE=filename [options]
Parameters
  • filename The name of the log file you want the trace output to go to. If you do not specify this parameter, the log file ccitrace.log is created in the current directory with all options set to their default states.
  • options Any, or all, of the following:
/F or -F logs the details of CCI API calls to the trace file. The default is OFF, unless a filename any other trace option is specified, in which case it is always ON.
/P or -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 may be greatly increased.
/D or -D logs the contents of all buffers passed to and from the CCI functions. The default is OFF. Data tracing may not be allowed if the application has been coded to prohibit data tracing for security reasons.

So to create a CCI trace file with the default name of ccitrc1.trc (with matching ccitrc1.idx file) which traces CCI API function flow, along with the underlying protocol function flow, but with no tracing of the user data passed to these calls, the value of the CCITRACE environment variable would be /P.

The CCI.INI file 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.
COBAIF

Specifies the directory path that Animator is to search for the session (.aif) file for the program being animated, if it is not found in the same directory as the information (.idy) file. 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

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

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

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

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

COBCONFIG=pathname
export COBCONFIG

Parameters

  • pathname The name of the COBOL configuration file that tailors the runtime

Comments

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

Example

COBCONFIG=/home/mydir/cobconfig
export 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

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

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

COBDATA=pathname[:pathname]...
export COBDATA
Parameters
  • A list of search directories, each item separated by a colon. The runtime 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

COBDATA=:demo:/home/data:progs
export COBDATA

causes COBDATA to be set to instruct the runtime 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 the required Micro Focus COBOL system is installed. Many of the COBOL system components and utilities require and use this information. If the COBDIR environment variable is not set then the COBOL system acts as if it had been set to the default COBOL system directory. This default directory is /opt/microfocus/VisualCOBOL on UNIX systems.

Syntax
COBDIR=pathname
export COBDIR

Parameters

  • pathname The directory that contains the required Micro Focus COBOL system software.

Comments

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.

Example

COBDIR=/home/products/cobse20
export COBDIR

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

COBIDY

Specifies the directory that Animator is to search for the information (.idy) file for the program being animated if it is not found in the same directory as the intermediate code (.int) file. 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.
COBJVM

Specifies which Java Virtual Machine (JVM) to load.

Syntax
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

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

When a terminal key is depressed, the terminal might send in response a single character or a group of characters to the runtime 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 runtime 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 runtime system in discrete packets, then the network can alter the intervals between each character arriving at the runtime system. COBKEYTIMEOUT is available to help compensate for typical network delays so the runtime system identifies escape sequences correctly.

Syntax

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 runtime system over the line or network connection. On encountering a lone Escape character, the runtime system waits n tenths of a second before assuming that the character does not introduce an escape sequence. The runtime 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

Specifies the size of the main stack.

Syntax

COBMAINSTACK=n
export COBMAINSTACK

Parameters

n A number in the range 1 through nnn that represents the size of the main stack.

Comments

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

  • If you are deploying 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

COBMODE
Whether to start the server in 32-bit or 64-bit mode.
Values
  • 32

    The system starts in 32-bit mode

  • 64

    The system starts in 64-bit mode

COBOPT
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 runtime system is to search for dynamically loadable .int and .gnt files, or callable shared objects.

Syntax

COBPATH=pathname[:pathname]...
export COBPATH

Parameters

pathname A list of search directories, each item separated by a colon, that the runtime 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

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

Specifies the name of a print spooler that is to receive, via its standard input stream (stdin), output from any DISPLAY UPON PRINTER statement.

Syntax

COBPRINTER=command-line
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

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.
COBSSL
If using SSL connections specifies the location of the DemoCA directory. If not found, SSLDIR is inspected instead.
COBSW
Specifies the run-time system switch settings for the run-time system to observe when running an application.

Syntax

COBSW=[+/-}s...
export COBSW
Parameters

A list of the runtime switches to set or unset.

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

Example

COBSW=+0+D
export COBSW

This enables runtime switch 0 and the ANSI COBOL debug switch.

COBTERMINFO
Specifies the directory or directories to be searched by the runtime 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 runtime 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 runtime 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 colon.
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 colon.
COLUMNS

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

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

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 runtime system searches for an entry name map file called mfentmap.dat in each folder specified by the COBDIR environment variable.

If the runtime 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 runtime 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_ABORT_PLTPI_ERROR
Enables the user to set the error on which to abort PLTPI processing, bypassing the prompt.
Syntax
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

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

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 default value is Y, which expands an environment variable when used to specify an allocation path. Set to N to override this behavior, which is to not expand the variable used in the path.

Syntax

ES_ALLOC_OVERRIDE=rules-file
export ES_ALLOC_OVERRIDE

Values

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

ES_CAS_API
Indicates whether casout or cassub has been executed by a call and not from the command line.
Syntax
ES_CAS_API=value
export ES_CAS_API
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_CERT_REG
Specifies the directory in which the cascertreg user certificate utility should store its registrations.
Syntax
ES_CERT_REG=pathname
export ES_CERT_REG
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_CESN_NO_OS390
Overrides the default behaviour CESN transaction response for invalid user credentials. Default behaviour reports "Your userid is invalid" or "Your password is invalid".
Syntax
ES_CESN_NO_OS390=value
export CESN_NO_OS390
Values
  • Setting this variable to any value causes CESN to produce an invalid credential message instead of a specific invalid user or invalid password message.
Default

Specific invalid user/password messages will be produced.

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

Syntax

ES_CICS_SINGLE=value
export ES_CICS_SINGLE
Values
  • Y|y A user can only log on once.
Default
Not set: A user can log on multiple times.
ES_CLASS_XPCT
Controls the CICS PCT resource class.
Syntax
ES_CLASS_XPCT=value
export ES_CLASS_XPCT
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.
ES_CLASS_XCMD
Controls the CICS CMD resource class.
Syntax
ES_CLASS_XCMD=value
export ES_CLASS_XCMD
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.
ES_CLASS_XDCT
Controls the CICS DCT resource class.
Syntax
ES_CLASS_XDCT=value
export ES_CLASS_XDCT
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.
ES_CLASS_XFCT
Controls the CICS FCT resource class.
Syntax
ES_CLASS_XFCT=value
export ES_CLASS_XFCT
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.
ES_CLASS_XJCT
Controls the CICS JCT resource class.
Syntax
ES_CLASS_XJCT=value
export ES_CLASS_XJCT
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.
ES_CLASS_XPPT
Controls the CICS PPT resource class.
Syntax
ES_CLASS_XPPT=value
export ES_CLASS_XPPT
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.
ES_CLASS_XPSB
Controls the CICS PSB resource class.
Syntax
ES_CLASS_XPSB=value
export ES_CLASS_XPSB
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.
ES_CLASS_XRES
Controls the CICS DOCTEMPLATE resource class.
Syntax
ES_CLASS_XRES=value
export ES_CLASS_XRES
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.
ES_CLASS_XTST
Controls the CICS TST resource class.
Syntax
ES_CLASS_XTST=value
export ES_CLASS_XTST
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.
ES_CLASS_XTRAN
Controls the CICS TRAN resource class.
Syntax
ES_CLASS_XTRAN=value
export ES_CLASS_XTRAN
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.
ES_CLUSTER
Identifies a region as participating in an Enterprise Server Cluster. Mandatory for all regions in a cluster.
Syntax
ES_CLUSTER=ON
export ES_CLUSTER
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
ES_CLUSTER_ISC_TRACE=value
export ES_CLUSTER_ISC_TRACE
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
ES_CLUSTER_LISTENER_PORT_TO_USE=port
export ES_CLUSTER_LISTENER_PORT_TO_USE
Values
  • port A port number
Default
If this is not set, ES Cluster listeners will use ephemeral ports.
ES_CSKL_NO_MSG_CONSOLE
Stops CSKL writing messages to console.log
Syntax
ES_CSKL_NO_MSG_CONSOLE=value
export ES_CSKL_NO_MSG_CONSOLE
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 of CICS applications that use COMP declarations.
Values
  • Y - Enables support for COMP declarations.
  • N - Does not enable support for COMP declarations.
Default

N

ES_DDBG_PORT_RANGE
A range of ports to use for dynamic debugging.
You specify a range of port numbers separated by a hyphen or a comma; the second port number must be greater than the first.
Syntax
ES_DDBG_PORT_RANGE=value
export ES_DDBG_PORT_RANGE
Values
  • low_port-high_port
Default
If this is not set, dynamic debugging will use random ports.

Example

ES_DDBG_PORT_RANGE=8001-8040 
			 
ES_DISABLE_DFLTUSR_SIGNON
Disables the default user ("mfuser") signon when invoking ES Monitor & Control (ESMAC).
Syntax
ES_DISABLE_DFLTUSR_SIGNON=value
export ES_DISABLE_DFLTUSR_SIGNON
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.
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
ES_DFS3650=value
export ES_DFS3650
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_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
ES_ECI_MAX_RESP=value
export ES_ECI_MAX_RESP
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_ESM_CMDSEC
Indicates whether CICS processing honors the CMDSEC option specified on a transaction's PLT definition.
Syntax
ES_ESM_CMDSEC=value
export ES_ESM_CMDSEC
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
ES_ESM_IDPW_CASE=xy
export ES_ESM_IDPW_CASE
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
ES_ESM_PLTPISEC=value
export ES_ESM_PLTPISEC
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
ES_ESM_PLTPIUSR=userid
export ES_ESM_PLTPIUSR
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
ES_ESM_RCF=value
export ES_ESM_RCF
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
ES_ESM_RESSEC=value
export ES_ESM_RESSEC
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
ES_ESM_SECPRFX=value
export ES_ESM_SECPRFX
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
ES_ESM_XUSER
Indicates whether CICS processing performs surrogate user checks.
Syntax
ES_ESM_XUSER=value
export ES_ESM_XUSER
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
ES_ESMAC_DISP_MAX_OVERRIDE=value
export ES_ESMAC_DISP_MAX_OVERRIDE
Value
  • An integer number denoting how many lines to display. The maximum number is 99999.
Default
10000
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
ES_EUSA_SIZE=number
export ES_EUSA_SIZE
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
ES_GLM=value
export ES_GLM
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
ES_GLM_TIMEOUT=seconds
export ES_GLM_TIMEOUT
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_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
ES_HOSTNAME_TO_USE=hostname
export ES_HOSTNAME_TO_USE
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

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_IMS_BASIC_CHKP_OPT
When set to 1, enables a basic checkpoint call to process as if a SYNC call had been issued. The default is 0 (zero).
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. In some circumstances, the previous behavior of assuming a non-OTMA client is desirable. To use the previous behavior, set this environment variable to Y.

Values

  • Y
  • N. This is the default.

Example

ES_IMS_BYPASS_OTMA_DEST_RES=Y
ES_IMS_CONFIG
The IMS TM parameters.
ES_IMS_DB_COMMIT_FLUSH
When set to 0 (zero), forces the flushing of database buffers to disk on CLOSE only (default). When set to 1, forces the flushing of database buffers to disk on COMMIT only.
ES_IMS_DB_TLOG_WRITETHRU
When set to 0 (zero), forces the flushing of TLOG buffers to disk on COMMIT only (default). When set to 1, forces the flushing of TLOG buffers to disk on all database I/O.
ES_IMS_DEADLOCK_WAIT
Time in milliseconds to wait before checking for a deadlock. The default is 1000 (1 second).
ES_IMS_DIAGNOSE
Marks IMS TM as diagnose mode only for IMSMSGQ.
Values
  • Y The Transaction Manager (TM) works in diagnostic mode only, and no activity key points are written to the message queue. Use this feature only when advised to do so by Micro Focus.
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 compiled code that contains segment, field, and/or print exits.
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
Returns to CICS upon logging off or timing out, rather than returning to the IMS sign-on screen, which is the default behavior.
ES_IMS_IBMPLATFORM
Sets the emulation for the IMS run-time. Valid values are: M (for MVS) or D (for DOSVS). The default value is M.
Note: This variable is rarely required to be changed from its 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
Value returned to an INQY call.
ES_IMS_LOCALDLI
Deprecated. See IMS Database Locking. When set to 1, directs batch program execution to process all IMS DB calls entirely in the JES initiator providing significant performance improvement. All IMS DB control processes accessed from the batch program must be stopped before execution because they become exclusively owned by JES until the program completes.
ES_IMS_IRLM
Enables Internal Lock Resource Manager (IRLM) locking. IRLM locking more closely parallels mainframe IMS database DB locking behavior, reducing data constraint and potential for deadlock.
ES_IMS_LOCK_TIMEOUT
Allows the user to specify the IMS System ID returned to the AIBTDLI INQY ENVIRON call.
ES_IMS_LOCK_RETRY_DELAY
The IMS DB lock retry delay in milliseconds.
ES_IMS_LTERM_PREFIX
Note: This is a technology preview feature only. It is being made available to allow you to test and provide feedback on this new capability; however, this feature is not intended for production use and it is not supported as such.

Enables specification of a one- to four-character alternative LTERM prefix to apply when ES_IMS_SINGLE is set to N. The default is OTMA.

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.

To avoid confusion with regard to OTMA, and to also exercise control over name conflicts, change the default setting to a prefix of your choice.

In addition, 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.

ES_IMS_LU_LTERM
Determines the value of the LTERM literal returned by the MFS system. Valid values are: Y to return the LU name; N to return 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.
Restriction: Manually set this variable only when advised to do so by Micro Focus SupportLine.
ES_IMS_MESGQ=[ds-file-name];max-blocks;buffer-count;start-control;[cushion-size]
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).
ES_IMS_OPEN_TIMEOUT
Defines the wait period in seconds during which IMS retries the opening of a database file that is in use by another task. Default is 30 seconds.
ES_IMS_OTMA_DEST
Each specified destination consists of the destination name, the NONOTMA keyword, and the LU type (LU1 or LU3) separated by commas. Each destination definition is separated by a semi-colon.
IMS_OTMA_DEST=printerName,NONOTMA,LUtype[;...]
ES_IMS_PATH
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.

The default is D (which stands for dynamic).

ES_IMS_RELEASE
Allows the user to specify 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. Valid values are: Y to enable; N to disable. The default is N.
ES_IMS_SINGLE
Note: This is a technology preview feature only. It is being made available to allow you to test and provide feedback on this new capability; however, this feature is not intended for production use and it is not supported as such.

Enables specification of a one- to four-character alternative LTERM prefix to apply when ES_IMS_SINGLE is set to N. The default is OTMA

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 the IMS_LTERM_PREFIX entry in this topic 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 sublist for each user showing all active connections. These connections persist throughout a session, and are dynamically recreated during a warm start.

No KEYPOINT activity is associated with the use of ES_IMS_SINGLE.

ES_IMS_SPARSE_EXIT_LANG
Indicates the language of the IMS DB secondary index sparse routines. Set the variable to one of the following values:
  • C (for COBOL)
  • A (for Assembler)
By default, this variable is not set (sparse exits are disabled).
ES_IMS_SUPPORT
Enables IMS support.
ES_IMS_TLOG_COMPRESS
When set to 0 (zero), disables compression of the Backward Recovery TLOG file. When not compressed, the file contains only the information required to recover databases. The default is enabled.
Note: When enabled, Enterprise Server reclaims space in the file when information becomes obsolete.
ES_IMS_TLOG_FLUSH
When set to 1, forces the frequent flushing of TLOG and database buffers to disk.
Warning: 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.
Note: This environment variable is deprecated. Use ES_IMS_DB_TLOG_WRITETHRU to flush TLOG buffers and ES_IMS_DB_COMMIT_FLUSH to flush database buffers.
ES_IMS_TLOG_MAXSIZE
Maximum size of the IMS DB transaction logging file in bytes. The default is 4GB or h"FFF00000".
ES_IMS_TLOG_PATH
The location of IMS DB transaction logging files. The default is the Enterprise Server system directory.
ES_IMS_TLOG_THRESHOLD
Threshold size of the IMS DB transaction logging file. When reached, the current TLOG file is closed and a new TLOG file created for subsequent transactions. The default is 2GB or h"7FFFFFFF".
ES_IMSCFG
The location of the IMS configuration files IMSCONFG.DAT. This is reserved for future use.
ES_IMSDAT
The location of IMS DB data files.
ES_IMSLIB
The location of DBDGEN2.DAT, DBDGEN2F.DAT and PSBGEN3.DAT files.
ES_INQFILE_RETURN
Modifies EXEC CICS INQUIRE FILE behavior for catalogued files.

Syntax

ES_INQFILE_RETURN=value
export ES_INQFILE_RETURN

Parameters

  • DSN - the DSN is returned. For an alternate file the BASEDSNAME will be the DSNAME of the BASE file.
  • PCN - the PC name of the file is returned.

Default

PCN

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

Syntax

ES_JESYSMSG_OUTPUT==Y|N}
export ES_JESYSMSG_OUTPUT

Values

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

Default

The default is N.

ES_JES_BYTES
Maximum number of bytes to output in a job before taking the action specified (either cancelling the job, cancelling the job and dumping memory contents, or issuing a warning message)
ES_JES_CARDS
Maximum number of cards to output in a job before taking the action specified (either cancelling the job, cancelling the job and dumping memory contents, or issuing a warning message)
ES_JES_DISABLE_RESTART_FLUSH
Indicates whether a region's jobs are moved from the Active queue to the Complete queue when a region is restarted
ES_JES_FREE_SSTM_SYSOUT
When set to Y, decreases the amount of memory used when processing CICS spool datasets in an SSTM enterprise server.
ES_JES_LEVEL
Sets the default JCL type on the JES Control page.
Syntax
ES_JES_LEVEL=type
export ES_JES_LEVEL
Values
type is the default JCL type, one of:
  • VSE
  • JES2
  • JES3
Default
JES2
ES_JES_LINES
Maximum number of lines to output in a job before taking the action specified (either cancelling the job, cancelling the job and dumping memory contents, or issuing a warning message)
ES_JES_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
ES_JES_PAGES
Maximum number of pages to output in a job before taking the action specified (either cancelling the job, cancelling the job and dumping memory contents, or issuing a warning message)
ES_JES_PARM_INIT_LOW
When set to Y, the parameter string passed to a program executed by JCL is initialized to low-values. The default is N, which is to initialize it to spaces.
ES_JES_RESTART
Enables JCL restart processing.
Syntax
ES_JES_RESTART=value
export ES_JES_RESTART
Values
  • Y|y Enables restart processing.
Default
By default JCL restart processing is not enabled.
ES_JES_SPOOL_ORDER
The order in which the spool list is displayed when you first open ESMAC.
Syntax
ES_JES_SPOOL_ORDER=value
export ES_JES_SPOOL_ORDER
Values
  • 1 - Displays the list in descending order by JOBID. Any other value displays it in ascending order.

Default
By default the list is displayed in ascending order by JOBID.
ES_LE370_SUPPORT
Enables support for Language Environment (LE) in CICS applications
Syntax
ES_LE370_SUPPORT=value
export ES_LE370_SUPPORT
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
ES_LEGACY_ECI=value
export ES_LEGACY_ECI
Values
  • Y|y Micro Focus ECI is used.
Default
By default IBM CTG is used.
ES_MAX_CATALOG_LINES
Restricts the number of entries displayed in ESMAC catalog view.
Syntax
ES_MAX_CATALOG_LINES=number
export ES_MAX_CATALOG_LINES
Values
  • number The number of lines to display. The maximum is 99999.
Default
The default is 5000.
ES_MEM_STRATEGY
Selects the types of memory processes supported.
Note: Note that memory strategy can also be set via the memory_strategy runtime tunable.
ES_MFASM_SUPPORT
Enables Assembler support when running CICS server regions.
Syntax
ES_MFASM_SUPPORT=value
export ES_MFASM_SUPPORT
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.
ES_MFSLIB
The location of the control blocks generated by the MFS generation program.
Syntax
ES_MFSLIB=pathname
export ES_MFSLIB
Values
  • pathname The path to the MFS directory.
Default
product_install_dir/etc/ims
ES_MOD3650
The default MOD file to be displayed after a successful sign-on to IMS. See ES_DFS3650.
Syntax
ES_MOD3650=filename
export ES_MOD3650
Values
  • filename - The name of the MOD file.
ES_MQ_1PC
Indicates whether the IBM WebSphere MQ switch module ESMQXA should operate in one-phase commit mode. Set this environment variable only when advised to do so by Micro Focus.

Syntax

ES_MQ_1PC=value
export ES_MQ_1PC

Values

  • Y|y|T - ESMQXA operates in one-phase commit mode.

Default

By default ESMQXA does not operate in one-phase commit mode.

ES_MQ_LIB
The full name including the path of the IBM WebSphere MQ client or server library. This should only be required if MQ was NOT installed in the default location.

Syntax

ES_MQ_LIB= fully_qualified_library
export ES_MQ_LIB

Values

  • fully_qualified_library - A fully-qualified library name.

Default

By default ES will try to locate libraries in the default location for the platform.

Important: 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
The full name including the path of the IBM WebSphere MQ client or server library, for threaded environments. This should only be required if MQ was NOT installed in the default location.

Syntax

ES_MQ_LIB_T= fully_qualified_library
export ES_MQ_LIB_T

Values

  • fully_qualified_library - A fully-qualified threaded library name.

Default

By default ES will try to locate threaded libraries in the default location for the platform.

ES_MQ_LIB_XA
The full name including the path of the IBM WebSphere MQ XA library. This should only be required if MQ was NOT installed in the default location.

Syntax

ES_MQ_LIB_XA= fully_qualified_library
export ES_MQ_LIB_XA

Values

  • fully_qualified_library - A fully-qualified library name.

Default

By default ES will try to locate libraries in the default location for the platform.

Important: 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_XA_T
The full name including the path of the IBM WebSphere MQ XA library, for threaded environments. This should only be required if MQ was NOT installed in the default location.

Syntax

ES_MQ_LIB_XA_T= fully_qualified_library
export ES_MQ_LIB_XA_T

Values

  • fully_qualified_library - A fully-qualified threaded library name.

Default

By default ES will try to locate threaded libraries in the default location for the 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 use MFDS configuration instead.

Syntax

ES_MQ_LISTENER={QueueManagerName,QueueName,ListenerName}
[,QueueManagerName,QueueName,ListenerName}...
export ES_MQ_LISTENER
Values

QueueManagerName,QueueName,ListenerName - the characteristics of the listener being defined.

Default

By default, 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=value
export ES_MQ_XA
Values
  • D: use a dynamic XA structure
  • S: use a static XA structure

Default

By default, a dynamic XA structure is used.

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
ES_OLD_SEC_TSTD=value
export ES_OLD_SEC_TSTD
Values
  • Any value.
Default
By default security is enforced for TS or TD queues that are not declared in the security repository.
ES_OTMA_TIMEOUT
The time in seconds that an OTMA client should wait for an answer. The default value is 120.
Syntax
ES_OTMA_TIMEOUT=seconds
export ES_OTMA_TIMEOUT
Values
  • seconds - The number of seconds to wait. The maximum is 43199.
Default
120 seconds.
ES_PL1_MFFH
Enables Micro Focus File Handler to perform all Open PL/I I/O operations. The default value is "Y". If it is set to "N", then all I/O will be routed to old Liant file handlers.

Syntax

ES_PL1_MFFH=Y|N
export ES_PL1_MFFH

Values

Y Micro Focus File Handler is used to perform all Open PL/I I/O operations.

N All I/O is routed to old Liant file handlers.

Default

The default value is Y.

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

Syntax

ES_PL1_MFFH_JCL=Y|N
export ES_PL1_MFFH_JCL

Values

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

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

Default

The default value is N.

ES_PLI_SUPPORT
Tells the CICS Emulation that it needs to load its subsystem support for PL/I user programs.

Syntax

ES_PLI_SUPPORT=value
export ES_PLI_SUPPORT

Values

  • Y|y - PL/I support is enabled.

Default

PL/I support is not enabled.

ES_PROG_PATH
Set ES_PROG_PATH=Y to display the program's load path in the JESYSMSG and SYSLOG datasets.
Note: This is only applicable for native enterprise server regions.
ES_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

ES_RLS_FILE_SUPPORT=value
export ES_RLS_FILE_SUPPORT

Values

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

Default

RLS file support is off.

ES_SAM_ESDS
Under VSE, when this is set to Y, opening an OUTPUT of a reusable ESDS file resets the file when the DISP is not specified in the DLBL statement.
ES_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

ES_SEP_DORMANT_TIME=seconds
export ES_SEP_DORMANT_TIME

Values

  • seconds Number of seconds' inactivity.

Default

Transient SEPs are terminated after 2 seconds of inactivity.

ES_SERVER
The default server name (used if no -r switch is specified on casstart or casstop).

Syntax

ES_SERVER=name
export ES_SERVER

Values

  • name The server name.

Default

ESDEMO/ESDEMO64

ES_SNATRC_DIR
Specifies the location of the SNA traces written by IMB's communication manager. You must set this environment variable before you start the region to ensure that the SNA trace files are written to a valid directory:
ES_SNATRC_DIR=path

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
ES_SSTM_IMS
Location of the JCL used to initialize the SSTM IMS environment.
ES_SSTM_JOB_FLUSH_ACTIVE
By default, this is set to N. When set to Y, it causes a CICS SSTM job to be removed from the ACTIVE queue when the region shuts down.
ES_SURROGATE_JOB_USER
Associates a user ID with a job when submitting the job for processing through the internal reader from CICS.

Syntax

ES_SURROGATE_JOB_USER=value
export ES_SURROGATE_JOB_USER
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
The status of the SYSOUT files are set to Out Hold.
ES_TMC_AGGREGATE
Controls the performance environment for IMS TM data stores.

Syntax

ES_TMC_AGGREGATE={[,N|,D]|nnn,Y}
export ES_TMC_AGGREGATE

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

ES_TN2370_FORCE_ALT=value
export ES_TN2370_FORCE_ALT

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

ES_TN2370_MODEL_LOG=value
export ES_TN2370_MODEL_LOG

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}

Values

Y Activate transaction class support
N Do not activate transaction class support

Default

N, no transaction class support.

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}

Values

TCPIPSERVICE Prioritize and limit TCPIPSERVICE transactions
URIMAP Prioritize and limit URIMAP transactions

Default

TCPIPSERVICE

ES_TRX3650
The default transaction to run after a successful sign-on to IMS. See ES_DFS3650.

Syntax

ES_TRX3650=transaction
export ES_TRX3650

Values

  • transaction The default transaction to run.
ES_USR_DFLT_CICS
Allows you to override the default user when no user is logged on for CICS authentication.

Syntax

ES_USR_DFLT_CICS=user
export ES_USR_DFLT_CICS

Values

  • user - the default user name.

Default

CICSUSER

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

Syntax

ES_USR_DFLT_ESMAC=user
export ES_USR_DFLT_ESMAC

Values

  • user - the default user name.

Default

mfuser

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

ES_ESM_DISABLE_DFLTUSER_ESMAC=value
export ES_ESM_DISABLE_DFLTUSER_ESMAC

Values

  • Y|y - Default ESMAC user is disabled.

Default

Default ESMAC user is not disabled.

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

Syntax

ES_USR_DFLT_JES=user
export ES_USR_DFLT_JES

Values

  • user The deafult user name.

Default

JESUSER

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
export ES_USR_DFLT_IMS

Values

  • user - The user name to override the default.

Default

IMSUSER

ES_XA_????_NB_RETRIES
Operates in conjunction with ES_XA_CONNECT. Sets the number of connection re-tries when attempting to connect to a resource.

Syntax

ES_XA_????_NB_RETRIES=nnnn
export ES_XA_????_NB_RETRIES

Values

  • ???? is the XA ID defined in MFDS.
  • nnnn is the number of subsequent XA call failures allowed before the SEP is recycled and the switch disabled.

Default

5 retries (ES_XA_RECONNECT must have been set).

ES_XA_LOG_SUPPRESS
Suppresses XA logging and the recovery of in-doubt XA transactions.

Syntax

ES_XA_LOG_SUPPRESS=value
export ES_XA_LOG_SUPPRESS

Values

  • Y|y - XA logging is suppressed.

Default

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

ES_XA_RECONNECT

This variable is used by the CRCN transaction to determine the frequency in which the enabled resource managers are checked for an available connection. Set the variable to a value that represents the delay, in seconds, between two monitoring sessions.

Syntax

ES_XA_RECONNECT=<interval>
export ES_XA_RECONNECT

Values

  • <interval> - the duration, in seconds, between checks for an available connection by the CRCN transaction.

Default

No value is set and the XA reconnect feature is not enabled.

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 by using Enterprise Server Administration instead.

Syntax

ES_EZASOKET_SUPPORT=value
export ES_EZASOKET_SUPPORT

Values

  • Y|y - EZASOKET support is enabled.

Default

By default no value is set and EZASOKET support is not enabled.

EXTFH
Specifies a configuration file for the Callable File Handler.

Syntax

EXTFH=filename.cfg
export EXTFH

Parameters

filename.cfg The name of the configuration file.

Example

EXTFH=/home/mydir/myconfig.cfg
export EXTFH

F

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

Syntax

FHREDIR=filename.cfg
export FHREDIR

Parameters

filename.cfg The name of the configuration file.

Example

FHREDIR=/home/mydir/myconfig.cfg
export FHREDIR
FS

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

Syntax

FS=filename.cfg
export FS

Parameters

filename.cfg The name of the configuration file.

Example

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

Syntax

FSCOMMS="\$local"
export FSCOMMS

Parameters

"\$local" Run the Fileshare System in single user mode.

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

Parameters

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

Example

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

ICONN1
Controls the client TCP connection status of an IMS Connect emulator.
IMSCPY
The location of copybook files for DBDGEN, PSBGEN and MFSGEN utilities .
ISPPROF
The location of ISPF dialog profiles.

J

JAVA_HOME
Specifies the location of the JDK.

L

LANG
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

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
Reserved for use by Micro Focus. Use only if directed by Micro Focus Technical Support.
LIBPATH
Specifies the directory or directories for the UNIX system, Cob and the runtime 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
LINES
Specifies the depth of the terminal screen or window, overriding the specified terminal default.

Syntax

LINES=n
export LINES

Parameters

n The depth of the terminal screen or window, in lines.

Comments

The default, when LINES is unset or null, is to use the lines value as defined in the specified terminal's terminfo entry, or the current depth of the terminal window if you are using X windows. The terminal type is specified via the standard UNIX environment variable, TERM.

On non-windowing environments, where the terminal screen area cannot be resized, the LINES values does not need to be set.

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

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

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

Example

LINES=50
export LINES

M

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

Syntax

MAINFRAME_FLOATING_POINT=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. Each set (pair) is 16 characters long - 8 characters for the program-name, and 8 characters for the alias. You can specify up to 10 pairs. This list is searched first and thus can potentially override the built-in list. If not found, the built-in alias table is searched.
MF_AMODE31ONLY
Indicates that all programs are AMODE(31).
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_CHARSET
Specifies the system character set (ASCII or EBCDIC).
MF_DUPJOBS
Enables jobs with identical names to run.
Values:
  • Y (Default)
  • N
MF_FALLTHRUCHECK
Specifies that MSS is to check that the main COBOL program ends by executing a GOBACK or STOP RUN.
Values:
  • y (default)
  • n
MF_JCL_AUDIT
Specifies that the audit log records audit information when a catalog entry is deleted.
Values:
  • 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
MF_MFA
Specifies what dataset catalogs are to be searched.
Values:
  • ALL - Search for datasets first in the local catalog, and if not found, on the mainframe (default)
  • RJSE - Search for datasets in the local catalog only. No mainframe is performed.
MF_MVSJOB
Sets the number at which a job starts and finishes.
MF_MVSJOB=<lower value>{-|+}<upper value>
Where:
<lower value>
Number at which a job starts. Contains 7 digits - for example, 0000001
-
Sets the values but only on the first startup of the region.
+
Reset the values to these new ones each time the region is started.
<upper value>
Upper job number. Contains 7 digits - for example, 9999999
For example:
set MF_MVSJOB=0000010+0000100
This resets the values to start with job number 10 and run through to job number 100. When the upper limit has been reached you receive a message:
All job numbers in the range 0000010:0000100 are in use
At this point you need to remove some jobs from the spool - you can use the spool housekeeping functions to do this.

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

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

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

MF_NEWSPACE
Indicates whether SPACE is required for NEW datasets.
MF_PCRENAME_LAX
When an MVS dataset is renamed, the associated physical file is normally renamed only if it is in the Default Allocation Dataset Location (which is the default, MF_PCRENAME_LAX=N). Set MF_PCRENAME_LAX to Y to enable physical files in other locations to be renamed if the cataloged name is changed. Set MF_PCRENAME_LAX to D to indicate that a new directory structure and filename will be constructed, and the existing file moved to that location.
MF_NODD
Specifies what action MSS is to take at run time if a job step uses a file that has not been allocated.
MF_RCCF
Enables Remote Job Step Execution (RJSE).
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 SMS support
MF_SPOOL_ARCHIVE_LOC
The base location for files archived as part of the spool housekeeping process, where the contents of the MVS SPOOL spool file are archived prior to deletion.

Syntax

MF_SPOOL_ARCHIVE_LOC=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

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

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

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

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
Enables emulation of UCC11, a third party add-on to the mainframe that affects data set disposition processing. If UCC11 is enabled, a data set disposition of NEW is accepted even if the data set already exists.
Values
  • y
  • n (Default)
MF_USESCA5
Specifies that the server should use version 5 of the Open Service Component Architecture.
Values:
  • ON (Default)
  • OFF
MF_USESCA7
Specifies that MSS accepts CA7 Scheduler control statements as comments rather than diagnosing them as errors.
Values:
  • ON (Default)
  • OFF
MFALLOC_LOC
The location of the default allocated dataset.
MFALLOC_PCFILE
When set to Y, which is the default, it will cause a catalogued file to be physically created if DSORG=PS is specified in the relevant DCB parameters.
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.
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
    DEFAULT For a single-byte character set environment, 0437 (US English) selected; else 0081 (Japanese Katakana Extended) selected.
    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
    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 conversion. 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 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.

MFCSCFG
Specifies a configuration file to be used by the Client/Server Binding client program.

Syntax

MFCSCFG=filename
export MFCSCFG

Parameters

filename The name of the configuration file.

Example

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.

MFE.SMS
Enables SMS support.
MFEXTMAP
Location of a mapper file.
MFIMS_ACBDUMP_TIMESTAMP
Suppresses date/time stamp display in ACB report.
MFIMS_BMPCHKP
Returns a QC to a checkpoint call when it the call includes an IO area.
MFIMS_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
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.

MFJ_INPUTDS_ERROR
When set to N, this will cause IEBDG, IEBGENER, IEBCOMPR, and DFSORT and ICETOOL emulation to treat missing files as though they were present but empty.
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

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=value
export MFJSENGINE
Values:
  • DFSORT Emulates DFSORT
  • SYNCSORT Emulates SYNCSORT

Example

Default

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

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

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

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

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

Syntax

MFLECONFIG=filename
export MFLECONFIG

Parameters

filename The file containing the LE runtime options you want to use.

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

Syntax

MFLOGDIR=dirname
export MFLOGDIR

Parameters

dirname The name of the directory for log files.

Example

MFLOGDIR=/home/mydir/logs
export MFLOGDIR
MFPLI_PRODUCT_DIR
The location of the Open PL/I installation. Used to find files needed for compiling and linking.
MFPRELOAD_USE
Calls MFPRELOAD to improve performance.
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.

Values:
  • Record length to use (Default = 255)
MFREXX_NOT
Specifies one or more characters to be used for the NOT operator in addition to REXX's default, which is "¬".
Values
  • 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.
MFREXX_OR
One or more characters to be used for the OR operator in addition to REXX's default, which is "|".
Values
  • 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.
MFSUB
Specifies whether to use SUBI or ASUBI.
Values
  • SUBI
  • ASUBI
MFSYSCAT
The location of the JES system catalog.
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_LOC
User catalog location
MQSERVER
The location of a WebSphere MQ Server installation.
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

Specifies the directories to be searched by all UNIX programs, including the runtime 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.

R

RANDOM
If using SSL connections, externally generated random data that is stored as a numeric value in the RANDOM variable will be inserted into the initial salt value used to generate temporary key pairs used in SSL hand-shaking. The RANDOM value will only form part of the initial salt value and is an aid to generating more randomness and not an essential requirement.

S

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

Syntax

SORTCOMPRESS=5
export SORTCOMPRESS

Parameters

5 This is the only value that you can supply. 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

SORTCOMPRESS=5
export SORTCOMPRESS
SORTSCHEME
Activates a sortscheme. Use in conjunction with SORTSPACE for improved performance.

Syntax

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

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

SORTSPACE=1024K
export SORTSPACE

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

Syntax

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

SORTTEMPSPACE=250MB
export SORTTEMPSPACE
SORTTYPE
Defines the sort type.

Syntax

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.
SSLDIR
If using SSL connections, this value specifies the generic location of the system's OpenSSL directory.
STEPLIB
The paths for Loader input load-members .390 files (must contain SYSLMOD) .
Note: For this environment, you can specify multiple paths, each separated by a colon.

T

TERM
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

Specifies the directory to be searched by all UNIX programs, including the runtime 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
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 runtime 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 runtime system needs to page data to disk when creating heaps or sorting.

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

U

USER
Default user name.

V

VSE_STARTUP_CFG
The location of the VSE JCL configuration file