Environment Variables

ART_IMS_CONFIG is an optional environment variable that specifies the absolute path where the IMS configuration files are located. This is required by Oracle Tuxedo Application Runtime for IMS when you access IMS DB. For more information, see "Oracle Tuxedo Application Runtime for IMS Users Configuration" in Oracle Tuxedo Application Runtime for IMS Users Guide.

ART_IMS_DB is an optional environment variable that specifies the container path where GSAM files are located. This is required by Oracle Tuxedo Application Runtime for IMS when you access IMS DB. For more information, see "Oracle Tuxedo Application Runtime for IMS Users Configuration" in Oracle Tuxedo Application Runtime for IMS Users Guide.

This is optional environment variable for local transaction optimization. When ARTKIX_XA_DISABLE=yes, it uses database local transaction instead of XA transaction. All ART application servers, such as ARTSTRN/1, ARTATRN/1, ARTCTRN/1, ARTWTRN/1, and ARTDPL support ARTKIX_XA_DISABLE by default; however, when rebuilding your own ART application server, you should specify -n option in buildartcics command to support ARTKIX_XA_DISABLE. This local transaction optimization should be used only in local transaction scenario. Default value is NO.

This is a mandatory environment variable when using COBOL-IT with ART CICS Runtime. It indicates VSAM file support with COBOL-IT/BDB under XA environment is enabled. It should be set to 1.

DD_VSAMFILE is a mandatory environment variable that indicates the location of VSAM configuration file "desc.vsam" generated by ART Workbench, if the CICS program contains some VSAM operations.

If ARTKIX_XA_DISABLE=yes, then DBCONNECT must be set, it specifies database connection string, for example, USER/PASSWD@SID when using Oracle.

ISC_ENABLE is an optional environment variable. Set ISC_ENABLE=YES to enable the following ISC related features:

•

When ISC_ENABLE=YES, ART CICS cannot validate LUNAME across multi-CICS regions. Users must ensure LUNAME is unique across different CICS regions.

KIXCONFIG is a mandatory environment variable that indicates the directory where resource configuration files are located.

KIXDIR is a mandatory environment variable that indicates the directory where the CICS Runtime product is installed.

Usually, the Tuxedo environment variable APPDIR should be set to ${KIXDIR}/bin.

KIX_CBL_TRAP_ERROR is used to enable or disable the COBOL LE (language environment) error procedure. The default value is Y, meaning the error procedure is enabled. If KIX_CBL_TRAP_ERROR=N is specified, the error procedure will be disabled. For more information, see Error Processing in CICS Runtime.

This is an optional environment variable that specifies CICS system code that returns in CICS INQUIRE SYSTEM RELEASE command. KIX_CICS_RELEASE is four characters long. Alternatively, you can specify the CICS system code by using system configuration file parameter CICS_RELEASE; if you do it, CICS_RELEASE configuration overrides KIX_CICS_RELEASE configuration.

This environment variable is optional. It specifies the "year" value returned by ASKTIME API. The value of KIX_CURRENT_YEAR is an integer greater than 0.

This environment variable is optional. It specifies the "month" value returned by ASKTIME API. The value of KIX_CURRENT_MONTH is a number 1 through 12, representing the months of the year beginning with January.

This environment variable is optional. It specifies the "day" value returned by ASKTIME API. The value of KIX_CURRENT_DAY is a number 1 through 31, representing the days of the month.

This environment variable is optional. It specifies the "hour" value returned by ASKTIME API. The value of KIX_CURRENT_HOUR is a number 0 through 23, indicating the hours of the day.

This environment variable is optional. It specifies the "minute" value returned by ASKTIME API. The value of KIX_CURRENT_MINUTE is a number 0 through 59, indicating the minutes of the hour.

This environment variable is optional. It specifies the "second" value returned by ASKTIME API. The value of KIX_CURRENT_SECOND is a number 0 through 59, indicating the seconds of the minute.

The Common Work Area (CWA), when defined (see KIX_CWA_SIZE), is implemented on each machine by a shared memory segment. The KIX_CWA_IPCKEY variable indicates the IPCKEY (the identifier) of the shared memory segment. The value must be defined in the range from 1 to 99 999 999.

