You can use CICSPlex® SM to install CICS® Definition objects in CICS systems that support
the EXEC CICS CREATE command. CICS resources that are represented by CICS
Definitions can be installed in the following ways:
- Individually, using the INSTALL action for a CICS Definition object (such
as CONNDEF).
- As part of a resource group, using the INSTALL action for the RESGROUP
object.
- As part of a resource description, using the INSTALL action for the RESDESC
object.
The syntax of the INSTALL action, which is shown with each
of the resource tables that support it, is essentially the same for each method
of installation. Some or all of the following parameters can be used:
- ASSIGNMENT
- (Optional) When installing a resource group, specify the name of a resource
assignment (RASGNDEF) to be used for the install.
- CRITERIA
- (Optional) When installing a resource group, identify attributes that
are to be used in selecting the resources to be installed. CICSPlex SM processes
only those resources that meet the specified filter criteria.
A filter
expression can be made up of one or more attribute expressions in the form:

Filter Expression
>>-| logic_expr |-- .------------------------------------------><
logic_expr:
.-AND/OR----------------------------.
V |
|----+-----+--+-| attr_expr |--------+-+------------------------|
'-NOT-' '-(--| logic_expr |--)-'
attr_expr:
|--attr--oper--value--------------------------------------------|
where:
- attr
- Is the name of an attribute in the resource table.
You can name the same
attribute more than once in a filter expression.
Note:
You cannot
specify the EYU_CICSNAME or EYU_CICSREL attributes in a filter expression.
- oper
- Is one of the following comparison operators:
- <
- Less than
- <=
- Less than or equal to
- =
- Equal to
- >=
- Greater than or equal to
- >
- Greater than
- ¬=
- Not equal to
- value
- Is the value for which the attribute is being tested. The value must
be a valid one for the resource table attribute.
If the attribute accepts character
data, this value can be a generic. Generic values can contain:
- An asterisk (*), to represent any number of characters, including
zero. The asterisk must be the last or only character in the specified value.
For example:
TRANID=PAY*
- A plus sign (+), to represent a single character. A + can appear in one
or more positions in the specified value. For example:
TRANID=PAY++96
If the value contains imbedded blanks or special characters
(such as periods, commas, or equal signs), the entire value string must be
enclosed in single quotes. For example:
TERMID=‘Z AB’
To include a single quote or apostrophe in a value, you must
repeat the character, like this:
DESCRIPTION=‘October’’s Payroll’
- AND/OR
- Combines attribute expressions into compound logic expressions using
the logical operators AND and OR, like this:
attr_expr AND attr_expr.
Filter expressions are evaluated from left to right. You can use
parentheses to vary the meaning of a filter expression. For example, this
expression:
attr_expr AND (attr_expr OR attr_expr).
has
a different meaning than this one:
(attr_expr AND attr_expr) OR attr_expr.
- NOT
- Negates one or more attribute expressions.
You can negate a single
attribute expression, like this:
NOT attr_expr
You
can also negate multiple attribute expressions or even a whole filter expression,
like this:
NOT (attr_expr OR attr_expr).
Note that you
must place parentheses around the attribute expressions (or the filter expression)
to be negated.
- FORCEINS
- (Optional) Specify YES or NO to indicate whether you want to install
the resource even if CICSPlex SM believes it does not need to be installed.
YES is the default.
Normally, CICSPlex SM checks to see if it was
responsible for placing the currently installed resource in the CICS system.
If so, CICSPlex SM does not install the new resource, to avoid inadvertently
changing attributes of an active resource.
If you specify YES, CICSPlex SM bypasses
this duplicate resource checking and installs the new resource unconditionally.
- MODE
- (Optional.
When installing a RESGROUP with the assignment
parameter see Installing a RESGROUP when ASSIGNMENT is specified
.) For some resource types, CICSPlex SM requires
additional information to determine which subset of resource attributes to
use in completing the installation. The MODE value you should specify depends
on the resource type being installed:
- Program definitions (PROGDEF)
- If you specified a USAGE of LOCAL, you can specify AUTO to have CICS
automatically install programs into a system. AUTO means that no explicit
definition of the programs is required in the CICS system.
- Transaction definitions (TRANDEF)
- If you specified a USAGE of REMOTE, you must identify the type of remote
reference:
- DYNAM
- Transactions should be processed by the dynamic transaction routing
(DTR) program.
- STAT
- Each transaction should be sent to the remote CICS system identified in the
transaction definition (TRANDEF).
The value you specify here overrides the Dynamic value in the TRANDEF.
- Transient data queue definitions (TDQDEF)
- You can identify the type of transient data queue to be installed:
- INTRA
- Intrapartition TDQ.
- EXTRA
- Extrapartition TDQ.
- IND
- Indirect TDQ.
If you do not specify the MODE parameter, CICSPlex SM uses the Type value
in the TDQDEF to install the transient data queue. If the Type value is REMOTE, CICSPlex SM installs
an indirect TDQ.
- NOTIFY
- (Optional) Specify the type of checking that should be performed before
attempting to install a resource:
- NO
- No checking is performed.
- INACTIVE
- Check for CICS systems in the target scope that are not currently active.
- RELEASE
- Check for CICS systems in the target scope that do not support EXEC CICS CREATE
commands.
- FULL
- Perform both INACTIVE and RELEASE checking.
- OVERRIDE
- (Optional.
When installing a RESGROUP with the assignment
parameter see Installing a RESGROUP when ASSIGNMENT is specified
.) Identify attributes of the specified
resource whose values are to be modified when it is installed in one or more
of the specified scopes. (The OVERTYPE value determines which scope the override
values are applied to.)
An override expression can be made up of one or
more attribute expressions in the form:

