PAC Environment Variables

Lists environment variables related to configuring a PAC in Enterprise Server..

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_ALLOC_OVERRIDE

The location of a file containing rules that determine where new data sets are created. This applies only to JES and batch files, and not CICS, IMS, or Web services files.
Syntax
ES_ALLOC_OVERRIDE=path-name\rules-file
Parameters
path-name
The full path to the dataset rules file.
rules-file
The name of the dataset rules file.
Default
Not set.

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_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_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_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_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_EMP_EXIT_n

ES_EMP_EXIT_n
Specifies the number of Event Manager user exits for the region.
ES_EMP_EXIT_n=batch-component
Parameters
n
A single digit ranging from 1 through 9, depending on the number of Event Manager user exits for the region.
Note: This must be set to 1 when mfbsiemx is the only Event Manager user exit for the region.
batch-component
An event manager component. See Components for details.
Default
Not set.
Comments
You must set ES_EMP_EXIT once for each Event Manager used in the region.

When setting ES_EMP_EXIT multiple times, they must be set in numerical order.

Example
ES_EMP_EXIT_1=mfbsiemx
ES_EMP_EXIT_2=mfmonemx
ES_EMP_EXIT_3=...

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_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_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_PAC_NO_GLOBAL_LOG

Stops the messages in the console.log from being stored in the PAC Scale-out Repository (PSOR) CasPacLog.
Syntax
ES_PAC_NO_GLOBAL_LOG={Y|N}
Parameters
Y
Prevents console.log messages for PAC member regions from being stored in the PSOR.
N
console.log messages for PAC member regions are stored in the PSOR.
Default
ES_PAC_NO_GLOBAL_LOG=N
Comments
You can set ES_PAC_NO_GLOBAL_LOG=Y to improve performance if you are not monitoring messages from the PSOR.

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_SCALE_OUT_REPOS_n

Specifies connection information for either Redis or Oracle Coherence data stores used by enterprise server regions that are part of a PAC.
Syntax
ES_SCALE_OUT_REPOS_n=sor-name=sor-Type,
   {redis-connection-details|oracle-connection-details}##[TMP#][models]
