Environment Variables

CICS Runtime Environment Variables

Two important Tuxedo environment variables are MANDATORY.

•	TUXDIR– must be set to indicate the directory in which Tuxedo is installed.

•	APPDIR – must be set to indicate the directory where the application server binaries are installed.

Note:

For CICS Runtime, APPDIR must be set to the directory containing the CICS Runtime server binaries.

CICS Runtime Specific Environment Variables

KIXDIR

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.

KIXCONFIG

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

KIX_TS_DIR

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

KIX_TD_DIR

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

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_NAME

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_TD_QSPACE_IPCKEY

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_TECH_DIR

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_CWA_SIZE

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_CWA_IPCKEY

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.

Note:

This variable is mandatory when KIX_CWA_SIZE is set to a value greater than zero.

KIX_QSPACE_IPCKEY

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_TRACE_LEVEL

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:

•	0 – servers startup and fatal errors information

•	1 – transaction / command audit information

•	2 – loading resources and advertising services information

•	3 – informations exchanged with the termnal

•	5 – SPOOL (CICS SPOOL) function traces

•	7 – CICS function traces (KIX__)

•	9 – traces for support team

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

KIX_USER_TRACE

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_TRACE_PATH

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.

KIX_MAP_PATH

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.

KIX_SPOOL_OUTPUT_DIR

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_SPOOL_JOB_SUBMIT

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

Note:

This script should be run in the batch execution environment. You can use “nohup” and “&” command to keep running the script in the background after you have logged out.

KIX_SPOOL_JOB_AUTO_SUBMIT

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

KIX_DUMP_FILE

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 a infinite loop condition for memory DUMP.

COB_ENABLE_XA

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

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.

ISC_ENABLE

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

•	ASSIGN ABDUMP/ABPROGRAM/ASRAINTRPT/ASRAKEY/ASRAPSW/ASRAREGS/ASRASPC/ASRASTG/INITPARM/INITPARMLEN/KATAKANA/NETNAME/SOSI/USERNAME

•

CANCEL

•	INQUIRE/SET FILE

•	INQUIRE PROGRAM RESCOUNT

•	INQUIRE SYSTEM JOBNAME

•	INQUIRE TERMINAL ALTSUFFIX/USERID

•	INQUIRE TRANSACTION PROGRAM

•	INQUIRE TERMINAL/NETNAME ACQSTATUS CREATESESS

•	ISSUE DISCONNECT

•	ISSUE PASS and EXTRACT LOGONMSG

•

SEND LAST

•	SET/INQUIRE TERMINAL

•	SET TERMINAL ACQSTATUS CREATE ACQUIRED RELEASED

•	START TRANSID with <ANY> TERMID

•	START TRANSID TERMID AFTER

•	START TARNSID REQID

•	START TRANSID SYSID

•	Configurable default transaction - GMTRAN (Good morning transaction)

•	3270 printer support

Note:

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

•	The validation is completed after users log on a CICS region (that is when users pass LOGON screen).