Override Expression
.-,--------------.
V |
>>---attr--=--value-+-- .--------------------------------------><
where:
- attr
- Is the name of a modifiable attribute in the resource definition.
- value
- Is the value to which you want the attribute set. The following restrictions
apply:
- OVERTYPE
- (Optional. ) If you plan to specify an OVERRIDE expression for the installation,
indicate which scope the override values should be applied to:
- TARGET
- Apply the override values to the TARGET scope only.
- RELATED
- Apply the override values to the RELATED scope only.
- BOTH
- Apply the override values to both the TARGET and RELATED scopes.
- NONE
- Do not apply any override values.
- REFASSIGN
- (Required when installing a CONNDEF) Identify the resource assignment
(RASGNDEF) that applies to the related sessions definitions (SESSDEF). For
each connection definition, CICSPlex SM requires one or more sessions definitions
to properly construct the actual CICS connection.
- RELATED
(Required, if USAGE is REMOTE. Optional when installing a RESGROUP
with the assignment parameter. See Installing a RESGROUP when ASSIGNMENT is specified.) Specify the name
of an existing CICS system or CICS system group into which a resource identified as REMOTE
is to be installed as LOCAL.
- RESTYPE
- (Required when installing a RESGROUP) Specify the type of resource being
installed, as one of the following CICS Definition objects:
- CONNDEF
- DB2CDEF
- DB2EDEF
- DB2TDEF
- DOCDEF
- ENQMDEF
- FENODDEF
- FEPOODEF
- FEPRODEF
- FETRGDEF
|
- FILEDEF
- FSEGDEF
- JRNLDEF
- JRNMDEF
- LSRDEF
- MAPDEF
- PARTDEF
- PROCDEF
- PROFDEF
- PROGDEF
|
- PRTNDEF
- RQMDEF
- TCPDEF
- TDQDEF
- TERMDEF
- TRANDEF
- TRNCLDEF
- TSMDEF
- TSQDEF
- TYPTMDEF
|
Note that sessions definitions (SESSDEF) cannot be directly installed.
They are installed along with their associated connection definitions (CONNDEF)
- STATECHK
- (Optional) Specify YES or NO to indicate whether the existence and operational
state of the resource should be checked before an EXEC CICS CREATE command
is issued.
- TARGET
(Required except when installing a RESGROUP with the assignment
parameter. See Installing a RESGROUP when ASSIGNMENT is specified.) Specify the name of an existing CICS system or CICS system group into
which the resource is to be installed.
- USAGE
(Required except when installing a RESGROUP with the assignment
parameter. See Installing a RESGROUP when ASSIGNMENT is specified.) Specify how the resource will be used:
- LOCAL
- The resource is contained within the target CICS system. LOCAL is valid for
all supported resource types.
- REMOTE
- The resource definition refers to a resource installed in a different CICS system. If you
specify REMOTE, you must also specify a RELATED value to identify the CICS system that
actually contains a local instance of the resource. REMOTE is valid only for
the following resource types:
- FILEDEF
- PROGDEF
- TDQDEF
- TRANDEF
You can use CICSPlex SM to replace a resource description, using the REPLACE
action for the RESDESC object. CICSPlex SM attempts to replace all of the resources
associated with an installed resource description with the resources associated
with a new description. That is, CICSPlex SM:
- Discards any resources that are associated with the old resource description,
but not the new one.
- Reinstalls any resources that are associated with both the old resource
description and the new one, regardless of whether the definitions have changed.
- Installs any additional resources that are associated with the new resource
description.
For replacement to occur, the CICS systems named in the Target and
Related scope fields of both resource descriptions must be active and must
be running a release of CICS that supports the EXEC CICS CREATE command.
Some or all of the following parameters can be used:
- CURRENT
- (Required) Specify the specific or generic name of a currently installed
resource description that is to be replaced.
- FORCEINS
- (Optional) See page FORCEINS for a description of the
FORCEINS parameter.
- NOTIFY
- (Optional) See page NOTIFY for a description of the
NOTIFY parameter.
- STATECHK
- (Optional) See page STATECHK for a description of the
STATECHK parameter.
When the ASSIGNMENT parameter is used on the INSTALL action for the RESGROUP,
the following parameters can be used to override temporarily the values in
the RASGNDEF specified by the ASSIGNMENT parameter:
- TARGET
- RELATED
- USAGE
- MODE
- OVERRIDE
In this case the above parameters are optional. In all other cases including
the case where a RESGROUP is installed and the ASSIGNMENT parameter is NOT
specified, refer to the descriptions listed above for the correct usage.
[[ Contents Previous Page | Next Page Index ]]