Parameters
n
Represents the SOR number. Valid values are 1 through 9.
sor-name
The name of the SOR. No spaces are allowed. In the context of using Redis, the SOR name is used to retrieve the Redis master from Redis.
sor-type
This is the type of data store. Valid values are:
redis Regular connection to a Redis data store
redis_TLS TLS -enabled connection to a Redis data store
coherence Oracle Coherence connection to an Oracle data store
redis-connection-details
One or more host and port name pairs used for Redis connections as follows:
host-name:port-name[,host-name:port-name[...]]
host-name The machine name or IP address of the host system where data stores are location
port-name The port used to make the connection to the host specified by the corresponding host-name
oracle-connection-details
[userid@][path-name|URL][config-file]
   [,java-property[[=java-property-value]][…]]##[TMP#]
   [={TS=ts-model[:ts-model]|TD=td-model[:td-model]}]
   [[#{TS=ts-model[:ts-model]|TD=td-model[:td-model]}]][...]]
userid@ The user ID to use when Oracle Coherence security is enabled.
path-name The path to the configuration file represented by config-file. If omitted, defaults to the current working directory.
URL A URL that contains the configuration content.
config-file The name of the cache configuration file. If omitted, defaults to mfes-cache-config.xml.
java-property The name of a Java property to set to the specified java-property-value, or is clear if java-property-value is unspecified.
java-property-value The value of the property specified by java-property.
# Delimiter character.
TMP Indicates that this PSOR stores active resources.
TS Indicates temporary storage resource type.
TD Indicates transient data resource type.
ts-model An identifier for the corresponding TS consisting of either a character string no more than four bytes in length.1
td-model An identifier for the corresponding TD consisting of a character string no more than 16 bytes in length.1
1 You may use the * wildcard character to represent any string, and the + character to represent any single character. Identifiers of a size smaller than the byte limit are automatically padded using + characters to extend the length to the limit.
Default
None. You must set ES_SCALE_OUT_REPOS_n for all enterprise server regions that are part of a PAC.
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.
Examples
See PAC and SOR Environment Variables.

ES_SOR_RETRIES

Sets the number of attempts to access records in the PSOR before stopping.
Syntax
ES_SOR_RETRIES=integer
Parameter
integer
An integer value ranging from 1 through 1000 that represents the number of attempts to access records in the PSOR before stopping.
Default
ES_SOR_RETRIES=10
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_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_USR_DFLT_JCL

Enables you to override the default user when no user is logged on for JCL authentication.
Syntax
ES_USR_DFLT_JCL=userid
Parameter
userid
The default user name.
Default
ES_USR_DFLT_JCL=JESUSER
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_USR_DFLT_JES

Allows you to override the default user when no user is logged on for JES authentication.
Syntax
ES_USR_DFLT_JES=userid
Parameter
userid
The default user name.
Default
ES_USR_DFLT_JES=JESUSER
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_WORKING_MODE

The bitism of the server, 32- or 64-bit.
Syntax
ES_WORKING_MODE={32|64}
Parameters
32
Indicates that the server runs in 32-bit mode.
64
Indicates that the server runs in 64-bit mode.
Default
ES_WORKING_MODE=64
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_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

MFSYSCAT

The location and file name of the JES system catalog.
Syntax
MFSYSCAT={path-name\CATALOG.DAT|URL}
Parameters
path-name
The full path to the location of the CATALOG.DAT file.
URL
For a database-hosted system catalog, the full SQL URL that points to the CATALOG.DAT file.
Default
Not set. Uses the location specified in the JES > Configuration > System Catalog field in ESCWA.
Comments
See the data category in The dbfhdeploy Command Line Utility for full notation details if specifying a database-hosted system catalog.
Examples
MFSYSCAT=C:\MY\CATALOG\FOLDER\CATALOG.DAT
MFSYSCAT=sql://localhost/JCLTEST/catalog.dat?folder=/JCLDEMO

MFUSERCAT_BASE_LOC

If an entry in MFUSERCAT_LOC only specifies the file name of the user catalog rather than the full path and file name, use this environment variable to specify where these catalogs are located.
Syntax
MFUSERCAT_BASE_LOC=path-name
Parameter
path-name
The full path to the location of the file specified by the MFUSERCAT_LOC environment variable.
Default
Not set. If the path is not specified in MFUSERCAT_LOC, the current working directory is used.
Comments
If multiple user catalog files are in the same location - for example, C:\USERCATALOGS or $$MYFILESHARE - use this environment variable to store that location. Then, you only need to specify the file name of the catalog in MFUSERCAT_LOC.

Valid only when the value of MFUSERCAT_LOC is a file name only.

MFUSERCAT_LOC

Specifies the location and name of each additional catalog, matching the values provided in the MFUSERCAT_NODE value.
Syntax
MFUSERCAT_LOC={[path-name\]file-name}[;{[path-name\]file-name}[...]]
Parameters
path-name
The full path to a catalog file.
file-name
The name of the catalog file.
Default
Not set. No file names or locations are provided for additional catalogs specified by MFUSERCAT_NODE.
Comments
Parameter values are limited to a total of 4096 characters.

If multiple catalog files are in the same location, you can use the environment variable MFUSERCAT_LOC to store that location. If you do this, you only need to specify the file name of each catalog file in MFUSERCAT_LOC.

MFUSERCAT_NODE

Specifies additional SMS, SPOOL, and User catalogs.
Syntax
MFUSERCAT_NODE=node-name[,node-name[...]]
Parameter
node-name
A user catalog or special node name, including optional wildcards * for any number of characters and ? for a single character.
Default
Not set.
Comments
Use this variable to specify additional SMS, SPOOL and User catalogs. Up to 64 additional catalogs may be specified with semi-colon separated values (see Support for Multiple Catalogs for more details). The physical file used for each catalog is stored in the environment variable MFUSERCAT_LOC.

The parameter specification is limited to 4096 characters.

In the parameter specification, you may optionally use the UNIX-style square bracket notation (part of the regular expression feature), to specify a list of permissible characters at a particular point within the node specification; see Examples of Using Multiple Catalogs for more information.

To enable support for the SMS entities DATACLAS and MGMTCLAS, this variable needs to be set in addition to setting MF_SMS=ON.

Each node-name entry in MFUSERCAT_NODE must have a corresponding entry in MFUSERCAT_LOC.

Use the ES_OPEN_CAT_ON_DEMAND variable to determine if these catalogs are opened when the region starts, or only opened when they are required.