Updates to IMS High Performance Fast Path Utilities for z/OS, V3R2 User's Guide Volume 1: Fast Path Advanced Tool

Product documentation


Abstract

Documentation updates to IMS HP Fast Path Utilities for z/OS, V3R2 User's Guide Vol. 1: Fast Path Advanced Tool (SC18-9869-03)

Content

Note to users: February 2009

Document changes after February 20th, 2009, will be documented in the technote for IMS High Performance Fast Path Utilities for z/OS, Version 3 Release 2, User's Guide (SC18-9869-04).

==================================================

Update 10: January 2009

This section of the techonote documents the changes for APAR PK75263 and APAR PK74273.

==================================================
APAR PK74273

Chapter 1. Introduction
1.2 Terminology

IMS Version 11 is added to the terminology section as follows:

    To make this information easier to read, the version and release levels of IMS are abbreviated, as follows:
    • ...
    • IMS Version 11 refers to IMS Version 11 Release 1.

==================================================
Chapter 2. Fast Path Advanced Tool  
2.3 JCL control language(JCL)  
2.3.2 DD statements  
2.3.2.1 Input  
   
Descriptions to support IMS Version 11 is added to the following DD statements.

IMSACB DD
    Notes on dynamic allocation:
      ... The DFSMDA member for IMSACB cannot be used under IMS Version 10 or later.

IMSACBA DD  
    Notes on dynamic allocation:  
      ... You can build the DFSMDA member for the IMSACBA library by using a TYPE=DATABASE statement of the DFSMDA macro under IMS Version 8,9 and 10. But the DFSMDA member for IMSACBA cannot be used under IMS Version 11.

IMSACBB DD
    Notes on dynamic allocation:  
      ... You can build the DFSMDA member for the IMSACBB library by using a TYPE=DATABASE statement of the DFSMDA macro under IMS Version 8,9 and 10. But the DFSMDA member for IMSACBB cannot be used under IMS Version 11.

==================================================
APAR PK75263

Chapter 3. Fast Path Advanced Tool command
3.1 Commands, subcommands, and keywords

New subcommands and keywords are added to Table 40 as follows:

    Table 40. HFPSYSIN commands, subcommands, and keywords
    Command Subcommands Keywords
    ...
    RELOAD
    • ...
    • ...
    • ...
    • FORMAT
    • ...
    • SEGREC_PREFIX
    • SEGREC_SUFFIX
    • ...
    ...
    • ...
    • ...
    UNLOAD
    • ...
    • USER_RECORD
    • ...
    • SEGREC_PREFIX
    • SEGREC_SUFFIX
    • ...

==================================================
Chapter 5. Unloading a DEDB
5.3 Input for Unload
5.3.1 HFPSYSIN

Descriptions about the FILECTL and the USER_RECORD subcommands are added to this section.

HFPSYSIN
    ...
    Function
      The HFPSYSIN data set contains the user description of the UNLOAD command and the optional subcommands FILECTL and USER_RECORD, all of which control  the Unload process.

--------------------------------------------------
5.3.1.1 UNLOAD command keywords

New keywords are added to Figure 21.
    [...]
    [SEGREC_PREFIX]
    [SEGREC_SUFFIX]
    [...]
    Figure 21. UNLOAD command keywords

The descriptions for the new keywords are added as follows:
    SEGREC_PREFIX
      An optional keyword that specifies the contents of the fields within the prefix portion of the segment records. For information about coding this parameter, see "SEGREC_PREFIX" in topic A.xx.

    SEGREC_SUFFIX
      An optional keyword that specifies the contents of the fields within the suffix portion of the segment records. For information about coding this parameter, see "SEGREC_SUFFIX" in topic A.xx.

--------------------------------------------------
5.3.1.x USER_RECORD subcommand keywords

New section is added after 5.3.1.2 FILECTL subcommand keywords.

USER_RECORD subcommand keywords
    The USER_RECORD subcommand is used to specify the user-defined header and the trailer records that are to be written to an unloaded file. For the USER_RECORD subcommand, you can specify the keywords that are listed in Figure xx.

    [BREAK]
    [FIELDS]
    Figure xx. USER_RECORD subcommand keywords

    BREAK
      An optional keyword that specifies the level and the timing for the trigger event for user-defined header and trailer of an unloaded file. For information about coding this parameter, see "BREAK" in topic A.xx.

    FIELDS
      A required keyword that specifies the content of the header and trailer records that are to be written to the output file. For information about coding this parameter, see “FIELDS" in topic A.xx.

--------------------------------------------------
5.4 Output for Unload
5.4.1 Unloaded segment records data set

The description about user-specified unloaded data set is added as follows:

Unloaded segment records data set
    ...
    Format
      For the format of an unloaded segment record, see Appendix C, "Unloaded segment records file format" in topic C.0.
      For the format of an unloaded segment record when FORMAT=USER is specified, see Appendix G, "Extracted file format" in topic G.4.

      If the unloaded data set, which was unloaded in a user-specified format with the FORMAT=USER keyword, satisfies all of the following conditions, the data set can be used as an input for the Reload function.
      • The USER_RECORD subcommand is not specified.
      • SEGMENT_NAME or SEGMENT_CODE is specified on the SEGREC_PREFIX keyword.
      • When COMPRTN is specified in the DBD definition, SEGMENT_ATTR is specified on the SEGREC_PREFIX keyword.
      • When SEGMENT_CKEY is specified on the SEGREC_PREFIX keyword, SEGMENT_CKEY_LENGTH is specified before SEGMENT_CKEY.
      • When KEY or SEGMENT_KEY is specified on the SEGREC_PREFIX keyword, SEGMENT_KEY_LENGTH is specified before KEY or SEGMENT_KEY.

      It can be allocated dynamically by one of following commands:
      • ...
      • ...
--------------------------------------------------
5.5 Examples
5.5.x Example x--Unloading areas in user-specified format

New example is added as follows:


