KeyAssociation (key association)

Purpose

Associates a resource definition with a change package.

To restrict a user's authority to add or remove resource definitions in a change package, you need to define security rules for Add or Remove commands. For details, see Example security scenario.

See the related object CmdAssociation (command association).

Object criteria

<KeyA>
  <CPID> change_package_ID </CPID>
  <CConfig> CICS_configuration </CConfig>  1 
  <CICSGroup> resource_group </CICSGroup>
  <CICSObjType> resource_type </CICSObjType>
  <CICSObjName> resource_name </CICSObjName>
</KeyA>
 1 
<CConfig>, <CICSGroup>, <CICSObjType>, and <CICSObjName> specify the selection key of the resource definition (not its original or previous keys; for details, see the object data descriptions).

Object data

Input data List default output Elements
Yes Yes
<CPID> change_package_ID </CPID>  1 
Yes Yes
<CConfig> CICS_configuration </CConfig>  2 
Yes Yes
<CICSGroup> resource_group </CICSGroup>
Yes Yes
<CICSObjType> resource_type </CICSObjType>
Yes Yes
<CICSObjName> resource_name </CICSObjName>
  Yes
<Ver> object_version </Ver>
  Yes
<ChangeTime> time_stamp </ChangeTime>
  Yes
<UserID> user_ID </UserID>
   
<O_CConfig> CICS_configuration </O_CConfig>  3 
   
<O_CICSGroup> resource_group </O_CICSGroup>
   
<O_CICSObjType> resource_type </O_CICSObjType>
   
<O_CICSObjName> resource_name </O_CICSObjName>
   
<P_CConfig> CICS_configuration </P_CConfig>  4 
   
<P_CICSGroup> resource_group </P_CICSGroup>
   
<P_CICSObjType> resource_type </P_CICSObjType>
   
<P_CICSObjName> resource_name </P_CICSObjName>
   
<CRC> checksum </CRC>
   
<CreMethod> D | P </CreMethod>  5 
 1 
change_package_ID identifies a change package to which the resource definition belongs.
 2 
The contents of <CConfig>, <CICSGroup>, <CICSObjType>, and <CICSObjName> collectively form the selection key. The Ready and Migrate commands use the selection key to locate the candidate resource definition. The original key and previous key (described in notes  3  and  4 ) contain historical selection keys.
 3 
Elements with the prefix "O_" contain the original key. This is the selection key of the resource definition when it was first added to the change package.
 4 
Elements with the prefix "P_" contain the previous key. This is the selection key of the resource definition before its previous migration.
 5 
<CreMethod> identifies how this key association was created:
D
Defined. This key association was created by an Add command, when a user added the resource definition to the change package.
P
Propagated. This key association was created by a Migrate command. When the Migrate command copies a resource definition from a source to a target CICS® configuration, it creates a new key association. The selection key of the new key association consists of the key field values of the migrated resource definition (in the target CICS configuration, after the Migrate command has applied transformation rules).

Usage

The combination of CICS configuration, group, type, and name constitutes a key that uniquely identifies a resource definition. Each key association contains three sets of keys: selection, original, and previous. The following table describes a sequence of Add and Migrate commands, illustrating the relationships between these keys.

Table 1. Key association: examples of selection key, original key, previous key, and creation method
Command Key association created by the command
CICS configuration, group, type, name Creation method
Selection key Original key Previous key
1. Add (user adds a resource definition to the change package)

CICSD
PAY
TRANDEF
PAY1

CICSD
PAY
TRANDEF
PAY1

  Defined
2. Migrate the change package from CICSD to CICST

CICST
PAY
TRANDEF
PAY1

CICSD
PAY
TRANDEF
PAY1

CICSD
PAY
TRANDEF
PAY1

Propagated
3. Migrate the change package from CICST to CICSP

CICSP
PAY
TRANDEF
PAY1

CICSD
PAY
TRANDEF
PAY1

CICST
PAY
TRANDEF
PAY1

Propagated

Reference Reference

Feedback


Timestamp icon Last updated: Friday, 1 November 2013


http://pic.dhe.ibm.com/infocenter/cicsts/v5r1/topic//ccv-api-obj-ccv-keyassociation.htm