Environment variables in alphabetical order

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

A

C

CAS_SRV_CANCEL

Determines the cancel regime for service modules loaded by a SEP: the regime affects the request handler upon completion of the service module invocation.
Syntax
CAS_SRV_CANCEL={P|L|N|D}
Parameters
P
Physical cancel.
L
Logical cancel.
N
No cancel.
D
Deferred cancel.
Default
CAS_SRV_CANCEL=P
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.
Example
CAS_SRV_CANCEL=L

CCITCPT_service-name

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

COBCCSIDDIR

Specifies the location where the translation tables are installed for a deployed application that uses CCSID translation tables.
Syntax
COBCCSIDDIR=base-dir
Parameter
base-dir
The base directory containing sub-directories for each translation table.
Default
Not set. CCSID tables are installed by default in the %ProgramFiles(x86)%\Micro Focus\Visual COBOL directory.

COBCONFIG

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

COBCONFIGJVM

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

COBCONFIG.BLOCK

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

COBCPY

Specifies the directory or directories that the Compiler and Animator should search for copybook files.
Syntax
COBCPY=path-name[[;path-name][...]]
Parameter
path-name
The full path to a directory that the Compiler and Animator are to search when looking for copybook files. When more than one path-name is present, a null path-name represents the current working directory.
Default
COBCPY=%COBCPY%;C:\Program Files (x86)\Micro Focus\Enterprise Developer\cpylib;
   C:\Program Files (x86)\Micro Focus\Enterprise Developer\cpylib\basecl;
   C:\Program Files (x86)\Micro Focus\Enterprise Developer\cpylibguicl;
   C:\Program Files (x86)\Micro Focus\Enterprise Developer\cpylibolecl
Comments
This environment variable is set in the system registry. You can change the values using the SET command, but values you set are only added to the values already set in the registry.
Example

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

COBCPY=C:\group\sharedcopy;.;C:\mydir\mycpy

COBDATA

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

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

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

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

The full mapping order for files is:

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

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

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

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

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

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

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

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

Example

The following causes COBDATA to be set to instruct the run-time system to search for data files in the current directory, then in the current directory's demo subdirectory, and finally in the C:\data\progs directory.

COBDATA=.;.\demo;C:\data\progs

COBDIR

Specifies the directory where Enterprise Server is installed. Many system components and utilities require and use this information.
Syntax
COBDIR=path-name
Parameter
path-name
The directory that contains the required Micro Focus COBOL system software.
Default
Not set. The default path is %ProgramFiles(x86)%\Micro Focus\Visual COBOL /opt/microfocus/VisualCOBOL .
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

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

COBDIR=C:\products\cobse20

COBJVM

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

COBKEYTIMEOUT

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

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

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

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

COBLANG

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

COBMAINSTACK

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

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

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

COBPATH

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

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

Example
COBPATH=C:\mydir\srclib;;\otherlib

COBPRFDIR

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

COBPRINTER

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

COBSW

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

D

DB2DBDFT

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

E

ENTRYNAMEMAP

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

ES_CERT_REG

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

ES_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_DB_FH

Enables or disables database file handler support. This is required if your data files are stored in a datastore, or your enterprise server region stores some of its resources in a database; see Micro Focus Database File Handler and Enterprise Server Region Database Management for more information.
Syntax
ES_DB_FH={[Y|true]|[N|false]}
Parameters
Y|true
Use the Micro Focus Database File Handler (MFDBFH) to direct file handling.
N|false
Disable database file handling.
Default
ES_DB_FH=N
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

ES_DB_SERVER

Specify the name of the database server to be used for region database operations.
Important: The configuration file specified by the MFDBFH_CONFIG environment variable must contain a corresponding <server> entry for the database server. <dsn> entries for the region, cross-region, and master databases must also be specified in the configuration file to enable use of region database operations.
Syntax
ES_DB_SERVER=server-instance
Parameter
server-instance
The name of a valid database server instance.
Default
Not set.
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.
Example
ES_DB_SERVER=MYSERVER

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

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

ES_DDBG_PORT_RANGE

