PI72375: NEW FUNCTIONS FOR PSINDEX

Obtain the fix for this APAR.

APAR status

• Closed as new function.

Error description

• This APAR provides the following new function:
  - Enabling IIUIN PARTNAME control statement when building
     PSINDEX databases.
   - Updating existing PSINDEX records which correspond to the
     PHDAM/PHIDAM partitions selected by the PARTNAME statement.
  

Local fix

Problem summary

• ****************************************************************
  * USERS AFFECTED: All users of IMS Index Builder for z/OS,     *
  *                 Version 3 Release 1 (FMID=H22O310)           *
  ****************************************************************
  * PROBLEM DESCRIPTION: IMS index builder newly supports        *
  *                      partial build of PSINDEX databases      *
  *                      after PHDAM or PHIDAM partitions are    *
  *                      selectively reorganized.                *
  ****************************************************************
  * RECOMMENDATION:                                              *
  ****************************************************************
  This APAR provides the following new function:
  - Enabling IIUIN PARTNAME control statement when building
    PSINDEX databases.
  - Supporting the new update mode, which updates only existing
    records in PSINDEX databases.
  

Problem conclusion

Temporary fix

Comments

• ========================
  = Documentation Change =
  ========================
  IBM IMS Index Builder for z/OS, V3R1, User's Guide
  (SC18-9101-05) should be changed as follows:
  ================================================================
  > Using IMS Index Builder
  >> IMS Index Builder functions
  >>> Creating secondary indexes
  >>>> Building partitioned secondary indexes using HPSRWFP as
       input
  D Requirement: The WFP files must be generated for all
  D partitions of the target HALDB by IMS High Performance Load
  D in advance.
    Tips:
    - The DD statements for the WFP files are not needed. The data
      sets are allocated dynamically.
    - The optional WFPDEL YES statement specifies to delete the
      WFP files after the indexes are loaded successfully.
    - The optional MAXTASKS 2,PSORT statement improves the
      performance of index sort processing.
  | - This example job requires WFP files for all HALDB
  |   partitions. If IMS High Performance Load processes some
  |
  |
  |
  |      PROC BLD_SECONDARY,HMPORDP1,ALL,UPDATE
  ================================================================
  > Using IMS Index Builder
  >> JCL and input control statements
  >>> IMS Index Builder JCL
  >>>> DD statements
  DDEFPDS DD statement
    This DD statement provides IMS Index Builder delete and define
    statements for the indexes it processes. It is optional. You
    might want to use it to change the allocation parameters (such
    as the volume or space allocations) of the new index. IMS
    Index Builder looks for the delete and define statements for
    each index data set in a member with the same name as the
    index DD name. The member contents must be only delete and
  | define statements. Members for PSINDEX partitions are ignored
  | if the UPDATE option is specified on the PROC control
  | statement.
    Define this data set as a PDS, fixed blocked with LRECL=80 and
    fixed-block format.
    In parallel IMS Index Builder job runs, the DDEFPDS
    functionality might result in concurrent IDCAMS delete and
    define operations, and one operation typically fails.
    This statement is optional.
  ================================================================
  > Using IMS Index Builder
  >> JCL and input control statements
  >>> IMS Index Builder input control statements
  >>>> Required control statements
  >>>>> PROC control statement
  :
  |                                 .-,ALL------.  .-,LOAD---.
  |>>-PROC-BLD_SECONDARY-,-database-+-----------+--+---------+--><
  |                                 '-,SELECTED-'  '-,UPDATE-'
  :
  |                           .-,LOAD---.
  |>>-PROC-BLD_ALL-,-database-+---------+-----------------------><
  |                           '-,UPDATE-'
  :
    ALL
     Specifies that all secondary indexes of the database must be
     built. If you specify ALL, any INDEX statements that are
     associated with the database named in the PROC statement are
  |  ignored. ALL is used as the default.
    SELECTED
     Specifies that each secondary index to be built will be
     selected with the INDEX statement.
  | LOAD
  |  Builds the secondary index in load mode. IMS Index Builder
  |  builds and loads all the secondary index records. LOAD is
  |  used as the default.
  | UPDATE
  |  Updates the PSINDEX in update mode. IMS Index Builder builds
  |  and loads only the PSINDEX records that point to certain
  |  HALDB partitions.
  |  Use this mode when HALDB partitions are selectively
  |  reorganized. The VSAM data sets of the PSINDEX must fully
  |  contain index records for all the HALDB partitions before
  |  the reorganization. IMS Index Builder determines the target
  |  HALDB partitions from the following statements:
  |  -If INPUT IBSCAN statement is specified, IMS Index Builder
  |   refers to the PARTNAME statement. If no PARTNAME statement
  |   is specified, IMS Index Builder processes the PSINDEX
  |   records for all the HALDB partitions.
  |??? ??PROC     BLD_SECONDARY,HMPORDP1,ALL,UPDATE
  |      INPUT    IBSCAN
  |      PARTNAME HORDP1B,HORDP1C
  | - If INPUT HPSRWFP statement is specified, IMS Index Builder
  |   dynamically allocates all the WFP files for the HALDB
  |   partitions that IMS High Performance Load reloaded and
  |   processes the records found in the WFP files.
  |      PROC     BLD_SECONDARY,HMPORDP1,ALL,UPDATE
  |      INPUT    HPSRWFP
  |      WFPHLQ   IMSTOOLS.WORK.HMPORDP1
  | Tips for update mode:
  | 1. If the DDEFPDS DD statement is specified, the IDCAMS
  |    commands for PSINDEX are not performed.
  | 2. CI or CA splits in the VSAM data sets remain.
  | 3. If IMS Index Builder cannot find an index record that
  |    should be updated, IMS Index Builder inserts a new index
  |    record.
  :
  BLD_ALL
    Specifies that the primary index, secondary indexes, and
    ILDS be built. You can specify only one PROC BLD_ALL
    statement per job. It will build only indexes appropriate
    to the database you specified.
  | The UPDATE option can be specified. This option is applied
  | only when building PSINDEX.
  ----------------------------------------------------------------
  >>>>> INPUT control statement
  HPSRWFP
    Specifies that data generated by IMS High Performance Load
    is used as input for building partitioned secondary indexes
    (PSINDEXes).
    If you specify HPSRWFP, you must also specify the PROC
    BLD_SECONDARY statement and the WFPHLQ control statement.
  | If the WFP files have been produced only for selected HALDB
  | partitions, the UPDATE option must be specified on the PROC
  | control statement. See PROC control statement.
  ---------------------------------------------------------------
  >>>> Optional control statements
  >>>>> PARTNAME control statement
    The PARTNAME control statement specifies one or more
  | HALDB (PHDAM or PHIDAM) partitions to be processed. IMS
  | Index Builder scans the selected partitions and builds the
  | index records of primary index, ILDS, and PSINDEX.  To build
  | a PSINDEX, the UPDATE option must be specified on the PROC
  | control statement.
  | This statement is optional.
  D It specifies when ILDS or primary indexes are to be built
  D for select partitions only.
  | If this statement is omitted, IMS Index Builder scans all
  | partitions of the HALDB.
  ----------------------------------------------------------------
  >>>>> SIDXBUF control statement
  d_buf
    Specifies the number of VSAM buffers that are to be used for
    the data component of the KSDS data set. The value must be an
    integer in the range of 1 - 255.
  D For each partition of PSINDEX, the default value is 16. For
  D each non-HALDB secondary index, the default value is 64.
  | If omitted, the default value applied is as follows:
  | - In load mode, the default value of 16 is used for each
  |   partition of PSINDEX.
  | - In update mode, a value that is equivalent to five tracks
  |   of disk space is used for each partition of PSINDEX.
  | - For each non-HALDB secondary index, the default value of
  |   64 is used.
  i_buf
    Specifies the number of VSAM buffers that are to be used for
    the index component of the KSDS data set. The value must be an
    an integer in the range of 1 - 255. For each partition of
  | PSINDEX, the default value is 16 in load mode and 2 in update
  | mode. For each non-HALDB secondary index, the default value is
    64.
  ================================================================
  >Troubleshooting
  >> IMS Index Builder messages
  | IIUB120I PSINDEX UPDATE MODE IN EFFECT
  | Explanation: The PSINDEX is being built in update mode because
  | the UPDATE option is specified on the PROC control statement.
  | System action:  Processing continues.
  | User response: None. This message is informational.
  
  | IIUB122I  'statement' STATEMENT OPTION option IS NOT
  |            APPLICABLE FOR NON-HALDB
  | Explanation: The indicated option is not supported for
  | non-HALDBs.
  | System action: Processing continues.
  | User response: None. This message is informational.
  
  | IIUB123E VSAM EMPTY DATA SET IS NOT SUPPORTED IN UPDATE MODE
  | Explanation:   The UPDATE option is specified on the PROC
  | control statement but one or more PSINDEX partitions are
  | empty.
  | System action: Processing stops.
  | User response: Rerun the job in load mode.
  ================================================================
  >Troubleshooting
  >> IMS Index Builder reason codes
  >>> IMS Index Builder verification phase failure reason codes
  794 NUM OF RECORDS MISMATCH: SECONDARY INDEX
  Explanation
    The sum of the number of the records that were loaded to the
    secondary index and the number of the rejected records must
    be equal to the number of the scanned occurrences of the
    index source segment in the prime database. If a DFSURWF1
  | file, a DFSURIDX file, or HPSRWFP files were used as input,
    the number of the records that were read from that file is
    verified instead of the number of scanned occurrences.
  | If update mode is specified for building the PSINDEX,  the
  | number of the records that were updated or inserted is used
  | instead of the number of the loaded records.
    This error was most likely caused by an IMS Index Builder
    internal error.
  ================ 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:

  UI43055

Modules/Macros

•    IIUBIBCD IIUBIDCM IIUBINIT IIUBMSGS IIUBSTMS
  IIUDRVRX IIUGVT00 IIUIFS2A IIUIFS2B IIUIFS22 IIUIFS23 IIUIFS24
  IIUIFS29 IIUIFS3A IIUIFS3B IIUIFS32 IIUIFS33 IIUIFS34 IIUIFS39
  IIUMMSGR IIUNDXRC IIUPLS00 IIUSCA12 IIUSE35P IIUSIBCD IIUSIN11
  IIUSRPRC IIUTXT10
  

Fix information

• Fixed component name

  IMS INDEX BUILD

• Fixed component ID

  5655E2400

Applicable component levels

• R310 PSY UI43055

     UP16/12/06 P F612

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.