PI32987: IPR UNLOAD UTILITY RETURN CODE CHANGED FROM RC04 TO RC00 FOR ERROR DURING ITKB OUTPUT REPOSITORY PROCESSING

Obtain the fix for this APAR.

APAR status

• Closed as new function.

Error description

• The return code of the IPR Unload utility will be changed from
  RC04 to RC00 for an error during IMS Tools KB Output Repository
  processing.
  

Local fix

Problem summary

• ****************************************************************
  * USERS AFFECTED: All users of IMS Database Reorganization     *
  *                 Expert for z/OS Version 4 Release 1          *
  *                 (FMID=H25N410)                               *
  ****************************************************************
  * PROBLEM DESCRIPTION: This APAR enables the IPR Unload        *
  *                      utility to issue the return code 0      *
  *                      even if IMS Tools KB Output Repository  *
  *                      processing fails.                       *
  ****************************************************************
  * RECOMMENDATION: Apply the maintenance for this APAR.         *
  ****************************************************************
  This APAR enables the IPR Unload utility to issue the return
  code 0 even if IMS Tools KB Output Repository processing fails.
  
  APAR PI32988 for IMS High Performance Unload for z/OS Version 1
  Release 2 (FMID=H1IN120) is also required.
  
  ==========
  =  NOTE  =
  ==========
  After applying APAR PI32988, the return code that indicates
  an IMS Tools Knowledge Base Output repository processing
  failure is changed from 4 to 0. This change was implemented to
  unify the behavior of the products across IMS Database Solution
  Pack.
  If you want return code 4,specify the ERRC04 keyword for
  the ITKBSRVR control statement.
     ITKBSRVR=xxxxxxxx,ERRC04
  

Problem conclusion

Temporary fix

Comments

• ========================
  = DOCUMENTATION CHANGE =
  ========================
  The IBM IMS Database Reorganization Expert for z/OS User's Guide
  Version 4 Release 1 Suffix 3 (SC19-1137-03)
  
  ----------------------------------------------------------------
  > Unloading a database
  >> IPR Unload JCL statements
  >>> Control statements for IPR Unload
  >>>> Control statements for the unload function
  >>>>> ITKBSRVR control statement
  
      __________________________________________________________
     |                                                          |
     |                 _*NO____________________                 |
     | >>__ITKBSRVR=__|_server_name____________|_____________>< |
   | |                              |_,ERRC04_|                 |
     |__________________________________________________________|
  
     *NO
        IPR Unload utility does not store reports in the IMS Tool
        KB Output repository.
     serverName
        IPR Unload utility stores reports in the IMS Tools KB
        Output repository of the specified server.
  
  
  |  ERRC04
  |     IPR Unload utility returns return code 4
  |     when it encounters IMS Tools KB errors.  If ERRC04 is not
  |     specified and an error is encountered in IMS Tools KB
  |     Output repository processing, the return code is 0.
  :
  ----------------------------------------------------------------
  >Reference
  >> Setting installation default options
  >>> How to code HPSCOPT macro statements
  
     ___________________________________________________________
    |                                                           |
    | UNLOAD                                                    |
    |                                                           |
    |            .-,------------------------------------.       |
    |            V                                      |       |
    | |--UNLOAD---+-----------------------------------+-+-----| |
    |             :                                   :         |
    |             |                                   |         |
    |             +-ITKBLOAD=-+-libName-+-------------+         |
    |             |           .-*NO-----------------. |         |
    |             +-ITKBSRVR=-+-serverName----------+-+         |
   ||             |           '-(serverName,ERRC04)-' |         |
    |             +-JCLTYPE=DFS-----------------------+         |
    |             :                                   :         |
    |___________________________________________________________|
  --
  ----------------------------------------------------------------
  >Troubleshooting
  >> Messages and codes
  >>> Return codes
  >>>> IPR Unload utility return codes
  
   Table 1. Return codes of the IPR Unload utility
   - Return code 4, Reason code X'0080'
   - Meaning:
      One or more errors occurred in the IMS Tools KB Output
  |   Repository processing if ERRC04 is specified on the ITKBSRVR
  |   control statement.
  ----------------------------------------------------------------
  ================= End of Documentation Change ==================
  

APAR Information

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

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

  UI25201

Modules/Macros

•    HPSCOPT  HPSCOPTS HPSGOPTU
  

Fix information

• Fixed component name

  IMS DB REORG EX

• Fixed component ID

  5655F7400

Applicable component levels

• R410 PSY UI25201

     UP15/02/18 P F502

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.