This environment variable is optional.

On the source platform the Common Work Area (CWA) is shared by all the Programs executing inside a single CICS Region. The size of this CICS zone can vary from 0 to 32765 bytes, 0 indicating that no CWA is defined.

On the target platform, the KIX_CWA_SIZE variable also indicates the size of the CWA, ranging from 0 to 32765 bytes. If this environment variable is not set, the value defaults to 0. A value of zero (either explicit or implicit) indicates that no CWA is defined.

KIX_DUMP_FILE is an optional environment variable that indicates the file where the COBOL-IT memory dumps are located. Currently, the KIX_DUMP_FILE only take effect for COBOL-IT. And you must make sure the COBOL-IT version is newer than 3.7.7. The COBOL-IT version older than 3.7.8 can lead an infinite loop condition for memory DUMP.

If KIX_DUMP_FILE is set to a valid local file, the final memory information of the program will be dumped in this specified dump file when CICS program aborts; otherwise, no dump file will be generated.

Specifies dump type. Valid values are NONE, SYSTEM, COBOL, and BOTH. Default value is BOTH.

KIX_IMSDB_TRACE_LEVEL is an optional environment variable that specifies IMS DB access log trace level; its value equals to the level in Oracle Tuxedo Application Runtime for IMS.

KIX_JOURNAL_DIR is a mandatory environment variable for WRITE JOURNALNAME. It indicates the directory where the files corresponding to journal records are located.

This optional variable defines the path (the list of directories) in which the physical file of the mapset will be searched, in case the absolute path is not specified in the FILENAME field of Mapset in the Typeterm configuration file.

Specifies the maximum exception count that one server can tolerate.

Default value is 16. It should be a value greater than 0 and less than 129.

KIX_PROFILING is used to enable or disable the CICS runtime statistics function. Specify KIX_PROFILING=YES to enable the statistics function. The default value is NO. For more information, see CICS Runtime Statistics.

This mandatory variable is used to create the Tuxedo qspace named ASYNC_QSPACE utilized by ARTATRN for delayed asynchronous transactions.

The value for the IPC key should be picked so as not to conflict with your other requirements for IPC resources. It should be a value greater than 32 768 and less than 262 143.

KIX_RESSEC is an optional environment variable that enables or disables resource-based authorization.

•

KIX_RESSEC=A: performs resource-based authorization when you access a resource in a transaction. This applies to all transactions.

•

KIX_RESSEC=Y: performs resource-based authorization when you access a resource in a transaction. This only applies to the transactions whose RESSEC=Y is specified in transactions.desc.

Mandatory for GETMAIN SHARED, it indicates the IPCKEY of the shared memory segment used for GETMAIN SHARED.

The IPCKEY must be unique for shared memory. If the IPCKEY value specified to KIX_SHR_IPCKEY is in use, then the feature does not work correctly -- if the shared memory with this IPCKEY is not used for GETMAIN SHARED, then server failed to boot; if it is used for GETMAIN SHARED, then server tries to attach to the shared memory and tries to use it to allocate memory.

Mandatory for GETMAIN SHARED, it indicates the size of shared memory used for GETMAIN SHARED in unit of Mega-byte. Valid range is from 0 to 32768*1024. A value of 0 indicates no GETMAIN SHARED support. Since the overhead introduced by internal implementation mechanism, the actual memory size that can be used by user is less than the value indicated by KIX_SHR_SIZE.

Optional for GETMAIN SHARED, the attaching address of shared memory, default: 0x300000000000. If the value is specified, it must be a page-aligned address, address in range 0x300000000000 ~ 0x500000000000 is taken as valid.

This is an optional environment variable. When using Micro Focus COBOL, set KIX_SO_SUBSYS_WRAPPER=YES, then ART uses a wrapper program to call real user program, this workarounds working-storage variables initialization when user program is in .so format. Default value is NO.

