IBM Support

PK16234: IPR UNLOAD SUPPORTS USERHDR= CONTROL STATEMENT

A fix is available

Subscribe

You can track all active APARs for this component.

 

APAR status

  • Closed as new function.

Error description

  • This APAR provides the new control statement USERHDR= to
    create a customized unload file.
    

Local fix

Problem summary

  • ****************************************************************
    * USERS AFFECTED: All users of IBM IMS High Performance        *
    *                 Unload for OS/390 Release 1 (FMID=H1IN110)   *
    *                 who are using IPR Unload Utility of IMS      *
    *                 Parallel Reorganization for z/OS             *
    *                 Version 2 Release 1 (FMID=H25N210) or        *
    *                 Version 3 Release 1 (FMID=H25N310).          *
    ****************************************************************
    * PROBLEM DESCRIPTION: This APAR enables IPR Unload utility    *
    *                      to support the *UH format and           *
    *                      the USERHDR control statement           *
    *                      which defines the header portion        *
    *                      of the *UH unload format records.       *
    ****************************************************************
    * RECOMMENDATION: Apply the maintenance for this APAR.         *
    ****************************************************************
    This APAR enables IPR Unload utility to support the *UH format
    and the USERHDR control statement. IPR Unload utility can
    produce the segment records with the user-defined header.
    The details of this new function are described
    in the documentation change.
    
    This APAR also includes the fix for the problem in IPR Unload
    utility:
    -If IMS Version 9 is used,  the value for "PACKING DENSITY OF
    ROOT ADDRESSABLE AREA" in the HDAM RAP CHAIN I/O SUMMARY report
    is incorrect.
    

Problem conclusion

Temporary fix

