IBM Support

PH14290: SUPPORT OF FUNCTIONALITY FOR THE AUTOMATIC INSERTION OF CHECKPOINTS INTO IMS PROGRAMS

A fix is available

Subscribe

You can track all active APARs for this component.

 

APAR status

  • Closed as new function.

Error description

  • Add functionality to the IMS Program Restart Facility tool
    that will provide a feature to allow users to have a
    user-controlled checkpoint issued automatically within IMS
    programs that do not have checkpoint logic written into the
    program.
    
    Note:
    The PTF for this issue is now marked PE and is being fixed by
    APAR PH25180.
    

Local fix

Problem summary

  • ****************************************************************
    * USERS AFFECTED: All IBM IMS Program Restart Facility for     *
    *                 z/OS Version 2 Release 2 (FMID=H23D220)      *
    *                 users.                                       *
    ****************************************************************
    * PROBLEM DESCRIPTION: This APAR addresses a requirement to    *
    *                      add a feature that allows users to have *
    *                      user-controlled checkpoints issued      *
    *                      automatically within IMS programs.      *
    ****************************************************************
    * RECOMMENDATION: Apply the maintenance for this APAR.         *
    ****************************************************************
    This enhancement is being implemented as a result of RFE ID
    65860.
    Provide the checkpoint insertion feature to add checkpoint
    calls dynamically without having to change the programs.
    

Problem conclusion

Temporary fix

