PK15675: ALLOW ONLINE DATA EXTRACT TO SORT OUTPUT FILE INTERNALLY INSTEADOF HAVING TO INVOKE A SEPERATE SORT STEP - RE: MR0208053646

APAR status

• Closed as new function.

Error description

• FPO ODE provides an option to sort output file (FPXOFILE)
  internallyfor FITS MR0208053646.
  .
  This option is effective when the following conditions are
  satisfied.
    - ODE is run using run-level control.
    - Output file is standard format or DBT unload/reload format.
    - SDEPHIER=YES is not specified in FPXCTL control statement.
  

Local fix

Problem summary

• ****************************************************************
  * USERS AFFECTED: All Online Data Extract users of High        *
  *                 Performance Fast Path Utilities FP Online    *
  *                 Tools Version 2 Release 2 (FMID: H31A220).   *
  ****************************************************************
  * PROBLEM DESCRIPTION: This APAR provides solutions for the    *
  *                      following requirements for Online Data  *
  *                      Extract (requirement number:            *
  *                      MR0208053646):                          *
  *                                                              *
  *                      1. Provide an option to sort output     *
  *                      file internally, and support SORT=YES   *
  *                      with OUTPUT=DBT.                        *
  *                                                              *
  *                      2. Support SDEPHIER keyword when both   *
  *                      OUTPUT=STD and SORT=YES are specified.  *
  ****************************************************************
  * RECOMMENDATION:                                              *
  ****************************************************************
  1. When SORT=YES was specified, Online Data Extract wrote the
  sort control statement to ODESORT DD, and needed separate SORT
  step. SORT=YES could be specified only for standard (STD) format
  output file.
  
  2. Online Data Extract did not support SDEPHIER keyword when
  both OUTPUT=STD and SORT=YES were specified.
  
  The APAR removes the above restrictions.
  

Problem conclusion

Temporary fix

Comments

