General Enterprise Server Environment Variables

ES_3270_REMOVE_NULL_COLOR_ATTRIB

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

ES_CAS_API

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

ES_CONSOLE_LOG (deprecated)

ES_CONSOLE_LOG (deprecated)
Sends console messages to the Windows Event Log.
Note: ES_CONSOLE_LOG is deprecated, and provided for backward compatibility only. We recommend that you use MFDS configuration options instead. For details, see the Windows Monitoring and Management section in the General Properties topic.
ES_CONSOLE_LOG={I|W|E|S}[...]
Parameters
I
Send informational messages to the Windows Event Log.
W
Send warning messages to the Windows Event Log.
E
Send error messages to the Windows Event Log.
S
Send severe messages to the Windows Event Log.
Default
Not set. No console messages are sent to the Windows Event log.

ES_CSKL_NO_MSG_CONSOLE

Stops the EZ Sockets CICS listener (CSKL) from writing messages to console.log.
Syntax
ES_CSKL_NO_MSG_CONSOLE=ON
Parameter
ON
CSKL does not write message to console.log.
Default
Not set. CSKL writes messages to console.log.
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

ES_ELAPSED_DISPATCH_SECONDS

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

ES_ESM_DISABLE_DFLTUSER_ESMAC

Allows you to disable the default ESMAC user to increase the security of your server.
Syntax
ES_ESM_DISABLE_DFLTUSER_ESMAC=Y
Parameter
Y
Disables the default ESMAC user, disables the DEFAULT button on the logon screen, and forces users to always enter a valid user ID and password.
Default
Not set. The ESMAC user is enabled.
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

ES_ESMAC_DISP_MAX_OVERRIDE

Limits the number of lines shown when viewing an individual catalog entry in the ESMAC catalog view or when viewing a SYSOUT file from the job list view.
Syntax
ES_ESMAC_DISP_MAX_OVERRIDE=value
Parameter
value
An integer denoting the number of lines to display to a maximum of 99999.
Default
ES_ESMAC_DISP_MAX_OVERRIDE=1000
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

ES_LEGACY_ECI

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

ES_HARD_KILL_PROCESS

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

ES_MAX_CATALOG_LINES

Restricts the number of entries displayed in ESMAC catalog view.
Syntax
ES_MAX_CATALOG_LINES=number
Parameter
number
The number of lines to display up to a maximum of 99999.
Default
ES_MAX_CATALOG_LINES=5000
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

ES_MAX_HTTP_OUT

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

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

ES_MEM_STRATEGY

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

ES_MFDS_ADDRESS

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

ES_OTMA_TIMEOUT

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

(2 minutes)

ES_PRODUCTION

Prevents the initiation of a debugging session from the IDE.
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

ES_RDO_MAX_RESOURCES

Specifies the maximum number of records for CICS resource types that display in Enterprise Server Common Web Administration (ESCWA) or Enterprise Server Monitor and Control (ESMAC).
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

ES_RTLS_CERT_AUTH_FILEPATH

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

ES_RTLS_CERT_FILEPATH

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

ES_RTLS_PRIVATE_KEY_FILEPATH

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

ES_SEP_DORMANT_TIME

Allows override of Transient SEP dormant time. Rather than automatically terminating transient SEPs on completion of a stateful request, the server manager allows a period of inactivity before scheduling their termination. This allows new requests to re-use the SEP rather than starting a new instance. This environment variable allows you to control the period of inactivity.
Syntax
ES_SEP_DORMANT_TIME=wait-time
Parameter
wait-time
The number of seconds that the Transient SEP is inactive.
Default
ES_SEP_DORMANT_TIME=2
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

ES_SERVER

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

ES_SYSOUT_HOLD

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

ES_TN3270_FORCE_ALT

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

ES_TN3270_MODEL_LOG

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

ES_USR_DFLT_CICS

Allows you to override the default user when no user is logged on for CICS authentication.
Syntax
ES_USR_DFLT_CICS=userid
Parameter
userid
An alternative default user name.
Default
ES_USR_DFLT_CICS=CICSUSER
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

ES_USR_DFLT_ESMAC

Allows you to override the default user when no user is logged on for ESMAC authentication.
Syntax
ES_USR_DFLT_ESMAC=userid
Parameter
userid
The default user name.
Default
ES_USR_DFLT_ESMAC=MFUSER
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

ES_USR_DFLT_IMS

Allows you to override the default user when no user is logged on for IMS authentication.
Syntax
ES_USR_DFLT_IMS=user-id
Parameter
user-id
The user name to override the default.
Default
ES_USR_DFLT_IMS=IMSUSER
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

ES_USR_DFLT_JES

Allows you to override the default user when no user is logged on for JES authentication.
Syntax
ES_USR_DFLT_JES=userid
Parameter
userid
The default user name.
Default
ES_USR_DFLT_JES=JESUSER
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

ES_WS_RUNAWAY_TIMEOUT

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

IMSCPY

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

ISPPROF

The location of ISPF dialog profiles.

JAVA_HOME

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

LANG

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

LD_LIBRARY_PATH

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

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

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

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

LIBPATH

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

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

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

LINES

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

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

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

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

Example
LINES=50

MAINFRAME_FLOATING_POINT

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

MF_AMODE31ONLY

Indicates that all programs are AMODE(31).

MF_CHARSET

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

MF_USESCA5

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

MFACCCGI_CHARSET

Specifies the charset used in the HTTP header returned by ESMAC.
Syntax
MFACCCGI_CHARSET=iana-string
Parameter
iana-string
An IANA-defined charset string.
Default
MFACCCGI_CHARSET=iso-8859-1

MFCODESET

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

MFCSCFG

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

MFEXTMAP

Location of a mapper file.

MFJSDCBOUTFIL

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

MFLECONFIG

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

MFLOGDIR

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

MFPRELOAD_USE

Calls MFPRELOAD to improve performance.

MFSUB

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

MFSYSCATDIR

The location of the system catalog directory.

MFUSER

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

MFUSERCAT_LOC

Specifies the location and name of each additional catalog, matching the values provided in the MFUSERCAT_NODE value.
Syntax
MFUSERCAT_LOC={[path-name\]file-name}[:{[path-name/]file-name}
Parameters
path-name
The full path to a catalog file.
file-name
The name of the catalog file.
Default
Not set. No file names or locations are provided for additional catalogs specified by MFUSERCAT_NODE.
Comments
Parameter values are limited to a total of 4096 characters.

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

MQSERVER

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

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

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

MULTIMFENTMAP

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

OOSW

OO run-time switches.

PATH

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

TERM

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

TERMINFO

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

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

TMPDIR

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

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

TX_TN3270_FORCE_ALT

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

TXMAPP

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

TXRDTP

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

USER

Specifies the default user name.