Comments

  • Provide the checkpoint insertion feature to add checkpoint
    calls dynamically without having to change the programs.
    
    ========================
    = Documentation Change =
    ========================
    IBM IMS Program Restart Facility for z/OS Version 2 Release 2
    User's Guide and Reference(SC19-3985-04) should be changed
    as follows:
    
    ================================================================
    > IMS Program Restart Facility overview
    >> What does IMS Program Restart Facility do?
    * The following text has been added as the last item in the
    * existing bulleted list:
    ----------------------------------------------------------------
    ...
    | You can insert checkpoint calls dynamically into application
    | programs that do not have any or enough checkpoint calls. By
    | using this feature, you can add commit points to batch jobs or
    | add checkpoint calls to application programs that require more
    | checkpoints without having to change the programs. This
    | capability, which is provided by the checkpoint insertion
    | feature, can be applied to various types of applications.
    | For example, you can use this feature when migrating programs
    | from DLIBATCH to BMP or adding checkpoint calls to existing
    | BMP programs.
    ...
    ----------------------------------------------------------------
    ================================================================
    > IMS Program Restart Facility overview
    >> IMS Program Restart Facility features
    * The following section has been added to the bottom of
    * this topic:
    ----------------------------------------------------------------
    ...
    | Checkpoint insertion
    |
    |  In a 24x7 operating environment, most of the databases in the
    |  production environment must be operable 24 hours a day for
    |  365 days a year. Therefore, many users find it necessary to
    |  migrate their DLIBATCH programs, which are run during the
    |  maintenance period, to BMP programs, which run in IMS online
    |  systems. To release the database resources to other programs,
    |  batch programs in data-sharing environments and BMP programs
    |  that run in IMS online systems need to issue checkpoint calls
    |  more frequently than regular batch programs.
    |  However, many DLIBATCH programs that do not assume to be run
    |  in those environments are not coded that way; they do not
    |  have any or enough processes to issue checkpoint calls. So,
    |  if you want to migrate DLIBATCH programs to BMP programs,
    |  you might need to modify those programs to add more commit
    |  points.
    |  By using the checkpoint insertion feature of IMS Program
    |  Restart Facility, you can add checkpoint calls dynamically
    |  without having to change the programs. This feature supports
    |  applications that do or do not currently issue checkpoint
    |  calls, so you can use it on various applications, such as
    |  the programs that are to be migrated from DLIBATCH to BMP
    |  or those that require more checkpoint calls.
    |  For more information about the procedures and considerations
    |  on this feature, see Chapter 5, "Using IMS Program Restart
    |  Facility."
    |
    ...
    ----------------------------------------------------------------
    ================================================================
    > Product options reference
    * The following topic has been added between "Symbolic
    * parameters for log data set names" and "IMS groups":
    ----------------------------------------------------------------
    ...
    | Checkpoint insertion feature options reference
    |
    |  By using the checkpoint insertion feature of IMS Program
    |  Restart Facility, you can add checkpoint calls dynamically
    |  without having to change the programs.
    |  You can control how you want to use this feature by
    |  specifying the options that are documented in this section.
    |  The following options are available for this feature:
    |   - ISRTCHKP: Specifies whether you want to enable the
    |               checkpoint insertion feature.
    |   - PCB:      Specifies which PCBs are to be used when
    |               determining the trigger for checkpoint call
    |               insertion.
    |   - ICPINTVL: Specifies the minimum time interval between
    |               checkpoint call insertions.
    |   - POS, CALLTYPE, and ICSTLST:
    |               Specifies what will be the trigger for
    |               checkpoint call insertion. If more than one of
    |               these options is specified, a checkpoint call
    |               is inserted if any of those conditions is
    |               satisfied.
    |
    |   ISRTCHKP=YES | NO
    |     The ISRTCHKP option specifies whether to enable the
    |     checkpoint insertion feature. By using this feature, you
    |     can insert checkpoint calls dynamically into an
    |     application that does not have any or enough checkpoints.
    |
    |     Important: Enable this feature through job override
    |     options or the IRT$CNTL DD statement. It is not
    |     recommended that you enable this feature in global
    |     options unless you have in-depth understanding of all
    |     the applications that are run under IMS Program Restart
    |     Facility.
    |
    |     Specify one of the following values for this option:
    |
    |       YES:  The checkpoint insertion feature is enabled. By
    |             specifying other options described in this
    |             section, you can control how IMS Program Restart
    |             Facility behaves when running this feature.
    |       NO :  The checkpoint insertion feature is disabled.
    |
    |     The default value is NO.
    |
    |   CALLTYPE=GU | NO
    |     The CALLTYPE option specifies whether to use GU and GHU
    |     calls as the trigger for checkpoint call insertion.
    |
    |     Specify one of the following values for this option:
    |
    |       GU :  GU and GHU calls are used as the trigger to
    |             insert checkpoint calls.
    |             A checkpoint call is inserted if both of the
    |             following conditions are satisfied:
    |             - The time interval specified by the ICPINTVL
    |               option has passed
    |             - A GU call against the PCB specified by the PCB
    |               parameter ends successfully
    |             After a checkpoint call is inserted, each database
    |             will be repositioned to its original position
    |             (before checkpoint call insertion).
    |
    |       NO :  GU and GHU calls are not used as the trigger to
    |             insert checkpoint calls.
    |
    |     The default value is NO.
    |
    |   POS=ROOT | NO
    |     The POS option specifies whether to use GN and GHN calls
    |     as the trigger for checkpoint call insertion.
    |
    |     Specify one of the following values for this option:
    |
    |       ROOT :GN and GHN calls are used as the trigger to
    |             insert checkpoint calls.
    |             A checkpoint call is inserted if both of the
    |             following conditions are satisfied:
    |             - The time interval specified by the ICPINTVL
    |               option has passed
    |             - A GN or GHN call against the PCB specified by
    |               the PCB parameter reaches the root segment
    |             After a checkpoint is inserted, each database
    |             will be repositioned to its original position
    |             (before checkpoint insertion).
    |
    |       NO   :GU and GHU calls are not used as the trigger to
    |             insert checkpoint calls.
    |
    |     The default value is NO.
    |
    |   ICPINTVL=hhmmssth
    |     The ICPINTVL option specifies the minimal time interval
    |     between checkpoint call insertions. IMS Program Restart
    |     Facility takes the following types of checkpoint calls
    |     into account to calculate the checkpoint interval:
    |     - Checkpoint calls that were issued from within the
    |       application
    |     - Checkpoint calls that were issued from IMS Program
    |       Restart Facility
    |
    |     Important: Set an appropriate checkpoint interval to
    |     avoid too many checkpoints, which might affect the job
    |     elapsed time and system performance.
    |
    |     Specify the minimal time interval as an 8-digit number in
    |     the form hhmmssth, where:
    |       hh: hours
    |       mm: minutes
    |       ss: seconds
    |        t: tenths of a second
    |        h: hundredths of a second
    |
    |     For example, if you specify ICPINTVL=00050000, IMS
    |     Program Restart Facility will wait for 5 minutes after
    |     the last checkpoint call. After 5 minutes have passed,
    |     a checkpoint call will be inserted when the specified
    |     triggers occur on the specified PCB.
    |
    |     If you do not specify this option, the setting in the
    |     global options takes effect.
    |
    |   PCB= nnnn | name | *
    |     The PCB option specifies which PCB or PCBs will be used
    |     when determining the trigger for checkpoint call
    |     insertion. For example, if you specify PCB=PCB01, a
    |     checkpoint call is inserted if both of the following
    |     conditions are satisfied:
    |     - The time interval specified by the ICPINTVL option
    |       has passed
    |     - PCB01 satisfies any of the conditions specified by
    |       the CALLTYPE, POS, or ICSTCLST option
    |
    |     Specify one or more PCBs in the following three ways:
    |
    |       nnnn :Specifies the PCB number in a range of 2-2500. 1
    |             indicates the IOPCB. If you specify a PCB number,
    |             AIB calls are not used as the trigger for
    |             checkpoint call insertion.
    |             Important: The PCB number is the sequence number
    |             of the PCB in the generated PCB list, which does
    |             not include the PCBs for which LIST=NO was
    |             specified. For example, if the PSB definition
    |             contains an IOPCB followed by four PCBs, specify
    |             PCB=4 for the fifth PCB if the third PCB is
    |             specified with LIST=NO.
    |
    |       name :Specifies the PCB name.
    |
    |        *   :Specifies that IMS Program Restart Facility uses
    |             all database PCBs to determine whether a
    |             checkpoint call should be inserted.
    |
    |     You cannot specify either IOPCB or GSAM PCB as the PCB
    |     parameter.
    |     If you do not specify this option, the setting in the
    |     global options takes effect.
    |
    |   ICSTCLST=status_codes
    |     The ICSTCLST option specifies one to five DL/I status
    |     codes. IMS Program Restart Facility inserts a checkpoint
    |     call if both of the following conditions are satisfied:
    |     - The time interval specified by the ICPINTVL option
    |       has passed
    |     - One of the specified DL/I status codes is returned
    |       from a DL/I call against the PCB specified by the
    |       PCB parameter
    |
    |     If you want to insert checkpoint calls only when the
    |     end of the database is reached, specify as follows:
    |       ICSTCLST=GB
    |     If you want to insert checkpoint calls if DL/I status
    |     code GB, FG, or FW is returned, specify as follows:
    |       ICSTCLST=GBFGFW
    |     You can specify up to five DL/I status codes. If you do
    |     not want to insert checkpoint calls for any specific
    |     DL/I status codes, leave this field blank.
    |
    |   ICSTCLST=status_codes
    |
    ...
    ----------------------------------------------------------------
    ================================================================
    ×**** PE20/05/07 FIX IN ERROR. SEE APAR PH25180  FOR DESCRIPTION
    

