IBM Support

PH49243: ENABLE THE UPDATE API COMMAND TO UPDATE A CHANGE PACKAGE'S LAST COMMAND ATTRIBUTES.

A fix is available

Subscribe

You can track all active APARs for this component.

 

APAR status

  • Closed as new function.

Error description

  • MIGRATE, INSTALL, NEWCOPY and other change package functions
    automatically update the set of last-command attributes saved on
    the change package record.  This includes the last processed API
    command, Scheme, date/time, return code and userID.
    
    The enhancement enables the UPDATE API command to update this
    set of previously restricted change package attributes.
    
    This may be useful where a change package is processed by
    multiple CICS CM Servers running on different LPARs.
    You may wish to reflect the processing performed by one
    CICS CM Server into the change package record on another Server.
    

Local fix

Problem summary

  • ****************************************************************
    * USERS AFFECTED: All users of CICS Configuration Manager.     *
    ****************************************************************
    * PROBLEM DESCRIPTION: Enable the UPDATE API command to update *
    *                      a change package's last command         *
    *                      attributes.                             *
    ****************************************************************
    MIGRATE, INSTALL, NEWCOPY and other change package functions
    automatically update the set of last-command attributes saved on
    the change package record.  This includes the last processed API
    command, Scheme, date/time, return code and userID.
    
    The enhancement enables the UPDATE API command to update this
    set of previously restricted change package attributes.
    
    This may be useful where a change package is processed by
    multiple CICS CM Servers running on different LPARs.  You may
    wish to reflect the processing performed by one CICS CM Server
    into the change package record on another Server.
    

Problem conclusion

  • CICS Configuration Manager is enhanced.  The UPDATE API now
    enables updating of the last-command (LC_xxxxx) change package
    fields. Other minor changes are included to assist the updating
    process and improve the consistency of the displayed information
    by the ISPF panels.
    
    SCCVSAMP sample CCVXXML3 is introduced to illustrate the UPDATE
    API XML elements, and describe how the CCVXXMLJ sample batch job
    can be used to perform the update.  The change package
    last-command XML elements are:
    
       LC_APICMD  the API command, e.g. MIGRATE, INSTALL, etc
       LC_SCHEME  the Migration Scheme processed
       LC_DATIME  the date/time in the format YYYY/MM/DD HH:MM:SS.hh
       LC_USERID  the user ID
       LC_EVID    the journal event ID as 16 hex characters
       LC_RC      the API command's return code, e.g. 00000004
       LC_RSN     the API command's reason code, e.g. 00000000
    
    The following processing rules apply when the UPDATE API request
    for the change package record includes the last-command fields.
    These rules also appear within SCCVSAMP sample CCVXXML3.
    
       1.  The service performing the UPDATE API request is
           responsible for ensuring the validity of the supplied
           data values.
    
           Invalid values can result in the UPDATE API failing with
           XML response RC=08 RSN=0014 (Value is invalid in
           context).  The INFO2 XML element value (returned in hex
           format) may hint as to the XML element value or XML
           element name in error.
    
       2.  All seven of the last-command fields are required,
           otherwise the last-command input XML elements are ignored
           for processing.
    
       3.  If the provided LC_DATIME (date/time) is less than that
           currently recorded on the change package record, then
    
           3.1  No error occurs.
           3.2  The update to the change package last-command fields
                is ignored, and the more recent, existing value
                retained.
           3.3  History information (see 6 below) updating occurs.
    
       4.  The Scheme referenced by LC_SCHEME does not need to exist
           locally - its existence is not validated.  If the remote
           LPAR's Scheme name conflicts with a Scheme on the local
           system, consider using a Scheme name pseudonym to
           distinguish the remote LPAR's Scheme name.
    
       5.  The UPDATE API request for the last-command fields also
           populates the history information saved on the
           package-scheme record, and used in the ISPF online
           dialog, change package history display.
    
       6.  The ISPF change package history will show 'No history
           data' when displaying the resources for the journal event
           ID, if the associated journal records do not exist.  This
           is to be expected when the reported API command was
           performed on a remote LPAR, or if the value
           <LC_EVID>FFFFFFFFFFFFFFFF is set because the event ID is
           unknown.
    
       7.  Running multiple UPDATE API requests with identical
           last-command values can result in duplicated entries in
           the package-scheme history block.
    
       8.  The LC_APICMD (API command) must be one of the change
           package API commands listed below, entered in uppercase
           characters:
    
              APPROVE   BACKOUT   DISAPPROVE   DISCARD   IMPORT
              INSTALL   MIGRATE   NEWCOPY      READY     UNREADY
    
           Example: <LC_APICMD>INSTALL</LC_APICMD>
    
       9.  The LC_SCHEME (Migration Scheme) is 1 to 8 characters,
           entered in uppercase characters.  Item 4 above provides
           other considerations for the Scheme name.
    
           Example: <LC_SCHEME>SCHEMEP1</LC_SCHEME>
    
       10. The LC_DATIME (date/time)
           is in the format YYYY/MM/DD HH:MM:SS.hh.
           You can use zeros for unknown HH:MM:SS.hh values.
    
           Example: <LC_DATIME>2022/03/01 13:30:00.00</LC_DATIME>
                    This is 01 March 2022, 1:30 pm.
    
    
       11. The LC_USERID (user ID) is 1 to 8 characters, entered in
           uppercase characters.
    
           Example: <LC_USERID>USER01</LC_USERID>
    
       12. The LC_EVID (journal event ID) is 16 hex characters,
           entered in uppercase characters.  CICS CM assigns all
           journal file (CCVJNL) records updated by an API command
           request a unique event ID, to enable grouping of the
           records.
    
           If the event ID is unknown, use 16 F characters thereby
           setting the event ID as hex high-values.
    
              Note:  DO NOT use 16 zeros (hex low-values).
                     All zeros is invalid and will result in errors
                     as per item 1 above.
    
           Example: <LC_EVID>FFFFFFFFFFFFFFFF</LC_EVID>
                    <LC_EVID>DBA1006F36FFFB68</LC_EVID>
    
       13. The LC_RC (return code) should be entered as an 8 digit
           decimal numeric value, as it normally appears in the
           response XML element <RETURNCODE> for API command
           requests.
    
           Example:  <LC_RC>00000000</LC_RC>   is RC=00
                     <LC_RC>00000008</LC_RC>   is RC=08
    
       14. The LC_RSN (reason code) should be entered as an 8
           character printable hex representation of the
           reason code, as it normally appears in the response XML
           element <REASONCODE> for API command requests.
    
           The reason code includes a module-ID in the first four
           characters, which if unknown can be set to '0000'.  For
           example:
    
                            .------- 0000 module: no module-id
                            |   .--- 0000 reason: no reason
                            |   |
          Example:  <LC_RSN>00000000</LC_RSN>
                    <LC_RSN>0028006E</LC_RSN>
                            |   |
                            |   '--- 006E reason: some newcopied
                            '------- 0028 module: CCVANCPY (NEWCOPY)
    

