CAS_SRV_CANCEL=L
Syntax
Windows:
SET CASSPOOL_LOCK_RETRY_COUNT=count
UNIX:
CASSPOOL_LOCK_RETRY_COUNT=count
export CASSPOOL_LOCK_RETRY_COUNT
Values
count The number of retries made to obtain a record lock.
Default
If not specified, this variable defaults to 20.
Allows the specification, in tenths of seconds, of the maximum time out period that will be used with any LSC style application, such as Drag and Drop, SourceConnect, or the Monitor. The maximum value that can be used is 2,147,483,647.
Syntax
Windows:
SET CCITIMEOUT=value
UNIX:
CCITIMEOUT=value}
export CCITIMEOUT
Default
The default is 1200 (2 minutes).
ExampleSET CCITIMEOUT=2400
Syntax
Windows:
set CCITCP2=hostname
UNIX:
CCITCP2=hostname
export CCITCP2
Parameters
hostname is the TCP hostname or dotted decimal IP address of the machine running the CCITCP2 daemon you wish to contact from that session.
Comments
The environment variable value will always take precedence over any value set using the Configuration Utility. To restore a process to using the value set by the Configuration Utility simply set the environment variable to an empty string, such as
set CCITCP2=
Alternatively, if this environment variable is set system-wide (by creating a system variable in the system environment settings, or by using a CONFIG.SYS file) then this value will always take precedence over any value set using the Configuration Utility.
Syntax
Windows:
set CCITCP2_PORT=port
UNIX:
CCITCP2_PORT=port
export CCITCP2_PORT
Syntax
Windows:
set CCITCPS_old_server_name=[new_server_name,]{MFNODE=node_name | MFPORT=port_number | MFNODE=node_name, MFPORT=port_number}
UNIX:
CCITCPS_old_server_name=[new_server_name,]{MFNODE=node_name | MFPORT=port_number | MFNODE=node_name, MFPORT=port_number}
export CCITCPS
Parameters
Note that this will only work if the server application process is started in the same session or process that has this environment variable set.
Example
Windows:
set CCITCPS_server_name=MFPORT:3000
UNIX:
set CCITCPS_MY_SERVER_NAME=MFPORT:3000
export CCITCPS_MY_SERVER_NAME
If a client is known to be trying to connect to a server with Server Name server_name, and the TCP address and port (e.g. 3000) that the server is using is known, then the client can be made to connect directly to it by setting this environment variable.
Syntax
CCITCPT_server_name=MFNODE:server_hostname,MFPORT:port_number
Note that this can be used instead of setting the client Machine Name value. This is useful if the Machine Name value the client specifies cannot be altered by an application defined method.
Parameters
Example
CCITCPT_server1=MFNODE:server2,MFPORT:3000
Syntax
CCITRACE=[options]
| /F or -F | Logs the details of CCI API calls to the trace file. The default is OFF, unless any other trace option is specified, in which case it is always ON. |
| /P or -P | Logs the details of protocol-level calls to the trace file. The default is OFF. If this flag is OFF, then only the details of the CCI user-level API will be traced. If this flag is ON, the level of function tracing can be increased. |
| /D or -D | Logs the contents of all buffers passed to and from the CCI functions. The default is OFF. Data tracing might not be allowed if the application has been coded to prohibit data tracing for security reasons. |
The CCI.INI file can also be used to control trace options, but any values specified by the CCITRACE environment variable will take precedence.
Specifies the directory path that Animator is to search for the session (.aif) file for the program being animated, if it is not found in the same directory as the information (.idy) file. Animator can update the session file to record information held between sessions. The .aif file contains details of breakpoints and monitors.
Syntax
COBAIF=pathname export COBAIF
Parameters
Comments
If the .aif file is not found in the directory specified, a search is made of the directories specified by the COBIDY environment variable. If the file is still not found, the current directory is searched.
If an .aif file does not exist, Animator creates it as follows:
Specifies the basename of the Animator session file (.aif ) for the program being animated. The .aif file contains details of breakpoints and monitors.
Syntax
COBAIFNAME=basename export COBAIFNAME
Parameters
Comments
You need to specify this environment variable if you are starting Animator using COBSW=+A and you want to save breakpoints for subsequent animation sessions. You can also specify it if you are starting Animator using the command anim; in this case the basename you specify overrides the application name as the basename of the .aif file.
Specifies additional directives to be used by Character Animator.
Syntax
COBANIMOPT=directive-list export COBANIMOPT
Parameters
Comments
When you invoke Character Animator, it first reads the directives you have specified in COBANIMOPT and then uses any directives you specify in the command line (which might override some of the directives you set in COBANIMOPT).
Example
COBANIMOPT="MIXEDLANGDEBUG MULTITHREAD" export COBANIMOPT
Identifies which COBOL program a waiting Character Animator process should attach to.
Syntax
COBANIMSRV=progid export COBANIMSRV
Parameters
Comments
This environment variable is particularly useful for starting cross-session debugging.
Example
In one console session:
export COBANIMSRV=myid
myid is now a unique identifier that you can use to match Character Animator to a program. Type the command to start Character Animator:
cobanimsrv
The Character Animator waits for a COBOL program to start that has a matching identifier. In another console session:
export COBANIMSRV=myid cobrun prog1.int
When prog1.int starts, the unique identifier myid matches that of Character Animator; therefore, Character Animator attaches to this process. In console session 1, the Character Animator main screen is displayed and the cursor placed on the first line of prog1.int.
Specifies non-standard behavior for HIGHLIGHT and LOWLIGHT clauses used with ACCEPT and DISPLAY statements. It provides compatibility with earlier COBOL products. You should avoid using it wherever possible as support might be discontinued at some future date.
Syntax
COBATTR=n export COBATTR
Parameters
n A value in the range 0 through 7. It can be one of the following values, or a cumulative value; for example, specifying a value of 6 would result in the behavior described for values 4 and 2.
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.
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.
High and low intensity space characters are not assumed to be the same as normal mode space characters.
As for 1 and 2 above
Provides compatibility with default behavior of products before COBOL version 3.2.
When a COBOL program displays text subject to a HIGHLIGHT clause, the effect depends on whether the dim mode is specified in the terminfo entry for the terminal. If dim mode is specified, then the run-time system uses the default mode for highlighted text and the dim mode for normal text. If the dim mode is not specified, then the run-time system uses the bold mode for highlighted text and default mode for normal text. The LOWLIGHT clause has no effect, giving the same appearance as normal text.
Example
COBATTR=1 export COBATTR
Syntax
Windows:
set COBCCSIDDIR=base-dir
UNIX:
COBCCSIDDIR=base-dir
export COBCCSIDDIR
Parameters
base-dir is the base directory containing sub-directories for each translation table.
Specifies a run-time configuration file that tailors the run-time configurable options in some way.
Syntax
Windows:
SET COBCONFIG=pathname
UNIX:
COBCONFIG=pathname
export COBCONFIG
Parameters
Comments
If $COBCONFIG is not set then the file $COBDIR/etc/cobconfig is searched for instead.
Example
UNIX:
COBCONFIG=/home/mydir/cobconfig
export COBCONFIG
Windows:
SET COBCONFIG=/home/mydir/cobconfig
Values
Specifies the directory or directories that the Compiler and Animator should search for copyfiles.
Syntax
Windows:
SET COBCPY=pathname[:pathname]...
UNIX:
COBCPY=pathname[:pathname]...
export COBCPY
Parameters
A directory that the Compiler and Animator are to search when looking for copyfiles. When more than one pathname is present, a null pathname represents the current working directory.
Example
Windows:
SET COBCPY=/home/group/sharedcopy::mydir/mycpy
UNIX:
COBCPY=/home/group/sharedcopy::mydir/mycpy
export COBCPY
causes the Compiler to search for a copyfile in /home/group/sharedcopy, then in the current directory and finally in ./mydir/mycpy until either the copyfile is found or it can be considered not found.
Specifies the directory or directories that the run-time system is to search for data files. Provides you with the facility to map data files globally, thus enabling you to put working data files in a directory whose name is not known until run time.
Syntax
UNIX:
COBDATA=pathname[:pathname]...
export COBDATA
Windows:
COBDATA=pathname[:pathname]...
Comments
COBDATA affects the compiler and other utilities. During compilation, for example, program source is regarded as a data file by the compiler. If you intend to use any COBOL development system utilities, we recommend that the COBDATA value starts with a colon (:).
COBDATA is considered set if there is an environment variable of this name in your environment space, and its value is non-empty.
The full mapping order for files is:
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
UNIX:
COBDATA=:demo:/home/data:progs
export COBDATA
Windows:
SET COBDATA=:demo:/home/data:progs
causes COBDATA to be set to instruct the run-time system to search for data files in the current directory, then in the directory ./demo, then in the directory /home/data and finally in ./progs.
Specifies the directory where the required Micro Focus COBOL system is installed. Many of the COBOL system components and utilities require and use this information. If the COBDIR environment variable is not set then the COBOL system acts as if it had been set to the default COBOL system directory. This default directory is /opt/microfocus/VisualCOBOL on UNIX systems.
Windows:
SET COBDIR=pathname
UNIX:
COBDIR=pathname
export COBDIR
Parameters
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
Windows:
SET COBDIR=/home/products/cobse20
UNIX:
COBDIR=/home/products/cobse20
export COBDIR
This causes the Cob utility to search the directory /home/products/cobse20 for the Micro Focus COBOL system software.
Specifies the directory that Animator is to search for the information (.idy) file for the program being animated if it is not found in the same directory as the intermediate code (.int) file. Animator can update the information file to record information held between sessions.
Syntax
COBIDY=pathname export COBIDY
Values
Enables just-in-time debugging.
The Eclipse workspace to open when just-in-time debugging starts.
Specifies which Java Virtual Machine (JVM) to load.
Windows:
SET COBJVM=platform_nnn
UNIX:
COBJVM=platform_nnn
export COBJVM
Parameters
platform_nnn where
Comments
You might need to set COBJVM if you are developing distributed applications with both COBOL and Java components.
Example
Windows:
SET COBJVM=ibm_122
UNIX:
COBJVM=ibm_122
export COBJVM
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.
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.
Syntax
Windows:
SET COBKEYTIMEOUT=n
UNIX:
COBKEYTIMEOUT=n
export COBKEYTIMEOUT
Parameters
n A number in the range 1 through 126 that represents the maximum elapsed time required for a terminal to transmit any valid escape sequence to the run-time system over the line or network connection. 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.
Example 1:
COBLPFORM 1:3:5:7:9:11:13:15:17:19:21:23
In this example C01 equals 1, C02 equals 3, and so on.
Example 2:
COBLPFORM :3::5: :9
In this example, C01 equals 3, C02 equals 5, C03 equals 1, and C04 equals 9. You can specify only a single line number for each channel.
In example 2 above, channels C05 - C12 are undefined. If a print statement specifies channel C05 - C12, the line is printed at line 1. In addition, in the example shown, C03 equals 1 because its value is a space and therefore undefined.
Any WRITE BEFORE/AFTER PAGE statements cause positioning to be at line 1. Each line advance increases the line number by one. A request to skip to a line number less than or equal to the current line causes a new page to begin. The appropriate number of line feeds are then generated.
This variable is used to specify the size of the main stack.
Syntax
Windows:
SET COBMAINSTACK=n
UNIX:
COBMAINSTACK=n
export COBMAINSTACK
Parameters
n - The size, in bytes, of the stack.
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:
The system starts in 32-bit mode
The system starts in 64-bit mode
Syntax
COBOPT="[set environment-variable=value] [options] ... [cobextn: .ext [.ext] ... ]" export COBOPT
or
COBOPT=[pathname/]filename export COBOPT
If a line does not begin with one of the identifiers set or cobextn: then it is taken as an options line.
Comments
COBOPT can either contain options that supplement or override the system default options defined in $COBDIR/etc/cobopt, or it can specify the path of a file that contains such options. The options can extend over more than one line and each line must have the same format as described for the file $COBDIR/etc/cobopt in the chapter COBOL System Interface (cob).
Examples
COBOPT="CANS85 set COBCPY=$COBDIR/srclib/:$HOME/mylib:" export COBOPT
This enables ANSI 85 standard COBOL syntax and sets COBCPY to the specified list of paths.
COBOPT=temp/options
Specifies that cob options are contained in the file options in the directory temp.
Specifies the directory or directories that the run-time system is to search for dynamically loadable .int and .gnt files, or callable shared objects.
Syntax
Windows:
SET COBPATH=pathname[:pathname]...
UNIX:
COBPATH=pathname[:pathname]...
export COBPATH
Parameters
pathname A list of search directories, each item separated by a semicolon (Windows) or colon (UNIX), that the run-time system is to search for a dynamically loadable program (.int, .gnt or callable shared object) file. When more than one pathname is specified, a null pathname represents the current working directory.
Example
Windows:
SET COBPATH=u:/home/mydir/srclib:otherlib
UNIX:
COBPATH=u:/home/mydir/srclib:otherlib
export COBPATH
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
Windows:
SET COBPRINTER=command-line
UNIX:
COBPRINTER=command-line
export COBPRINTER
Parameters
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
Windows:
SET COBPRINTER="myspooler -a $TMPDIR\spoolfile"
UNIX:
COBPRINTER="myspooler -a $TMPDIR/spoolfile"
export COBPRINTER
Specifies the UNIX Session Recorder functions to perform.
Syntax
COBSES={option[filename]}...
export COBSES
option can be one or more of the following:
These flags are all case sensitive. Also, you cannot combine the -r flag with either -f or -p.
Syntax
Windows:
SET COBSW=[+/-}s...
UNIX:
COBSW=[+/-}s...
export COBSW
A list of the run-time switches to set or unset.
Example
Windows:
SET COBSW=+0+D
UNIX:
COBSW=+0+D
export COBSW
This enables run-time switch 0 and the ANSI COBOL debug switch.
COBTERMINFO=pathname[:pathname]... export COBTERMINFO
Parameters
pathname A list of search directories, each item separated by a colon, that identify a terminfo database containing terminal settings tailored for COBOL applications. A null pathname represents the current working directory.
Comments
The COBOL system takes the value of the standard UNIX environment variable TERM as the name of the terminal in use. It uses this to search for the appropriate terminal information in a terminfo database. The run-time system first searches the databases identified in COBTERMINFO and then, if the terminal information is not found it searches the database identified in the standard UNIX environment variable TERMINFO.
If COBTERMINFO is not set, the run-time system acts as if it had been set to $COBDIR/terminfo.
Micro Focus recommend that the first directory listed in COBTERMINFO is $COBDIR/terminfo so that the terminfo database supplied with this COBOL system is found first. For commonly used terminals this terminfo contains settings that are fuller and more appropriate to COBOL than those normally available in the UNIX system terminfo database. When debugging using Animator, COBTERMINFO must be set to $COBDIR/terminfo.
COBTERMINFO can also be used to identify a terminfo database that is portable between UNIX systems. Such a database conforms to the standard UNIX database format but does not include any supplementary, UNIX implementation-dependent terminal information. Many UNIX system terminfo databases are not portable because they include such supplementary information. The COBOL system ignores any such nonportable details.
Example
COBTERMINFO=$COBDIR/terminfo:/home/mydir/terms export COBTERMINFO
Specifies the column width of the terminal screen or window, overriding the specified terminal default.
Syntax
COLUMNS=n export COLUMNS
Parameters
n The width of the terminal screen or window, in column positions.
Comments
The default, when COLUMNS is unset or null, is to use the cols value defined in the specified terminal's terminfo entry, or the current width of the terminal window if you are using an X terminal. The terminal type is specified using the standard UNIX environment variable, TERM.
On non-windowing environments, where the terminal screen area cannot be resized, the COLUMNS values does not need to be set. Terminals that can switch into a wide mode (usually from 80 through 132 columns) have a terminal name ending in "w" and these are automatically supported, without the need to set COLUMNS.
In windowing environments, where the size of windows can be changed, the initial size of the window is used in preference to the cols value in terminfo. When the window is resized, the new size is reread. If the new size is greater than the initial size then the extra columns might not be used.
If you want to use the full width of the window you might need to set COLUMNS to the current column width of the window on some platforms.
Using COLUMNS values that do not correspond to the actual width of the window produces unexpected results.
Example
COLUMNS=100 export COLUMNS
Values
Syntax
Windows:
SET ENTRYNAMEMAP={filename|directory}; ...
UNIX:
ENTRYNAMEMAP={filename|directory}; ...
export ENTRYNAMEMAP
Parameters
filename An entry map file.
directory A directory containing an entry name map file. The name of the entry name map file must be mfentmap.dat.
Comments
You must set the entry_name_mapper tunable to enable entry point mapper support.
If ENTRYNAMEMAP is not set, the run-time system searches for an entry name map file called mfentmap.dat in each folder specified by the COBDIR environment variable.
If the run-time system finds more than one entry name map file and same entry point is defined differently in different files, precedence is given to the definition in the entry name map file that was found first. To change the order in which the 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.
Syntax
Windows:
SET ES_ALLOC_EXPAND=value
UNIX:
ES_ALLOC_EXPAND=value
export ES_ALLOC_EXPAND
Values
Y Expands an environment variable used to specify an allocation path.
N Do not expand the variable used in the path.
Default
The default value is Y.
Syntax
Windows: SET ES_ALLOC_OVERRIDE=rules-file
UNIX: ES_ALLOC_OVERRIDE=rules-file export ES_ALLOC_OVERRIDE
Values
rules-file The file path and name of the dataset rules file.
UNIX:
ES_CAS_API=value
export ES_CAS_API
Windows:
SET ES_CAS_API=value
The utility will attempt to log messages.
UNIX:
ES_CERT_REG=pathname
export ES_CERT_REG
Windows:
SET ES_CERT_REG=pathname
pathname Pathname of the directory where registrations are stored.
By default no directory is specified. In this case it must be specified on the cascertreg command.
UNIX:
ES_CESN_NO_OS390=value
export CESN_NO_OS390
Windows:
SET CESN_NO_OS390=value
Specific invalid user/password messages will be produced.
ES_CONSOLE_LOG=port export ES_CONSOLE_LOG
Can be any combination of the following:
UNIX:
ES_CSKL_NO_MSG_CONSOLE=value
export ES_CSKL_NO_MSG_CONSOLE
Windows:
ES_CSKL_NO_MSG_CONSOLE=value
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 Native Database File Handling and Enterprise Server Region Database Management for more information.
Syntax
UNIX:
ES_DB_FH=value
export ES_DB_FH
Windows:
SET ES_DB_FH=value
Values
Default
Database file handler support is disabled.
Specify the name of the database server to be used for region database operations.
There also needs to be a corresponding <server> entry for the database server within the configuration file specified by the MFDBFH_CONFIG environment variable. <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
UNIX:
ES_DB_SERVER=server-instance
export ES_DB_SERVER
Windows:
SET ES_DB_SERVER=server-instance
Values
server-instance is the name of a valid database server instance. For example, set ES_DB_SERVER=(local)\SQLEXPRESS.
Default
Not set.
Using the example above, you would be required to have something similar to that below in your database configuration file:
<?xml version="1.0" encoding="utf-8"?>
<datastores usevault="false">
<server name="(local)\SQLEXPRESS" 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>
If you use a hyphen, the values you specify are the start and the end of the port range, and the second port number must be greater than the first.
If you specify a comma, the values you specify are the start of the port range and the number of ports available from the start of the range.
UNIX:
ES_DDBG_PORT_RANGE=value
export ES_DDBG_PORT_RANGE
Windows:
ES_DDBG_PORT_RANGE=value
or
Examples
The following definition specifies that ports 8001 through 8040 are to be used:
ES_DDBG_PORT_RANGE=8001-8040
The following definition specifies the same ports but using a different format:
ES_DDBG_PORT_RANGE=8001,40
UNIX:
ES_DISABLE_DFLTUSR_SIGNON=value
export ES_DISABLE_DFLTUSR_SIGNON
Windows:
ES_DISABLE_DFLTUSR_SIGNON=value
UNIX:
ES_ESMAC_DISP_MAX_OVERRIDE=value
export ES_ESMAC_DISP_MAX_OVERRIDE
Windows:
ES_ESMAC_DISP_MAX_OVERRIDE=value
Syntax
Windows:
SET ES_HSF_CFG=cfg-options
UNIX:
ES_HSF_CFG=cfg-options
export ES_HSF_CFG
Parameters
field_name=value;[field_name=value;]...using the following values:
| Field name | Range | Default |
|---|---|---|
| CUSTOM | 0-5 | 0 |
| CICSF | 0-20 | 5 |
| TSQ | 0-20 | 5 |
| TDQ | 0-20 | 5 |
For example: ES_HSF_CFG=CUSTOM=2;CICSF=10;TSQ=32 generates 2 custom fields, 10 CICS file fields, 5 TSQ fields and 5 TDQ fields.
Custom fields are written to using the ES_WRITE_CUSTOM_HSF library routine.
Specifies the region database that is to process resource locking (step- and system-scoped ENQs) for an enterprise server within a cluster, where resources (such as spool queues and catalogs) are deployed to a database.
Syntax
UNIX:
ES_LOCKDB=region-db
export ES_LOCKDB
Windows:
SET ES_LOCKDB=region-db
Parameters
UNIX:
ES_MAX_CATALOG_LINES=number
export ES_MAX_CATALOG_LINES
Windows:
ES_MAX_CATALOG_LINES=number
Values
Y Enables previous default behavior of cataloging and creating the physical files for dynamic PDS when referenced in a JCL DD statement.
N Physical files for dynamic PDS members are only created and cataloged when created using the JCL utility or by a user program.
Default
The default value is N.
UNIX:
ES_OLD_SEC_TSTD=value
export ES_OLD_SEC_TSTD
Windows:
SET ES_OLD_SEC_TSTD=value
UNIX:
ES_OTMA_TIMEOUT=seconds
export ES_OTMA_TIMEOUT
Windows:
SET ES_OTMA_TIMEOUT=seconds
Syntax
UNIX:
ES_RLS_FILE_SUPPORT=value
export ES_RLS_FILE_SUPPORT
Windows:
SET ES_RLS_FILE_SUPPORT=value
Values
Default
RLS file support is off.
Syntax
UNIX:
ES_SEP_DORMANT_TIME=seconds
export ES_SEP_DORMANT_TIME
Windows:
ES_SEP_DORMANT_TIME=seconds
Values
Default
Transient SEPs are terminated after 2 seconds of inactivity.
Syntax
UNIX:
ES_SERVER=name
export ES_SERVER
Windows:
ES_SERVER=name
Values
Default
ESDEMO/ESDEMO64
Syntax
UNIX:
ES_USR_DFLT_ESMAC=user
export ES_USR_DFLT_ESMAC
Windows:
SET ES_USR_DFLT_ESMAC=user
Values
Default
mfuser
Syntax
UNIX:
ES_ESM_DISABLE_DFLTUSER_ESMAC=value
export ES_ESM_DISABLE_DFLTUSER_ESMAC
Windows:
ES_ESM_DISABLE_DFLTUSER_ESMAC=value
Values
Default
Default ESMAC user is not disabled.
Syntax
UNIX:
ES_XA_LOG_SUPPRESS=value
export ES_XA_LOG_SUPPRESS
Windows:
ES_XA_LOG_SUPPRESS=value
Values
Default
By default no value is specified and XA logging is not suppressed.
Syntax
UNIX: ES_XA_RECONNECT=Y,<seconds>,<retry_count> export ES_XA_RECONNECT
Windows: SET ES_XA_RECONNECT=Y,<seconds>,<retry_count>
For example:
ES_XA_RECONNECT=Y,120,4If the first value is set to Y this indicates that the reconnect process is required. The second is the number of seconds to delay before the XA recovery transaction is triggered after a two-phase commit failure and between each reschedule of the XA recovery transaction if the syncpoint phase 2 returns an RC 04. The third value is the number of recovery retry attempts if the XA commit or rollback executed by the XA recovery transaction returns an xa-retry (04) return code. In this case, the following messages will be sent to the console:
CASXO0054W XA recovery error RC=4 on commit in-doubt transaction RM: RM01 RC: 00004 XID: MF_CAS DEMOMYREG 000000***********000010000000** 0000
When the maximum number of retries is reached the following message is sent to the console:
CASXO0055S XA MAX recovery attempts, manually commit in-doubt transaction RM: RM01 RC: 00004 XID: MF_CAS DEMOMYREG 000000***********000010000000** 0000
Default
If this variable is not set than the default is that the XA reconnect feature is not enabled.
UNIX:
ES_ZOS_SYSPRINT_DCB=value
export ES_ZOS_SYSPRINT_DCB
Windows:
ES_ZOS_SYSPRINT_DCB=value
Syntax
Windows:
SET EXTFH=filename.cfg
UNIX:
EXTFH=filename.cfg
export EXTFH
Parameters
filename.cfg The name of the configuration file.
Example
Windows:
SET EXTFH=/home/mydir/myconfig.cfg
UNIX:
EXTFH=/home/mydir/myconfig.cfg
export EXTFH
Syntax
Windows:
SET FHREDIR=filename.cfg
UNIX:
FHREDIR=filename.cfg
export FHREDIR
Parameters
filename.cfg The name of the configuration file.
Example
Windows:
SET FHREDIR=/home/mydir/myconfig.cfg
UNIX:
FHREDIR=/home/mydir/myconfig.cfg
export FHREDIR
Specifies a configuration file to be used by the Fileshare Server.
Syntax
Windows:
SET FS=filename.cfg
UNIX:
FS=filename.cfg
export FS
Parameters
filename.cfg The name of the configuration file.
Example
Windows:
SET FS=myconfig.cfg
UNIX:
FS=myconfig.cfg
export FS
Syntax
Windows:
SET FSCOMMS="\$local"
UNIX:
FSCOMMS="\$local"
export FSCOMMS
Parameters
"\$local" Run the Fileshare System in single user mode.
Syntax
Windows:
SET HCOBND=pathname
Windows:
HCOBND=pathname
export HCOBND
Parameters
pathname The directory that the DB2 ECM is to use to store bind files.
Example
SET HCOBND=d:\mydir\binds
SET HCOBND=/mydir/binds export HCOBND
Comments
The DB2 ECM uses the specified directory until the variable is unset or reset to a different directory. The DB2 Compiler directive option BIND overrides this environment variable.
JCLTEMP_DIR=path
Syntax
LANG=language[_territory[.codepage]] export LANG
Example
LANG=fr_FR export LANG
Specifies the directory or directories for the UNIX system, cob command, and the run-time system to search for shared libraries and callable shared objects. If you have installed the product to a directory other than the default one, you must set this variable to include $COBDIR/lib on all platforms except AIX (which uses LIBPATH). It should also include any directories that contain callable shared objects used by your application. If you have installed the product in the default directory (/opt/microfocus/VisualCOBOL), you do not need to set this variable.
Syntax
LD_LIBRARY_PATH=pathname[:pathname]... export LD_LIBRARY_PATH
pathname A path or a list of paths, each separated by a colon (:).
Comments
The list of directories must include $COBDIR/lib. The COBDIR environment variable is described earlier.
This environment variable is a system environment variable; see your UNIX documentation for more information.
Example
LD_LIBRARY_PATH=$COBDIR/lib:/home/mydir/myapp:$LD_LIBRARY_PATH export LD_LIBRARY_PATH
Syntax
LIBPATH=pathname[:pathname]... export LIBPATH
Parameters
pathname A directory to search for shared libraries.
Example
LIBPATH=$COBDIR/lib:/lib:/usr/lib
Syntax
LINES=n export LINES
Parameters
n The depth of the terminal screen or window, in lines.
Comments
The default, when LINES is unset or null, is to use the lines value as defined in the specified terminal's terminfo entry, or the current depth of the terminal window if you are using X windows. The terminal type is specified via the standard UNIX environment variable, TERM.
On non-windowing environments, where the terminal screen area cannot be resized, the LINES values does not need to be set.
In windowing environments, where the size of windows can be changed, the initial size of the window is used in preference to the lines value in terminfo. When the window is resized, the new size is reread. If the new size is greater than the initial size then the extra lines might not be used.
If you want to use the full depth of the window you might need to set LINES to the current depth of the window on some platforms.
Using LINES values that do not correspond to the actual depth of the window produces unexpected results.
Example
LINES=50 export LINES
Syntax
Windows:
SET MAINFRAME_FLOATING_POINT=fpstatus
UNIX:
MAINFRAME_FLOATING_POINT=fpstatus
export MAINFRAME_FLOATING_POINT
Parameters
fpstatus Which format to use for floating point data items. This must be one of:
Setting MAINFRAME_FLOATING_POINT to anything other than true has the same effect as setting it to false.
The setting of this environment variable can be overridden by the NATIVE-FLOATING-POINT directive.
Specifies the name of the MFCATMNT user exit program if not compiled to the default name of MFCATMNTUE.
Syntax
UNIX:
MFCATMNTUE=program-name
export MFCATMNTUE
Windows:
SET MFCATMNTUE=program-name
Values
program-name represents the name of the MFCATMNT user exit program if not compiled to the default name of MFCATMNTUE.
Default
MFCATMNTUE=MFCATMNTUE
Determines if the MFELX* files associated with a job are also deleted when spool housekeeping is run.
Syntax
Windows:
SET MF_SPOOL_HK_LEX_SCAN=Y|N
UNIX:
MF_SPOOL_HK_LEX_SCAN=Y|N
export MF_SPOOL_HK_LEX_SCAN
Values
Y The files are deleted.
N The files are not deleted.
Default
The default is Y.
Syntax
Windows: SET MF_SPOOL_HK_OUTPRTC=value
UNIX: MF_SPOOL_HK_OUTPRT=value export MF_SPOOL_HK_OUTPRTC
Values
Y Files from the Complete queue are deleted.
NFiles from the Complete queue are not deleted.
Default
The default is Y.
Syntax
Windows:
MF_SPOOL_HK_TESTDATE=YYYYMMDD
UNIX:
MF_SPOOL_HK_TESTDATEC=YYYYMMDD
export MF_SPOOL_HK_TESTDATEC
Values
YYYYMMDD The date which is to override the normal date.
Default
If this variable is not set, the normal date for the spool housekeeping is used.
Syntax
Windows:
SET MF_SPOOL_HK_WRITE_PROFILES=Y|N
UNIX:
MF_SPOOL_HK_WRITE_PROFILES=Y|N
export MF_SPOOL_HK_WRITE_PROFILES
Values
Y Profile files are created.
N Profile files are not created.
Default
The default is Y.
Syntax
Windows:
SET MFCSCFG=filename
UNIX:
MFCSCFG=filename
export MFCSCFG
Parameters
filename The name of the configuration file.
Example
Windows:
SET MFCSCFG=/home/mydir/mfclisrv.cfg
UNIX:
MFCSCFG=/home/mydir/mfclisrv.cfg
export MFCSCFG
Comments
The value of MFCSCFG is overridden by any value defined in the command line. If neither of the above yields a filename, the default filename mfclisrv.cfg is assumed, and is searched for in the current directory. If that in turn is not found, the default settings for the configuration entries are used.
Specifies the location and the name of the configuration file that defines the database server instances and associated databases.
Syntax
UNIX:
MFDBFH_CONFIG=value
export MFDBFH_CONFIG
Windows:
SET MFDBFH_CONFIG=value
Values
value represents the full path and filename of your database configuration file.
Default
Not set.
Grants execute privileges to specific users or roles, for types and procedures that are created when configuring an Oracle database for MFDBFH access.
Syntax
UNIX:
MFDBFH_GRANT_USER_PERMISSIONS=value
export MFDBFH_GRANT_USER_PERMISSIONS
Windows:
MFDBFH_GRANT_USER_PERMISSIONS=value
Values
value is a space-separated list of users and/or roles that will be granted to execute privileges to the types and procedures created by MFDBFH.
Default
Not set.
Notes
If the variable is not specified, the Oracle default permissions are applied, which are to grant execute permissions to the schema owner of that type/procedure only.
This variable has no effect on permissions for any other database provider used with MFDBFH.
Specifies the type of record locking that it is to be used when the database file handler is in effect.
Syntax
UNIX:
MFDBFH_RECORD_LOCKING=table|database
export MFDBFH_RECORD_LOCKING
Windows:
SET MFDBFH_RECORD_LOCKING=table|database
Parameters
Default
Specifies the location of the scripts and stored procedures required when the database file handler is in effect.
Syntax
UNIX:
MFDBFH_SCRIPT_DIR=value
export MFDBFH_SCRIPT_DIR
Windows:
SET MFDBFH_SCRIPT_DIR=value
Values
value represents a path to the directory containing the required resources.
Default
value defaults to the \etc\mfdbfh\scripts sub directory of your product installation directory.
For more information on secrets vaults, see Vault Facility.
Syntax
UNIX:
MFDBFH_VAULT=value
export MFDBFH_VAULT
Windows:
SET MFDBFH_VAULT=value
Values
value represents the name of a vault.
Default
Not set.
For EBCDIC datasets, translates from EBCDIC to ASCII using a PUT, and ASCII to EBCDIC using a GET.
Syntax
MFFTP_ASCII_CMD_XLATE={Y|N}
Comments
When set to Y, must be used with TYPE A or ASCII sub command.
Specifies a configuration file for Language Environment (LE) run-time options.
Syntax
Windows:
SET MFLECONFIG=filename
UNIX:
MFLECONFIG=filename
export MFLECONFIG
Parameters
filename The file containing the LE run-time options you want to use.
Syntax
Windows:
SET MFLOGDIR=dirname
UNIX:
MFLOGDIR=dirname
export MFLOGDIR
Parameters
dirname The name of the directory for log files.
Example
Windows:
SET MFLOGDIR=/home/mydir/logs
UNIX:
MFLOGDIR=/home/mydir/logs
export MFLOGDIR
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.
When the variable is not set (which is the default), the registration process is not skipped.
Syntax
SET MFRU_NOINHERIT=Y|TRUE
The default is that the variable is not set.
Specifies the directories to be searched by all UNIX programs, including the run-time system, when finding executables to be run.
Syntax
PATH=pathname[:pathname]... export PATH
Parameters
pathname A directory to search for executables.
Example
PATH=$COBDIR/bin:$PATH export PATH
Syntax
Windows:
SET SORTCOMPRESS=n
UNIX:
SORTCOMPRESS=n
export SORTCOMPRESS
Parameters
n - An integer that indicates if compression is enabled or not. 0 (zero, the default) indicates not enabled; any positive integer indicates enabled. When enabled, it allows for run-length encoding of sort records, resulting in much better performance when records contain multiple repeated characters.
Comments
This variable is recommended if the sort records contain many single repeated characters, for example, multiple spaces, as it can be very effective in improving memory usage and therefore sort performance.
Example
Windows:
SET SORTCOMPRESS=5
UNIX:
SORTCOMPRESS=5
export SORTCOMPRESS
SORTEXITREENTRY={ON|OFF}
SORTEXITREENTRY=OFF
Syntax
Windows:
SET SORTSCHEME=1
UNIX:
SORTSCHEME=1
export SORTSCHEME
Syntax
Windows:
SET SORTSPACE=n[K|k|M|m|G|g]
UNIX:
SORTSPACE=n[K|k|M|m|G|g]
export SORTSPACE
Parameters
n[K|k|M|m|G|g The amount of memory to be allocated to internal workspace for SORT operations. K or k indicates kilobytes, M or m indicates megabytes and G or g indicates gigabytes. No letter indicates bytes. Defaults to 1 megabyte.
Comments
A larger value for SORTSPACE will generally result in a faster sort. However, if you specify a value that exceeds the capacity of main memory in your computer, such that the operating system has to page memory in and out, performance will be degraded.
Example
Windows:
SET SORTSPACE=1024K
UNIX:
SORTSPACE=1024K
export SORTSPACE
Syntax
Windows:
SET SORTTEMPSPACE=n[K|k|M|m|G|g]
UNIX:
SORTTEMPSPACE=n[K|k|M|m|G|g]
export SORTTEMPSPACE
Parameters
n[K|k|M|m|G|g] The amount of memory to be allocated to temporary workspace for SORT operations. K or k indicates kilobytes, M or m indicates megabytes and G or g indicates gigabytes. No letter indicates bytes. 32 megabytes is the lowest amount of memory that can be allocated.
Comments
The memory allocation strategy used by SORT can be adjusted through use of SORTTEMPSPACE, which generally improves performance in systems suffering from memory fragmentation.
Example
Windows:
SET SORTTEMPSPACE=250MB
UNIX:
SORTTEMPSPACE=250MB
export SORTTEMPSPACE
Syntax
Windows:
SET SORTTYPE=2
UNIX:
SORTTYPE=2
export SORTTYPE
Syntax
TERM=name export TERM
Parameters
name The name of the terminal in the terminfo database.
Example
TERM=at386 export TERM
Specifies the directory to be searched by all UNIX programs, including the run-time system, for the UNIX system terminfo database.
Syntax
TERMINFO=pathname export TERMINFO
Parameters
pathname The name of a directory that contains the UNIX system terminfo database.
Comments
The UNIX system terminfo database is used by all UNIX applications that need to use a terminal. However, COBOL applications tend to make much fuller and sophisticated use of the terminal and require a fuller terminfo description than is required by typical UNIX applications such as vi. Some terminal capabilities, such as those set during the initialization of the terminal to control the use of function keys, commonly conflict with the needs of typical COBOL applications. In such cases, the terminal information required by COBOL can be stored in a separate terminfo database and referenced using COBTERMINFO.
Syntax
TMPDIR=pathname export TMPDIR
Parameters
pathname The directory used by UNIX applications for any temporary work files. Temporary work files can be created by COBOL utilities such as Cob or by the run-time system when it executes statements such as SORT. If you do not specify a directory, the system default directory is used.
Comments
You might need to use this environment variable if the run-time system needs to page data to disk when creating heaps or sorting.
The CIPHERS attribute in these CICS resources (which is for USAGE(CLIENT)) can be specified in one of the following ways:
UNIX: USSCONFIG=/absolute/path/to/cipher/suite/specification/file(s) export USSCONFIG
Windows: SET USSCONFIG=/absolute/path/to/cipher/suite/specification/file(s)
Syntax:
SET XFHLOG=DEFAULT
Parameters:
DEFAULT - generates the log file in the current directory.
Comments:
If the XFHLOG variable is not set, the log file is created in C:\ProgramData\Micro Focus\File Handler\[version-number].
where [version-number] represents the version of your Micro Focus product.
The effect of this variable can be overridden by the LOGFILENAME configuration option.