APAR Information

  • APAR number

    PH14290

  • Reported component name

    IMS PGM RESTART

  • Reported component ID

    5655E1400

  • Reported release

    220

  • Status

    CLOSED UR1

  • PE

    NoPE

  • HIPER

    NoHIPER

  • Special Attention

    YesSpecatt / New Function / Xsystem

  • Submitted date

    2019-07-09

  • Closed date

    2020-04-16

  • Last modified date

    2020-05-18

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

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

    UI69021

Modules/Macros

  • IRT141B  IRT151B  IRTC11   IRTC12   IRTDBQ14 IRTDBQ15 IRTDLHK0
    IRTFCMD0 IRTFPA14 IRTFPA15 IRTFPB14 IRTFPB15 IRTFPH14 IRTFPH15
    IRTFSC14 IRTFSC15 IRTINCL  IRTIXT14 IRTIXT15 IRTLFE14 IRTLFE15
    IRTLPH14 IRTLPH15 IRTOPG   IRTOPG7  IRTOPJ   IRTOPJ7  IRTOPTA
    IRTOPTJ  IRTOPTL  IRTOPTR  IRTPRE00 IRTPRE10 IRTRCC00 IRTRFE14
    IRTRFE15 IRTXSC14 IRTXSC15 IRTZF701 IRTZF702 IRTZF703 IRTZF704
    IRTZF705 IRTZF706 IRTZGETV IRTZINIT IRTZOPGE IRTZOPJE IRTZPUTV
    

Publications Referenced
SC19398504    

Fix information

  • Fixed component name

    IMS PGM RESTART

  • Fixed component ID

    5655E1400

Applicable component levels

  • R220 PSY UI69021

       UP20/04/21 P F004  

Fix is available

  • Select the PTF appropriate for your component level. You will be required to sign in. Distribution on physical media is not available in all countries.

[{"Business Unit":{"code":"BU058","label":"IBM Infrastructure w\/TPS"},"Product":{"code":"SSV7D2","label":"IMS Tools"},"Platform":[{"code":"PF025","label":"Platform Independent"}],"Line of Business":{"code":"LOB35","label":"Mainframe SW"}}]

Document Information

Modified date:
28 November 2022