Input, Output, and Display Environment Variables

Parent topic: Environment Variables by Groups
Related concepts
Creating a DB2 LUW Database for HCO

CCITCP2

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

CCITCP2_PORT

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

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

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

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.

COBDIR

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

COBKEYTIMEOUT

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

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

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

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

COBLANG

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

COBLPFORM

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

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

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

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

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

COBMAINSTACK

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

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

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

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.

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

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_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_JES_SPOOL_ORDER

The order in which the spool list is displayed when you first open ESMAC.
Syntax 
ES_JES_SPOOL_ORDER=1
Parameter
1
Displays the list in descending order by JOBID.
Default
Not set. Displays the list in ascending order by JOBID.

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

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

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

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.

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_SPOOL_ARCHIVE_LOC

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

MF_USESCA5

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

MF_USESCA7

Determines whether MSS accepts CA7 Scheduler control statements as comments rather than diagnosing them as errors.
Syntax 
MF_USESCA7={ON|OFF}
Parameters
ON
Accepts CA7 Scheduler control statements as comments.
OFF
Diagnoses CA7 Scheduler control statements as errors.
Default 
MF_USESCA7=ON

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.
Comments
If you are not using UK or US language settings, you must also set MFCODESET as a Windows system variable. See your Windows documentation for details.

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

MFEXTMAP

Location of a mapper file.

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=d:\mydir\logs

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.

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.

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.

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.