Discard

Request format

Change package:

<CCV540>
  <Discard>
     <SelectionCriteria>
        <CPID> change_package_ID </CPID>
        <Scheme> migration_scheme </Scheme>
     </SelectionCriteria>
     <ProcessParms>                                          
        <Quiesce> No | Yes </Quiesce> 1                     
        <QualificationData> exit-data </QualificationData> 2
        <NoConnection> Ignore </NoConnection> 3             
        <DeleteDiscard> No | Yes </DeleteDiscard> 4         
        <ExitDate> exit-date </ExitDate> 5                  
        <ExitText> exit-text </ExitText> 6                  
        <CPSMParms>                                         
           <TargetScope> target_scope </TargetScope> 7                                    
        </CPSMParms> 8                                      
     </ProcessParms>
  </Discard>
</CCV540> 

1

<Quiesce> specifies whether or not to set the resource to a status that allows its definition to be discarded (for example, disabled, closed, or out of service), prior to attempting the action. The status depends on the resource type. If you do not specify this quiesce option, and a resource is in a status that does not allow the discard action, then the discard action for that resource definition will fail.

2

<QualificationData> is optional data passed through the Discard operations qualification exit point. The needs of your organization determine whether you use an exit program and what processing it performs.

3

<Noconnection> Ignore specifies that the Discard request should ignore processing for CICS regions whose remote connections are either undefined or unavailable for service. For example, inactive CICS regions will have their remote connections unavailable.

• Setting the parameter ignores processing for unavailable region connections. No errors or audit logging occurs for the unavailable connections.
• Omission of the parameter will process the unavailable region connections, resulting in error messages and audit logging occurs for failed resources for the unavailable connections.

4

<DeleteDiscard> specifies whether change package resources marked for deletion within scheme target CICS Configurations should be included for discard processing. The option applies only to CSD based CICS Configurations. For CICSPlex SM context based CICS Configurations, the option is ignored.

5

The EXITDATE parameter is used to collect optional input data for change package pre and post processing exit programs. The data collected is used for site based exit program customizations, and the parameter may not be in use at your site. If entered, EXITDATE is a date and time in the format "YYYY/MM/DD.HH:MM".

6

The EXITTEXT parameter is used to collect optional input data for change package pre and post processing exit programs. The data collected is used for site based exit program customizations, and the parameter may not be in use at your site. If entered, the EXITTEXT format is up to 50 characters of free form textual data.

7

If the change package contains candidates for migration to context-based target CICS configurations, target_scope is required.

8

No <CSDParms> element applies for change packages.

Ad hoc:

<CCV540>
  <Discard>
    <LocationCriteria>
      <LocationName> CICS_configuration </LocationName> 1
      <LocationType> CConfig </LocationType> 2
    </LocationCriteria>
 
    <ObjectCriteria>  3
      <ListCount> element_count </ListCount>
      <ListElement>
        <ObjectData>
          <ObjName> resource_name </ObjName>
          <ObjGroup> resource_group </ObjGroup>
          <ObjType> resource_type </ObjType>
        </ObjectData>
      </ListElement>
 
      More list elements…
 
    </ObjectCriteria>
 
    <ProcessParms>
      <Quiesce> No | Yes </Quiesce> 4
      <QualificationData> exit-data
        </QualificationData> 5
      <CSDParms>
        <ConnectionCount> All | element_count | Local </ConnectionCount> 6
        <ConnectionElement>
          <ConnectionName> remote_system_connection </ConnectionName>
        </ConnectionElement>
 
        More connection elements…
 
      </CSDParms>
      
      <CPSMParms>
        <TargetScope> target_scope
</TargetScope>7
      </CPSMParms>

    </ProcessParms>
  </Discard>
</CCV540>

1

<LocationName> must specify the name of a CSD-based CICS configuration.

2

<LocationType> must contain CConfig.

3

<ObjectCriteria> identifies the resource definitions that you want to discard.

You can specify the object criteria in several ways:

• To identify a single resource definition, specify only one set of <ObjName>, <ObjGroup>, and <ObjType>, with no masking (wildcards). Do not specify <ListCount> or <ListElement>.
• To identify one or more resource definitions, either:
  • Specify <ListCount> followed by one or more <ListElement>. Each <ListElement> must identify a single resource definition, with no masking.

    or

  • Specify only one set of <ObjName>, <ObjGroup>, and <ObjType> with masked values. Do not specify <ListCount> or <ListElement>. The values can be any combination of:
    • Mask or specific value for the resource name
    • Mask or specific value for the resource group
    • Specific resource type, or the value * or All to identify all resource types (you cannot use masking to identify a subset of resource types)

    For example, to identify all program resource definitions beginning with the characters PAY, from all groups beginning with the characters FIN, specify:

    <ObjectCriteria>
      <ObjName>PAY*</ObjName>
      <ObjGroup>FIN*</ObjGroup>
      <ObjType>PROGDEF</ObjType>
    </ObjectCriteria>

4

<Quiesce> specifies whether or not to set the resource to a status that allows its definition to be discarded (for example, disabled, closed, or out of service), prior to attempting the action. The status depends on the resource type. If you do not specify this quiesce option, and a resource is in a status that does not allow the discard action, then the discard action for that resource definition will fail.

5

<QualificationData> is optional data passed through the Discard operations qualification exit point. Whether you use an exit program and what processing it performs is up to you.

6

<ConnectionCount> specifies the CSD-based CICS regions on which to perform this action:

All

Performs the action via all of the remote system connections defined in the CICS configuration. If you omit <ConnectionCount> or its parent <CSDParms>, this is the default.

element_count

Performs the action via the remote system connections identified by one or more <ConnectionElement> elements. The number of <ConnectionElement> elements must match element_count. Each <ConnectionElement> must refer to a remote system connection specified in the CICS configuration.

Local

Performs the action on the CICS region that is running the CICS Configuration Manager server. If you specify local:

• <LocationName> must specify a CICS configuration that refers to the CSD file used by the CICS Configuration Manager server.
• Do not specify any connection elements (if you do, they are ignored).

7

If the change package contains candidates for migration to context-based target CICS configurations, target_scope is required.