Example 11: Unloading areas in user-specified format
    These are example JCL statements for unloading areas in user-specified format.
      Two examples are provided in this topic. The first example is for creating an unloaded file that can be used as an input for the Reload function and the second example shows a case in which the created file is not enabled for the Reload function.

      The unloaded file that is created by the following JCL can be used as an input for the RELOAD command to reload areas because this JCL satisfies all the conditions described in Unloaded segment records data set on page xx.

      In this example:
      • The SEGREC_PREFIX keyword defines the content of the segment prefix.
      • Segment code is included in the segment prefix.

      //HFP      EXEC PGM=HFPMAIN0
      //STEPLIB  DD DISP=SHR,DSN=HPFP.SHFPLMD0
      //         DD DISP=SHR,DSN=IMSVS.SDFSRESL
      //         DD DISP=SHR,DSN=IMSVS.PGMLIB
      //         DD DISP=SHR,DSN=IMSVS.MDALIB
      //IMSACB   DD DISP=SHR,DSN=IMSVS.ACBLIB
      //DB22AR01 DD DISP=SHR,DSN=HPFP.DB22AR0.ADS1
      //OAREA001 DD DISP=OLD,DSN=HPFP.USRFILE
      //HFPPRINT DD SYSOUT=*
      //HFPRPTS  DD SYSOUT=*
      //HFPSYSIN DD *
      GLOBAL
         DBRC=YES
      UNLOAD
         DBD=DEDBJN22,
         IAREA=(DB22AR0),
         OAREA=(DB22AR0),
         FORMAT=USER,
         SEGREC_PREFIX=(SEGMENT_CODE)
      /*
      Figure xx. Unloading areas in user-specified format (enabled for Reload)


      The unloaded file that is created by the following JCL cannot be used with the Reload function because this JCL does not satisfy all the conditions described in Unloaded segment records data set on page xx.
        In this example:
        • The USER_RECORD subcommand defines the position and the content of the header and trailer.
        • BREAK=(DATABASE,BEFORE) defines the database-level header.
        • FIELDS=(DBD_NAME) specifies to include the DBD name in the header.
        • The SEGREC_PREFIX keyword defines the content of the segment prefix.
        • Segment code is included in the segment prefix.
        • The SEGREC_SUFFIX keyword defines the content of the segment suffix.
        • Segment name is included in the segment suffix.

        //HFP      EXEC PGM=HFPMAIN0
        //STEPLIB  DD DISP=SHR,DSN=HPFP.SHFPLMD0
        //         DD DISP=SHR,DSN=IMSVS.SDFSRESL
        //         DD DISP=SHR,DSN=IMSVS.PGMLIB
        //         DD DISP=SHR,DSN=IMSVS.MDALIB
        //IMSACB   DD DISP=SHR,DSN=IMSVS.ACBLIB
        //DB22AR01 DD DISP=SHR,DSN=HPFP.DB22AR0.ADS1
        //OAREA001 DD DISP=OLD,DSN=HPFP.USRFILE
        //HFPPRINT DD  SYSOUT=*  
        //HFPRPTS  DD  SYSOUT=*  
        //HFPSYSIN DD  *        
         GLOBAL
           DBRC=YES
         UNLOAD  
           DBD=DEDBJN22,    
           IAREA=(DB22AR0),
           OAREA=(DB22AR0),
           FORMAT=USER,
           SEGREC_PREFIX=(SEGMENT_CODE),
           SEGREC_SUFFIX=(SEGMENT_NAME)
         USER_RECORD
           BREAK=(DATABASE,BEFORE),
           FIELDS=(DBD_NAME)
        /*
        Figure yy. Unloading areas in user-specified format (not enabled for Reload)


      ==================================================
      Chapter 6. Reloading a DEDB
      6.3 Input for Reload
      6.3.1 HFPSYSIN
      6.3.1.1 RELOAD command keywords

      New keywords are added to Figure 38.
        [...]
        [FORMAT]
        [...]
        [SEGREC_PREFIX]
        [SEGREC_SUFFIX]
        [...]
        Figure 38. RELOAD command keywords

      The descriptions for the new keywords are added as follows:
        FORMAT
          An optional keyword that specifies the format of the unloaded file. For information about coding this parameter, see "FORMAT" in topic A.27.

        SEGREC_PREFIX
          An optional keyword that specifies the contents of the fields within the prefix portion of the segment records. For information about coding this parameter, see "SEGREC_PREFIX" in topic A.xx.

        SEGREC_SUFFIX
          An optional keyword that specifies the contents of the fields within the suffix portion of the segment records. For information about coding this parameter, see "SEGREC_SUFFIX" in topic A.xx.

      --------------------------------------------------
      6.3 Input for Reload
      6.3.2 Unloaded segment records data set

      The description about user-specified unloaded data set is added as follows:

      Unloaded segment records data set
        ...
        Format
          For the format of the record, see Appendix C, "Unloaded segment records file format" in topic C.0.
          For the format of an unloaded segment record when FORMAT=USER is specified, see Appendix G, "Extracted file format" in topic G.4.

          If the unloaded data set, which was unloaded in a user-specified format with the FORMAT=USER keyword, satisfies all of the following conditions, the data set can be used as an input for the Reload function.
          • The USER_RECORD subcommand is not specified.
          • SEGMENT_NAME or SEGMENT_CODE is specified on the SEGREC_PREFIX keyword.
          • When COMPRTN is specified in the DBD definition, SEGMENT_ATTR is specified on the SEGREC_PREFIX keyword.
          • When SEGMENT_CKEY is specified on the SEGREC_PREFIX keyword, SEGMENT_CKEY_LENGTH is specified before SEGMENT_CKEY.
          • When KEY or SEGMENT_KEY is specified on the SEGREC_PREFIX keyword, SEGMENT_KEY_LENGTH is specified before KEY or SEGMENT_KEY.

          It can be allocated dynamically by the IDSNMASK keyword parameter of the RELOAD command, or it can be specified in one of following DD statements explicitly:
          • ...
          • ...

      --------------------------------------------------
      6.5 Examples
      6.5.x Example x--Reloading an area from a user-specified format data set

      New example is added as follows:

      Example 11-- Reloading an area from a user-specified format data set
        Figure xx shows an example JCL statement for reloading an area from a user-specified format data set.

        This example shows the case of reload by using the unloaded segment records data set that is created by the JCL shown in "Example 11: Unloading areas in user-specified format" on page xx.
        • The content of the segment prefix is directed by SEGREC_PREFIX keyword.
        • Segment code is contained in the segment prefix.

        //HFP      EXEC PGM=HFPMAIN0
        //STEPLIB  DD DISP=SHR,DSN=HPFP.SHFPLMD0
        //         DD DISP=SHR,DSN=IMSVS.SDFSRESL
        //         DD DISP=SHR,DSN=IMSVS.PGMLIB
        //         DD DISP=SHR,DSN=IMSVS.MDALIB
        //IMSACB   DD DISP=SHR,DSN=IMSVS.ACBLIB
        //DB22AR01 DD DISP=SHR,DSN=HPFP.DB22AR0.ADS1
        //IAREA001 DD DISP=SHR,DSN=HPFP.USRFILE
        //SYSOUT   DD  SYSOUT=*
        //HFPPRINT DD  SYSOUT=*  
        //HFPRPTS  DD  SYSOUT=*  
        //HFPSYSIN DD  *    
         GLOBAL
           DBRC=YES
         RELOAD        
           DBD=DEDBJN22,  
           IAREA=(DB22AR0),
           OAREA=(DB22AR0),
           FORMAT=USER,
           SEGREC_PREFIX=(SEGMENT_CODE)
        /*
        Figure zz. Reloading an area from a user-specified format data set 

      ==================================================
      Appendix A. Command reference
      A.4 AREA_INFORMATION_RECORD

      Description is added as follows:
        parameter
          parameter can be one of the following values:

          YES
            Specify that an area information record is included in an unloaded segment record data set. If FORMAT=USER is specified for the UNLOAD command, this parameter is ignored.

          NO
            ...
      --------------------------------------------------
      A.x BREAK

      Description is modified as follows:
        Use this keyword to specify the level and the timing for the trigger event for user-defined header and trailer of an extract or unloaded  file.
        ...
        Parameters
          level
            Specify one of the following values:
              DATABASE
                The trigger event occurs at the database processing level. This is the default value.
              AREA
                The trigger event occurs at the area processing level. When the UNLOAD command is processed in the non-REORG mode, the AREA parameter cannot be specified.
              ...

      --------------------------------------------------
      A.27 FORMAT

      Description is modified as follows:
        ...
        FORMAT is an optional keyword for the following commands:
        • UNLOAD
        • RELOAD
        ...
        parameter
          Specify one of the following parameters:
          TFMT
            ... This value can be specified only on the UNLOAD command.

          DBT
            ... This value can be specified only on the UNLOAD command.

          USER
            Allows more granular control of the input file or the output file. This format should be used when an existing application program requires unloaded data in a specific format.
        Default:
          FORMAT=DBT on the UNLOAD command.
          NONE on the RELOAD command.

      This keyword can be specified for the site default only on the UNLOAD command.

      --------------------------------------------------
      A.51 LRECL

      Description is modified as follows:

      ...
        parameter
        ...

        If FORMAT=USER is specified, these parameters are ignored except for LRECL=SEGMENT.
      LRECL is determined on the basis of ...

      --------------------------------------------------
      A.71 RELOAD

      Description is added as follows:
        Related keywords:
        • ...
        • FORMAT
        • ...
        • SEGREC_PREFIX
        • SEGREC_SUFFIX
        • ...

      The syntax diagram is changed to include the new keywords.

      --------------------------------------------------
      A.82 SDEP

      Description is added as follows:

      ...

      PHYSIC AL
        Processing in physical order results in all segments between the SDEP logical beginning and logical end being extracted in physical sequence and inserted into the SDEP part of the new area. The SDEP segments remain in the same physical order (this mode fully supports the marker segment concept).
        If FORMAT=USER is specified for the UNLOAD command, this parameter is ignored.

      --------------------------------------------------
      A.x SEGREC_PREFIX

      Description is modified as follows:
        Use this keyword to specify the contents of the fields within the prefix portion of the segment records, which are to be written to an extract or an unload file. This keyword is valid only when EFORMAT=USER with the EXTRACT command, or FORMAT=USER with the UNLOAD command or the RELOAD command is specified.

        SEGREC_PREFIX is an optional keyword for the following commands:
        • EXTRACT
        • UNLOAD
        • RELOAD


        ...
        Built-in variable
          Following built-in variables can be specified.

          Built-in Variable Data type Contents
          ... ... ...
          SEGMENT_ATTR 1X Segment attribute (Only for the UNLOAD or the RELOAD command)
          X'40': SDEP segment
          X'04': Fixed length segment
          X'02': Compressed segment
          ... ... ...
          SEGMENT_LENGTH ... Length of segment (When COMPRESS=YES is specified, the length of the compressed segment)
          ... ... ...
          SEGMENT_OCCURRENCE 4X Segment code and segment sequence number for the current hierarchical level  (Only for the UNLOAD or the RELOAD command)
          SEGMENT_SCSQ_DEF (X 3X)xn Segment code and segment sequence number for the defined hierarchical level  (Only for the UNLOAD or the RELOAD command)
          SEGMENT_SCSQ_MAX (X 3X)x14 Segment code and segment sequence number for all hierarchical levels  (Only for the UNLOAD or the RELOAD command)
          ... ... ...
      --------------------------------------------------
      A.x SEGREC_SUFFIX

      Description is modified as follows:
        Use this keyword to specify the contents of the fields within the suffix portion of the segment records, which are written to an extract or an unload file. This keyword is valid only when EFORMAT=USER with the EXTRACT command, or FORMAT=USER with the UNLOAD command or the RELOAD command is specified.

        SEGREC_SUFFIX is an optional keyword for the following commands:
        • EXTRACT
        • UNLOAD
        • RELOAD

        Note: The specification of SEGREC_SUFFIX does not affect the RELOAD function.

        ...

        Built-in variable
          Following built-in variables can be specified

          Built-in Variable Data type Contents
          ... ... ...
          SEGMENT_ATTR 1X Segment attribute (Only for the UNLOAD or the RELOAD command)
          X'40': SDEP segment
          X'04': Fixed length segment
          X'02': Compressed segment
          ... ... ...
          SEGMENT_LENGTH ... Length of segment (When COMPRESS=YES is specified, the length of the compressed segment)
          ... ... ...
          SEGMENT_OCCURRENCE 4X Segment code and segment sequence number for the current hierarchical level  (Only for the UNLOAD or the RELOAD command)
          SEGMENT_SCSQ_DEF (X 3X)xn Segment code and segment sequence number for the defined hierarchical level  (Only for the UNLOAD or the RELOAD command)
          SEGMENT_SCSQ_MAX (X 3X)x14 Segment code and segment sequence number for all hierarchical levels  (Only for the UNLOAD or the RELOAD command)
          ... ... ...
      --------------------------------------------------
      A.90 SORT

      Description is added as follows:

      parameter
        parameter can be one of the following values:
        NO
          ... If FORMAT=USER is specified for the RELOAD command, this parameter is changed to YES internally.

        YES
          ... If FORMAT=USER is specified for the UNLOAD command, this parameter is ignored.

      --------------------------------------------------
      A.92 SSP

      Description is added as follows:

      parameter
        parameter can be one of the following values:

        YES
          ... If FORMAT=USER is specified for the UNLOAD command, this parameter is changed to NO internally.

        NO
          ...

      --------------------------------------------------
      A.100 UNLOAD

      The following keywords are added:
        Related keywords:
        • ...
        • SEGREC_PREFIX
        • SEGREC_SUFFIX
        • ...

      The syntax diagram is changed to include the new keywords.
      --------------------------------------------------
      A.x USER_RECORD

      Description is modified as follows:
        Use this subcommand to specify the user-defined header and the trailer records that are to be written to an extract or an unload file. This keyword is valid only when EFORMAT=USER or FORMAT=USER is specified.

        USER_RECORD is an optional subcommand for the following commands:
        • EXTRACT
        • UNLOAD

      ==================================================
      Appendix B. Sample reports
      B.2 Processing report

      The following reports are modified:


             UNLOAD PROCESSING OPTION
                       - AREA_INFORMATION_RECORD          : YES
                       - COMPRESS                         : NO
                       - DBD                              : DEDBJN21
                       - EXITRTN                          :
                       - FORMAT                           : DBT
                       - IAREA                            : ALL
                       - ICACHE                           : YES
                       - ICINCOMP                         : NO
                       - ICNOTIFY                         : NO
                       - ICOUT                            : NO
                       - IDSNMASK                         :
                       - ITASKCTL                         : 1
                       - KEYCHGCHK                        : YES
                       - KEYSEQCHK                        : NOCHECK
                       - LRECL                            : SEGMENT
                       - ODSNMASK                         :
                       - PAD                              : X'00'
                       - PTRCHK                           : ABEND
                       - SDEP                             : LOGICAL
                       - SEGREC_PREFIX                    :
                       - SEGREC_SUFFIX                    :
                       - SORT                             : NO
                       - SSP                              : YES
                       - IMSACB                           : IMSVS.ACBLIB
                       - NEWACB                           : IMSVS.ACBLIB  (DYNAMIC ALLOCATION)
      Figure 110. Processing report for Unload


             RELOAD PROCESSING OPTION
                       - ATASKCTL                         : 0
                       - CISNAP                           : NO
                       - DBD                              : DEDBJN21
                       - EXITRTN                          :
                       - FORMAT                           :
                       - HISTORYDD                        :
                       - IAREA                            : ALL
                       - ICNOTIFY                         : NO
                       - ICOUT                            : NO
                       - IDSNMASK                         :
                       - ITASKCTL                         : 1
                       - KEYCHGCHK                        : YES
                       - KEYSEQCHK                        : NOCHECK
                       - OAREA                            : ALL
                       - OCACHE                           : YES
                       - ODSNMASK                         :
                       - PTRCHKLVL                        : NONE
                       - SDEP_ORPHAN_MSGLVL               : ERROR
                       - SDEPCHKLVL                       : QUICK
                       - SEGREC_PREFIX                    :
                       - SEGREC_SUFFIX                    :
                       - SORT                             : YES
                       - SSP                              : YES
                       - IMSACB                           : IMSVS.ACBLIB
      Figure 111. Processing report for Reload
        ==================================================
        Appendix C. Unloaded segment records file format

        The following description is added:
          For the format of the unloaded segment records that were created during an Unload process with  FORMAT=USER specification, see Appendix G, "Extracted file format" in topic G.4.

        ==================================================
        Appendix G. Extracted file format
        G.4 User format

        Description and new figure (added by APAR PK71459) are changed as follows:

        User Format
          The following figure shows the layout of the user format extracted file or the user format unloaded file .
            The user-defined header and the trailer records are defined by the USER_RECORD
            subcommand.

            User-defined prefix and suffix are defined by the SEGREC_PREFIX keyword and
            the SEGREC_SUFFIX keyword on the EXTRACT command  or the UNLOAD command .


            Figure x. Layout of the user format extracted file

          ==================================================
          Appendix H. Messages and codes
          H.3 Messages
          H.3.2 HFPC messages

          The following new messages are added:

          HFPC0127E INPUT FILE CANNOT BE RELOADED.
            - SEGREC_PREFIX IS NOT SPECIFIED.
            - BUILT-IN VARIABLE: built-in_variable  IS NOT SPECIFIED IN SEGREC_PREFIX.
            - NEITHER SEGMENT_NAME NOR SEGMENT_CODE IS SPECIFIED IN SEGREC_PREFIX.
            - built-in_variable1  MUST BE SPECIFIED BEFORE built-in_variable2  IN SEGREC_PREFIX.

          Explanation: The unloaded segment records data set, which is in user-specified format, cannot be reloaded because the file format is not valid for the Reload function.

          System Action: If SCAN=YES is specified, the return code is set to 8. If SCAN=NO is specified, an abend occurs with a code of U3003.

          Programmer Response: Correct the unloaded segment records data set, and rerun the job.
          --------------------------------------------------
          HFPC0128E IN CASE OF NON-REORG MODE, AREA CANNOT BE SPECIFIED AS THE FIRST PARAMETER OF THE BREAK KEYWORD.

          Explanation: While processing the UNLOAD command in the non-REORG mode, incorrect value, AREA, was found on the BREAK keyword.
          System Action: If SCAN=YES is specified, the return code is set to 8. If SCAN=NO is specified, an abend occurs with a code of U3003.
          Programmer Response: Correct the command syntax of HFPSYSIN, and rerun the job.

          --------------------------------------------------
          H.3.8 HFPK messages

          The following new messages are added:

          HFPK3212E ERROR IN CALL TO RANDOMIZER: randomizer .
            - RETURN CODE: nn
            - INCORRECT AREA NO: nnnnn
            - USR RECORD NO: nnnn
            - DDNAME: ddname , DSNAME: dsname

          Explanation: The error was returned from the randomizer module.
          System action: The job ends with an abend code of 3003.
          Programmer Response: Correct the unloaded segment records data set or the randomizer module, and rerun the job.

          --------------------------------------------------
          HFPK3213E SEGMENT HIERARCHICAL SEQUENCE ERROR WAS DETECTED.
            - SDEP OR DDEP MUST BE AFTER ROOT SEGMENT.
            - USR RECORD NO: nnnn
            - DDNAME: ddname , DSNAME: dsname

          Explanation: A segment hierarchical sequence error was found in the unloaded segment records data set.
          System action: The job ends with an abend code of 3003.
          Programmer Response: Correct the unloaded segment records data set, and rerun the job.

          --------------------------------------------------
          HFPK3214E INCORRECT USER FORMAT RECORD WAS DETECTED.
            - SEGMENT NAME: seg-name  IS INCORRECT.
            - SEGMENT CODE: nn  IS IN CONFLICT WITH SEGMENT NAME: seg-name . 
            - SEGMENT CODE: nn IS INCORRECT.
            - SEGMENT DATA LENGTH IS TOO SHORT.       
            - SEGMENT DATA LENGTH IS TOO LONG. 
            - SEGMENT ATTRIBUTE IS IN CONFLICT WITH DBD DEFINITION.  
            - USR RECORD NO: nnnn
            - DDNAME: ddname , DSNAME: dsname

          Explanation: Incorrect user format unloaded segment record was found while processing the RELOAD command.
          System action: The job ends with an abend code of 3003.
          Programmer Response: Correct the unloaded segment records data set, and rerun the job.
            ==================================================

            Update 9: November 2008

            This section of the technote documents the changes for APAR PK74388 and changes for improving readability of the User's Guide.

            ==================================================
            Chapter 8. Reorganizing a DEDB
            8.1 Program functions
            8.1.6 Recovery and restart

            The following description is added:

            If the Reorg function ends abnormally during the copy phase, the copy phase can be completed by rerunning the job. When restarted, the process starts from the beginning of the copy phase on the UOW that was being processed at the time the process ended.

            ==================================================
            Appendix A. Command reference
            A. 70 RECOVOPT

            The description of the parameters are changed as follows:

            RECOVOPT
              ...

              parameter
                parameter can be one of the following values:
                NORMAL
                  The method for recovering an area depends on the first parameter value specified for the RFSSCAN keyword.
                  • RFSSCAN=(YES,any):  
                    After processing the UOW that was being processed at the time the area ended abnormally, the REORG function ranks the set of UOWs that meet the RBASEFS and RDOVFFS criteria and continues to process the remaining UOWs in the order they are ranked.

                    Note: In the recovery process, the UOWs that were successfully reorganized in the previous job will not be reorganized because they will not meet the RBASEFS and RDOVFFS criteria.
                  • RFSSCAN=(NO,any):  
                    Processes the UOW that was being processed at the time the area ended abnormally and continues to process the remaining UOWs in ascending order.

                EMERGENCY
                  Processes only the UOW that was being processed at the time the area ended abnormally. Other UOWs, even those that are not reorganized, will not be processed.
             Default: ...

            ==================================================
            APAR PK74388

            Chapter2. Fast Past Path Advanced Tool  
            2.3 JCL control language(JCL)  
            2.3.2 DD statements
            2.3.2.1 Input  

            The description of the EXITLIB DD is changed as follows:

            EXITLIB DD

            <Before change>
              This statement defines the user exit routine library. This DD statement is used when the EXITRTN keyword is specified for the UNLOAD or the RELOAD command.... the routines are loaded from the JOBLIB or the STEPLIB DD statement.

            <After change>
              This statement defines the user exit routine library.  This DD statement is used when one of the following conditions is met:  
              • The EXITRTN keyword is specified for the UNLOAD or the RELOAD command.
              • The IEXITRTN or the OEXITRTN keyword is specified for the CHANGE command.
              ...the routines are loaded from the JOBLIB or the STEPLIB DD statement.
              All of the data sets that are listed within the EXITLIB concatenation must be APF-authorized.  

            --------------------------------------------------
            New description is added to the description of IMSRESLB DD as follows:

            IMSRESLB DD
              ...DD statement must not be specified.
              All of the data sets that are listed within the IMSRESLB concatenation must be APF-authorized.  

            --------------------------------------------------
            New description is added to the description of OLDRESLB DD as follows:

            OLDRESLB DD
              ... from the JOBLIB or the STEPLIB DD statement.
              All of the data sets that are listed within the OLDRESLB concatenation must be APF-authorized.  

            --------------------------------------------------
            New description is added to the description of NEWRESLB DD as follows:

            NEWRESLB DD
              ... from the JOBLIB or the STEPLIB DD statement.
              All of the data sets that are listed within the NEWRESLB concatenation must be APF-authorized.  

            ==================================================
            Appendix A. Command reference  
            A.22 EXITRTN  

            EXITRTN

            The following description is added to the first paragraph:
              When this keyword is specified, you must either specify the EXITLIB DD statement or the library that contains the user exit routine in JOBLIB or STEPLIB DD.

            The following description in Requirement section is deleted:
              You must provide an EXITLIB DD statement when this keyword is specified.

            --------------------------------------------------
            Appendix A. Command reference  
            A.40 IEXITRTN  

            IEXITRTN

            The following description is added to the first paragraph:
              When this keyword is specified, you must either specify the EXITLIB DD statement or the library that contains the user exit routine in JOBLIB or STEPLIB DD.

            The following description in Requirement section is deleted:
              You must provide an EXITLIB DD statement when this keyword is specified.

            --------------------------------------------------
            Appendix A. Command reference  
            A.57 OEXITRTN  
             

            OEXITRTN

            The following description is added to the first paragraph:
              When this keyword is specified, you must either specify the EXITLIB DD statement or the library that contains the user exit routine in JOBLIB or STEPLIB DD.  

            The following description in Requirement section is deleted:  
              An EXITLIB DD statement must be provided when this keyword is specified.

            ==================================================
            Appendix H. Message and Codes  
            H.3 Messages
            H.3.10 HFPM messages  

            New subtext for message HFPM3061E is added as follows:  
            - FROM ddname  (REASON: NOT APF-AUTHORIZED)  

            --------------------------------------------------
            New subtext for message HFPM3062E is added as follows:  
            - FROM ddname  (REASON: NOT APF-AUTHORIZED)  

            --------------------------------------------------
            New subtext for message HFPM3360E is added as follows:  
            - FROM ddname  (REASON: NOT APF-AUTHORIZED)

              ==================================================

            Update 8: October 2008

            This section of the technote documents the changes for APAR PK71259 and PK71459.

            ==================================================
            APAR PK71259

            Chapter 2. Fast Path Advanced Tool  
            2.3 Job control language(JCL)  
            2.3.2 DD statements
            2.3.2.3 Input/Output  

            Description for itttWKnn DD is changed as follows:

            itttWKnn DD  
              An optional DD statement for PTRCHKLVL=FULL that is used with the RELOAD, CHANGE, ANALYZE, and REORG commands. These are intermediate storage data sets that are used by DFSORT. For more information about coding the SORTWKnn DD statements, see DFSORT Application Programming Guide. Allocating twice the space used by the SORTIN data set is usually adequate for each work data set.

              The naming rules of the ddnames are as follows:  
                i: The thousands digit of the area number of the area to be analyzed or the thousands digit of ATASKCTL.  
                  A, D, G and J:  
                    If the number of area to be analyzed  or the number of ATASKCTL is 999 or less.
                  B, E, H and K:  
                    If the number of area to be analyzed  or the number of ATASKCTL is from 1000 to 1999.  
                  C, F, I and L:  
                    If the number of area to be analyzed or the number of ATASKCTL is from 2000 to 2048.  

                ttt: The hundreds digit of the area number of the area to be analyzed or the hundreds   digit of ATASKCTL.
                nn: The number of ...

                Notes on dynamic allocation:  
                ...

            ==================================================
            Appendix A.Command reference  
            A.x MAXERROR

            A new keyword, MAXERROR, is added as follows:

            A.x MAXERROR  
              Use this keyword to specify the maximum number of pointer errors that might be encountered before ANALYZE process ends abnormally.

              MAXERROR is an optional keyword for the following commands:  
              • ANALYZE
              • CHANGE
              • RELOAD  

              Related keywords: None.

              Format:  
                MAXERROR= parameter
                parameter
                  Specify a value from 0 to 999. If 0 is specified, there is no maximum number of errors.  

              Default:  
                MAXERROR=100  
                This keyword can be specified for the site default.  

            ==================================================
            Appendix H. Message and codes  
            H.2 Messafes
            H.3.15 HFPU messages

            New messages are added as follows:

            HFPU3042E INSUFFICIENT TABLE STORAGE FOR: xxxxxxxx,  
                      TCT: tctname, MODULE: modulename,  
                      REQUEST LENGTH: nnnnnnnnn  
                      - OLD TABLE ADDRESS: xxxxxxxx, HEADER: xx..xx  

            Explanation: Program HFPMAIN0 was unable to obtain sufficient virtual storage.
            System action: The job ends with an abend code of U3042.
            Programmer response: Correct the errors, and rerun the job. If this situation persists, contact IBM Software Support.  

            --------------------------------------------------
            HFPU3043E TABLE STORAGE RELEASE FAILURE FOR: xxxxxxxx,  
                      TCT: tctname, MODULE: modulename  
                      - TABLE ADDRESS: xxxxxxxx, HEADER: xx..xx  

            Explanation: Program HFPMAIN0 was unable to release virtual storage.
            System action: The job ends with an abend code of U3043.
            Programmer response: Correct the errors, and rerun the job. If this situation persists, contact IBM Software Support.

            ==================================================


            APAR PK71459

            Chapter 3. Fast Path Advanced Tool command
            3.1 Commands, subcommands, and keywords

            New subcommand and new keywords are added to Table 40 and Table 41 as follows:

            Table 40. HFPSYSIN commands, subcommands, and keywords
            Command Subcommands Keywords
            ... ...
            EXTRACT
            • ...
            • ...
            • USER_RECORD
            • ...
            • SEGREC_PREFIX
            • SEGREC_SUFFIX
            • ...
            ... ...
            Table 41. HFPSYSIN subcommands and keywords
            Subcommand Keywords
            ... ...
            USER_RECORD
            • BREAK
            • FIELDS
            ... ...

            --------------------------------------------------
            3.2 Keywords

            New keywords are added to Table 42 as follows:

            Table 42. HFPSYSIN keywords
            Keyword Purpose of the keyword
            ... ...
            BREAK Specifies the level and the timing for the trigger event for user-defined header and trailer of an extract file.
            ... ...
            SEGREC_PREFIX Specifies the contents of the fields within the prefix portion of the segment records, which are to be written to an extract file.
            SEGREC_SUFFIX Specifies the contents of the fields within the suffix portion of the segment records, which are to be written to an extract file.
            ... ...

            ==================================================
            Chapter 10. Extracting a DEDB
            10.1 Program functions

            User format is added to the list of QSAM data set format as follows:

            Program functions
              The EXTRACT function provides an easy-to-use, flexible method to extract segment data from one or more offline DEDB areas and writes the output to QSAM data sets. The QSAM data set can be one of the following formats:
              • Standard format
              • FPB Unload/Reload format
              • FPB Unload/Reload TFMT format
              • TRIMAR Unload/Reload format
              • HD Unload format
              • User format
            --------------------------------------------------
            10.1.3 Samples of SELECT and OUTPUT commands

            The description for Table 48 is changed as follows:

            Table 48 shows selected segments and segment output when EFORMAT=STD or EFORMAT=USER  is specified.

            Caption for Table 48 is changed as follows:

            Table 48. SELECT and OUTPUT subcommands with EFORMAT=STD or EFORMAT=USER

            --------------------------------------------------
            10.4 Input for Extract
            10.4.1 HFPSYSIN

            The description for the HFPSYSIN data set is changed as follows:

            HFPSYSIN
              ...

              Function
                The HFPSYSIN data set contains the user description of the EXTRACT command and the optional subcommands FILECTL, OUTPUT, SELECT, and USER_RECORD,  all of which control the Extract process.

              ...
            --------------------------------------------------
            10.4.1.1 EXTRACT command

            New keywords are added to Figure 93 as follows:

            ...
            [SEGREC_PREFIX]
            [SEGREC_SUFFIX]
            ...
            Figure 93. EXTRACT command keywords

            Descriptions for the new keywords are added as follows:
              SEGREC_PREFIX
                An optional keyword that specifies the contents of the fields within the prefix portion of the segment records. For information about coding this parameter, see "SEGREC_PREFIX" on page xxx.

              SEGREC_SUFFIX
                An optional keyword that specifies the contents of the fields within the suffix portion of the segment records. For information about coding this parameter, see "SEGREC_SUFFIX" on page xxx.

            --------------------------------------------------
            10.4.1.x USER_RECORD subcommand

            A new section is added as follows:

            USER_RECORD subcommand
              The USER_RECORD subcommand is used to specify the user-defined header and the trailer records that are to be written to an extract file. For the USER_RECORD subcommand, you can specify the keywords that are listed in Figure xx.

              [BREAK]
              [FIELDS]
              Figure xx. USER_RECORD subcommand keywords

              BREAK
                An optional keyword that specifies the level and the timing for the trigger event for  user-defined header and trailer of an extract file. For information about coding this parameter, see "BREAK" on page xxx.

              FIELDS
                A required keyword that specifies the content of the header and trailer records that are to be written to the output file. For information about coding this parameter, see “FIELDS" on page xxx.

            ==================================================
            Appendix A. Command reference
            A.x BREAK

            A new keyword is added as follows:

            BREAK
              Use this keyword to specify the level and the timing for the trigger event for user-defined header and trailer of an extract file.

              BREAK is an optional keyword for the USER_RECORD subcommand.

              Related keywords: None.

              Format:
                BREAK=( level , when )
                Parameters
                  level
                    Specify one of the following values:
                    DATABASE
                      The trigger event occurs at the database processing level. This is the default value.
                    AREA
                      The trigger event occurs at the area processing level.
                  when
                    Specify one of the following values:

                    BEFORE
                      The user record is triggered when processing begins for the specified level. This is the default value.
                    AFTER
                      The user record is triggered after processing is complete for the specified level.
              Default: BREAK=(DATABASE,BEFORE)

            --------------------------------------------------
            A.19 EFORMAT

            New parameter is added as follows:

            EFORMAT
              Format:
                ...

                parameter
                ...
                  USER
                    Allows more granular control of   the output file. This format should be used when an existing application program requires extracted data in a specific format.

            --------------------------------------------------
            A.24 EXTRACT

            Keywords are added to the list of related keywords:

            EXTRACT
              Related keywords:
                • ...
                • SEGREC_PREFIX
                • SEGREC_SUFFIX
                • ...
            The syntax diagram is changed to include the SEGREC_PREFIX keyword and the SEGREC_SUFFIX keyword.

            --------------------------------------------------
            A.25 FIELDS

            Description is changed as follows:
             
            FIELDS
              Use this keyword to specify the content of   the segment data records , user-defined header records, or user-defined trailer records  that are written to the output file. The extracted fields are in the output record in the order that is specified by the FIELDS parameter. When using the OUTPUT subcommand, and if you want a complete segment, do not use this keyword.

              FIELDS is :
              • An optional keyword for the OUTPUT subcommand.
              • A required keyword for the USER_RECORD subcommand.

              Parameters:
                ss
                  Integer specifying the position of the field that is to be compared relative to 1. The value of ss cannot be greater than the maximum segment length. This value can only be specified on the OUTPUT subcommand.
                ll
                  Integer specifying the length of the field that is to be compared relative to 1. The value of ll cannot be greater than the maximum segment length. You can specify an asterisk (*) to mean (from ss to) the last position of the segment. This value can only be specified on the OUTPUT subcommand.
                literal
                  ...
                Built-in variable
                Following built-in variables can be specified on the OUTPUT subcommand.

                Built-in Variable name Data type Contents
                ... ... ...
                DBD_SEGMENTS ... ...
                KEY or SEGMENT_KEY nC Key for current segment
                ROOT_KEY nC Key for root segment
                ROOT_KEY_LENGTH 2F Length of root segment key
                ... ... ...
                SEGMENT_CKEY ... ...
                SEGMENT_CKEY_LENGTH 2F Length of concatenated key for current segment
                SEGMENT_CODE ... ...
                SEGMENT_KEY_LENGTH 2F Length of current segment key
                ... ... ...
                 
                Following built-in variables can be specified on the USER_RECORD subcommand.

                Built-in Variable name Data type Contents
                AREA_COUNT 2X
                • Number of areas that were attempted to be written to an extract file. (BREAK=(DATABSE, BEFORE))
                • Number of areas written to an extract file. (BREAK=(DATABASE, AFTER))
                AREA_NAME 8C Area name
                BREAK=(AREA,
                when) only
                AREA_NUMBER 1X Area number (1 byte)
                 BREAK=(AREA,when) only
                AREA_NUMBER2 2X Area number (2 bytes)
                 BREAK=(AREA,when) only
                DBD_AREAS 2F Number of areas in DBD
                DBD_LEVELS 2F Maximum hierarchic level in DBD
                DBD_NAME 8C DBD name
                DBD_SEGMENTS 2F Number of segment types in DBD
                RUNDATE 4X Date when FPA started
                RUNDATETIME 12X Date and time when FPA started
                RUNTIME 4X Time when FPA started
                SEGMENT_COUNT_DETAIL 4X x 127 Number of extracted segments for each segment type
                SEGMENT_COUNT_DETAIL_SEG 4X x n Number of extracted segments for each segment type defined in DBD
                SEGMENT_COUNT_TOTAL 4X Number of extracted segments
                TODAY 4X Date when FPA started

                VL=YES
                ...
                VL=NO
                ...
              Default:
                VL=NO when the value of EFORMAT keyword is STD. VL=YES when the value of EFORMAT keyword is DBT, HDUNLOAD, TFMT,  UR, or USER.

            --------------------------------------------------
            A.x SEGREC_PREFIX

            New keywords are added as follows:

            SEGREC_PREFIX
              Use this keyword to specify the contents of the fields within the prefix portion of the segment records, which are to be written to an extract file. This keyword is valid only when EFORMAT=USER is specified.

              SEGREC_PREFIX is an optional keyword for the EXTRACT command.

              Related keyword: SEGREC_SUFFIX

              Format:

                               +-----,-------------+
                               v                   |
               SEGREC_PREFIX=(-------------------------[,VL=YES|NO]-- )
                               +-literal-----------+
                               +-build-in variable-+

              Parameters:
                literal
                  Specify one or more alphabetic or numeric characters that are contained within apostrophes ('') or within quotation marks (""). You can specify an optional data-type declaration as follows:
                  • C'xxxxxx' (character): Case-sensitive character data. You must specify a minimum of 1 and maximum of 28 characters (28 bytes).
                  • F'xxxxxx' (signed binary): Must contain only numeric digits. You must specify a minimum of 1 and maximum of 19 digits (4 bytes).
                  • P'xxxxxx' (packed decimal): Assumed positive. Must contain only numeric digits. You must specify a minimum of 1 and maximum of 31 digits (16 bytes).
                  • X'xxxxxx' (unsigned binary): Must be an even number of hexadecimal characters. You must specify a minimum of 2 hexadecimal characters (representing 1 byte) and a maximum of 56 hexadecimal characters (representing 28 bytes).
                  You can also declare the length, by specifying it before the data-type declaration.
                  Example:
                    8C'CUSDB'
                    2P'01'
                Built-in variable
                Following built-in variables can be specified.

                Built-in Variable name Data type Contents
                AREA_NAME 8C Area name
                AREA_NUMBER 1X Area number (1 byte)
                AREA_NUMBER2 2X Area number (2 bytes)
                DBD_AREAS 2F Number of areas in DBD
                DBD_LEVELS 2F Maximum hierarchic level in DBD
                DBD_NAME 8C DBD name
                DBD_SEGMENTS 2F Number of segment types in DBD
                KEY or SEGMENT_KEY nC Key for current segment
                ROOT_KEY nC Key for root segment
                ROOT_KEY_LENGTH 2F Length of root segment key
                RUNDATE 4X Date when FPA started
                RUNDATETIME 12X Date and time when FPA started
                RUNTIME 4X Time when FPA started
                SEGMENT_CKEY nC Concatenated key for current segment
                SEGMENT_CKEY_LENGTH 2F Length of concatenated key for current segment
                SEGMENT_CODE 1X Segment code
                SEGMENT_KEY_LENGTH 2F Length of current segment key
                SEGMENT_LENGTH 2F Length of segment
                SEGMENT_LEVEL 1X Segment level
                SEGMENT_NAME 8C Segment name
                TODAY 4X Date when FPA started

                VL=YES
                Request a length prefix.
                VL=NO
                Suppress a length prefix.

              Default: VL=YES

              Alias: PREFIX
            --------------------------------------------------
            A.x SEGREC_SUFFIX

            SEGREC_SUFFIX
              Use this keyword to specify the contents of the fields within the suffix portion of the segment records, which are written to an extract file. This keyword is valid only when EFORMAT=USER is specified.

              SEGREC_SUFFIX is an optional keyword for the EXTRACT command.

              Related keyword: SEGREC_PREFIX

              Format:

                               +-----,-------------+
                               v                   |
               SEGREC_SUFFIX=(-------------------------[,VL=YES|NO]-- )
                               +-literal-----------+
                               +-build-in variable-+

              Parameters:
                literal
                  Specify one or more alphabetic or numeric characters that are contained within apostrophes ('') or within quotation marks (""). You can specify an optional data-type declaration as follows:
                  • C'xxxxxx' (character): Case-sensitive character data. You must specify a minimum of 1 and maximum of 28 characters (28 bytes).
                  • F'xxxxxx' (signed binary): Must contain only numeric digits. You must specify a minimum of 1 and maximum of 19 digits (4 bytes).
                  • P'xxxxxx' (packed decimal): Assumed positive. Must contain only numeric digits. You must specify a minimum of 1 and maximum of 31 digits (16 bytes).
                  • X'xxxxxx' (unsigned binary): Must be an even number of hexadecimal characters. You must specify a minimum of 2 hexadecimal characters (representing 1 byte) and a maximum of 56 hexadecimal characters (representing 28 bytes).
                  You can also declare the length, by specifying it before the data-type declaration.
                  Example:
                    8C'CUSDB'
                    2P'01'
                Built-in variable
                Following built-in variables can be specified

                Built-in Variable name Data type Contents
                AREA_NAME 8C Area name
                AREA_NUMBER 1X Area number (1 byte)
                AREA_NUMBER2 2X Area number (2 bytes)
                DBD_AREAS 2F Number of areas in DBD
                DBD_LEVELS 2F Maximum hierarchic level in DBD
                DBD_NAME 8C DBD name
                DBD_SEGMENTS 2F Number of segment types in DBD
                KEY or SEGMENT_KEY nC Key for current segment
                ROOT_KEY nC Key for root segment
                ROOT_KEY_LENGTH 2F Length of root segment key
                RUNDATE 4X Date when FPA started
                RUNDATETIME 12X Date and time when FPA started
                RUNTIME 4X Time when FPA started
                SEGMENT_CKEY nC Concatenated key for current segment
                SEGMENT_CKEY_LENGTH 2F Length of concatenated key for current segment
                SEGMENT_CODE 1X Segment code
                SEGMENT_KEY_LENGTH 2F Length of current segment key
                SEGMENT_LENGTH 2F Length of segment
                SEGMENT_LEVEL 1X Segment level
                SEGMENT_NAME 8C Segment name
                TODAY 4X Date when FPA started

                VL=YES
                Request a length prefix.
                VL=NO
                Suppress a length prefix.

              Default: VL=YES

              Alias: SUFFIX

            --------------------------------------------------
            A.90 SORT

            Description is changed as follows:
             
            SORT
              ...
               
              parameter
                parameter  can be one of the following values:
                NO
                  Do not sort the sequential file.
                YES
                  Sort the sequential file. If EFORMAT=HDUNLOAD or EFORMAT=USER  is specified for the EXTRACT command, this parameter is ignored.

            --------------------------------------------------
            A.x USER_RECORD

            New subcommand is added as follows:

            USER_RECORD
              Use this subcommand to specify the user-defined header and the trailer records that are to be written to an extract file. This keyword is valid only when EFORMAT=USER is specified.

              USER_RECORD is an optional subcommand for the EXTRACT command.

              Related keywords:
              • BREAK
              • FIELDS

              Format:
                USER_RECORD [ keyword = parameter [,...]]  
                Parameters:
                  N/A

              Default: None.

            ==================================================
            Appendix B. Sample reports
            B.2 Processing report

            Following lines are added to Figure 115:


            ...
            ...
              EXTRACT PROCESSING OPTION
                        - ...
                        - SEGREC_PREFIX                    : (SEGMENT_CODE)
                        - SEGREC_SUFFIX                    : (SEGMENT_NAME)

              EXTRACT SUBCOMMAND PROCESSING OPTION
                       ...
                       USER_RECORD
                        - BREAK                            : (AREA,BEFORE)
                        - FIELDS                           : (AREA_NAME)  

            Figure 115. Processing report for Extract

            ==================================================
            Appendix G. Extracted file format
            G.4 User format

            New section is added after G.3 "HD Unload format".

            User format
              Figure xx shows the layout of the user format extracted file.

              The user-defined header and the trailer records are defined by the USER_RECORD subcommand. For details, see "BREAK" on page xxx and "FIELDS" on page 230.

              User-defined prefix and suffix are defined by the SEGREC_PREFIX keyword and the SEGREC_SUFFIX keyword on the EXTRACT command. For details, see "SEGREC_PREFIX" on page xxx and "SEGREC_SUFFIX" on page xxx.


              user-defined database-level header record
              user-defined area-level header record
              segment data records
              user-defined prefix
              segment data
              user-defined suffix
              :
              :
              user-defined area-level trailer record
              user-defined database-level trailer record
              Figure xx. Layout of the user format extracted file

            ==================================================
            Appendix H. Messages and codes
            H.3 Messages

            Following messages are added :

            HFPC0120E ROW:  nn , COLUMN:  nn , AN INCORRECT VALUE IS SPECIFIED FOR THE EXPRESSIONS.
            - BUILT-IN VARIABLE: built-in _ variable CANNOT BE SPECIFIED FOR THIS STATEMENT SPECIFICATION.
            - THE FIELD VARIABLE CANNOT BE SPECIFIED FOR THIS STATEMENT SPECIFICATION.
            --------------------------------------------------

            HFPC0122E keyword1 =USER IS REQUIRED TO SPECIFY KEYWORD: keyword2 .  

            Explanation: Program HFPMAIN0 found that keyword2  was specified in HFPSYSIN. However, keyword2  must be specified with keyword1 =USER.
            System action: If SCAN=YES is specified, the return code is set to 8. Or if SCAN=NO is specified, the job ends with an abend code of U3003.
            Programmer response: Correct the command set in HFPSYSIN, and rerun the job.
            --------------------------------------------------

            HFPC0123E keyword =USER IS REQUIRED TO SPECIFY SUBCOMMAND: subcommand .

            Explanation: Program HFPMAIN0 found that subcommand  was specified in HFPSYSIN. However, subcommand must be specified with keyword =USER.
            System action: If SCAN=YES is specified, the return code is set to 8. Or if SCAN=NO is specified, the job ends with an abend code of U3003.
            Programmer response: Correct the command set in HFPSYSIN, and rerun the job.
            --------------------------------------------------

            HFPC0124E keyword  VALUE IS DUPLICATED FOR SUBCOMMAND: subcommand ( n ).

            Explanation: Program HFPMAIN0 found that the same keyword value was specified more than once for subcommand .
            System action: If SCAN=YES is specified, the return code is set to 8. Or if SCAN=NO is specified, the job ends with an abend code of U3003.
            Programmer response: Correct the command set in HFPSYSIN, and rerun the job.


            ==================================================

            Update 7: September 2008
            APAR PK70784

            This section of the technote documents the changes for APAR PK70784.

            Description for HFPARERG DD is changed.

            This change applies to the following sections:
            •  Chapter 6. Reloading a DEDB (6.2.2.2 Output)
            •  Chapter 7. Changing a DEDB (7.2.2.2 Output)

            HFPARERG DD
              <Before change>
              This statement defines the output data set for the reorganization control statements that might be generated for input to the High-Speed DEDB Direct Reorganization utility (DBFUHDR0). This is effective when the REPORT subcommand and PTRCHKLVL=FULL are specified. For details, see HFPARERG DD statement on page 40.

              <After change>
              This statement defines the output data set for the reorganization control statements that might be generated for input to the High-Speed DEDB Direct Reorganization utility (DBFUHDR0). This is effective when the REPORT subcommand is specified with PTRCHKLVL=FULL or QUICK.  For details, see HFPARERG DD statement on page 40.

            ==================================================
            Description for HFPASNAP DD is changed.

            This change applies to the following sections:
            • Chapter 6. Reloading a DEDB (6.2.2.2 Output)
            • Chapter 7. Changing a DEDB (7.2.2.2 Output)
            • Chapter 8. Reorganizing a DEDB (8.3.2.2 Output)

            HFPASNAP DD
              <Before change>
              This statement defines the output data set for the CI Map/CI Dump report and the Pointer Chain Reconstruction report. This is effective when the REPORT subcommand, PTRCHKLVL=FULL, and CISNAP=YES are specified. For details, see HFPASNAP DD statement on page 40.

              <After change>
              This statement defines the output data set for the CI Map/CI Dump report and the Pointer Chain Reconstruction report. This is effective when the REPORT subcommand, PTRCHKLVL=FULL or QUICK,  and CISNAP=YES are specified. For details, see HFPASNAP DD statement on page 40.

            ==================================================
            Description for the REPORT subcommand keyword is changed.

            This change applies to the following sections:
            • Chapter 6. Reloading a DEDB (6.3.1.4 REPORT subcommand keyword)
            • Chapter 7. Changing a DEDB (7.3.1.5 REPORT subcommand keywords)
            • Chapter 8. Reorganizing a DEDB (8.4.2.3 REPORT subcommand keywords)
            • Chapter 9. Analyzing a DEDB (9.3.1.2 REPORT subcommand keywords)

            REPORT subcommand keyword
              <Before change>
              The REPORT subcommand is used to request the analysis reports. If you do not specify the PTRCHKLVL=FULL keyword, this subcommand is ignored. For details, see "REPORT subcommand keyword" on page 167.

              <After change>
              The REPORT subcommand is used to request the analysis reports. If you do not specify the PTRCHKLVL=FULL or QUICK  keyword, this subcommand is ignored. For details, see "REPORT subcommand keyword" on page 167.

            ==================================================
            New description is added to the Function section of HFPRPTS.

            This change applies to the following sections:
            • Chapter 6. Reloading a DEDB (6.4.3 HFPRPTS)
            • Chapter 7. Changing a DEDB (7.4.3 HFPRPTS)
            • Chapter 8. Reorganizing a DEDB (8.5.3 HFPRPTS)
            • Chapter 9. Analyzing a DEDB (9.4.2 HFPRPTS)

            HFPRPTS
              ...
              Function

              FPA generates the following reports to ...
              • ...
              • ...
              • ...

              When the REPORT subcommand and PTRCHKLVL=FULL...
              • ...
              • ...
              • ...

              When the REPORT subcommand and PTRCHKLVL=QUICK are specified, the following reports are generated:
              • DEDB Area Analysis reports  (FREESPACE ANALYSIS only)
              • Process Summary of Analysis report
              • UOW report (without DB record information)
              • UOW Exception report  (without DB record information)

              You can generate reports...

            ==================================================
            Description for HFPARERG is changed.

            This change applies to the following sections:
            • Chapter 6. Reloading a DEDB (6.4.6 HFPARERG)
            • Chapter 7. Changing a DEDB (7.4.6 HFPARERG)
            • Chapter 9. Analyzing a DEDB (9.4.4 HFPARERG)

            Description for the HFPARERG data set is changed as follows:

            HFPARERG
              <Before change>
              This is an output data set that contains the reorganization control statements for the High-Speed DEDB Direct Reorganization utility (DBFUHDR0). This is effective when the REPORT subcommand and PTRCHKLVL=FULL are specified.

              <After change>
              This is an output data set that contains the reorganization control statements for the High-Speed DEDB Direct Reorganization utility (DBFUHDR0). This is effective when the REPORT subcommand is specified with PTRCHKLVL=FULL or QUICK .

            ==================================================
            Description for HFPASNAP is changed.

            This change applies to the following sections:
            • Chapter 7. Changing a DEDB (7.4.7 HFPASNAP)
            • Chapter 8. Reorganizing a DEDB (8.5.5 HFPASNAP)

            HFPASNAP
              <Before change>
              This section describes the HFPASNAP data set, which is used by the Change/Reorg process. This is effective when the REPORT subcommand, PTRCHKLVL=FULL, and CISNAP=YES are specified.

              <After change>
              This section describes the HFPASNAP data set, which is used by the Change/Reorg process. This is effective when the REPORT subcommand, PTRCHKLVL=FULL or QUICK, and CISNAP=YES are specified.

            ==================================================
            Chapter 2. Fast Path Advanced Tool
            2.3        Job control language (JCL)
            2.3.2      DD statements
            2.3.2.1    Input

            Description for HFPAPARM DD is changed as follows:

            HFPAPARM DD
              <Before change>
              An optional DD statement for the RELOAD, CHANGE, ANALYZE, and REORG commands. This statement defines the control parameters for generating the analysis reports. This statement is used only when you specify both the REPORT subcommand and the PTRCHKLVL=FULL keyword.

              <After change>
              An optional DD statement for the RELOAD, CHANGE, ANALYZE, and REORG commands. This statement defines the control parameters for generating the analysis reports. This statement is used only when you specify the REPORT subcommand with the PTRCHKLVL=FULL or QUICK keyword.

            --------------------------------------------------
            2.3.2.2    Output

            Description for HFPARERG DD is changed as follows:

            HFPARERG DD
              <Before change>
              An optional DD statement for the RELOAD, CHANGE, and ANALYZE commands. This statement defines an output data set that contains the reorganization control statements for the High-Speed DEDB Direct Reorganization utility (DBFUHDR0). This statement is used only when you specify both the REPORT subcommand and the PTRCHKLVL=FULL keyword.

              <After change>
              An optional DD statement for the RELOAD, CHANGE, and ANALYZE commands. This statement defines an output data set that contains the reorganization control statements for the High-Speed DEDB Direct Reorganization utility (DBFUHDR0). This statement is used only when you specify the REPORT subcommand with the PTRCHKLVL=FULL or QUICK keyword.

            ==================================================
            Chapter 9. Analyzing a DEDB
            9.3        Input for Analyze
            9.3.3      HFPAPARM data set

            Descriptions for the Function section and the Record format section are changed as follows:

            HFPAPARM data set
              ...

              Function
                The HFPAPARM data set contains the user's specification of control parameters for generating the analysis reports. This data set is used only when you specify the REPORT subcommand with the PTRCHKLVL=FULL or QUICK keyword.

              Format
              ...

              Record format
                ...
                SYNTBL=
                  This keyword controls the number of reporting entries in the Synonym Chain Analysis table. The default value is 41 (that is, all synonym chains longer than 40 are grouped and reported together). The maximum value is 99, and the minimum value is 12. This keyword is ignored if you specify the REPORT subcommand with the PTRCHKLVL=QUICK keyword.
                ...

            ==================================================
            Appendix A. Command reference
            A.74        REPORT

            Description for the REPORT subcommand is changed as follows:

            REPORT
              <Before change>
              If you do not specify the PTRCHKLVL=FULL keyword, this subcommand is ignored.

              <After change>
              If you do not specify the PTRCHKLVL=FULL or QUICK  keyword, this subcommand is ignored.

            ==================================================
            Appendix B. Sample reports
            B.11        Process Summary of Analysis report

            Description for the Process Summary of Analysis report is changed as follows:

            Process Summary of Analysis report
              ...

              This report is generated by the following commands:
              • ANALYZE with the REPORT subcommand and the PTRCHKLVL=FULL or QUICK keyword
              • CHANGE with the REPORT subcommand and the PTRCHKLVL=FULL or QUICK keyword
              • RELOAD with the REPORT subcommand and the PTRCHKLVL=FULL or QUICK keyword
              • REORG with the REPORT subcommand and the PTRCHKLVL=FULL or QUICK keyword

            --------------------------------------------------
            Appendix B. Sample reports
            B.12        DEDB Area Analysis reports

            New description is added to the DEDB Area Analysis reports section as follows:

            DEDB Area Analysis reports
              ...

              This report is generated by the following commands:
              • ...
              • ...

              The Freespace Analysis reports are also generated by the following commands:
              • ANALYZE with the REPORT subcommand and the PTRCHKLVL=QUICK keyword
              • CHANGE with the REPORT subcommand and the PTRCHKLVL=QUICK keyword
              • RELOAD with the REPORT subcommand and the PTRCHKLVL=QUICK keyword
              • REORG with the REPORT subcommand and the PTRCHKLVL=QUICK keyword
              ...

            --------------------------------------------------
            Appendix B. Sample reports
            B.13        UOW report

            Description for the UOW report section is changed as follows:

            UOW report
            ...

              This report is generated by the following commands:
              • ANALYZE with the REPORT subcommand and the PTRCHKLVL=FULL or QUICK keyword
              • CHANGE with the REPORT subcommand and the PTRCHKLVL=FULL or QUICK keyword
              • RELOAD with the REPORT subcommand and the PTRCHKLVL=FULL or QUICK keyword
              • REORG with the REPORT subcommand and the PTRCHKLVL=FULL or QUICK keyword

              Figure 139 is an example of the UOW report when PTRCHKLVL=FULL is specified.

              ...
              ...

              #DB RECORDS
              Shows the number of database records in the UOW.
              When PTRCHKLVL=QUICK is specified, this field is not reported and is shown as '-'.

              RECORD LENGTH STATS
              Shows statistics about the average, maximum, and minimum record lengths. The record length includes both prefix and data lengths.
              When PTRCHKLVL=QUICK is specified, this field is not reported and is shown as '-'.

            --------------------------------------------------
            Appendix B. Sample reports
            B.14        UOW Exception report

            Description for the UOW Exception report is changed as follows:

            UOW Exception report
              ...

              This report is generated by the following commands:
              • ANALYZE with the REPORT subcommand and the PTRCHKLVL=FULL or QUICK keyword
              • CHANGE with the REPORT subcommand and the PTRCHKLVL=FULL or QUICK keyword
              • RELOAD with the REPORT subcommand and the PTRCHKLVL=FULL or QUICK keyword
              • REORG with the REPORT subcommand and the PTRCHKLVL=FULL or QUICK keyword

              Figure 140 is an example of the UOW Exception report when PTRCHKLVL=FULL is specified.

              ...
              ...
              #DB RECORDS
              Shows the number of database records in the UOW.
              When PTRCHKLVL=QUICK is specified, this field is not reported and is shown as '-'.

              RECORD LENGTH STATS
              Shows statistics about the average, maximum, and minimum record lengths. The record length includes both prefix and data lengths.
              When PTRCHKLVL=QUICK is specified, this field is not reported and is shown as '-'.


            ==================================================

            Update 6: August 2008
            APAR PK65463 and PK67974

            This section of the technote documents the changes for APAR PK65463 and PK67974.

            Chapter 1. Introduction
            1.2        Terminology

            The following abbreviation is added:

            ITKB    Represents IMS Tools Knowledge Base.  

            --------------------------------------------------
            1.4        System requirements
            1.4.1      Software

            Description is added as follows:

            Fast Path Advanced Tool requires the following product for the optional function:
            • ...
            • IMS High Performance Image Copy for z/OS, Version 4 Release 1 with PK45121 or later if ICOUT=YES and ITKBSRVR=servername are  specified.
            • IMS Tools Knowledge Base for z/OS, Version 1 Release 1 (5655-R34), if ITKBSRVR=servername is specified.

            ==================================================
            Chapter 1. Introduction
            1.x        Support for IMS Tools Knowledge Base

            A new section is added after 1.6 Compatibility:

            1.x Support for IMS Tools Knowledge Base

            IMS Tools Knowledge Base is an IMS Tools product that provides common services for storing and viewing reports that are generated by other IMS Tools products.

            To fully participate in the IMS Tools Knowledge Base information management environment, each IMS tool must be enabled to communicate with the IMS Tools Knowledge Base server. An enabled IMS tool can automatically send its generated reports to the IMS Tools Knowledge Base repository. This version of FPA is enabled to participate in the IMS Tools Knowledge Base environment.

            You must perform three configuration procedures to allow FPA to send reports to the IMS Tools Knowledge Base repository:

            1. Register IMS HPFPU with IMS Tools Knowledge Base

            The registration process defines IMS HPFPU reports to IMS Tools Knowledge Base so that IMS HPFPU reports can be stored in the IMS Tools Knowledge Base repository.

            Use the IMS Tools Knowledge Base product administration utility (HKTAPRA0) to register IMS HPFPU with IMS Tools Knowledge Base as described in the IMS Tools Knowledge Base User's Guide (SC18-9963). Follow the instructions in the topic "Registering IMS Tools products by using the default definition table".

            To register IMS HPFPU with IMS Tools Knowledge Base, you need to submit the following job. Before submitting the job, add a job card and change the parameter in italics to meet your site's requirements.

            //DEFREPDF EXEC PGM=HKTAPRA0,PARM='ITKBSRVR= servername '  
            //STEPLIB  DD DISP=SHR,DSN=HKT.SHKTLOAD  
            //SYSPRINT DD SYSOUT=*  
            //OUTRPT   DD SYSOUT=*  
            //SYSUDUMP DD SYSOUT=*  
            //LOGFILE  DD SYSOUT=*  
            //SYSIN    DD *
              ADDPROD  PRODUCTID=DF,RELEASE=030200,RETENTION=(30,30),  
                       TABLE=HFPGPRS0,REPLACE=YES  
            /*

            2. Verify communication with the IMS Tools Knowledge Base server

            Verify that the systems that you will run FPA on will have XCF communications with the IMS Tools Knowledge Base server and that the FPQ subsystem is started on each of these systems.  In the IMS Tools Knowledge Base User's Guide, refer to the topic "Defining IMS Tools KB to the operating system".


            3. Request that FPA write reports to the IMS Tools Knowledge Base repository

            Specify the name of the IMS Tools Knowledge Base server in the ITKBSRVR parameter of the FPA control statement (HFPSYSIN).

            This parameter directs FPA to communicate to the IMS Tools Knowledge Base server so that FPA reports can be stored in the IMS Tools Knowledge Base repository.

            Syntax and configuration instructions for the HFPSYSIN control statement are located in ITKBLOAD on page xx and ITKBSRVR on page xx.


            After completing these configuration procedures, you can use the ISPF user interface to view, print, and manage reports that are generated by FPA and that are stored in the IMS Tools Knowledge Base repository.

            ==================================================
            Chapter 3. Fast Path Advanced Tool command  
            3.1        Commands, subcommands, and keywords

            The following lines are added:

            Table 40. HFPSYSIN commands, subcommands and keywords
            Command Keywords
            ... ...
            GLOBAL
            • ...
            • ITKBLOAD
            • ITKBSRVR
            • ...
            ... ...

            --------------------------------------------------
            3.2        Keywords  

            The following lines are added:
             
            Table 42. HFPSYSIN keywords
            Keyword Purpose of the keyword
            ... ...
            ITKBLOAD Specifies the library name of ITKB.
            ITKBSRVR Specifies the name of the ITKB server.
            ... ...

            ==================================================
            Appendix A. Command reference
            A.32        Global

            The following lines are added in the related keywords:
            • ITKBLOAD  
            • ITKBSRVR  

            Two keywords are added in the syntax diagram as follows:




             |
             +---ITKBLOAD=--+---*NO---+-----------------+
             |              +-dsname--+
             |
             +---ITKBSRVR=--+---*NO------+--------------+
             |              +-servername-+



            --------------------------------------------------
            The following keywords are added in Appendix A. Command reference:

            ITKBLOAD
            Use this keyword to specify the name of the load module library for ITKB.

            ITKBLOAD is an optional keyword for the GLOBAL command.

            It is used only when ITKBSRVR=servername is specified. If you do not explicitly specify this keyword, ITKBLOAD=*NO will be used and FPA attempts to load an ITKB module from the STEPLIB libraries.

            Related keyword: ITKBSRVR

            Format: ITKBLOAD= parameter

            Parameter
              Parameter can be one of the following values:
              dsname
                Specifies the name of the load module library for ITKB.
              *NO
                The ITKB modules are loaded from the private library or the system library of the job.

            Default: ITKBLOAD=*NO

            --------------------------------------------------
            ITKBSRVR

            Use this keyword to specify the name of the ITKB server.

            ITKBSRVR is an optional keyword for the GLOBAL command.

            If you do not explicitly specify this keyword, ITKBSRVR=*NO will be used .

            Related keyword: ITKBLOAD

            Format: ITKBSRVR= parameter

            Parameter
              Parameter can be one of the following values:
              servername
                FPA stores reports in the ITKB Output repository of the specified server.
              *NO
                FPA does not store reports in the ITKB Output repository.

            Default: ITKBSRVR=*NO

            ==================================================
            Appendix B. Sample reports
            B.1         Reports generated by each process of FPA

            A new section is added as follows:

            B.1 Reports generated by each process of FPA

            With each process of FPA, several reports are generated.

            The following table summarizes the reports that are generated by each process of FPA.

            Table. x Reports generated by each process
            FPA process Generated reports Whether the report can be stored in the output repository of ITKB
            Unload Audit report
            Y
            Processing report
            Y
            DBD Definition report
            Y
            Unloaded report
            Y
            Reloaded report
            Y
            Output File report
            Y
            Site and System Default report when the site default module or the site default table is used
            Y
            Image Copy Output report when ICOUT=YES is specified
            Y
            Reload Audit report
            Y
            Processing report
            Y
            DBD Definition report
            Y
            Reloaded report
            Y
            Input File report
            Y
            Reports related to the Analyze process when PTRCHKLVL=QUICK or FULL is specified
            Y *1
            Site and System Default report when the site default module or the site default table is used
            Y
            Image Copy Output report when ICOUT=YES is specified
            Y
            Change Audit report
            Y
            Processing report
            Y
            DBD Definition report
            Y
            Unloaded report
            Y
            Reloaded report
            Y
            Reports related to the Analyze process when PTRCHKLVL=QUICK or FULL is specified
            Y *1
            Site and System Default report when the site default module or the site default table is used
            Y
            Image Copy Output report when ICOUT=YES is specified
            Y
            Reorg Audit report
            Y
            Processing report
            Y
            DBD Definition report
            Y
            Reorganization Processing Summary report
            Y
            UOW Space Statistics report when RFSSTAT=YES is effective
            Y
            Reports related to the Analyze process when PTRCHKLVL=QUICK or FULL is specified
            Y *1
            Site and System Default report when the site default module or the site default table is used
            Y
            Image Copy Output report when ICOUT=Yes is specified
            Y
            Analyze Audit report
            Y
            Processing report
            Y
            DBD Definition report
            Y
            Resolve Pointers report
            -
            Pointer Chain Reconstruction report
            -
            CI Map/CI Dump report
            -
            Process Summary of Analysis report
            Y
            DEDB Area Analysis reports
            Y
            UOW report
            Y
            UOW Exception report
            Y
            Site and System Default report when the site default module or the site default table is used
            Y
            Image Copy Output report when ICOUT=YES is specified
            Y
            Extract Audit report
            -
            Processing report
            -
            DBD Definition report
            -
            Extracted report
            -
            Output File report
            -
            Site and System Default report when the site default module or the site default table is used
            -
            DMAC Print Audit report
            Y
            Processing report
            Y
            DBD Definition report
            Y
            DMACPRT report
            Y
            Note: *1 The Resolve Pointers report, the Pointer Chain Reconstruction report and the CI Map/CI Dump report cannot be stored in the output repository of ITKB.

            Report retention settings are applied to all reports to control the growth of the report repository. The retention values for a product's reports are provided by the product Definition Table when the product is registered with ITKB. Because the Audit report, the Processing report, the DBD Definition report, and the Site and System Default report are generated by all processes of FPA, you can change their retention period to avoid being deleted earlier than other reports. For details, see the topic “Changing the retention values for individual reports”in ITKB User's Guide.

            --------------------------------------------------
            Appendix B. Sample reports
            B.2         Viewing FPA reports stored in ITKB

            A new section is added as follows:

            B.2 Viewing FPA reports stored in ITKB

            There are many ways to use the ISPF user interface to view the FPA reports that are stored in the ITKB repository. The examples provided in this topic show some of the typical ways. For details about viewing reports in ITKB, see the topic "Finding and viewing reports" in ITKB User's Guide.

            Viewing DEDB Area Analysis report by using report name

            1. Select option 6 List of Reports  from the IMS Tools Knowledge Base main menu panel. Press Enter.

            2. Select HPFPU-FPA-DEDB Area Analysis report  from the Report List  panel by using the List  row action (S). Press Enter.

            3. Use the Row Actions commands to view and manage your reports from the appropriate reports.

            4. View all the reports that were generated in the same step as the DEDB Area Analysis report by using the STEP  row action (T). Press Enter.


            Viewing reports by using database name

            1. Select option 1 List of Databases with reports  from the IMS Tools Knowledge Base main menu panel. Press Enter.

            2. Select the database from the Database List  panel by using the List  row action (S). Press Enter.

            3. Use the Row Actions commands to view and manage your reports related to the specified database.


            ==================================================
            Appendix H. Messages and codes
            H.3         Messages

            Following new messages are added:

            HFPC0018I THE ITKBLOAD PARAMETER WAS IGNORED BECAUSE NO SERVER NAME WAS SPECIFIED.

            Explanation: An ITKB load module library was specified for the ITKBLOAD keyword parameter, but the specification was ignored because no server name was specified for the ITKBSRVR keyword parameter.
            System Action:  Processing continues, but HPFPU does not store any reports to the ITKB Output repository.
            Programmer Response: If you want to store the reports to the ITKB output repository, specify the ITKB server name for the ITKBSRVR keyword parameter.

            --------------------------------------------------
            HFPG0001W ITKB SERVER NAME WAS INCORRECT.

            Explanation: The connection to the ITKB server failed, because the server name specified by the ITKBSRVR keyword was incorrect.
            System Action: Processing continues, but HPFPU does not store any reports to the ITKB Output repository.
            Programmer Response: If you want to store the reports to the ITKB Output repository, specify the correct ITKB server name.

            --------------------------------------------------
            HFPG0002W THE ACCESS TO OUTPUT REPOSITORY WAS CANCELED REASON: reason

            Explanation: HPFPU canceled its access to the ITKB Output repository, because the initialization process failed.
            The reason is one of the following:
            • Dynamic allocation for the library that is specified with the ITKBLOAD keyword failed
            • Failed to open the library specified with the ITKBLOAD keyword
            • Failed to load the HKTXXLI module
            System Action: Processing continues, but HPFPU does not store any reports to the ITKB Output repository.
            Programmer Response: If you want to store the reports to the ITKB Output repository, specify the correct load module library of the ITKB product.

            --------------------------------------------------
            HFPG0003W HPFPU WAS NOT DEFINED IN ITKB.

            Explanation: HPFPU was not defined in the ITKB information management environment as a product that can store reports to the ITKB Output repository.
            System Action: Processing continues, but HPFPU does not store any reports to the ITKB Output repository.
            Programmer Response: If you want to store the reports to the ITKB Output repository, register the HPFPU product by using the ITKB product administration utility (HKTAPRA0).

            --------------------------------------------------
            HFPG0004W REPORT WAS NOT DEFINED IN ITKB.

            Explanation: The report was not defined in the ITKB information management environment.
            System Action: Processing continues, but HPFPU does not store the report to the ITKB Output repository.
            Programmer Response: If you want to store the report to the ITKB Output repository, register the report by using the ITKB product administration utility (HKTAPRA0).

            --------------------------------------------------
            HFPG0005W ERROR OCCURRED IN ACCESSING OUTPUT REPOSITORY
            FUNC: function  RC:  rc  RSN: rsn

            Explanation: An error occurred while getting access to the ITKB Output repository.
            System Action: Processing continues. If the return code is equal to or greater than 08, HPFPU does not store its reports to the ITKB Output repository.
            Programmer Response: If you want to store the reports to the ITKB Output repository, correct the error.

            --------------------------------------------------
            HFPG0006W DBD: dbdname  AREA: areaname  DD: ddname  REPORT: reportname

            Explanation: This message is displayed after message HFPG0005W.
            System Action: Processing continues. If the return code in the message HFPG0005W is equal to or greater than 08, HPFPU does not store the reportname  report for dbdname , areaname , and ddname .
            Programmer Response: See the description for message HFPG0005W.

            --------------------------------------------------
            HFPG0007W RECON ENTRY WAS NOT FOUND IN ITKB.

            Explanation: The RECON entry was not defined in your ITKB information management environment.  
            System Action: Processing continues, but HPFPU does not store any reports to the ITKB Output repository.
            Programmer Response: If you want to store the reports to the ITKB Output repository, add a RECON environment. For more information about adding the RECON environment, see IMS Tools Knowledge Base for z/OS User's Guide (SC18-9963).

            --------------------------------------------------
            HFPM3009I LEVEL IS NOT HIGH ENOUGH TO SUPPORT OUTPUT REPOSITORY: HP Image Copy

            Explanation: The maintenance level of the product does not support the ITKB Output repository.
            System Action: Processing continues. The reports of FPA are stored to the ITKB Output repository, but the reports of the product are not stored to the ITKB Output repository.
            Programmer Response: If you want to store the reports of the product to the ITKB Output repository, apply the maintenance of the product that supports the ITKB Output repository.

            ==================================================
            Appendix D. Total segments records file format

            The description for the following item is changed as follows:

            Table 54. Total segments records layout
            Field name Assembler definition Description
            ... ... ...
            TOTRECVE CL1 HFP Version C'3'
            ... ... ...
             

            ==================================================
            Update 5: June 2008
            APAR PK65351

            This section of the technote documents the changes for APAR PK65351.

            Chapter 2. Fast Path Advanced Tool  
            2.3        Job control language (JCL)  
            2.3.2      DD statements  

            The HFPASNAP DD statement is now available for the UNLOAD command, and Table 1. DD statements for program HFPMAIN0 is changed as follows:

            Table 1. DD statements for program HFPMAIN0
            DDNAME
            Use (I:
            Input, O:
            Output)
            Format
            Possibility of dynamic allocation (Y:Yes, N:No)
            Necessity
            (R: Required, O: Optional, -:N/A)
            UNLOAD RELOAD CHANGE ANALYZE DMACPRT EXTRACT REORG
            HFPASNAP
            O
            PS
            N
            O
            O
            O
            O
            -
            -
            O

            --------------------------------------------------
            2.3.2.2     Output

            The description of HFPASNAP DD is changed as follows:

            HFPASNAP DD
            ...

            Table 30. HFPASNAP DD statements  
            Format
            Possibility of dynamic allocation (Y:Yes, N:No)
            Necessity
            (R: Required, O: Optional, -:N/A)
            UNLOAD RELOAD CHANGE ANALYZE DMACPRT EXTRACT REORG
            PS
            N
            O
            O
            O
            O
            -
            -
            O

            An optional DD statement for the UNLOAD,  RELOAD, CHANGE, ANALYZE, and REORG commands. This statement defines the output data set for the CI Map/CI Dump report and the Pointer Chain Reconstruction report.  

            ==================================================
            Chapter 3. Fast Path Advanced Tool command  
            3.1        Commands, subcommands, and keywords  

            The CISNAP keyword is added in Table 40. HFPSYSIN commands, subcommands, and keywords as follows:

            Table 40. HFPSYSIN commands, subcommands, and keywords  
            Command Subcommands Keywords
            UNLOAD FILECTL CISNAP

            ==================================================
            Chapter 5. Unloading a DEDB  
            5.2        Job control language (JCL)
            5.2.2      DD statements
             
            The HFPASNAP DD statement is added to Table 43. DD statements for the UNLOAD command as follows:

            Table 43. DD statements for the UNLOAD command
            DDNAME
            Use (I:
            Input, O:
            Output)
            Format
            Possibility of dynamic allocation (Y:Yes, N:No)
            Necessity (R:Required, O:Optional)
            HFPASNAP
            O
            LRECL=133
            N
            O
             
            --------------------------------------------------
            5.2.2.2    Output

            The description of HFPASNAP DD is added as follows:

            HFPASNAP DD
              This statement defines the output data set for the CI Map/CI Dump report and the Pointer Chain Reconstruction report. This is effective when PTRCHK=DETAIL and CISNAP=YES are specified. For details, see "HFPASNAP DD statement" on page 40.  

            --------------------------------------------------
            5.3        Input for Unload
            5.3.1      HFPSYSIN
            5.3.1.1    UNLOAD command keywords

            The CISNAP keyword is added to Figure 21. UNLOAD command keywords, and its description is added as follows:

            Figure 21. UNLOAD command keywords
            [AREA_INFORMATION_RECORD]
            [COMPRESS]
            [CISNAP]
            ...
             
            CISNAP
              An optional keyword to specify to request the CI Map/CI Dump report and the Pointer Chain Reconstruction report when the unloaded area is analyzed concurrently. For information about coding this parameter, see "CISNAP" on page 217.

            --------------------------------------------------
            5.4        Output for Unload

            Description is changed as follows:

            This section describes the output for unloading a DEDB, which can be one of the following types:  
            • An output data set for all of the database segment records produced for one or more of the areas defined in the output DMB
            • The Processing Messages report in HFPPRINT
            • Reports in HFPRPTS
            • Processed segments statistics records in HFPTOTAL
            • Image copy data set
            • Reports produced by IMS High Performance Image Copy
            • CI Map/CI Dump report and Pointer Chain Reconstruction report in HFPASNAP

            --------------------------------------------------
            5.4.x      HFPASNAP

            A new section is added as follows:

            HFPASNAP
              This section describes the HFPASNAP data set, which is used by the Unload process when PTRCHK=DETAIL and CISNAP=YES are specified.  
              Function  
                This statement defines an output data set that contains the following reports:  
                • CI Map/CI Dump report  
                • Pointer Chain Reconstruction report  
              Format  
                This data set contains 133-byte, fixed-length records. It is recommended that you code your DD statement as follows:

                //HFPASNAP DD SYSOUT=A

                For more information about HFPASNAP, see Appendix B, "Sample reports," on page 291.  

            ==================================================
            Appendix A. Command reference
            A.9         CISNAP

            The description for the CISNAP keyword is changed as follows:

            CISNAP  
              CISNAP is an optional keyword for the following commands:  
              • ANALYZE  
              • CHANGE  
              • GLOBAL  
              • RELOAD  
              • REORG  
              • UNLOAD  

            --------------------------------------------------
            A.61        PTRCHK

            The description for the PTRCHK keyword is changed as follows:

            PTRCHK  
            ...

              parameter
                parameter can be one of the following values:
                ABEND ...

                BYPASS ...

                DETAIL
                  Print pointer error information in the Unloaded report when the child or twin segments of any segment has a pointer error. Processing resumes with the next valid segment in the hierarchical chain. This value can be specified only on the UNLOAD command.

            --------------------------------------------------
            A.100        UNLOAD

            The description for the UNLOAD command is changed as follows:

            UNLOAD
              ...
              Related keywords:  
              • AREA_INFORMATION_RECORD
              • COMPRESS
              • CISNAP
              • ...

              ...

               Syntax:

              >>-- UNLOAD ---------------------------------><-
                           +--...------+---...------+  
                           |                        |  
                           +- CISNAP=--+- NO --+----+
                           |           +- YES -+    |
                           |                        |
                           +- PTRCHK=--+- ABEND --+-+
                                       +- BYPASS -+  
                                       +- DETAIL -+
            ==================================================
            Appendix B. Sample reports  

            The description of the reports for the Unload process is changed as follows:

            In the Unload process, the following reports are generated:  
            • ...
            • Reports related to the Analyze process when PTRCHK=DETAIL is specified (Only when pointer errors are detected)

            --------------------------------------------------
            B.4         Unloaded report  

            Description for the POINTER ERROR DETAILS field is added as follows:  

            POINTER ERROR DETAILS  
              If PTRCHK=DETAIL is specified and the UNLOAD process detects any pointer errors, the same messages as for the Resolve Pointers report are issued. For information about each message, see "Resolve Pointers report messages" on page 422.

            ==================================================
            Appendix F. Site default options support  

            The CISNAP keyword is added to the list of UNLOAD command keywords:

            Keywords that can be registered as site defaults
             
            UNLOAD  
              AREA_INFORMATION_RECORD, CISNAP,  COMPRESS, FORMAT, ICACHE, ICINCOMP, ICNOTIFY, ICOUT, ITASKCTL, KEYCHGCHK, KEYSEQCHK, LRECL, PAD, PTRCHK, SORT, SSP

            ==================================================
            Appendix H. Messages and codes
            H.3         Messages  
            H.3.4       HFPF messages

            Following message is added:

            HFPF0012I POINTER ERROR INFORMATION IS NOT PROVIDED BECAUSE THE INPUT DATA SET IS AN IMAGE COPY.  
                      - AREA NO: nnnn, AREANAME: areaname  

            Explanation: When an image copy data set is provided as an input data set, PTRCHK=DETAIL option is treated as PTRCHK=BYPASS. Therefore, the pointer error information is not provided.  

            System action: Processing continues.  

            Programmer response: None.  
            --------------------------------------------------
            H.3.7       HFPJ messages

            Following messages are added:

            HFPJ0014W POINTER ERROR INFORMATION IS NOT PROVIDED. REASON: xxx  
                      - AREA NO: nnnn, AREANAME: areaname  

            Explanation: The pointer error information is not provided because of one of the following reasons:
            • STORAGE ALLOCATION FAILED FOR THE UOW TABLE  
            • DYNAMIC ALLOCATION FAILED FOR THE REPORT DATA SET  
            • OPEN FAILED FOR THE REPORT DATA SET  

            System action: The return code is set to 4 and processing continues.  

            Programmer response: Correct any errors, and rerun the job.
             
            --------------------------------------------------
            HFPJ0015W CI MAP/CI DUMP REPORT FOR SDEP IS NOT PROVIDED. REASON: xxx  
                      - AREA NO: nnnn, AREANAME: areaname  

            Explanation: The CI map/CI dump report for SDEP is not provided because of one of the following reasons:  
            • DYNAMIC ALLOCATION FAILED FOR THE REPORT DATA SET  
            • OPEN FAILED FOR THE REPORT DATA SET  

            System action: The return code is set to 4 and processing continues.  

            Programmer response: Correct any errors, and rerun the job.


            ==================================================
            Update 4: April 2008
            APAR PK61732

            This section of the technote documents the changes for APAR PK61732.

            Chapter 3. Fast Path Advanced Tool command  
            3.1        Commands, subcommand, and keywords

            New keywords are added to Table 40 "HFPSYSIN commands, subcommands, and keywords" as follows:

            Table 40. HFPSYSIN commands, subcommands, and keywords
            Command Subcommands Keywords
            ANALYZE ...
            • ...
            • ICHECK
            • ...
            CHANGE ...
            • ...
            • ICHECK
            • ...
            ... ... ...
            EXTRACT ...
            • ...
            • ICHECK
            • ...
            • OCHECK
            • ...
            ... ... ...
            RELOAD ...
            • ...
            • ICHECK
            • ...
            UNLOAD ...
            • ...
            • ICHECK
            • ...
            • OCHECK
            • ...

            --------------------------------------------------
            New keywords are added to Table 42 "HFPSYSIN keywords":

            Table 42. HFPSYSIN keywords
            Keyword Purpose of the keyword
            ...
            ICHECK Controls the concurrent number
            of input devices to access by using the ITASKCTL keyword.
            ... ...
            OCHECK Controls the concurrent number
            of output devices to access by using the ITASKCTL keyword.
            ...
            ==================================================
            Appendix A. Command reference  

            New keywords are added to the several sections of Appendix A "Command reference" as follows:

            A.3        ANALYZE  

            Related keywords:  
              • ...
              • ICHECK
              • ...

              Syntax:

              >>-- ANALYZE---------------------------------><-
                           |                        |      
                           +- ............... ------+      
                           |                        |      
                           +- ICHECK=--- NODEFER ---+      
                           |           +-DEFER---+  |      
                           +- ............... ------+      
                 
            --------------------------------------------------
            A.8        CHANGE  
              Related keywords:  
              • ...
              • ICHECK
              • ...

              Syntax:

              >>-- CHANGE----------------------------------><-
                           |                        |      
                           +- ............... ------+      
                           |                        |      
                           +- ICHECK=--- NODEFER ---+      
                           |           +-DEFER---+  |      
                           +- ............... ------+      
                 
            --------------------------------------------------
            A.24        EXTRACT

              Related keywords:  
              • ...
              • ICHECK
              • ...
              • OCHECK

              Syntax:  

              >>-- EXTRACT---------------------------------><-
                           |                        |      
                           +- ............... ------+      
                           |                        |      
                           +- ICHECK=--- NODEFER ---+      
                           |           +-DEFER---+  |      
                           +- ............... ------+      
                           |                        |      
                           +- OCHECK=--- NODEFER ---+      
                                       +-DEFER---+  
               
            --------------------------------------------------
            A.71        RELOAD  
              Related keywords:  
              • ...
              • ICHECK
              • ...

              Syntax:  

              >>-- RELOAD ---------------------------------><-
                           |                        |      
                           +- ............... ------+      
                           |                        |      
                           +- ICHECK=--- NODEFER ---+      
                           |           +-DEFER---+  |      
                           +- ............... ------+      
                 
            --------------------------------------------------
            A.100       UNLOAD
              Related keywords:
              • ...
              • ICHECK
              • ...
              • OCHECK

              Syntax:

              >>-- UNLOAD ---------------------------------><-
                           |                        |      
                           +- ............... ------+      
                           |                        |      
                           +- ICHECK=--- NODEFER ---+      
                           |           +-DEFER---+  |      
                           +- ............... ------+      
                           |                        |      
                           +- OCHECK=--- NODEFER ---+      
                                       +-DEFER---+  
               
            --------------------------------------------------
            New keywords are added in Appendix A. "Command reference":


            ICHECK  
              Use this keyword to control the input devices.

              ICHECK is an optional keyword for the following commands:  
              • ANALYZE
              • CHANGE
              • EXTRACT  
              • RELOAD  
              • UNLOAD  

              Related keywords:
              None.

              Format:  
               
                ICHECK=parameter
               

              parameter  
                parameter  can be one of the following values:  
                  NODEFER  
                    Gets access to all devices that are associated with the input data sets at a time.
                  DEFER
                    Access to devices for obtaining input data sets are limited to the number that is specified by the ITASKCTL keyword.

              Default: ICHECK=NODEFER  

              This keyword can be specified for the site default.  

            --------------------------------------------------
            OCHECK
              Use this keyword to control the output devices.

              OCHECK is an optional keyword for the following commands:
              • EXTRACT  
              • UNLOAD  

              Related keywords:  
              None.

              Format:  
               
                OCHECK=parameter
               

              parameter  
                parameter  can be one of the following values:
                  NODEFER
                    Gets access to all devices that are associated with the output data sets at a time.
                  DEFER
                    Access to devices for obtaining output data sets are limited to the number that is specified by the ITASKCTL keyword.
                    This value is ignored in non-REORG mode (restructure).

              Default: OCHECK=NODEFER

              This keyword can be specified for the site default.

            ==================================================
            Appendix F. Site default options support  
            F.3         Keywords that can be registered as site defaults  

            The new keywords are added as follows:

            --------------------------------------------------------------  

            ANALYZE  
              ATASKCTL, CISNAP, ICACHE, ICHECK , ICINCOMP, ICNOTIFY, ICOUT, PTRCHKLVL, SDEPCHKLVL, SDEP_ORPHAN_MSGLVL  

            CHANGE  
              CISNAP, ICACHE, ICHECK , ICINCOMP, ICNOTIFY, ICOUT, ITASKCTL, KEYCHGCHK, KEYSEQCHK, OCACHE, OTASKCTL, PAD, PTRCHK, PTRCHKLVL, SDEPCHKLVL, SDEP_ORPHAN_MSGLVL, SSP  

            EXTRACT  
              COMPRESS, EFORMAT, ICACHE , ICHECK, ICINCOMP, ITASKCTL, KEYSEQCHK, OCHECK , PTRCHK, SORT  

            RELOAD  
              CISNAP, ICHECK , ICNOTIFY, ICOUT, ITASKCTL, KEYCHGCHK, KEYSEQCHK, OCACHE, PTRCHKLVL, SDEPCHKLVL, SDEP_ORPHAN_MSGLVL, SORT, SSP  

            UNLOAD  
              AREA_INFORMATION_RECORD, COMPRESS, FORMAT, ICACHE, ICHECK , ICINCOMP, ICNOTIFY, ICOUT, ITASKCTL, KEYCHGCHK, KEYSEQCHK, LRECL, OCHECK , PAD, PTRCHK, SORT, SSP  

            ==================================================
            Appendix H. Messages and codes  
            H.3         Messages  

            A new message is added as follows:

            HFPC0017I OCHECK=DEFER IS REPLACED BY OCHECK=NODEFER.  

            Explanation: OCHECK=DEFER for the UNLOAD command was ignored due to running in the non-REORG mode (restructure).  
            System action: Processing continues.  
            Programmer response: None.


            ==================================================
            Update 3: April 2008
            APAR PK61987

            This section of the technote documents the changes for APAR PK61987.

            Chapter 2. Fast Path Advanced Tool  
            2.3        Job control language (JCL)  
            2.3.2      DD statements  

            A new DD is added to Table 1. DD statement for program HFPMAIN0:

            Table 1. DD statement for program HFPMAIN0
            DDNAME
            Use (I:
            Input, O:
            Output)
            Format
            Possibility of dynamic allocation (Y:Yes, N:No)
            Necessity
            (R: Required, O: Optional, -:N/A)
            UNLOAD RELOAD CHANGE ANALYZE DMACPRT EXTRACT REORG
            HFPSEQER
            O
            PS
            N
            O
            -
            O
            -
            -
            -
            -

            --------------------------------------------------
            2.3.2.2    Output

            The description of HFPSEQER DD is added as follows:

            HFPSEQER DD
            Table x  summarizes the characteristics of the HFPSEQER DD statements.

            Table x . HFPSEQER DD statements
            Format
            Possibility of dynamic allocation (Y:Yes, N:No)
            Necessity
            (R: Required, O: Optional, -:N/A)
            UNLOAD RELOAD CHANGE ANALYZE DMACPRT EXTRACT REORG
            PS
            N
            O
            -
            O
            -
            -
            -
            -

            An optional DD statement for the UNLOAD and CHANGE commands. This statement defines the output data set that contains the sequence error segment data records for one or more areas.

            This statement defines an output data set for the sequence error segment data records that are produced for one or more of the areas defined in the "output" ACB library (NEWACB DD statement or IMSACB DD statement in Reorg mode).

            This data set is used when you specify KEYSEQCHK=BYPASS or KEYSEQCHK=WARNING.

            ==================================================

            Chapter 5. Unloading a DEDB  
            5.2        Job control language (JCL)  
            5.2.2      DD statements  

            New DD, HFPSEQER, is added to Table 43. DD statements for the UNLOAD command:

            Table 43. DD statements for the UNLOAD command
            DDNAME
            Use (I:
            Input, O:
            Output)
            Format
            Possibility of dynamic allocation (Y:Yes, N:No)
            Necessity (R:Required, O:Optional)
            HFPSEQER
            O
            PS
            N
            O

            --------------------------------------------------
            5.2.2.2    Output

            The description of HFPSEQER DD is added as follows:

            HFPSEQER DD  
              This statement defines the output data set that contains the sequence error segment data records for one or more areas. For details, see the description of "HFPSEQER DD statement" on page xx.

            ==================================================
            Chapter 7. Changing a DEDB  
            7.2        Job control language (JCL)  
            7.2.2      DD statements  

            New DD, HFPSEQER, is added to Table 45. DD statements for the CHANGE command:

            Table 45. DD statements for the CHANGE command
            DDNAME
            Use (I:
            Input, O:
            Output)
            Format
            Possibility of dynamic allocation (Y:Yes, N:No)
            Necessity (R:Required, O:Optional)
            HFPSEQER
            O
            PS
            N
            O

            --------------------------------------------------
            7.2.2.2    Output

            The description of HFPSEQER DD is added as follows:

            HFPSEQER DD  
              This statement defines the output data set that contains the sequence error segment data records for one or more areas. For details, see the description of "HFPSEQER DD statement" on page xx.

            ==================================================
            Appendix B. Sample reports  
            B.4         Unloaded report  

            SUMMARY OF KEY SEQUENCE ERRORS
              ...
              ERROR SEGMENTS WRITTEN TO HFPSEQER DATA SET
                The number of the segments that were written to the HFPSEQER data set in unloading processes. This information is provided only when the HFPSEQER DD statement is specified together with KEYSEQCHK=BYPASS or KEYSEQCHK=WARNING.


            ==================================================
            Appendix H. Message and Codes  
            H.3         Messages
            H.3.4       HFPF messages  

            The explanation of message HFPF0003W is changed as follows:

            Explanation: The LRECL or BLKSIZE for the USR file or the sequence error segment records file that was specified in ddname  was incorrect. Program HFPMAIN0 overrides the LRECL or BLKSIZE with the system value.  

            --------------------------------------------------
            A new message, HFPF0011I, is added as follows:

            HFPF0011I   ONE OR MORE SEQUENCE ERROR SEGMENTS WERE WRITTEN TO DATA SET.
                      - DDNAME: HFPSEQER, DSNAME: dsname

            Explanation: One or more sequence error segments were written to the data set dsname  that was specified in the HFPSEQER DD statement.  
            System action: Processing continues.  
            Programmer response: None.  

            ==================================================
            A new appendix section is added as follows:

            Appendix y . Sequence error segment records file

            +-----------Product-Sensitive Programming Interface---------+  
            |                                                           |  

            You can use the HFPZSER macro to map these records. Table yy  
            shows the layout, which is a product-sensitive programming  
            interface.

            Table yy . Sequence error segment records layout
            Fied name Assembler definition Description
            "RDW" fields
            SERRDW H H RDW "LL" field
            RDW "ZZ" field
            SERDBD_NAME CL8 DBD name
            SERAREA_NAME CL8 Area name
            SERAREA_NUMBER2 XL2 Area number
            SERSEGNAME CL8 Segment name
            SERSEGLEVEL XL1 Segment level
            SERSEGCODE XL1 Segment code
            SERSCSQ2 XL1,XL3 Seg-Code/Seg Seq. Field for Hierarchical Level 2 Direct Dependent segments (binary zeros for Root Segment)
            • First byte is seg-code of the segment in this Segment data record  
            • Second-forth bytes are a sequential counter of the occurrence of this segment type within this database record
            SERSCSQ3 XL1,XL3 Seg-Code/Seg Seq. Field for Hierarchical Level 3 Direct Dependent segments (binary zeros for Root Segment)
            SERSCSQ4 XL1,XL3 Seg-Code/Seg Seq. Field for Hierarchical Level 4 Direct Dependent segments (binary zeros for Root Segment)  
            SERSCSQ5 XL1,XL3 Seg-Code/Seg Seq. Field for Hierarchical Level 5 Direct Dependent segments (binary zeros for Root Segment)
            SERSCSQ6 XL1,XL3 Seg-Code/Seg Seq. Field for Hierarchical Level 6 Direct Dependent segments (binary zeros for Root Segment)
            SERSCSQ7 XL1,XL3 Seg-Code/Seg Seq. Field for Hierarchical Level 7 Direct Dependent segments (binary zeros for Root Segment)
            SERSCSQ8 XL1,XL3 Seg-Code/Seg Seq. Field for Hierarchical Level 8 Direct Dependent segments (binary zeros for Root Segment)
            SERSCSQ9 XL1,XL3 Seg-Code/Seg Seq. Field for Hierarchical Level 9 Direct Dependent segments (binary zeros for Root Segment)
            SERSCSQA XL1,XL3 Seg-Code/Seg Seq. Field for Hierarchical Level 10 Direct Dependent segments (binary zeros for Root Segment)
            SERSCSQB XL1,XL3 Seg-Code/Seg Seq. Field for Hierarchical Level 11 Direct Dependent segments (binary zeros for Root Segment)
            SERSCSQC XL1,XL3 Seg-Code/Seg Seq. Field for Hierarchical Level 12 Direct Dependent segments (binary zeros for Root Segment)
            SERSCSQD XL1,XL3 Seg-Code/Seg Seq. Field for Hierarchical Level 13 Direct Dependent segments (binary zeros for Root Segment)
            SERSCSQE XL1,XL3 Seg-Code/Seg Seq. Field for Hierarchical Level 14 Direct Dependent segments (binary zeros for Root Segment)
            SERSCSQF XL1,XL3 Seg-Code/Seg Seq. Field for Hierarchical Level 15 Direct Dependent segments (binary zeros for Root Segment)
            SERSEGPKEYL XL2 The length of SERSEGPKEYL
            SERSEGPKEY XLnnn Parent's concatenated key
            SERSEGDATA XLnnn Segment data
            1st two bytes of SERSEGDATA is the length of the segment  

            When a segment is detected as a sequence error, the second to forth bytes of SERSCSQx, which corresponds to the segment level with the key sequence error, show the number of occurrences of previous segments that have no sequence errors. Similarly, in the sequence error segment data record for its child segment, the second to forth bytes of SERSCSQx, which corresponds to the segment level with the key sequence error, show the number of occurrences of previous segments that have no sequence errors.

            |                                                           |  
            +----End of Product-Sensitive Programming Interface---------+    

             
            ==================================================
            Update 2: February 2008

            APAR PK59882

            This section of the technote documents the changes for APAR PK59882.

            Chapter 3. Fast Path Advanced Tool command
            3.1        Commands, subcommands, and keywords

            Three new keywords are added in Table 41 "HFPSYSIN subcommands and keywords" and in Table 42 "HFPSYSIN keywords":

            Table 41. HFPSYSIN subcommands and keywords
            Subcommand Keywords
            ...
            REPORT
            • REPORTDD
            • STARTUOW
            • STOPUOW
            • UOW_REPORT
            ...

            Table 42. HFPSYSIN keywords
            Keyword Purpose of the keyword
            ...
            STARTUOW Specifies the start position of the UOW range for UOWs to be reported in the UOW report and the UOW Exception report.
            STOPUOW Specifies the end position of the UOW range for UOWs to be reported in the UOW report and the UOW Exception report.
            UOW_REPORT Specifies whether to generate the UOW report.
            ...

            ==================================================
            Chapter 9. Analyzing a DEDB
            9.3        Input for Analyze
            9.3.1      HFPSYSIN
            9.3.1.2    REPORT subcommand keyword

            Three keywords are added in Figure 80 "REPORT subcommand keyword":

            Figure 80. REPORT subcommand keyword
             
             REPORTDD
             STARTUOW
             STOPUOW
             UOW_REPORT
             

            Descriptions for these new keywords are added as follows:

            REPORTDD
            ...

            STARTUOW  
              An optional keyword to specify the number that defines the first UOW to be reported in the UOW report and the UOW Exception report. For information about coding this parameter, see STARTUOW on page xx.

            STOPUOW
              An optional keyword to specify the number that defines the last UOW to be reported in the UOW report and the UOW Exception report. For information about coding this parameter, see STOPUOW on page xx.

            UOW_REPORT  
              An optional keyword to specify whether to generate the UOW report. For information about coding this parameter, see UOW_REPORTS on page xx.

            ==================================================
            Appendix A. Command reference

            A.74 REPORT

            Description of the REPORT subcommand is changed as follows:

            REPORT
              ...
              Related keywords:  
              • REPORTDD  
              • STARTUOW  
              • STOPUOW  
              • UOW_REPORT  

              Syntax:

              >>-- REPORT ---------------------------------><-
                           |                        |      
                           +- REPORTDD=ddname ------+      
                           |                        |      
                           +- STARTUOW=parameter ---+      
                           |                        |      
                           +- STOPUOW=parameter ----+      
                           |                        |      
                           +- UOW_REPORT=--- YES ---+      
                                          +- NO -+  
               

            --------------------------------------------------
            Three new keywords are added in Appendix A. "Command reference":

            STARTUOW
              Use this keyword to specify the number that defines the first UOW to be reported in the UOW report and the UOW Exception report.

              STARTUOW is an optional keyword for the REPORT subcommand.

              Related keywords:  
              • STOPUOW  
              • UOW_REPORT  

              Format:
               
                STARTUOW=parameter
               

              parameter  
                Specify a value from 0 to 32767. This value must be less than or equal to the value specified for the STOPUOW keyword.

              Default: STARTUOW=0  

              This keyword can be specified for the site default.

            --------------------------------------------------

            STOPUOW
              Use this keyword to specify the number that defines the last UOW to be reported in the UOW report and the UOW Exception report.

              STOPUOW is an optional keyword for the REPORT subcommand.

              Related keywords:  
              • STARTUOW  
              • UOW_REPORT  

              Format:  
               
                STOPUOW=parameter
               

              parameter  
                Specify a value from 0 to 32767. This value must be greater than or equal to the value specified for the STARTUOW keyword.  

              Default: STOPUOW=32767  

              This keyword can be specified for the site default.  

            --------------------------------------------------

            UOW_REPORT
              Use this keyword to specify whether to generate the UOW report.

              UOW_REPORT is an optional keyword for the REPORT subcommand.  

              Related keywords:
              • STARTUOW  
              • STOPUOW  

              Format:
               
                UOW_REPORT=parameter
               

              parameter  
                parameter can be one of the following values:
                YES
                  Generate the UOW report.
                NO  
                  Do not generate the UOW report.

              Default: UOW_REPORT=YES

              This keyword can be specified for the site default.

            ==================================================
            Appendix H. Messages and codes  
            H.3         Messages  
            H.3.2       HFPC messages

            A new message is added as follows:  

            HFPC0126E INCORRECT UOW RANGE SPECIFIED: STARTUOW=nnnnn, STOPUOW=mmmmm  

            Explanation: An incorrect UOW range was specified. STARTUOW must not be greater than STOPUOW.  
            System action: If SCAN=YES is specified, the return code is set to 8. Or if SCAN=NO is specified, the job ends with an abend code of U3003.  
            Programmer response: Correct the command set in HFPSYSIN, and rerun the job.  


            ==================================================
            Update 1: January 2008

            APAR PK58079

            This section of the technote documents the changes for APAR PK58079. APAR PK56312 has added the support for the XCI randomizer interface for batch, which is provided by IMS Version 10 PK40256.

            Appendix H. Message and Codes  
                        HFPF messages  

            Message HFPF3369E is added as follows:

            HFPF3369E ERROR IN CALL TO RANDOMIZER: randomizer , FUNCTION: functionname  
                      - RETURN CODE: xxxx   REASON CODE: xxxxxxxx  

            Explanation: The function task invoked the XCI randomizer routine to perform an initialization or termination call. The return code from the randomizer routine shown in the error message was not zero.  
            System Action: The job ends with an abend code of U3369.  
            Programmer Response: See the description of the return code and reason code for the XCI randomizer specification. Correct any errors, and rerun the job.


            APAR PK58924

            This section of the technote documents the changes for APAR PK58924.

            Appendix A. Command reference  
            A.90 SORT  

            The description of the SORT keyword is changed as follows:

            ...

            Format:  

            ...

            YES  
              For the UNLOAD command, this keyword is ignored when all of the following conditions are met:
              • A single area is unloaded into the file.
              • The SDEP=LOGICAL keyword is not specified in HFPSYSIN.
              • The Unload function is processed in the REORG mode.  

              For the EXTRACT command, this keyword is ignored when both of the following conditions are met:
              • A single area is extracted into the file.
              • The database that is specified in DBD does not have an SDEP segment.

            ==================================================
            Appendix H. Message and Codes
            H.3. Messages
            H.3.7 HFPJ messages  

            A new message is added as follows:

            HFPJ0013I SORT PROCESS WAS SKIPPED FOR DDNAME: ddname.  

            Explanation: The sort process was skipped for the unloaded segment record file or the extracted output record file that was specified in DD statement ddname.

            For the UNLOAD command, this message is issued when all of the following conditions are met:
            • A single area was unloaded into the file.
            • The SDEP=LOGICAL was not specified in HFPSYSIN.
            • The Unload function was processed in the REORG mode.

            For the EXTRACT command, this message is issued when both of the following conditions are met:  
            • A single area was extracted into the file.
            • The database that was specified in DBD did not have an SDEP segment.  

            System action: Processing continues.  
            Programmer response: None.

            Related information

            HP Fast Path Utilities: Vol.1 Advanced Tool

            Publication number

            SC18-9869-03

            Copyright date

            2000, 2007

            Original publication date

            2007/12/14

            Rate this page:

            (0 users)Average rating

            Add comments

            Document information


            More support for:

            IMS Tools
            IMS HP Fast Path Utilities

            Software version:

            3.2.0

            Operating system(s):

            z/OS

            Reference #:

            7011288

            Modified date:

            2009-01-26

            Translate my page

            Machine Translation

            Content navigation