This is an optional environment variable for SPOOL functions. Only if KIX_SPOOL_JOB_SUBMIT is not set, KIX_SPOOL_JOB_AUTO_SUBMIT submits the spool files automatically when it is set to YES or yes.

For example: KIX_SPOOL_JOB_AUTO_SUBMIT=yes

This is a mandatory environment variable used for SPOOL functions. It indicates the command line for the spool files submission. The command line should contain the first mandatory %s symbol that refers to the spool file name and the second facultative %s symbol that refers to the CLASS.

For example: KIX_SPOOL_JOB_SUBMIT=/my_path/my_shell_script -f %s -c %s

This is a mandatory environment variable used for SPOOL functions. It indicates the directory where the CICS Runtime writes the spool files named <spool_token>.<sever_pid>.<time_in_microseconds>.<occurrence_number>

KIX_TD_DIR is a mandatory environment variable that indicates the directory where files corresponding to the extra partition TDQueues are located.

KIX_TD_QSPACE_DEVICE is a mandatory environment variable for TD QUEUE(INTRA). It indicates the Tuxedo QSPACE needed by the tdq_srv server.

KIX_TD_QSPACE_IPCKEY is a mandatory environment variable for TD QUEUE(INTRA). It indicates the Tuxedo QSPACE ipckey needed by the tdq server.

KIX_TD_QSPACE_NAME is a mandatory environment variable for TD QUEUE(INTRA). It indicates the Tuxedo QSPACE name needed by the tdq server.

KIX_TECH_DIR is a mandatory environment variable that indicates the directory where technical files used internally by ART CICS, for exemple to manage named DELAYs and CANCELs (thru the REQID option) or ENQ/DEQ are written. It should be the same for each server until one wants to reproduce the source limitation, where a named DELAY submitted on one CICS region, could not be canceled easily in another region.

KIX_TS_DIR is a mandatory environment variable that indicates the directory where files corresponding to non-recoverable TS are located. It can be differentiated for each tsq server by setting it differently in the server envfile (see the Tuxedo documentation).

This optional variable allows the administrator to get traces for the system activities.

It can be set from 0 to 9, 0 represents no trace, 9 represents maximum trace. The default value is 0 when the variable is not defined. The most relevant trace levels are:

Other levels are reserved for support team. The higher level covers all traces deliverred by lower level.

If KIX_USER_TRACE is set to SID, KIX_TRACE_PATH variable must be set. It defines the directory containing the trace files (the file name is ended by ".trc").

This variable is not used to store other files.

Optional variable for ARTTSQ. Set KIX_TSQ_FILE_OPT=YES to enable file open/close optimization for non-recoverable TSQ. Default is NO.

This optional variable defines the type of traces, one trace file per connection or all traces in the same file.

KIX_USER_TRACE=SID represents one trace file per connection. The other value is STD, in this case traces will be in each stdout of server, if the variable is not set to STD is assumed.

When you want to use transaction / command audit tool against mulitple homonymous ART servers, SID should be used.

KIX_USERID_TOUPPER is an optional environment variable that enables or disables user ID uppercase conversion. When KIX_USERID_TOUPPER is set to Y, user ID that is specified in the CESN transaction is converted to uppercase after authentication. The default value is N.

KIX_XA_REOPEN_THRESHOLD is an optional environment variable. It defines threshold to trigger RM reopen. Threshold is continuous XA operation failure times; XA operation is tpbegin/tpcommit/tpabort, from Tuxedo perspective. When the threshold is met, ART for CICS application servers (ARTSTRN/1, ARTATRN/1, ARTCTRN/1, ARTWTRN/1 and ARTDPL) suspend its transaction service, and then try to re-open RM to recover the failure. KIX_XA_REOPEN_THRESHOLD must be a positive value in decimal format; if it is not set, "XA error detect and RM reopen" function is not enabled.

KIX_XA_REOPEN_INTERVAL is an optional environment variable. It defines interval in seconds between two XA reopen tries. Specify KIX_XA_REOPEN_INTERVAL when XA_REOPEN_THRESHOLD is set. Its value must be positive integer in decimal format; the default interval is 30 seconds.