CICS environment variables

CICS_AS_STARTUP_PROG="/program/path/moduleC"

To specify a TXSeries C program module to be executed before terminating an application server. You must specify absolute path of module and modules must be compiled as TXSeries C programming language module.

CICS_AS_SHUTDOWN_PROG="/program/path/moduleC"

• When a program is not found
• When you are using an absolute path, a relative path in the region directory, or a filename in the region or bin directories

The path name entry in a program definition of the program that is to be loaded from this path must not include any directory information (for example, strings that contain any slash characters (/) on Open Systems, or backslash characters (\) on Windows systems).

This environment variable supports the standard operating-system behavior for paths. Therefore, on Windows platforms, the paths are delimited with a semicolon (;), and on Open Systems platforms, they are delimited with a colon (:).

To set CICS_PPC_GWY_SERVER in a Korn shell, specify the path name for the appropriate PPC Gateway server (for example, /.:/branch1/server/gwy1) as follows:

export CICS_PPC_GWY_SERVER=/.:/branch1/server/gwy1

To set CICS_PPC_ALLOCATE_TIMEOUT in a Korn shell, specify the appropriate timeout value (for example, 400) as follows:

export CICS_PPC_ALLOCATE_TIMEOUT 400

To set CICS_SFS_EXTFH in a Korn shell, specify the path name for the appropriate SFS server (for example, /.:/branch1/server/sfs2) as follows:

export CICS_SFS_EXTFH /.:/branch1/server/sfs2

Setting the variable to 0 disables operational force; any other value enables operational force. If this variable is not set, it defaults to 0.

To set CICS_SFS_EXTFH_AUTO_FLUSH in a Korn shell, specify the appropriate value for the use of operational force (for example, 1 to enable operational force) as follows:

export CICS_SFS_EXTFH_AUTO_FLUSH 1

Use one of the following formats to set the value of this environment variable:

read_and_insert_cache_size[:flag[,flag...]]

read_cache_size:insert_cache_size[:flag[,flag...]]

The parameters are defined as follows:

• read_and_insert_cache_size specifies the size of both the read and insert caches in pages. Setting this value to 0 (zero) disables read and insert caching.
• read_cache_size specifies the size of the read cache in pages. Setting this value to 0 (zero) disables read caching.
• insert_cache_size specifies the size of the insert cache in pages. Setting this value to 0 (zero) disables insert caching.
• flag specifies one or more caching restrictions to be relaxed. For a listing of these flags, see the reference page for the sfs_InitializeCache function. When specifying a flag, omit the SFS_CACHE_ prefix. For example, to specify the SFS_CACHE_ALLOW_DIRTY_READS flag, use ALLOW_DIRTY_READS.

To set CICS_SFS_EXTFH_CACHE in a Korn shell, specify the appropriate cache sizes (for example, 0 to disable the read cache, and 64 pages for the insert cache) followed by any flags (for example, ALLOW_DIRTY_READS) as follows:

export CICS_SFS_EXTFH_CACHE 0:64:ALLOW_DIRTY_READS

To set CICS_SFS_EXTFH_DUP_DETECTION in a Korn shell, specify the appropriate value for duplicate detection in a file (for example, NONE) as follows:

export CICS_SFS_EXTFH_DUP_DETECTION NONE

To set in a Korn shell, specify the appropriate number of seconds for an operation timeout (for example, 120) as follows:

export CICS_SFS_EXTFH_OP_TIMEOUT 120

To set CICS_SFS_EXTFH_OPEN_TIMEOUT in a Korn shell, specify the appropriate number of seconds for an open timeout (for example, 120) as follows:

export CICS_SFS_EXTFH_OPEN_TIMEOUT 120

To set CICS_SFS_EXTFH_VOL in a Korn shell, specify the name of the appropriate SFS logical volume (for example, sfsVol1) as follows:

export CICS_SFS_EXTFH_VOL sfsVol1

CICS_SNA_RECEIVE_TIMEOUT="SYS1,N1,SYS2,N2,SYS3,N3,SYS5,N5,. . .SYSn,Nn"

where SYS1 to SYSn are the Communications Definitions in the CD stanza of the CICS region that are subject to the forced timeout. Each of these is a remote system identifier with a maximum size of four alphanumeric characters. N1 through Nn are the actual timeout values in seconds. Each is the timeout value for the preceding system identifier, and is an integer value greater than, or equal to, 0.

To set CICS_TK_BDE_STACK_SIZE in a Korn shell, specify the appropriate stack size (for example, 65536 for 64 KB) as follows:

