ReadyLst (ready list)

Purpose

Contains the list of resource definitions and commands that are in a change package, optionally limited to the candidates for a particular migration scheme. Also identifies the ready status of each candidate.

Object criteria

<CPID> change_package_ID </CPID>
<Scheme> migration_scheme </Scheme>

Object data

<Sel_Command> A | R | D </Sel_Command>  1   2 
<Sel_CPID> change_package_ID </Sel_CPID> 
<Sel_CConfig> CICS_configuration </Sel_CConfig>
<Sel_Group> resource_group </Sel_Group>
<Sel_ObjType> resource_type </Sel_ObjType>
<Sel_ObjName> resource_name </Sel_ObjName>
<Sel_TContainer> resource_group </Sel_TContainer>  3 
<CSD> CSD_DSN </CSD>  4 
<Context> context </Context>
<CreMethod> D | P </CreMethod>  5 
<CC_Type> C | D | E </CC_Type>  6 
<Prev_CConfig> change_package_ID </Prev_CConfig>  7 
<Prev_Group> resource_group </Prev_Group>
<Prev_ObjType> resource_type </Prev_ObjType>
<Prev_ObjName> resource_name </Prev_ObjType>
<Prev_TContainer> resource_group </Prev_TContainer>
<ReturnCode> return_code </ReturnCode>
<ReasonCode> reason_code </ReasonCode>  6 
 1 
<Sel_Command> appears for packaged commands only (not for packaged resource definitions), and identifies the type of command: A (Add), R (Remove), or D (Delete).
 2 
Elements with the prefix "Sel_" contain the selection key of the resource definition. Elements with the prefix "Prev_" contain the previous key. These values are taken from either the key association object (for resource definitions; see KeyAssociation (key association)) or the command association object (for commands; see CmdAssociation (command association)).
 3 
Add and Remove commands only: refers to the target container (resource group) of the command.
 4 
If the resource definition is in a CSD file, then the <Context> element is empty; if the resource definition is in a context, then the <CSD> element is empty.
 5 
<CreMethod> identifies how the key association for this resource definition was created. For details, see KeyAssociation (key association).
 6 
<CC_Type> identifies the file type of the CICS® configuration where this resource definition is stored, or with which this command is associated: C (context), D (CSD file), or E (export file).
 7 
The reason code for each item identifies its ready status:
Table 1. Reason codes for items in a ready list
Return code Reason code (last 4 digits*) Status
0 0000 Ready
4 0018 Not ready: this item has been changed after the change package was marked as ready
4 004E Not ready: either this item was added to the change package after the change package was marked as ready; or the change package has never been marked as ready. (For example, a key association was found for the resource definition, but its checksum was zero.)
4 0058 Not found: the change package refers to a resource definition that no longer exists. (The resource definition was added to the change package, but then subsequently deleted.)

* The reason code is returned in the response as 8 hexadecimal digits. The first four digits identify the CICS Configuration Manager server module that performed the processing. The last four digits (shown above) identify the status of the item in the ready list. For a list of all reason codes, see Reason codes.

Usage

A ready list is different from most other repository objects because it does not directly represent an equivalent record type in the repository. Instead, the CICS Configuration Manager server generates ready list objects dynamically, when it receives a List command that requests a ready list.

List is the only command that you can use with a ready list. Here is the request format:

<CCV210>
  <List>
    <LocationCriteria>
      <LocationType> Repository </LocationType>
    </LocationCriteria>
 
    <ObjectCriteria>
      <ObjType> ReadyLst </ObjType>
      <Scheme> migration_scheme </Scheme>  1 
      <CPID> change_package_ID </CPID>
    </ObjectCriteria>
 
    <RestrictionCriteria>  2 
          <ListCount> element_count </ListCount>
          <ListElement>
            <RestrictionField>CCONFIG</RestrictionField>
            <RestrictionOperator>EQ</RestrictionOperator>
            <RestrictionValue> CICS_configuration </RestrictionOperator>
          </ListElement>
    </RestrictionCriteria>
 
  </List>
</CCV210>
 1 
<Scheme> is optional. If specified, the List command returns the candidate resource definitions and commands for that migration scheme: that is, the resource definitions in the change package that belong to the source CICS configurations of the migration scheme, and the commands that are associated with either the source or the target CICS configurations of the migration scheme. Otherwise, the List command returns all resource definitions in the change package, regardless of which CICS configurations they belong to.

In either case, you can further limit the resource definitions returned by the List command by specifying restriction criteria, described below.

 2 
<RestrictionCriteria> is optional. If specified, it limits the items returned by the List command to resource definitions that belong to, or commands that are associated with, the specified CICS configuration name (which can be a masked value, such as PROD*).

Each list element in the response represents a resource definition or a command in the change package specified in the request:

<CCV210>
  <List>
    <OutputData>
      <ReturnCode> return_code </ReturnCode>
      <ReasonCode> reason_code </ReasonCode>  1 
      <TaskNo> CICS_task_number </TaskNo>
 
      <ListCount> element_count </ListCount>
      <ListElement>
        <ObjectData>
 
          Object data for an item in the ready list
 
        </ObjectData>
      </ListElement>
 
      More list elements…
 
    </OutputData>
  </List>
</CCV210>
 1 
The last four digits of this reason code report the overall status of the ready list:
003F
Nothing found that matches the request.
0042
The change package is not ready for the specified migration scheme. Review the reason codes for the individual items to identify which items are not ready.
004F
Ready list has errors.
0055
The specified migration scheme has been changed after the change package was marked as ready.
0059
Missing package-scheme: the change package has not yet been used with the specified migration scheme.