A range of ports to use for dynamic debugging.
Syntax
ES_DDBG_PORT_RANGE={starting-port-number-ending-port-number |
   starting-port-number,number-of-ports
Parameters
starting-port-number
A port number that represents the start of the range.
ending-port-number
A port number that represents the end of the range. This number must be greater than the value of starting-port-number. All available ports within the range are used.
number-of-ports
The total number of ports. The ports used include those available, starting with the starting-port-number port and continuing with ports greater than the starting-port-number port, up to the total number specified.
Default
Not set. Dynamic debugging uses random ports.
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.
Examples
The following specifies that all available ports from 8001 through 8040 are to be used:
ES_DDBG_PORT_RANGE=8001-8040

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

ES_DDBG_PORT_RANGE=8001,40

ES_DISABLE_DFLTUSR_SIGNON

Disables the default user (mfuser) signon when invoking ES Monitor & Control (ESMAC).
Syntax
ES_DISABLE_DFLTUSR_SIGNON=Y
Parameter
Y
Disables the mfuser auto-logon after starting Enterprise Server administration via your MFDS internal security account.
Default
Not set. mfuser is signed in to ESMAC.
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

ES_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_HSF_CFG

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

The ES_WRITE_CUSTOM_HSF library routine writes to the custom fields.

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

ES_LOCKDB

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

ES_MAX_CATALOG_LINES

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

ES_MAX_HTTP_OUT

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

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

ES_MEM_STRATEGY

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

ES_MFDS_ADDRESS

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

ES_MQ_1PC

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

ES_MQ_LIB

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

ES_MQ_XA

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

ES_OLD_SEC_TSTD

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

ES_PRODUCTION

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

ES_PROG_PATH

Determines whether to display the program's load path in the JESYSMSG and SYSLOG datasets.
Note: Applies to native enterprise server regions only.
Syntax
ES_PROG_PATH={Y|N}
Parameters
Y
Display the program's load path in the JESYSMSG and SYSLOG datasets.
N
Do not display the program's load path in the JESYSMSG and SYSLOG datasets.
Default
Not set.

ES_RLS_FILE_SUPPORT

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

Parameter values are not case sensitive.

ES_SEP_DORMANT_TIME

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

ES_SERVER

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

ES_SNATRC_DIR

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

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

ES_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_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_WS_RUNAWAY_TIMEOUT

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

ES_XA_LOG_SUPPRESS

Suppresses XA logging and the recovery of in-doubt XA transactions.
Syntax
ES_XA_LOG_SUPPRESS=Y
Parameter
Y
Default
Not set. XA logging is not suppressed.
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

Parameter value is not case sensitive.

EXTFH

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

F

FHREDIR

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

FS

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

FSCOMMS

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

G

I

ISPPROF

The location of ISPF dialog profiles.

J

JAVA_HOME

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

L

LIB

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

M

MF_AMODE31ONLY

Indicates that all programs are AMODE(31).

MF_LE_CBLOPTS

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

Otherwise, the syntax is of the form:

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

MF_ROOT_CERT

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

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=windows-1252

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.

MFBSI_DIR

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

MFCROW_DISABLE

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

MFCSCFG

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

MFDBFH_CONFIG

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

MFDBFH_GRANT_USER_PERMISSIONS

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

MFDBFH_RECORD_LOCKING

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

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

MFDBFH_SCRIPT_DIR

Specifies the location of the scripts and stored procedures required when the database file handler is in effect.
Syntax
MFDBFH_SCRIPT_DIR=path-name
Parameter
path-name
The full path to the directory containing the required resources.
Default
MFDBFH_SCRIPT_DIR=%ProgramFiles(x86)%\Micro Focus\Visual COBOL\etc\mfdbfh\scripts

MFDBFH_VAULT

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

MFE.SMS

Enables SMS support.

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.

MFLOCKING

Enables Locking Support.

MFLOGDIR

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

MFPRELOAD_USE

Calls MFPRELOAD to improve performance.

MFRU_NOINHERIT

Determines whether to skip registering processes in shared memory during initialization of the run-time system.
Syntax
MFRU_NOINHERIT={Y|TRUE}
Parameters
Y|TRUE
Do not register processes in shared memory during initialization of the run-time system.
Default
Not set. Processes are registered.
Comments
Consider setting this variable to avoid COBRT105 errors, which can occur during initialization if a very large number of COBOL processes are running and there are no available slots in the shared memory segment.

When set, various run-time settings such as switches, shared memory, console window settings, and so on, are no longer inherited by any child processes.

MFSUB

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

MFTRACE_ANNOTATIONS

The location of the trace files.

MFTRACE_CONFIG

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

MFTRACE_LOGS

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

MFTSO_DEBUG

Controls the display of debug messages.

MFUSER

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

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

O

OOSW

OO run-time switches.

S

SORTCOMPRESS

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

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

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

SORTEXITREENTRY

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

SORTSCHEME

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

SORTSPACE

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

Parameter values are not case sensitive.

Example
SORTSPACE=1024K

SORTTEMPSPACE

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

Parameter values are not case sensitive.

Example
SORTTEMPSPACE=250M

SORTTYPE

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

T

TX_MQ_CONVERT

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

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

TX_MQ_CONVERT=037,Force

TX_MQTRACE

Enables tracing in dfh0mqis for WebSphere MQ calls.

TXFILEP

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

U

X

XFHLOG

Determines the location of the log file when the LOG option is active.
Syntax
XFHLOG=DEFAULT
Parameter
DEFAULT
Generates the log file in the current working directory.
Default
Not set. The log file is generated in %ProgramData%\Micro Focus\File Handler\version-number, where version-number represents the version of your Micro Focus product.
Comments
The effect of this variable can be overridden by the LOGFILENAME configuration option.