export CICS_TK_BDE_STACK_SIZE 65536

To set CICS_TK_SERVER in a Korn shell, specify the path name for the appropriate Toolkit server (for example, /.:/branch1/server/tk1) as follows:

export CICS_TK_SERVER /.:/branch1/server/tk1

The name is the name of the CICS Toolkit components for which trace output can be generated. To get a list of valid component names, issue the tkadmin list trace command. The value is an expression that can contain numeric constants or one of the following string values. (Each string value sets one or more bits in a trace mask.)

• trace_event—Trace all events
• trace_entry—Trace external function entry or exit
• trace_param—Trace external function parameters
• trace_internal_entry—Trace internal function entry or exit
• trace_internal_param—Trace internal function parameters
• trace_global—Trace all of the following: trace_event, trace_entry, trace_param, trace_internal_entry, and trace_internal_param
• trace_export—Trace external function entry or exit and function parameters
• trace_dump—Dump the component on a fatal error
• trace_dump_selected—Dump the component on a fatal error
• trace_all—Trace all except trace_dump
• all—Trace all except trace_dump

To determine which numeric constants are accepted for a given component, use the tkadmin query trace command. Trace specifications must not contain white space. Multiple statements can be separated with commas, as follows: name=value,name=value

To assign the same trace value to multiple components (name), use the following syntax: name=name=value

Two operators are supported in trace specifications: + (plus sign) or | (pipe) for bitwise addition and - (minus sign) for bitwise subtraction. In both bitwise addition and subtraction, a bit-by-bit comparison is made between two operands:

• In bitwise addition, the bit position in a trace mask is turned on if the bit is turned on in either of the two operand values.
• In bitwise subtraction, the bit position in a trace mask is turned off if the bit is turned off in either of the two operand values.

These operators can be placed between two values or prior to an = (equal sign). For example, to set all of the bits in the trace mask for the CICS Toolkit, use the following syntax: tpm=trace_all+trace_dump

For backward compatibility, the following form of trace specification is available: name:mask[:name:mask...]

In this format, mask is a numeric value that is implicitly assumed to be in hexadecimal; no leading 0x is necessary.

To set CICS_TK_TRACE in a Korn shell on a Open Systems platform, specify the appropriate trace specifications (for example, all=trace_event to view trace events for all CICS Toolkit components) as follows: export CICS_TK_TRACE all=trace_event

This environment variable takes the following format:

trace_class[=trace_class...][[[buffering][,formatting]]]
=destination

The trace_class can take any of the following values to indicate the events to be traced:

• audit: Trace administratively significant events
• critical: Trace a combination of audit, error, and fatal
• dump: Trace state dumps
• entry: Trace function entry and exit
• error: Trace nonfatal errors (warnings)
• event: Trace events
• fatal: Trace fatal errors
• param: Trace parameters
• serious: Same as critical
• trace: Trace a combination of entry, event, and param

The buffering argument describes the buffering characteristics of the output. You can specify either buffered or unbuffered. The formatting argument describes the formatting characteristics of the output. You can specify either formatted or unformatted. These two arguments are independent of each other, you can specify one or both. These arguments must be separated by a , (comma) and enclosed in [ ] (square brackets).

The destination can be any of the following:

• The key word FILE: followed by the full path name of a file (for example: /tmp/error).
• The key word RPC(contextString): followed by the CDS name or string binding of an RPC recipient. The contextString is a character string included to identify the source of the trace output. This destination can be used in conjunction with the traceListener server.
• The key word AIX: followed by either
  • errlog: The AIX error log facility (AIX only)
  • trace: The AIX trace stream facility (AIX only)
• The key word STREAM: followed by either
  • stderr: Standard error
  • stdout: Standard output

To set CICS_TK_TRACE_REDIRECT in a Korn shell, specify the appropriate trace classes and destinations (for example, to redirect trace and dump trace messages from myprog to a traceListener server, traceListener1) as follows:

export CICS_TK_TRACE_REDIRECT /
dump=trace=RPC(myprog):/.:/mycell/server/traceListener1

export CICS_TK_TRACE_RING_SIZE 524288

You can also set the ring buffer size by using the tkadmin set ringbuffersize command. If you use this command, the new ring buffer size takes effect immediately. If you use the CICS_TK_TRACE_RING_SIZE environment variable, the change takes effect the next time the server is started.

To set CICS_TK_TRACE_VERBOSE in a Korn shell, specify the appropriate direction for trace output (for example, 1 to direct it to stderr) as follows:

export CICS_TK_TRACE_VERBOSE 1