CICS Environment Variables

Lists environment variables related to configuring the CICS environment.

CICS_SIT

The name of the SIT used by the enterprise server region.
Syntax
CICS_SIT=sit-name
Parameter
sit-name
The name of the CICS SIT to use for the enterprise server region.
Default
Not set. The CICS SIT specified in ESCWA is used.

ES_ABORT_PLTPI_ERROR

Enables the user to set the error on which to abort PLTPI processing, bypassing the prompt.
Syntax
ES_ABORT_PLTPI_ERROR={YN|NY|YY}
Parameters
YN
Abort on PGMIDERR.
NY
Abort on ABEND.
YY
Abort on PGMIDERR or ABEND.
Default
Not set. When an error occurs during PLTPI processing, mainframe CICS enterprise servers display a prompt that enables the user to cancel the startup or ignore the error.
Comments
Set ES_ABORT_PLTPI_ERROR to bypass the prompt and automatically abort the initialization as dictated by the value provided.

ES_CICS_SINGLE

Configures CICS so that a user can only log on once when the enterprise server region is running in a PAC with CICS enabled.
Syntax
ES_CICS_SINGLE={Y|N}
Parameters
Y
A user can only log on once.
N
The same user may sign on to multiple terminals with CICS.
Default
ES_CICS_SINGLE=Y
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

ES_CLASS_XPCT