• Online Data Extract has been enhanced to support the following
  functions:
  
  1. Sort output file internally, instead of writing the sort
  control statement to ODESORT DD.
  
  This function is effective when SORT=YES is specified in FPXCTL
  control statement, ODESORT DD is not specified in the JCL, and
  the following conditions are satisfied.
   - Output file is standard format (OUTPUT=STD), or DBT
     unload/reload format (OUTPUT=DBT).
   - SDEPHIER=YES is not specified in FPXCTL control statement.
   - ODE is run using run-level control.
  
  Sorted output file is written to FPXOFILE DD, or DD specified by
  OFILE= keyword in FPXCTL control statement.
  SDEP segments are not extracted by the function.
  
  2. Extract SDEP segments hierarchically for standard (STD) with
  sort format file.
  
  This function is effective when the following conditions are
  satisfied.
   - OUTPUT=STD,SORT=YES,SDEPHIER=YES is specified in FPXCTL
     control statement.
   - ODESORT DD is specified in JCL.
  
  Extract file can be sorted using separate SORT step, and SORT
  control statement in ODESORT DD.
  
  
  ========================
  = DOCUMENTATION CHANGE =
  ========================
  The IMS High Performance Fast Path Utilities for z/OS User's
  Guide Volume 3: Fast Path Online Tools Version 2 Release 2
  (SC18-9239-01) should be changed as follows:
  (Revision bar shows the part of change)
  
  Part 2. Online Data Extract
   Chapter 6. Using Online Data Extract
    Figure 12. ODE sample JCL and control statements
  
  *The ODESORT DD statement in JCL should be changed as follows,
  
  The following is an example of the ODESORT DD statement:
  //ODESORT  DD  DISP=(NEW,KEEP),
  //             DSN=IMSESA.SORTCARD,
  //             SPACE=(TRK,(1,1),RLSE),
  //             UNIT=SYSALLDA
  
  
  Subsection: JCL Statements
   Subsection: DD Statements
  
  *Description of ODESORT DD should be changed as follows,
  
    ODESORT DD
     Describes the output data set that contains the sort control
  |  statement when SORT=YES.
  |  DCB parameter is not needed. ODE internally sets necessary
  |  DCB attributes.
  
  
  Subsection: Utility Control Statements
   Subsection: FPXCTL Statement
    Subsection: SORT Keyword
  
  *Description of SORT keyword should be changed as follows,
  
  The SORT keyword specifies ...
    ...
    The variable fields are defined as follows:
  | NO  Write the extract in RAP (physical) sequence.
        You can specify just N rather than NO.
  | YES If ODESORT DD statement is specified in the JCL,
  |     Online Data Extract generates the sort control statements
        that will write the extract in ascending root key
        sequence. The sort control statements are written to
        //ODESORT for an offline sort.
  |     If no ODESORT DD statement is specified in the JCL,
  |     extracted information is sorted for output internally
  |     instead of generating sort control statements.
  
        When SORT=YES is specified, a DD statement
  |       //ODESORT DD DISP=SHR,DSN=IMSESA.SORTCARD
  
  |     can be provided. DCB parameter is not needed.
  |     ODE internally sets necessary DCB attributes.
        You can specify just Y rather than YES.
  
    UR  Same as OUTPUT=UR.
    ...
  
    Restrictions:
    - The specification of YES is mutually exclusive with
  | OUTPUT=TFMT, and OUTPUT=UR.
    - If SORT=YES is specified, the SDEP segment is not extracted
  | unless SDEPHIER=YES is specified.
  | - The function of internal sort is effective when ODE is run
  | using run-level control, and SDEPHIER=NO is specified.
  | If no DD statement is found for ODESORT, and ODE is run using
  | area-level control or SDEPHIER=YES is specified, ODE issues
  | the message FPX0002E and ends with an error.
  
  Subsection: Utility Control Statements
   Subsection: FPXCTL Statement
    Subsection: SDEPHIER Keyword
  
  *Description of SDEPHIER keyword should be changed as follows,
  
    The SDEPHIER keyword ...
    ...
    YES SDEP segment records should be extracted hierarchically.
        You can specify just Y rather than YES.
        When SDEPHIER=YES is effective, the SDEP segment records
        are generated immediately after the ROOT record. Each
        record contains the ROOT key.
  |     If SDEPHIER=YES and SORT=YES is specified, the SDEP
  |     segment is extracted together with ROOT and DDEP segments.
  
  Default: If SDEPHIER keyword is not specified, the default is
  NO. If the keyword is specified, but no value is specified, the
  default is YES.
  
  Restrictions: The SDEPHIER keyword is effective only when all of
  the following conditions are satisfied:
    1. OUTPUT=STD
  | 2. SORT=NO, or SORT=YES and ODESORT DD statement is specified
  |    in JCL
    3. SDEP is defined in the DBD definition
  
  
  Appendix D.
   Messages and codes
    Messages
  
  *The FPX0040E, FPX0107E and FPX0114I message descriptions should
  be changed as follows,
  
  | FPX0040E OUTPUT=UR|TFMT mutually exclusive to SORT=YES.
  | Explanation: DEDB TFMT or UR unload/reload format was selected
    for OUTPUT. An unload-formatted file cannot be sorted; this is
    because a sort might create a record sequence that is invalid
    for reload.
    System action: Processing terminates with a return code of 12.
    User response: Correct the incompatible specification, and
    resubmit the job.
    Issuing Module: FPXPARM1
  
  
    FPX0107E SDEPHIER keyword is specified with mutually exclusive
    keyword value or against no SDEP defined DB.
  
    Explanation: The SDEPHIER keyword is specified with one of the
    following specifications:
    - OUTPUT=DBT|TFMT (this keyword and SDEPHIER are mutually
    exclusive)
  | - SORT=YES, and ODESORT DD statement is not specified in JCL
    - A database that has no SDEP defined in the DBD definition
    System Action: Processing terminates with a return code of 12.
    User Response: SDEPHIER keyword cannot be specified when any
    one of the above three conditions is met. Correct the
    incompatible specification, and resubmit the job.
    Issuing Module: FPXPARM1
  
  
    FPX0114I SDEP segment ignored for SORT=YES option: AREA
    NAME=areaname AREA NUMBER=area#
    Explanation: SDEP segment was not extracted because SORT=YES
  | option was specified but SDEPHIER=YES was not specified.
    System Action: Processing continues.
  | User Response: If you need SDEP segment for the extract, you
  | can rerun the job by specifying SDEPHIER=YES to extract SDEP
  | segment with SORT=YES.
    Issuing Module: FPXPROC0
  
  
  *The new FPX0201E message description should be added as
  follows,
  
  FPX0201E SORT ended with internal error. SORT may issue the
  message to SYSOUT DD.
  SORT return code is: nnnn
  Explanation: ODE ended with error during internal sort process.
  nnnn indicates hexadecimal SORT return code. Also, SORT may
  issue the message to SYSOUT DD.
  System Action: Processing ends with an abend code of 3504.
  User Response: Please see SYSOUT DD for further information,
  correct errors, and rerun the job.
  Issuing Module: FPXESRT0
  

APAR Information

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

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

  UK09839

Modules/Macros

•    FPXDRIV0 FPXDRIV7 FPXDRIV8 FPXDRIV9 FPXESDP0
  FPXESRT0 FPXEWPR0 FPXMBLK  FPXMBLK0 FPXMSG00 FPXOURF0 FPXPARM1
  FPXSRCT0 FPXTRCT0 FPXTRSA0 FPXWSRT0 FPXWSTD0 FPXWURF1 H31A220J
  

Fix information

• Fixed component name

  IMS HP FP UTILI

• Fixed component ID

  5655K9400

Applicable component levels

• R220 PSY UK09839

     UP05/12/08 P F512