Alter

Alters selected attribute values across one or more resource definitions, without affecting other attribute values.

Request format

<CCV510>
  <Alter>
    <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>
      <object_type>  2 
        <ObjectData>  3 
 
          <attribute_name>value</attribute_name> …
 
        </ObjectData>
      </object_type>
    </InputData>
 
  </Alter>
</CCV510>
 1 
<ObjectCriteria> identifies the resource definitions that you want to alter.
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>
 2 
<object_type> and its end tag are optional. Specifying this "wrapper" element allows you to use the supplied schema to validate the contents of the <ObjectData> element for that object type. For details, see Using the supplied schema to write API commands.
 3 
The child elements of <ObjectData> represent the resource definition attributes and their new values.

The names of the object data elements match the attribute names used by CICSPlex® SM. For details, see the XML schema CCVXXRES supplied in sample library SCCVSAMP. For example, to set the PROGRAM attribute of a TRANDEF resource definition to QAAFLTC, you specify <Program>QAAFLTC</Program>. See Examples for an example using the Create API command. For a complete list of attributes for each object, see the resource table descriptions in CICS® Transaction Server for z/OS®: CICSPlex SM Resource Tables Reference. To set an attribute to its default value, specify an empty element, such as <attribute_name/>, or an element containing whitespace only.

Response format

<CCV510>
  <Alter>
    <OutputData>
      <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>
        <Config> CICS_configuration </Config>
        <LocationName> CSD_DSN | context </LocationName>
        <ChangeTime> time_stamp </ChangeTime>
        <IntegrityToken> integrity_token </IntegrityToken>
      </ListElement>
 
      More list elements…
 
    </OutputData>
  </Alter>
</CCV510>

Security key

API command (READ access authority):

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

Resource definitions (ALTER access authority):

Read syntax diagramSkip visual syntax diagram
>>-prefix.target_CICS_config.group.type.name-------------------><


Reference Reference

Feedback


Timestamp icon Last updated: Friday, 8 February 2013


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