Controls the CICS PCT resource class.
Syntax
ES_CLASS_XPCT={YES|NO|class-name
Parameters
YES
ACICSPCT is the default PCT class.
NO
Security for PCTs is bypassed.
class-name
The name of a class to override the default PCT ACICSPCT class.
Default
ES_CLASS_XPCT=YES
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

ES_CLASS_XCMD

Controls the CICS CMD resource class.
Syntax
ES_CLASS_XCMD={YES|NO|class-name}
Parameters
YES
CICS CMD is the default CMD class.
NO
Security for CMDs is bypassed.
class-name
The name of a class to override the default CMD CICSCMD class.
Default
ES_CLASS_XCMD=YES
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

ES_CLASS_XDCT

Controls the CICS DCT resource class.
Syntax
ES_CLASS_XDCT={YES|NO|class-name}
Parameters
YES
DCICSDCT is the default DCT class.
NO
Security for DCTs is bypassed.
class-name
The name of a class to override the default DCT DCICSDCT class.
Default
ES_CLASS_XDCT=YES
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

ES_CLASS_XFCT

Controls the CICS FCT resource class.
Syntax
ES_CLASS_XFCT={YES|NO|class-name}
Parameters
YES
FCICSFCT is the default FCT class.
NO
Security for FCTs is bypassed.
class-name
The name of a class to override the default PCT FCICSFCT class.
Default
ES_CLASS_XFCT=YES
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

ES_CLASS_XJCT

Controls the CICS JCT resource class.
Syntax
ES_CLASS_XJCT={YES|NO|class-name}
Parameters
YES
JCICSJCT is the default JCT class.
NO
Security for JCTs is bypassed.
class-name
The name of a class to override the default JCT JCICSJCT class.
Default
ES_CLASS_XJCT=YES
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

ES_CLASS_XPPT

Controls the CICS PPT resource class.
Syntax
ES_CLASS_XPPT={YES|NO|class-name}
Parameters
YES
MCICSPPT is the default PPT class.
NO
Security for PPTs is bypassed.
class-name
The name of a class to override the default PPT MCICSPPT class.
Default
ES_CLASS_XPPT=YES
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

ES_CLASS_XPSB

Controls the CICS PSB resource class.
Syntax
ES_CLASS_XPSB={YES|NO|class-name}
Parameters
YES
PCICSPSB is the default PSB class.
NO
Security for PSBs is bypassed.
class-name
The name of a class to override the default PSB PCICSPSB class.
Default
ES_CLASS_XPSB=YES
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

ES_CLASS_XRES

Controls the CICS DOCTEMPLATE resource class.
Syntax
ES_CLASS_XRES={YES|NO|class-name}
Parameters
YES
RCICSRES is the default RES class.
NO
Security for DOCTEMPLATEs is bypassed.
class-name
The name of a class to override the default RES RCISRES class.
Default
ES_CLASS_XRES=YES
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

ES_CLASS_XTST

Controls the CICS TST resource class.
Syntax
ES_CLASS_XTST={YES|NO|class-name}
Parameters
YES
SCITST is the default TST class.
NO
Security for TSTs is bypassed.
class-name
The name of a class to override the default TST SCITST class.
Default
ES_CLASS_XTST=YES
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

ES_CLASS_XTRAN

Controls the CICS TRAN resource class.
Syntax
ES_CLASS_XTRAN={YES|NO|class-name}
Parameters
YES
TCICSTRN is the default TRAN class.
NO
Security for TRANs is bypassed.
class-name
The name of a class to override the default TRAN TCICSTRN class.
Default
ES_CLASS_XTRAN=YES
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

ES_CSKL_NO_MSG_CONSOLE

Stops the EZ Sockets CICS listener (CSKL) from writing messages to console.log.
Syntax
ES_CSKL_NO_MSG_CONSOLE=ON
Parameter
ON
CSKL does not write message to console.log.
Default
Not set. CSKL writes messages to console.log.
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

ES_CWS_WSBIND_COMP

Enables support for CICS applications that use COMP declarations.
Syntax
ES_CWS_WSBIND_COMP={Y|N}
Parameters
Y
Enables support for COMP declarations in CICS applications.
N
Support for COMP declarations is disabled for CICS applications.
Default
ES_CWS_WSBIND_COMP=N

ES_DISABLE_DFLTUSR_SIGNON

Disables the default user (mfuser) signon when invoking ES Monitor & Control (ESMAC).
Syntax
ES_DISABLE_DFLTUSR_SIGNON=Y
Parameter
Y
Disables the mfuser auto-logon after starting Enterprise Server administration via your MFDS internal security account.
Default
Not set. mfuser is signed in to ESMAC.
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

ES_ECI_MAX_RESP

Specifies the maximum expected response size to use when using Micro Focus ECI support to invoke CICS programs.
Syntax
ES_ECI_MAX_RESP=resp-size
Parameter
resp-size
A decimal from 1 to 16777215 representing the maximum expected response size in bytes.
Default
Not set. The maximum expected response size is calculated dynamically by multiplying the size of the TIOA by 2.
Comments
You need to use this environment variable when the amount of data returned from the CICS programs is approximately more than twice the size of the input data, which is sometimes the case when using channels and containers where the back-end program creates or enlarges containers.

ES_ESM_CMDSEC

Indicates whether CICS processing honors the CMDSEC option specified on a transaction's PLT definition.
Syntax
ES_ESM_CMDSEC=YES
Parameter
YES
CICS overrides the CMDSEC option, and always calls its command security checking routine to issue the appropriate call to the SAF interface.
Default
Not set. CICS honors the CMDSEC option defined in a transaction's resource definition. CICS calls its command security checking routine only when CMDSEC(YES) is specified in a transaction resource definition.

ES_ESM_IDPW_CASE

Forces the case of user ID and password for a single attempt ESM authentication.
Syntax
ES_ESM_IDPW_CASE=xy
Parameters
x
Specifies the case for the user ID. Use one of the following:
U All upper case
L All lower case
M Mixed case and case-sensitive
y
Specifies the case for the password. Use one of the following:
U All upper case
L All lower case
M Mixed case and case-sensitive
Default
Not set. Uses legacy behavior.
Comments
When this environment variable is set, Enterprise Server makes only one attempt to identify a user presenting the user ID and password as is (M), folded to upper case (U), or folded to lower case (L).

For the legacy behavior for CICS, the user ID and the password are used as supplied possibly filtered by the upper-case translation configuration of the sign-on transaction.

For ESMAC and IMS, the legacy behavior is that, first, the user ID and password are used as supplied. If the authentication fails, the user ID is folded to upper case and used again. If this fails as well, both the user ID and the password are folded to upper case and then used.

Example
This example tries a single authentication with the user ID folded to upper case, and the password used as-is:
ES_ESM_IDPW_CASE=UM

ES_ESM_PLTPISEC

The level of security checking for PLTPI processing.
Syntax
ES_ESM_PLTPISEC={NONE|CMDSEC|RESSEC|ALL}
Parameters
NONE
No security checking is performed on PLT initialization programs.
CMDSEC
CICS performs command security checking only.
RESSEC
CICS performs resource security checking only.
ALL
CICS performs both command and resource security checking.
Default
ES_ESM_PLTPISEC=NONE

ES_ESM_PLTPIUSR

Specifies the user ID under which PLT programs run during CICS initialization.
Syntax
ES_ESM_PLTPIUSR=userid
Parameter
userid
The user ID for CICS to use for security checking for PLT programs that run during CICS initialization.
Default
Not set. The user specified when starting the CICS-enabled enterprise server region is used.
Comments

The user ID specified must have appropriate authorization to access all the resources used by the programs as determined by the ES_ESM_PLTPISEC environment variable.

ES_ESM_RCF

Determines how RACF is used for command authorization.
Syntax
ES_ESM_RCF={A|C|N|S|T|Y}
Parameters
A
A combination of options T, C, and S.
C
Use RACF for ETO terminal command authorization.
N
RACF does not perform sign-on, transaction, or command authorization.
S
Use RACF for static and ETO terminal command authorization. Includes option C.
T
Use RACF for sign-on and transaction authorization.
Y
A combination of options T and C.
Default
ES_ESM_RCF=N

ES_ESM_RESSEC

Indicates whether CICS processing honors the RLS security setting specified on a transaction definition (PCT).
Syntax
ES_ESM_RESSEC=ALWAYS
Parameter
ALWAYS
CICS processing always performs resource level security checking irrespective of the RLS security setting on the transaction definition.
Default
Not set. The RLS security setting of a transaction is honored. That is, resource-level security checking is performed only when the RLS security checkbox is marked in the PCT definition.

ES_ESM_SECPRFX

Indicates whether CICS processing adds a prefix to resource names when making security queries.
Syntax
ES_ESM_SECPRFX={NO|YES|prefix}
Parameters
NO
Use no prefixes.
YES
Uses prefix resource names with the CICS region user ID.
prefix
Define a prefix for resource names as an alphanumeric string that starts with an alphabetic character, and is one to eight upper-case characters in total.
Default
ES_ESM_SECPRFX=NO
Comments
This environment variable is applied only to CICS classes.

ES_ESM_XUSER

Indicates whether CICS processing performs surrogate user checks.
Syntax
ES_ESM_XUSER={NO|YES}
Parameters
NO
No surrogate user checking is performed.
YES
Perform surrogate user checking wherever such checks are permitted.
Default
ES_ESM_XUSER=YES

ES_EUSA_SIZE

Sets the size of the extended user storage area, allowing large memory allocations to be set using the GETMAIN SHARED command.
Syntax
ES_EUSA_SIZE=number
Parameter
number
A numeric value representing the number of MB to allocate for the extended user storage area.
Default
ES_EUSA_SIZE=16

ES_INQFILE_RETURN

Modifies EXEC CICS INQUIRE FILE behavior for cataloged files.
Syntax
ES_INQFILE_RETURN={DSN|PCN}
Parameters
DSN
The DSN is returned. For an alternative file, the BASEDSNAME is the DSNAME of the BASE file.
PCN
The PC name of the file (truncated at 44 characters) is returned if the file is open, or if FCT fix-up has been performed. Otherwise, the dataset name is returned.
Default
ES_INQFILE_RETURN=PCN

ES_JES_FREE_SSTM_SYSOUT

Determines whether to free the memory assigned to store details about each CICS spool file that you create using the CICS Spool Write APIs, once the spool file has been created.
Syntax
ES_JES_FREE_SSTM_SYSOUT={Y|N}
Parameters
Y
Free the memory assigned to store details about each CICS spool file.
N
Do not free the memory assigned to store details about each CICS spool file.
Default
ES_JES_FREE_SSTM_SYSOUT=N
Comments

Setting ES_JES_FREE_SSTM_SYSOUT=Y helps to avoid problems with receiving out of memory errors when creating multiple new files.

CAUTION:
Setting the variable also removes the tracking information about the file which means that the file's status (SPOOLED) no longer appears in the JESYSMSG for the SSTM job.

ES_LE370_SUPPORT

Enables support for Language Environment (LE) in CICS applications
Syntax
ES_LE370_SUPPORT=Y
Parameter
Y
Enables LE support.
Default
Not set. LE support is not enabled.
Comments
Parameter value is not case sensitive.

ES_LEGACY_ECI

Indicates that Enterprise Server must use Micro Focus ECI instead of IBM CTG.
Syntax
ES_LEGACY_ECI=Y
Parameter
Y
Micro Focus ECI is used.
Default
Not set. IBM CTG is used.
Comments
Parameter value is not case sensitive.

ES_MFASM_SUPPORT

Enables Assembler support in a CICS enterprise server region.
ES_MFASM_SUPPORT={Y|N}
Parameters
Y
Assembler supported for CICS server regions.
N
No Assembler supported for CICS server regions.
Default
ES_MFASM_SUPPORT=N

ES_MQ_1PC

Indicates whether the IBM WebSphere MQ switch module ESMQXA operate in one-phase commit mode.
CAUTION:
Set this environment variable only when advised to do so by OpenText Support for Micro Focus Products.
Syntax
ES_MQ_1PC={[Y|y|Yes|T|True]|[N|n|No|F|False}
Parameters
Y|y|Yes|T|True
The ESMQXA switch module operates in one-phase commit mode.
N|n|No|F|False
The ESMQXA switch module operates in two-phase commit mode.
Default
ES_MQ_1PC=F

ES_MQ_LIB

The full name including the path of the IBM WebSphere MQ client or server library. This should only be required if MQ was NOT installed in the default location.
Syntax
ES_MQ_LIB=path-name/library-name
Parameters
path-name
The full path to the library location.
library-name
The name of the library file.
Default
Not set. Enterprise Server looks for library files in the default location for your platform.
Comments
In AIX environments the library is an object inside a shared object. For example:
ES_MQ_LIB="/usr/mqm/lib64/libmqmxa64.a(libmqm64.o)"

ES_MQ_LIB_T

For threaded environments, the full path to and file name of the IBM WebSphere MQ client or server library. Required only when WebSphere MQ was not installed in the default location.
Syntax
ES_MQ_LIB_T=path-name/library-name
Parameters
path-name
The full path to the threaded library location.
library-name
The name of the threaded library file.
Default
Not set. Enterprise Server looks for threaded library files in the default location for your platform.

ES_MQ_LIB_XA

The full path to and file name of the IBM WebSphere MQ XA library. Required only when WebSphere MQ was not installed in the default location
Syntax
ES_MQ_LIB_XA=path-name/library-name
Parameters
path-name
The full path to the library location.
library-name
The name of the library file.
Default
Not set. Enterprise Server looks for library files in the default location for your platform.
Comments
In AIX environments, the library is an object inside a shared object. For example:
ES_MQ_LIB_XA="/usr/mqm/lib64/libmqmxa64.a(libmqm64.o)"

ES_MQ_LIB_XA_T

The full path to and file name of the IBM WebSphere MQ XA library for threaded environments. Required only when WebSphere MQ was not installed in the default location
Syntax
ES_MQ_LIB_XA_T=path-name/library-name
Parameters
path-name
The full path to the threaded library location.
library-name
The name of the threaded library file.
Default
Not set. Enterprise Server looks for threaded library files in the default location for your platform.

ES_MQ_XA

The type of XA structure to use for the two-phase commit XA switch module.
Syntax
ES_MQ_XA={D|S}
Parameters
D
Use a dynamic XA structure
S
Use a static XA structure.
Default
ES_MQ_XA=D

ES_SSTM_CICS

Location of the JCL used to initialize the SSTM CICS environment.
Syntax
ES_SSTM_CICS=file-location
Parameter
file-location
The full path to the location of the SSTMCICS.JCL file used to initialize the SSTM CICS environment.
Default
Not set.

ES_SURROGATE_JOB_USER

Associates a user ID with a job when submitting the job for processing through the internal reader from CICS.
Syntax
ES_SURROGATE_JOB_USER=ON
Parameter
ON
The user ID that started the enterprise server region is used in the job submission.
Default
Not set. The CICS default user CICSUSER, or as specified by ES_USR_DFLT_CICS, is used in the job submission.
Comments
This environment variable is considered to be turned on when set to any value, including ON.

Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

ES_TEST_TRANCLASS

Activates transaction class support.
Syntax
ES_TEST_TRANCLASS={Y|N}
Parameters
Y
Activate transaction class support.
N
Do not activate transaction class support.
Default
ES_TEST_TRANCLASS=N
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

ES_TRANCLASS_CWI

For CICS Web Services, enables the prioritizing and limiting of Web requests in a TRANCLASS-enabled region.
Syntax
ES_TRANCLASS_CWI={TCPIPSERVICE|URIMAP}
Parameters
TCPIPSERVICE
Prioritize and limit TCPIPSERVICE transactions.
URIMAP
Prioritize and limit URIMAP transactions.
Default
ES_TRANCLASS_CWI=TCPIPSERVICE
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

ES_TSC_AGGREGATE

Controls the performance environment for CICS TS/TD data stores.
Syntax
ES_TSC_AGGREGATE=wait-time,{Y|N|D}
Parameters
wait-time
The time in milliseconds to wait for additional flush requests to accumulate.
Y
Use aggregate data store flush-buffers-to-disk operations
N
Do not aggregate
D
Disable flush operations.

ES_USR_DFLT_CICS

Allows you to override the default user when no user is logged on for CICS authentication.
Syntax
ES_USR_DFLT_CICS=userid
Parameter
userid
An alternative default user name.
Default
ES_USR_DFLT_CICS=CICSUSER
Comments
Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

ES_XA_%xaname%_OPTIONS

When set with ES_XA_RECONNECT=Y, configures the XA reconnect process to operate in a multi-attempt mode.
Syntax
ES_XA_%xaname%_OPTIONS={reconnect_attempts,wait-time|EX}
Parameters
%xaname%
The name of the RM as specified in MFDS or ESCWA.
reconnect_attempts
The number of reconnect attempts to the target RM. Maximum is 9999.
wait-time
The number of seconds to delay between each attempt.
EX
Exclude the target RM from XA reconnect processing.
Default
Not set.
Comments
ES_XA_%xaname%_OPTIONS must be set along with ES_XA_RECONNECT=Y.

You might need to set ES_XA_%xaname%_OPTIONS multiple times — once for each RM that you require to operate in a multiple-attempt mode.

Examples
Specify that an XA reconnect processing attempts to reconnect to MQPROD 100 times and waiting for 10 seconds between each reconnect attempt:
ES_XA_MQPROD_OPTIONS=100,10

Specify that the XA reconnect processing is to exclude MQPROD from the XA reconnect processing:

ES_XA_MQPROD_OPTIONS=EX

ES_XA_ABEND

Recycles non-batch SEPs when a severe error is returned by an xa-start by an Oracle switch.
Syntax
ES_XA_ABEND=RECYCLE
Parameter
RECYCLE
Recycles non-batch SEPs when a severe error is returned by an xa-start by an Oracle switch.
Default
Not set. Non-batch SEPs are not recycled.

ES_XA_RECONNECT

Configures the XA reconnect process to operate in a single-attempt mode.
Syntax
ES_XA_RECONNECT=Y,wait-time[,retry_count]
Parameters
Y
Enables the reconnect process.
wait-time
The number of seconds to delay before triggering the XA recovery transaction after a two-phase commit failure and between each reschedule of the XA recovery transaction if the syncpoint phase 2 returns an RC 04. Maximum is 300.
retry_count
The number of recovery retries to attempt when the XA commit or rollback executed by the XA recovery transaction returns an RC-04. Default is 5.
Default
Not set. XA reconnect operates in multi-attempt mode.
Comments
In case of failure, the following messages are 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
Example
ES_XA_RECONNECT=Y,120,4

TXMAPP

The location of the BMS load module.
Syntax
TXMAPP=path-name
Parameter
path-name
The full path to the location of the BMS load module.

TXTRANP

The location of the CICS application object files.
Syntax
TXTRANP=path-name
Parameter
path-name
The full path to the location of the CICS application object files.

USSCONFIG

Points to the location of the SSL cipher suite specification file(s) used by the CIPHERS attribute in the CICS URIMAP or TCPIPSERVICE resource.
Syntax
USSCONFIG=cipher-path
Parameter
cipher-path
The absolute path to the cipher suite specification file or files.
Comments
For details about ciphers and cipher files, see the Security Attributes > Ciphers section of the Universal Resource Identifier Map topic.