Previous Topic Next topic Print topic


Environment variables in alphabetical order

Restriction: This topic applies only when the Enterprise Server feature is enabled.

C

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 default is 2 minutes (1200), and the maximum value that can be used is 2,147,483,647.

Example for setting this 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
Locates the TCP/IP registration program.
Values
  • The name or the IP address of the machine hosting the CCITCP2 registration program.
CCITCP2_PORT
The port that is being used for the registration process.
Values
  • The port on which the CCITCP2 registration program operates.
CCITRACE
Specifies the level of CCI tracing
Values

Filename for and trace output and the trace options. The trace options are as follows:

  • /F or -F

    Logs the details of CCI API calls to the trace file. The default condition for this option is OFF, unless a filename or any other trace option are specified, in which case it is always ON.

  • /P or -P

    logs the details of protocol level calls to the trace file. If this flag is not ON, 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. The default condition for this option is OFF.

  • /D or -D

    Logs the contents of all buffers passed to and from the CCI functions. The default condition for this option is OFF. Data tracing may not be allowed if the application has been coded to prohibit data tracing for security reasons.

COBAIF
The path location of the .aif files.
Values
  • The path where the .aif files are located.
COBAIFNAME
The basename of animator session (.aif) files.
Values
  • The base animator session filename.
COBANIMOPT
Additional directives to be used by Animator.
Values
  • An Animator directive, or a list of directives. Must not be a filename.
COBANIMSRV
Attaches Animator to a running COBOL program.
Values
  • The progid identifier that is used to identify the program to which Animator will attach.
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.

Values

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.

COBCONFIG
Specifies a run-time configuration file that tailors the run-time configurable options in some way.
Values
  • The location of a COBOL runtime configuration file.
COBCONFIGJVM
Specifies a Java properties file that tailors the run-time configurable options for Java Virtual Machine applications.
Values
  • The location of a properties file.
COBCONFIG.BLOCK
The location of the application configuration file.
COBDATA
Specifies the directory or directories that the run-time system is to search for data files. This 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.
Values
  • A list of search directories, each item separated by a semicolon (Windows) or colon (UNIX).
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.
Values
  • A list of search directories, each item separated by a semicolon (Windows) or colon (UNIX).
COBIDY
The location of Animator information (.idy) file for the program being animated if it is not found in the same directory as the intermediate code (.int) file.
Values
  • A list of search directories, each item separated by a semicolon (Windows) or colon (UNIX).
COBJIT_ECLIPSE
(applies to UNIX environments only)

Values

  • true

    Enables just-in-time debugging.

  • workspace

    The Eclipse workspace to open when just-in-time debugging starts.

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.

Values
  • Terminal timeout time in tenths of a second.
COBLANG
The language environment in which your COBOL program runs
Values
  • A COBOL language environment (LE) value.
COBLPFORM
Logical printer channels.
Values
  • A valid logical printer channel.
COBMAINSTACK
The size of the main stack.
Values
  • A number in the range 1 through nnn that represents the size of the main stack in bytes.
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
User default Cob utility options.
Values
  • 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.
COBPATH
The path location of programs for dynamic loading.
Values
  • A list of search directories, each item separated by a semicolon (Windows) or colon (UNIX).
COBPRINTER

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

Values
  • 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.
COBPRFDIR
Location of .ipf files created by programs compiled with the PROFILE compiler directive.
Values
  • A list of search directories, each item separated by a semicolon (Windows) or colon (UNIX).
COBSES
The UNIX Session Recorder functions to perform.
Values

COBSES={option[filename]}..., where 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
COBSSL
If using SSL connections specifies the location of the DemoCA directory. If not found, SSLDIR is inspected instead.
COBSW
Run-time system switch settings for the run-time system to observe when running an application.
Values

A list of the runtime switches to set or unset.

  • + sets a switch.
  • - un-sets a switch.
COBTERMINFO
The directory or directories to be searched by the run-time system for a terminfo database of terminal information tailored to the needs of COBOL applications. This enables COBOL applications to use different terminfo settings to those used by non-COBOL applications, such as vi, when using the same terminal.
Values
  • A list of search directories, each item separated by a semicolon (Windows) or colon (UNIX).
COLUMNS
Sets the screen width.
Values
  • An integer number of 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.

E

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.
Values
  • Y/N.
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.
Values
  • 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
Values
  • ON The utility has been invoked by a call, and messages will not be sent to the console or command line.
ES_CERT_REG
Specifies the directory in which the cascertreg user certificate utility should store its registrations.
Values
  • pathname
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".
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.
ES_CONSOLE_LOG
Sends console messages to the Windows Event Log
Values
  • Yes Console messages are sent to the Windows Event Log
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.
Example: ES_DDBG_PORT_RANGE=8001-8040
ES_DISABLE_DFLTUSR_SIGNON
Disables the default user ("mfuser") signon when invoking ES Monitor & Control (ESMAC).
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.
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.
The settings for "x" and "y" are:
  • U - Always uppercase.
  • L - Always lowercase.
  • M - Mixed case and case sensitive

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_ESMAC_DISP_MAX_OVERRIDE
Limits the number of lines shown when viewing the individual catalog entry.
Values
  • An integer number of the ESMAC catalog view lines to display.
ES_MAX_CATALOG_LINES
Restricts the number of entries displayed in ESMAC catalog view, and the default is 5000
ES_MEM_STRATEGY
Selects the types of memory processes supported
ES_OLD_SEC_TSTD
Prevents security being 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 (default value 120)
ES_RLS_FILE_SUPPORT
Stops dirty records being returned when a record is locked by another process.
ES_SEP_DORMANT_TIME
Allows override of Transient SEP dormant time
ES_SERVER
Server name (used if no -r switch is specified on casstart or casstop).
ES_SYSOUT_HOLD
Sysout held classes
ES_USR_DFLT_ESMAC
Allows you to override the default user when no user is logged on for ESMAC authentication
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.
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:

ES_XA_????_NB_RETRIES= nnnn where:

  • ???? 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.
ES_XA_LOG_SUPPRESS
Suppresses XA logging and the recovery of in-doubt XA transactions if set to Y.
Values
  • No Value (default)
  • Y
ES_XA_RECONNECT

If this environment variable is set, when an error occurs on a call to XA, the server recycles the SEP and attempts to reconnect to the Resource Manager. The ES_XA_????_NB_RETRIES variable specifies the number of XA call failures allowed before the SEP is recycled and the switch disabled.

EXTFH
Specifies a configuration file for the Callable File Handler

F

FHREDIR
A configuration file to be used by the Fileshare Client.
FS
A configuration file to be used by the Fileshare Server.
FSCOMMS
Specifies that the Fileshare system is to run in single user mode.
Values
  • "\$local" Run the Fileshare System in single user mode.

H

HCOBND
A directory for DB2 bind files.

I

ISPPROF
The location of ISPF dialog profiles.

J

JAVA_HOME
Locates the JDK.

L

LANG
Specifies the language environment.
Values
  • 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

LD_LIBRARY_PATH

Specifies the directory or directories for the UNIX system, Cob and the run-time system to search for shared libraries and callable shared objects. It must be set 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.

Values
  • A path or a list of paths, each separated by a colon (:).
LIB
The location of the DB2 LIB directory
LIBPATH
Locates shared libraries (applies to AIX only).
Values
  • A path or a list of paths, each separated by a colon (:).
LINES
Specifies screen depth in lines.
Values
  • An integer that specifies the number of lines.

M

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_CHARSET
Specifies the system character set (ASCII or EBCDIC).
MF_DUPJOBS
Enables jobs with identical names to run.
Values:
  • Y (Default)
  • N
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_HK_TESTDATE
Spool housekeeping testing date override.
MF_USESCA5
Specifies that the server should use version 5 of the Open Service Component Architecture
Values:
  • ON (Default)
  • OFF
MFAUDIT_LOGS
The location of audit files.
MFCODESET
Specifies which translation tables to use.
Values
  • A pre-defined country code:
    Country code Language
    AUTOMATIC Operating system default
    AUTO Operating system default
    DEFAULT US English
    0031 Dutch
    0033 French
    0034 Spanish
    0039 Italian
    0043 German (Austrian)
    0044 UK English
    0045 Danish
    0046 Swedish
    0047 Norwegian
    0049 German
    0066 Thai Extended
    0081 *Japanese Katakana Extended
    0082 *Korean
    0086 *Simplified Chinese
    0351 Portuguese
    0358 Finnish
    0437 US English
    0500 International (Latin 1)
    0886 *Traditional Chinese
    0939 *Japanese Latin Extended
    9122 *Japanese Katakana

    Character sets marked with an asterisk (*) are capable of mixed single-byte and double-byte character conversion.

On Windows platforms:
  • If you are not using UK or US language settings, you will also have to set the codepage in your PC environment settings:
    • Right click My Computer.
    • Select Properties.
    • Click Advanced system settings.
    • Click Environment Variables.
    • Under System Variables click New.
    • Enter MFCODESET as Variable name and XXXX as Variable value, where XXXX is your chosen codepage.
  • To use the Euro symbol (€), prefix the country code for EURO codesets with "E".
On UNIX platforms:

Always prefix the country code for EURO codesets with "E".

MFCSCFG
A configuration file to be used by the client/server binding client program
MFE.SMS
Enables SMS support.
MFEXTMAP
Location of a mapper file.
MFJ_INPUTDS_ERROR
When set to N, this will cause IEBDG, IEBGENER and IEBCOMPR to treat missing files as though they were present but empty.
MFJSENGINE
Specifies which sort engine the utility MFJSORT is to emulate.
Values:
  • DFSORT (Default)
  • SYNCSORT
MFJSTATS
Specifies to create a report containing statistics for a SORT.
MFLECONFIG
Path and filename for a configuration file for Language Environment (LE) run-time options
MFLOCKING
Enables Locking Support
MFLOGDIR
A directory that the client/server binding process is to use for log files.
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
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 message
MFUSERCAT_LOC
User catalog location
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
Directories to be searched for all UNIX programs.

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.
Values
  • SORTCOMPRESS=5 allows for run-length encoding of sort records, resulting in much better performance when records contain multiple repeated characters.
    Note: 5 is the only valid value for this environment variable.
SORTSCHEME
Activates a sortscheme. Use in conjunction with SORTSPACE for improved performance.
Values
  • SORTSCHEME=1 - this is the only valid value for the environment variable. See SORTSPACE below 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.
Values
  • n[K|k|M|m|G|g No letter indicates bytes. Defaults to 1 megabyte.
SORTTEMPSPACE
The amount of temporary memory to be allocated to internal workspace for SORT operations. This can be specified in different formats much like the SORTSPACE environment variable. By using SORTTEMPSPACE, you can maximize available memory.
SORTTYPE
Defines the sort type.
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 means 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 specifies the generic location of the system's OpenSSL directory.

T

TERM
Sets the terminal type.
Values
  • name The name of the terminal in the terminfo database.
TERMINFO
Locates the UNIX system terminfo database.
TMPDIR
Locates the directory for temporary files.
TXFILEP
The location of Micro Focus VSAM files.

U

USER
Default user name.
Previous Topic Next topic Print topic