1. Application Runtime for IMS Reference Guide
  2. Oracle Tuxedo Application Runtime for IMS Reference Guide
  3. Environment Variables

1.8 Environment Variables

ART_IMS_CONFIG
An environment variable required by Tuxedo ART for IMS to specify the absolute path where the configuration files are located, such as *.desc and *.psb. This environment variable is mandatory for: ARTIMPP, ARTIMPP_ORA, ARTIBMP, ARTIBMP_ORA, ARTIBMPT, ARTIADM.
ART_IMS_DB
Container path where GSAM files are located.
ART_IMS_FMT
An environment variable required by ARTICTL to specify the absolute path where the control block files which generated through MFSGEN are located. It is a series of paths similar to PATH environment variable, the separator is “:”. If this variable is not specified, the PATH APPDIR is used. It is a mandatory environment variable for ARTICTL if MFS is used.
ART_IMSLOGDIR
Specify the directory where all the record log files are located. Record log file is used by CHKP (Symbolic) and XRST. If not specified, the ART_IMSLOGDIR default value is $APPDIR/IMSLOGDIR. In MP mode, if the program wants to share the record log file among machines in an Oracle Tuxedo domain, ART_IMSLOGDIR should point to an NFS directory which can be accessed by machines in the Oracle Tuxedo domain.
ARTIMS_CAPITAL_USERID
An environment variable required by ARTICTL to specify whether to translate user name to upper case or not. If it is set to Y, all user name characters are translated to upper case. If it is set to N or if it is not set, there is no translation.
ARTIMS_COBOL_MODE
Specifies user COBOL program invocation/cancel method (Micro Focus COBOL only). For COBOL-IT, it is ignored. The available values and descriptions are listed in the following table 19. If not set, its default value is MF_SUBSYS.

Table 1-20 ARTIMS_COBOL_MODE Values

Value Description
MF_SUBSYS Use SUBSYSTEM method.
MF_COBFUNC Use COBFUNC method.
MF_DEFAULT_CA NCEL Use cobcall with default CANCEL behavior.
MF_PHYSICAL_C ANCEL Use cobcall with physical CANCEL behavior.
MF_LOGICAL_CA NCEL_STANDARD Use cobcall with logical CANCEL behavior, and physically cancel .dll code and shared object code as part of a logical cancel operation.
MF_LOGICAL_CA NCEL_SPECIAL Use cobcall with logical CANCEL, and do not physically cancel .dll code and shared object code as part of a logical cancel operation.
MF_NOCANCEL Use cobcall without CANCEL behavior.
ARTIMS_DYNAMIC_BMP
Specifies dynamic BMP setting. The value can be set to "Y" or "N".

If set to "Y", BMP server exits after executing a BMP program. If set to "N", BMP server remains live after executing a BMP program.

If not set, the default is "N".

ART_IMS_EXCEPTION_TO_CATCH
Specifies the list of signal numbers that you want to catch for application exception. Each number is separated by comma (e.g., ART_IMS_EXCEPTION_TO_CATCH=8,11,4 ).

If this environment variable is not set, the default list (SIGSEGV,SIGILL,SIGBUS,SIGFPE), is used. If an illegal signal number is specified, it is ignored and a warning message is written in the ULOG file. If a legal signal number which can’t be caught is specified (e.g., SIGKILL or SIGSTOP), the server boot fails and warning message is written in the ULOG file.

ARTIMS_EXCEPTION_HANDLING
Specifies server behavior when a severe exception is generated by a user application is caught. The value can be set to KEEP or ABORT.

If set to ABORT, server MPP/BMP aborts when an exception from the user application is caught the core file of the server may or may not be generated based on the system configuration.

If set to KEEP, the server is kept alive. If not set, the default value is KEEP.

ARTIMS_LOGON_SCREEN
Specifies the logon screen directory, which must be a sub-directory in $IMSDIR. If not set, the default value is sysmap, which means the logon screen in $IMSDIR/sysmap is used. There is another logon screen defined in $IMSDIR/sysmap2; the only difference between sysmap2 and sysmap is the positions for user name and password input fields. For more information about user defined logon screen, see the readme file in $IMSDIR/sysmap2.
COBPATH
An environment variable required by Micro Focus COBOL environment. It defines one or more directories to search COBOL programs to be loaded dynamically. Its usage is similar to UNIX PATH. It is a mandatory environment variable for Micro Focus COBOL.
COB_LIBRARY_PATH
If you are using COBOL-IT, COB_LIBRARY_PATH is required by COBOL-IT to define the search order for COBOL programs. It defines one or more directories to search COBOL programs to be loaded dynamically. Its usage is similar to Unix PATH. It is a mandatory environment variable for COBOL-IT.
DFSRRC00_TIMEOUT_SEC
Used for DFSRRC00 to specify the timeout second value for DFSRRC00 to wait for the BMP/BMPT program response. It uses the following rules:
  • If not defined, or its value is set to 0 or negative value, or bigger than 0xFFFFFFFF, no timeout is allowed. DFSRRC00 will wait until it receives a response from BMP/BMPT.
  • If its value is set to a positive value smaller than 0xFFFFFFFF, DFSRRC00 will wait until the specified timeout value is reached, or receives a response from BMP/BMPT within the timeout value.