Comments

  • ========================
    = DOCUMENTATION CHANGE =
    ========================
    IMS Parallel Reorganization for z/OS Version 3 Release 1
    User's Guide (SC18922801) should be changed as follows:
    
    ================================================================
    Chapter 3. The IPR Unload Utility
    3.1 Program Functions    :
    3.1.4 Supporting Various Unload Data Set Format
    
     The IPR Unload utility unloads IMS (S)HISAM databases,
     HD databases (HDAM and HIDAM), and partitioned HD databases
     (PHDAM and PHIDAM) into one of the following eleven formats:
     - HD, SH, CS, F1, F2, F3, F6, A1, A2, A3, or A4
    |You can also use the user-defined header format UH.
    |For the details, see "USERHDR control statement".
     :
    
    ================================================================
    3.8 Control Statements
    3.8.1 Overview of control statements
     :
     The following control statements are provided to control
     the unload function:
      - CHECKREC
      - DBRECDIST
      - DBRECKEYS
      - DECODEDBD
      - DECOMPRESS
      - HOMECHK
      - OUTPUT
      - PARTITION
      - PROGMON
      - RAPCHECK
    | - USERHDR
      - SEGSEL
      - STATREP
     :
    ================================================================
    3.8.3 Control statements for unload function
    
    (The new control statement USERHDR is added to Table 12.)
    
    Table 12. Control statements for unload function
     ---------------------------------------------------------
    | Keyword: USERHDR
    | Acceptable Values: (elem1,...,elemN)
    | Default: (No default)
    | Description: Specifies the list of the elements
    | in the header portion of the *UH unload format record.
    ----------------------------------------------------------
    ================================================================
     3.8.3.6 OUTPUT control statement
    
                +-SYSUT2---+   +-*HD------+
     >>-OUTPUT=-+----------+-,-+----------+-+-------------+---><
                +-|ddname|-+   +-|format|-+ +-|,exitspec|-+
     :
     format:
      |-+-*SH-+-----------------------------------------------|
           :
        +-*A4-+
    |   +-*UH-+
        +-*NO-+
    
     format
      Specifies one of the following unloaded data formats:
      :
    | *UH
    |  The user-defined header format. You must specify
    |  the USERHDR control statement together to define
    |  the header format. For more details, see
    |  "USERHDR control statement".
      :
    
    ================================================================
    (This section to describe the new control statement is added.)
    |3.8.4.X USERHDR control statement
    |
    | The USERHDR control statement specifies the list of
    | the elements to be stored in the header portion of the *UH
    | unload format record. To use the *UH format, you must specify
    | *UH on one or more OUTPUT statements together.
    |
    |                ___ , ___
    |                V        |
    | >>--USERHDR=--(-elemant-+-)---------------><
    |
    | Specify a list of the elements to be stored in the header
    | portion of each unload record in the *UH format.
    | You can select the elements up to 22 from Table X below
    | in multiple statements as shown in Example 2.
    |
    |Table X. Description and Values of the Elements for USERHDR
    | (This table is omitted in this document. See Table 32
    | "Table 32. Description and values of the elements of USERHDR"
    | in place of this table.)
    | ----------------------------------------------------------
    |  Notes of Table X.
    |  1. For ROOTKEY, SEGCKEY and SEGKEY, if the sequence key
    |     is undefined or still compressed by using DECOMPRESS=NO,
    |     no value is set and its length is zero.
    |  2. For ROOTRBA and SEGRBA, binary zeros are filled
    |     for the HISAM segments.
    |  3. For SEGKEYOF and SEGKEYSZ, if the sequence key is
    |     undefined or still compressed by using DECOMPRESS=NO,
    |     binary zeros are filled.
    | ------------------------------------------------------------
    |
    |Note: The *UH format unload data set can be the input of
    | the IPR Reload utility unless the logical relationships
    | is defined in the database. For that purpose, you must keep
    | the following rules:
    |  - SEGNAME or SEGCODE must be included.
    |  - If you specify one or more elements with variable length
    |    such as SEGCKEY, SEGKEY, and ROOTKEY, HDRLEN must be
    |    included ahead of the variable length elements.
    |    SEGNAME or SEGCODE must also precede them.
    |
    |Example 1.
    | The following control statements are assumed:
    |   OUTPUT=SYSUT2,*UH
    |   USERHDR=(HDRLEN,SEGNAME,ROOTKEY)
    | The variable-length records illustrated below are put to
    | the SYSUT2 data set.
    |
    |        |<------ Header portion  ------->|
    | +------+------+------------+------------+---------------
    | | LLZZ |HDRLEN|  SEGNAME   |  ROOTKEY   |(Segment data)
    | +------+------+------------+------------+---------------
    | |  4   |  2   |    8       |  variable  |
    |   bytes  bytes    bytes
    |
    | The HDRLEN element contains the length of the header portion
    | and the value can be used for getting the length of the root
    | key and the starting position of the segment data.
    |
    |Example 2.
    | The following control statements are assumed:
    |  OUTPUT=SYSUT2,*UH
    |  USERHDR=(HDRLEN,DBDNAME,SEGNAME,SEGLEV1)
    |  USERHDR=(SEGKEYSZ,ROOTKEY,FILLER08)
    | The list of the elements is separated in two statements
    | and seven elements are stored in the header portion
    | of each unload record. The last 8 bytes in the header portion
    | is filled with binary zeros.
    |
    ================================================================
    10.0   Messages and Codes
    10.1   Return codes
    10.1.2 The IPR Unload return codes
    
     (The new reason code is added in the Table 49.)
     Table 49. Return codes of the IPR Unload utility
     ---------------------------------------------------------
    |Return code 4 / Reason code X'0020'
    | USERHDR was specified, but the *UH format was not specified
    | on any OUTPUT control statement.
     ---------------------------------------------------------
    ================================================================
    10.3   Messages
    10.3.2 HPSG Messages
    ----------------------------------------------------------------
    | HPSU3350W NO OUTPUT CONTROL STATEMENT SPECIFIES *UH FORMAT
    | Explanation: Even though USERHDR control statement was
    | specified, there is no OUTPUT control statement that
    | specifies the *UH format.
    | Syatem Action: The IPR Unload ignored the USERHDR control
    | statement and continued the processing.
    | Programmer Response: If you want to validate the specification
    | of the USERHDR control statement, specify the OUTPUT control
    | statement that specifies the *UH format.
    ----------------------------------------------------------------
    | HPSU3351E MORE THAN 22 ELEMENTS ARE SPECIFIED IN USERHDR
    | Explanation: More than 22 elements are specified on
    | the USERHDR control statements.
    | System Action: Processing stops.
    | Programmer Response: Reduce the number of elements
    | on the USERHDR control statements, and rerun the job.
    ----------------------------------------------------------------
    | HPSU3352E DUPLICATE ELEMENT (element) SPECIFIED IN USERHDR
    |           CONTROL STATEMENT
    | Explanation: The keyword element is specified more than once
    | on the USERHDR control statement. The element can be specified
    | only once.
    | System Action: Processing stops.
    | Programmer Response: Correct the parameter error, and rerun
    | the job.
    | Problem Determination: None.
    ----------------------------------------------------------------
    | HPSU3353E INCORRECT KEYWORD ON USERHDR STATEMENT WAS DETECTED
    | Explanation: The IPR Unload detected an undefined keyword
    | on the USERHDR control statement.
    | System Action: The IPR Unload issues message HPSU3360E
    | and ends its processing.
    | Programmer Response: Correct the USERHDR control statement.
    | Problem Determination: See the 'USERHDR control statement'.
    ----------------------------------------------------------------
    | HPSU3354E USERHDR CONTROL STATEMENT IS REQUIRED FOR *UH FORMAT
    | Explanation: The *UH format is specified on the OUTPUT control
    | statement, however, there is no USERHDR control statement.
    | System Action: The IPR Unload issues message HPSU3360E
    | and ends its processing.
    | Programmer Response: Specify the USERHDR control statement.
    ======================= End of Doc-Change ======================
    

APAR Information

  • APAR number

    PK16234

  • Reported component name

    IMS HIGHPERF UN

  • Reported component ID

    5655E0600

  • Reported release

    110

  • Status

    CLOSED UR1

  • PE

    NoPE

  • HIPER

    NoHIPER

  • Special Attention

    NoSpecatt / Xsystem

  • Submitted date

    2005-12-05

  • Closed date

    2005-12-26

  • Last modified date

    2006-01-04

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

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

    UK10421

Modules/Macros

  •    FABHJCB  FABHJCB0 FABHLINK FABHPSL  FABHPSL8
    FABHPSL9 FABHRTI0 FABHSDB  FABHSDB0 FABH0207 FABH0208 FABH0209
    HPSUFCB0 HPSUGTI0 HPSUHFCB HPSUHOUT HPSURCBM HPSUSTMT HPSUURG7
    HPSUURG8 HPSUURG9 HPSUUSHD HPSUUSHF HPSU015  HPSU015A H1IN110J
    

Publications Referenced
SC18922801    

Fix information

  • Fixed component name

    IMS HIGHPERF UN

  • Fixed component ID

    5655E0600

Applicable component levels

  • R110 PSY UK10421

       UP05/12/28 P F512

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.

[{"Line of Business":{"code":"LOB10"},"Business Unit":{"code":"BU029","label":"Software"},"Product":{"code":"SSCX89K","label":"IMS Tools"},"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"110"}]

Document Information

Modified date:
20 October 2020