Temporary fix

Comments

APAR Information

  • APAR number

    PH49243

  • Reported component name

    CICS CONFIG MGR

  • Reported component ID

    5697CIC00

  • Reported release

    540

  • Status

    CLOSED PER

  • PE

    NoPE

  • HIPER

    NoHIPER

  • Special Attention

    YesSpecatt / New Function / Xsystem

  • Submitted date

    2022-09-02

  • Closed date

    2022-11-01

  • Last modified date

    2022-12-01

  • APAR is sysrouted FROM one or more of the following:

  • APAR is sysrouted TO one or more of the following:

    UI83073 UI83074 UI83075

Modules/Macros

  • CCV$$$$$ CCVABACK CCVAUPD  CCVBCCVE CCVBMAIN CCVE52   CCVHCODE
    CCVI10   CCVOCCVA CCVOCCVE CCVOPKBE CCVSMSGE CCVSMSGK CCVXXCCV
    CCVXXML3 CCVXXMLJ
    

Fix information

  • Fixed component name

    CICS CONFIG MGR

  • Fixed component ID

    5697CIC00

Applicable component levels

  • R540 PSY UI83073

       UP22/11/09 P F211  

  • R54E PSY UI83074

       UP22/11/09 P F211  

  • R54K PSY UI83075

       UP22/11/09 P F211  

Fix is available

  • Select the PTF appropriate for your component level. You will be required to sign in. Distribution on physical media is not available in all countries.

[{"Business Unit":{"code":"BU058","label":"IBM Infrastructure w\/TPS"},"Product":{"code":"SS2L7A","label":"CICS Configuration Manager for z\/OS"},"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"5.4","Line of Business":{"code":"LOB35","label":"Mainframe SW"}}]

Document Information

Modified date:
01 December 2022