EXTERCODE
Specifies which encoding type of outbound data is used. The value could be any EBCDIC encoding type used in z/OS platform. If this variable is not specified, IBM-37 will be used. If this variable is specified, then INTERCODE should be specified as well.
IMS_DUMP_TYPE
Specifies the program dump type. The dump file is generated when any of the following conditions are met:
  • CEE3ABD/ART3ABD is called (except when CEE3ABD is called in an MF environment).
  • DLI ROLL is called.
  • Signal specified in ART_IMS_EXCEPTION_TO_CATCH or in default signal list (ART_IMS_EXCEPTION_TO_CATCH is not set), is caught.
The available values and descriptions are listed in the following table.

Table 1-21 0 IMS_DUMP_TYPE Values

IMS_DUMP_TYPE Description
NONE No dump.
SYSTEM_DUMP dump process using system utility
COBOL_DUMP dump COBOL program using COBOL runtime dump method , only available for COBOL program in CIT environment now
BOTH dump two files using both system utility and COBOL runtime dump method
If IMS_DUMP_TYPE is not configured, the default value is NONE - but if ARTIMS_EXCEPTION_HANDLING is set to ABORT, SYSTEM_DUMP is enabled when the signal is caught. The dump types for all combinations are listed in the following table.

Table 1-22 Real Effect Dump Type

ARTIMS_EXCEPTIO N_HANDLING Dump Condition IMS_DUMP_TYPE Real Effect Dump Type
C Program MF-COBOL Program CIT-COBOL Program
KEEP or ABORT ABEND or ROLL NONE NONE NONE NONE
SYSTEM_DUMP SYSTEM_DUMP SYSTEM_DUMP SYSTEM_DUMP
COBOL_DUMP NONE NONE COBOL_DUMP
BOTH SYSTEM_DUMP SYSTEM_DUMP SYSTEM_DUMP

COBOL_DUMP

KEEP Signal Caught NONE NONE NONE NONE
SYSTEM_DUMP SYSTEM_DUMP SYSTEM_DUMP SYSTEM_DUMP
COBOL_DUMP NONE NONE COBOL_DUMP
BOTH SYSTEM_DUMP SYSTEM_DUMP SYSTEM_DUMP COBOL_DUMP
ABORT Signal Caught NONE SYSTEM_DUMP SYSTEM_DUMP SYSTEM_DUMP
SYSTEM_DUMP SYSTEM_DUMP SYSTEM_DUMP SYSTEM_DUMP
COBOL_DUMP SYSTEM_DUMP SYSTEM_DUMP SYSTEM_DUMP

COBOL_DUMP

Both SYSTEM_DUMP SYSTEM_DUMP SYSTEM_DUMP

COBOL_DUMP

Requirements to generate dump file are lists in the following table:

Table 1-23 Dump File Requirements

IMS_DUMP_TYPE Requirements
LINUX AIX
COBOL_DUMP In CIT environment, COBOL programs must be compiled with -g or -fmem-info or -debug flag.
SYSTEM_DUMP gcore could be invoked; gencore could be invoked; system configuration core file size is big enough
BOTH Both above COBOL_DUMP and SYSTEM_DUMP requirements.

All dump files are located at $APPDIR.

The process dump file name is core.${servername}.${timestamp}.${pid}.

The CIT dump file name is CIT.core.${program name}.${timestamp).

IMS_ENV_LIST
Used for DFSRRC00 to specify all the environment variable names that need to be sent to ARTIBMP server except all those environment variables with prefix "DD_". All the environment variable's name should be separated with a comma. It should be set before DFSRRC00 is launched.
IMS_LONG_USERNAME
ARTIMS supports login IMS from terminal using the traditional 8-byte username/password, and also supports max 30 bytes username/password. This environment variable is used to switch between the traditional username/password and long username/password. The default mode is traditional 8-byte username/password.

If IMS_LONG_USERNAME is set to be “Y”, the max 30 bytes username/password is used; otherwise, the traditional 8-byte username/password is used.

IMS_PERF_ENABLE
A global switch for performance tracing. If IMS_PERF_ENABLE is set to Y/N, it controls turning performance tracing on/off, and takes precedent over the UBBCONFIG file setting.

If IMS_PERF_ENABLE is not set, the performance behavior is set by using the UBBCONFIG file -V option.

IMS_PRO_LOG
A global switch for program invocation log. If IMS_PRO_LOG is set to Y/N, it controls turning program invocation log on/off.

If set to Y, at the start/end of a transaction/program in MPP/BMP servers a trace line is added to the program invocation log file in the following format: transaction name, program name, Sstart time, Eend time, group id, server id.

Note:

When used, "-" indicates an empty value.

If not set, the default value is N.

IMS_STAT_IPCKEY
Specify IPCKEY to create a share memory for collecting IMS status information. Only when IPCKEY is set to a valid IPC value can ARTIMSAGENT get real time information from IMS domain.
IMS_TRACE_PATH
Specifies the path where debug trace, program invocation log, and performance tracing reports are located. Tuxedo ART for IMS server must have both write and execute permissions for this directory.

If not specified, by default, they are located at $APPDIR/log.

IMSDIR
An environment variable containing the root path (absolute path), of the installed Tuxedo ART for IMS subsystem. It is a mandatory environment variable if ARTICTL is used to be connected from terminal.
INTERCODE
Specifies which encoding type of inbound data is used. The value could be any encoding type used in universal platform. If this variable is not specified, ASCII is used. If this variable is specified, then EXTERCODE should be specified as well.

Parent topic: Oracle Tuxedo Application Runtime for IMS Reference Guide