Using CMCI to update a resource definition

Update a BAS or CSD resource definition using the CICS Management Client Interface (CMCI).

Before you begin

You must have a connection with the CMCI. For more information, see Setting up access for CICS Explorer.

About this task

Use a PUT request to update a resource definition. For the request, specify the URI and an XML body containing the parameters and attributes for the resource, as instructed in the Procedure below.

For information about PUT requests, see CMCI PUT requests.

Procedure

  1. Specify the URI for the request, following the instructions in CMCI PUT request URI.
    Note:
    • If you are updating a BAS resource, the SCOPE parameter, if specified in the URI, is ignored.
    • If you are updating a CSD resource, you must specify the SCOPE and PARAMETER=CSDGROUP(value) in the URI.

      The SCOPE must be the CICS system in which you are updating the resource. The CSDGROUP parameter is passed to instruct CICSPlex SM to search in the CSD groups in the specified system.

  2. Add an XML body containing the parameters and attributes for the resource.
    The XML body comprises an <update> element inside a <request> element. Specify new attribute values in the <update> element.

    For information about CMCI XML elements, see CMCI XML.

    Note:
    • If you are updating a BAS resource, you must include a defver attribute in the XML body.
    • If you are updating a CSD resource, do not include a defver attribute.

Example

The following example shows how to update a BAS transaction definition. In this example, the value of the program name for transaction definition TRN1 is updated to PRGM2.
PUT http://exampledomain.com:12345/CICSSystemManagement/
    CICSDefinitionTransaction/<CONTEXT>/
    ?CRITERIA=NAME%3TRN1

<request>
   <update>
      <attributes program="PRGM2"/>
   </update>
</request>
The following example shows an update request for a CSD transaction definition. In this example, a PUT request is issued to update the transaction named TRN1, in CSD group GRP1 in a CICS system named MYREGION. The program name of transaction TRN1 is updated to PRGM2. Note that SCOPE specifies MYREGION and that PARAMETER=CSDGROUP(GRP1) is specified in the URI. Note also that the defver attribute is excluded in the XML body.
PUT http://exampledomain.com:12345/CICSSystemManagement/
    CICSDefinitionTransaction/<CONTEXT>/MYREGION/
    ?CRITERIA=NAME%3DTRN1&PARAMETER=CSDGROUP%28GRP1%29 

<request>
   <update>
      <attributes program="PRGM2"/>
   </update>
</request>
Both the examples, updating a resource definition and updating a CSD resource definition, return a similar output when they complete successfully. A successful update returns a CICSPlex SM API response message that contains api_response1="1024" and api_response1_alt="OK" as shown:
<response xmlns:...>
   <resultsummary api_response1="1024" api_response1_alt="OK".. />
   <records>
         ...
   </records>
</response>