Rename

Renames resource definitions, and optionally moves them to another group.

This command has two formats:

Request format

Renaming individual resource definitions:

<CCV210>
  <Rename>
    <LocationCriteria>
      <LocationName> location_name </LocationName>
      <LocationType> CConfig | Context | CSD </LocationType>
    </LocationCriteria>
    <ObjectCriteria>  1 
      <ListCount> element_count </ListCount>
      <ListElement>
        <ObjName> resource_name </ObjName>
        <ObjGroup> resource_group </ObjGroup>
        <ObjType> resource_type </ObjType>
      </ListElement>
 
      More list elements…
 
    </ObjectCriteria>
    <InputData>
      <TargetCount> element_count </TargetCount>
      <TargetElement>
        <TargetName> resource_name </TargetName>
        <TargetGroup> resource_group </TargetGroup>
      </TargetElement>
 
      More target elements…
 
    </InputData>
 
    <ProcessParms>
      <Replace> No | Yes </Replace>
    </ProcessParms>
 
  </Rename>
</CCV210>
 1 
<ObjectCriteria> identifies the resource definitions that you want to rename.
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>

Renaming from a group or ResGroup:

<CCV210>
  <Rename>
    <LocationCriteria>
      <LocationName> location_name </LocationName>
      <LocationType> CConfig | Context | CSD </LocationType>
    </LocationCriteria>
    <ObjectCriteria>
      <ObjName> resource_group </ObjName>
      <ObjType> ResGroup </ObjType>
    </ObjectCriteria>
    <InputData>
      <SourceName> object_name </SourceName>
      <SourceType> object_type </SourceType>
      <TargetGroup> resource_group </TargetGroup>
    </InputData>
 
    <ProcessParms>
      <Replace> No | Yes </Replace>
    </ProcessParms>
 
  </Rename>
</CCV210>

Response format

<CCV210>
  <Rename>
      <ReturnCode> return_code </ReturnCode>
      <ReasonCode> reason_code </ReasonCode>
      <TaskNo> CICS_task_number </TaskNo>
 
      <ListCount> element_count </ListCount>
      <ListElement>
        <ReturnCode> return_code </ReturnCode>
        <ReasonCode> reason_code </ReasonCode>
        <ObjName> resource_name </ObjName>
        <ObjGroup> resource_group </ObjGroup>
        <ObjType> resource_type </ObjType>
      </ListElement>
 
      More list elements…
 
    </OutputData>
  </Rename>
</CCV210>

Security key

API command (READ access authority):

Read syntax diagramSkip visual syntax diagram
>>-prefix.REN.object_type.location_type.location_name----------><

Resource definitions:

For the source resource definition (ALTER access authority):

Read syntax diagramSkip visual syntax diagram
>>-prefix.target_CICS_config.source_group.type.source_name-----><

For the target resource definition (ALTER access authority):

Read syntax diagramSkip visual syntax diagram
>>-prefix.target_CICS_config.target_group.type.target_name-----><

A Rename API command for a group/ResGroup involves resource definition security checks (requiring ALTER access authority) for all of the following:
  • Each source resource definition (in the original group/ResGroup)
  • Each target resource definition (in the renamed group/ResGroup)
  • When renaming a ResGroup (not a group): the target ResGroup