Updates to IMS Library Integrity Utilities V2.1 User's Guide

Product documentation


Abstract

Updates that apply to IMS Library Integrity Utilities V2.1 User's Guide (SC19-2479-01).

Content

The most recent update is listed first.



Update 17
Date of change:
March 2014
Change description:
User's Guide update. IMS Version 13 supports the following online database change capabilities for HALDBs and DEDBs:
  • Combination of the INITIATE OLREORG command (with the ALTER option) and the online change (OLC) function to alter the definition of an online HALDB database
  • DEDB Alter utility (DBFUDA00) to alter the definition of an online DEDB database
This documentation update adds steps for changing online databases with these capabilities when Integrity Checker's DMB verification is turned on for the databases.
Topic:
> 3.0 Integrity Checker utility
>> 3.4 Considerations for Integrity Checker

The following sections have been added to the end of this topic:

Considerations when altering the definition of an online HALDB with the INITIATE OLREORG and online change commands

When you use IMS commands to alter the definition of an online HALDB database, which are the INITIATE OLREORG command with the ALTER option and an online change command, you must temporarily stop the DMB verification. Then, after the new definition is applied to the online database, you must restart the DMB verification with new RDEs that contain the new definition. Without these steps, the DMB verification is done with the old definition that was used before the change, and, therefore, Integrity Checker might deny pertinent accesses to the database.

Note: The ALTER option is supported in IMS Version 13 and later.

The following figure shows the steps to alter the definition of an online HALDB database that has DMB verification turned on.


Figure 1. Steps to alter an online HALDB that has DMB verification turned on

The following step numbers correspond to the steps in the figure. Steps 3 and 6 are Integrity Checker utility steps, other steps are for IMS utilities and functions.
Important: These steps must be completed in the order that they are listed.
  1. Run the DBDGEN procedure with the new definition to update the DBD member in the DBD library with the new database structure.
  2. Run the ACBGEN utility to update the ACB member in the staging ACBLIB.
  3. Stop the DMB verification by issuing the following LICON utility command:
    CHANGE.DB DBD(dbname) CHECKON(N)
  4. Apply the new definition to the online database by issuing the INITIATE OLREORG command with the OPTION(ALTER) parameter.
    IMS reads the staging ACB library and applies the changes to the online database.
    The ALTER option is supported only by the type-2 format of the command. For more information about the command, see the topic "INITIATE OLREORG command" in IMS Commands.
  5. Use the ACB member online change (OLC) function to activate the new ACB member.
    The new DBD definition is applied to the ACBLIB and is used for accessing the altered database.
    For more information about the ACB member online change function, see the topic "Changing or adding IMS.ACBLIB members online" in IMS System Administration.
  6. Re-create the RDEs to reflect the new definition and start the DMB verification by issuing the following LICON utility command:
    INIT.DB DBD(dbname) CHECKON(Y,D) REPLACE
    The DMB verification is started with the new DBD definition.

Considerations when altering the definition of an online DEDB with the DEDB Alter utility (DBFUDA00)

When you use the DEDB Alter utility (DBFUDA00) to alter the definition of an online DEDB, you must temporarily stop the DMB verification. Then, after the new definition is applied to the online database, you must restart the DMB verification with new RDEs that contain the new definition. Without these steps, the DMB verification is done with the old definition that was used before the change, and, therefore, Integrity Checker might deny pertinent accesses to the database.

Note: The DEDB Alter utility is supported in IMS Version 13 and later.

The following figure shows the steps to alter the definition of an online DEDB that has DMB verification turned on.


Figure 2. Steps to alter an online DEDB that has DMB verification turned on

The following step numbers correspond to the steps in the figure. Steps 3 and 5 are Integrity Checker utility steps, other steps are for IMS utilities and functions.
Important: These steps must be completed in the order that they are listed.
  1. Run the DBDGEN procedure with the new definition to update the DBD member in the DBD library with the new database structure.
  2. Run the ACBGEN utility to update the ACB member in the staging ACBLIB.
  3. Stop the DMB verification by issuing the following LICON utility command:
    - When altering a DEDB area, issue: CHANGE.DB DBD(dbname) AREA(areaname) CHECKON(N)
    - When replacing the randomizer, issue: CHANGE.DB DBD(dbname) CHECKON(N)
  4. Run the DEDB Alter utility to apply the changes to the online DEDB.
    The new DBD definition is applied to the ACBLIB and is used for accessing the altered database.
    For more information about the DEDB Alter utility, see the topic "DEDB Alter utility (DBFUDA00)" in IMS Database Utilities.
  5. Re-create the RDEs to reflect the new definition and start the DMB verification by issuing the following LICON utility command:
    - When altering a DEDB area, issue: INIT.DB DBD(dbname) AREA(areaname) CHECKON(Y,D) REPLACE
    - When replacing the randomizer, issue: INIT.DB DBD(dbname) CHECKON(Y,D) REPLACE
    The DMB verification is started with the new DBD definition.




Update 16
Date of change: November 2012
Change description: User's guide update. A description about the DFS3PPRM DD statement has been added to the topic "8.3 JCL requirement for Advanced ACBGEN". For more information about this update, see the Update 10 section of this techdoc.




Update 15
Date of change: October 2012
Change description: Documentation changes by APAR PM72387. This APAR enables the DBD/PSB/ACB Reversal utility to obtain and use GSAM information from DBDs or PSBs when decoding or reporting ACBs.
Topics: Changes apply to the following multiple topics.

> 7.0 DBD/PSB/ACB Reversal utility
>> 7.4 JCL requirements for DBD/PSB/ACB Reversal

Descriptions have been changed as follows:

DBDLIB DD
    This statement is required when processing DBDs. This statement is also required when you specify the OPTION ACB_GSAM=YES option to process ACBs that have GSAM information.
    The DBDLIB DD input data set is the load library that contains the DBDs for which reports and control statements are created.

PSBLIB DD
    This statement is required when processing PSBs. This statement is also required when you specify the OPTION ACB_GSAM=YES option to process ACBs that have GSAM information.
    The PSBLIB DD input data set is the load library that contains the PSBs for which reports and control statements are created.

---------------------------------------
>> 7.5 Control statements for DBD/PSB/ACB Reversal

This topic has been changed as follows:

The input to the DBD/PSB/ACB Reversal utility consists of control statements in the SYSIN data set. These control statements specify the functions to be performed and the runtime options.

The DBD/PSB/ACB Reversal utility supports two types of control statements:
Runtime option control statements
    This type of statement specifies the runtime options. A runtime option control statement consists of a runtime option keyword and its associated options.
Function control statements
    This type of statement specifies the function to be performed. A function control statement consists of a function keyword, a function keyword operand, and a function keyword option.

Subsections:
    Control statement example
    Syntax rules
    Control statement keywords
    Runtime option control statements
    Function control statements
    Operands Function keyword operands
    Options Function keyword options
    Quick reference for control statements and DD statements

Control statement example

The following figure shows an example of the control statements for DBD/PSB/ACB Reversal.

Note: This figure shows all combinations of keywords, operands, and options.

In this example:
  • The first line specifies the SYSIN DD.
  • The second and third lines specify runtime option control statements.
    • ACB_GSAM=YES is applied to all the subsequent function control statements except for the statements that contain a SEGREF function keyword.
    • COMMENT=YES and COMPRESS=YES are applied to all the subsequent function control statements that contain a DECODE function keyword.
  • The fourth and subsequent lines specify function control statements. All combinations of keywords, operands, and options are included in this example.


      //SYSIN DD *
              OPTION ACB_GSAM=YES
              DECOPT COMMENT=YES,COMPRESS=YES
            DECODE DBD ALL
            DECODE DBD INCLUDE= member , member ,...
            DECODE DBD EXCLUDE= member , member ,...
            DECODE PSB ALL
            DECODE PSB INCLUDE= member , member ,...
            DECODE PSB EXCLUDE= member , member ,...
            DECODE ACB ALL
            DECODE ACB INCLUDE= member , member ,...
            DECODE ACB EXCLUDE= member , member ,...
            DECODE ACBPSB ALL
            DECODE ACBPSB INCLUDE= member , member ,...
            DECODE ACBPSB EXCLUDE= member , member ,...
            DECODE ACBDBD ALL
            DECODE ACBDBD INCLUDE= member , member ,...
            DECODE ACBDBD EXCLUDE= member , member ,...
            LIST DBD ALL
            LIST DBD INCLUDE= member , member ,...
            LIST DBD EXCLUDE= member , member ,...
            LIST PSB ALL
            LIST PSB INCLUDE= member , member ,...
            LIST PSB EXCLUDE= member , member ,...
            LIST ACB ALL
            LIST ACB INCLUDE= member , member ,...
            LIST ACB EXCLUDE= member , member ,...
            DDNAMES DBD ALL
            DDNAMES DBD INCLUDE= member , member ,...
            DDNAMES DBD EXCLUDE= member , member ,...
            DDNAMES ACB ALL
            DDNAMES ACB INCLUDE= member , member ,...
            DDNAMES ACB EXCLUDE= member , member ,...
            PROCOPT PSB ALL
            PROCOPT PSB INCLUDE= member , member ,...
            PROCOPT PSB EXCLUDE= member , member ,...
            PROCOPT ACB ALL
            PROCOPT ACB INCLUDE= member , member ,...
            PROCOPT ACB EXCLUDE= member , member ,...
            XREF DBD ALL
            XREF DBD INCLUDE= member , member ,...
            XREF DBD EXCLUDE= member , member ,...
            XREF PSB ALL
            XREF PSB INCLUDE= member , member ,...
            XREF PSB EXCLUDE= member , member ,...
            XREF ACB ALL
            XREF ACB INCLUDE= member , member ,...
            XREF ACB EXCLUDE= member , member ,...
            XREF PSB ALL DBDNAME= member
            XREF ACB ALL DBDNAME= member
            SEGREF DBD ALL SEGMENT= segname
            SEGREF DBD INCLUDE= member , member ,... SEGMENT= segname
            SEGREF DBD EXCLUDE= member , member ,... SEGMENT= segname
            SEGREF PSB ALL SEGMENT= segname
            SEGREF PSB INCLUDE= member , member ,... SEGMENT= segname
            SEGREF PSB EXCLUDE= member , member ,... SEGMENT= segname
      /*

Figure 61. Control statements for DBD/PSB/ACB Reversal

...

Runtime option control statements

Runtime option control statements control the behavior of the subsequent function control statements. When no function control statements follow a runtime option control statement, the runtime option control statement is not used.

The following keywords are available (the abbreviations that can be used are shown in parentheses):

OPTION
    This keyword affects all the subsequent function control statements. This keyword is optional. If specified, it must be placed before any other control statements (blank and comment lines can precede the OPTION keyword), and must be followed by the following keyword:

    ACB_GSAM=
    Specifies whether to obtain and use GSAM information when decoding or reporting ACBs.
      YES
        DBD/PSB/ACB Reversal obtains GSAM information from the DBD and PSB libraries when processing ACBs, and uses the information to decode or to report the ACBs. ACB_GSAM=YES affects the following function control statements:
        • DECODE ACB
        • DECODE ACBPSB
        • LIST ACB
        • DDNAMES ACB
        • PROCOPT ACB
        • XREF ACB

        To specify ACB_GSAM=YES, the following conditions must be met:
        • ACBLIB DD, DBDLIB DD, and PSBLIB DD must be specified in the JCL.
        • The DBD or the PSB must be consistent with the ACB.
      NO
        DBD/PSB/ACB Reversal does not use GSAM information to process ACBs. ACB_GSAM=NO is the default value.

DECOPT (DO)
    This keyword affects all the subsequent DECODE statements. The following options can be specified:
    COMMENT= (C=)
    Specifies whether this program prints the comment lines (the heading part of the DATASET, SEGM, or PCB statement) from the decoded DBD or PSB sources.
      YES
        The comment lines are printed. COMMENT=YES is the default value.
      NO
        The comment lines are not printed.

    COMPRESS= (COMP=)
    This option specifies whether the decoded DBD or PSB sources are printed in compressed format.
    Note: In the DBD/PSB/ACB Reversal utility of Library Management Utilities and other prior products, non-compressed format was used.
      YES
        The decoded sources are printed in compressed format. COMPRESS=YES is the default value.
      NO
        The decoded sources are printed in noncompressed format.

    In the following example, the options specified on the DECOPT statement affect the two DECODE statements:

             DECOPT COMMENT=NO,COMPRESS=NO
             DECODE DBD ALL
             DECODE PSB ALL

Function control statements

Function control statements specify the functions to be performed. A function control statement consists of a function keyword, a function keyword operand, and a function keyword option. The following function keywords can be used (the abbreviations that can be used are shown in parentheses):

DECODE (D)
    This keyword specifies that this program re-creates the control statements of the IMS DBDGEN/PSBGEN utility in the SYSPUNCH data set or the DBDSRC/PSBSRC data set, or both.

DECOPT (DO)
    This keyword specifies the option that is used for processing all the succeeding DECODE statements. The following option is available:
...

Function keyword o perands

The following operands can be specified on the function control statements (the abbreviation that can be used is shown in parentheses):
...

Function keyword o ptions

The following options can be specified on the function control statements (the abbreviation that can be used is shown in parentheses):
...

Quick reference for control statements and DD statements

The following table lists the DBD/PSB/ACB Reversal functions, control statements, and DD statements.

Table. DBD/PSB/ACB Reversal functions, control statements, and DD statements
(Table 12 in PDF and BookManager formats)
Function ... DBDLIB PSBLIB ... OPTPRT
... ... ... ... ... ...
ACB reversal ... O (*5) O (*5) ... ...
ACB reversal
(PSB-type only)
... O (*5) ... ...
... ... ... ... ... ...
DBD summary ... ... ... ... O
PSB summary ... ... ... ... O
ACB summary ... O (*5) O (*5) ... O
PCB PROCOPT ... ... ... ... O
PCB/ACB(PSB) PROCOPT ... ... O (*5) ... O
DBD-DBD XREF ... ... ... ... O
PSB-DBD XREF ... ... ... ... O
ACB(DBD)- ACB(DBD) XREF ... ... O (*5) ... O
ACB(PSB)- ACB(DBD) XREF ... ... O (*5) ... O
DDname XREF ... ... ... ... O
DDname XREF
(ACB(DBD))
... O (*5) O (*5) ... O
... ... ... ... ... ...
Notes:
1. ...
...
5. When the ACB reversal or the report function is run with OPTION ACB_GSAM=YES, the DD statement is required.

---------------------------------------
>> 7.7 Output from DBD/PSB/ACB Reversal
>>> 7.7.7 OPTPRT data set

The following description has been modified:

This report is printed when both of the following conditions are met:
  • The OPTPRT DD statement is specified in JCL.
  • The DECODE statement is specified in the SYSIN data set
  • One or more function control statements (except for SEGREF control statements) are specified in the SYSIN data set.

---------------------------------------
>> 7.8 DBD/PSB/ACB Reversal Site Default Generation utility
>>> 7.8.4 Control statements for the Reversal Site Default Generation utility

The description has been changed as follows:

The Reversal Site Default Generation utility analyzes the runtime option control statements DECOPT statements and sets the site default values.
Other control statement keywords, such as DECODE, are ignored. If the keywords are omitted, the DBD/PSB/ACB Reversal utility system default values will be used.

OPTION
    This control statement keyword is required if a DECOPT statement is not specified. The following table shows the runtime options that are available for this control statement keyword.

DECOPT
    This control statement keyword is required if an OPTION statement is not specified. The following table shows the runtime options that are available for this control statement keyword.

Table. Options for the site default in the SYSIN control statement
(Table 14 in PDF and BookManager formats)
Keyword Option (abbreviation) Operand
OPTION ACB_GSAM YES or NO
DECOPT COMMENT (C) YES or NO
DECOPT COMPRESS (COMP) YES or NO

=======================================
> 13.0 Troubleshooting
>> 13.4 IMS Library Integrity Utilities messages
>>> 13.4.3 FABN messages

The following messages have been modified:

FABN0007 W E UNKNOWN KEYWORD IN SYSIN

Explanation: There is an unknown keyword in the SYSIN data set.
System action: The DBD/PSB/ACB Reversal skips this record and continues processing. ends with RC=16.
User response: Correct the keyword, and rerun the utility.

---------------------------------------
FABN0036E BLDL FAILED FOR ACB [ACB | PSB] DIRECTORY             

Explanation: An error occurred while a BLDL macro was being issued for the ACB or PSB directory.
System action: The DBD/PSB/ACB Reversal utility skips this control statement and continues processing.
User response: Determine the cause of the BLDL macro failure, correct it, and rerun the utility.

---------------------------------------
FABN0062I DECOPT keyword USED IS: xxxxxxxxx

Explanation: The DBD/PSB/ACB Reversal utility proceeds with the indicated DECOPT runtime option.
System action: The DBD/PSB/ACB Reversal utility continues processing.
User response: None.

---------------------------------------
FABN1107 W E UNKNOWN KEYWORD IN SYSIN: keyword

Explanation: keyword, which is specified in the SYSIN data set, is not a valid keyword.
System action: The site default generation utility skips this record and continues processing. ends with RC=16.
User response: Determine if the correct input control statement for site default is supplied. If necessary, correct the keyword and rerun the utility.

---------------------------------------
FABN1109 W E UNKNOWN OPTION IN SYSIN: option

Explanation: option, which is specified in the SYSIN data set, is not a valid option.
System action: The site default generation utility skips this record and continues processing. ends with RC=16.
User response: Determine if the correct input control statement for site default is supplied. If necessary, correct the keyword and rerun the utility.

---------------------------------------
FABN1023I DECOPT keyword OPTION USED: option

Explanation: The site default generation utility proceeds with the DECOPT runtime option.
System action: The site default generation utility continues processing.
User response: None.

---------------------------------------
The following messages have been added:

FABN0074I THE INFORMATION ABOUT GSAM [DBD | PCB] IS RETRIEVED FROM membername

Explanation: The DBD/PSB/ACB Reversal utility is attempting to obtain GSAM DBD information from a DBD member in the DBDLIB or GSAM PCB information from a PSB member in the PSBLIB.
System action: The DBD/PSB/ACB Reversal utility continues processing.
User response: None.

---------------------------------------
FABN0075E membername IS NOT CONSISTENT BETWEEN ACBLIB AND [DBDLIB | PSBLIB]

Explanation: The member in the ACBLIB is not consistent with the member that has the same name in the DBDLIB or PSBLIB.
System action: The DBD/PSB/ACB Reversal utility skips the member in the ACBLIB and continues processing.
User response: Determine if the correct DBDLIB or PSBLIB is specified on the DD statement. If necessary, rerun the utility.

---------------------------------------
FABN0076E THE keyword STATEMENT IS INCORRECT

Explanation: Either the option that is specified for the indicated keyword is incorrect or the order of the keywords in the SYSIN data set is incorrect.
System action: The DBD/PSB/ACB Reversal ends with RC=16.
User response: Ensure that the option specified for the indicated keyword is correct. If an OPTION statement is specified, ensure that the statement is located at the top of the SYSIN data set. Rerun the utility. 

---------------------------------------
FABN1111E THE keyword STATEMENT IS INCORRECT

Explanation: Either the option that is specified for the indicated keyword is incorrect or the order of the keywords in the SYSIN data set is incorrect.
System action: The site default generation utility ends with RC=16.
User response: Ensure that the option specified for the indicated keyword is correct. If an OPTION statement is specified, ensure that the statement is located at the top of the SYSIN data set. Rerun the utility. 




Update 14
Date of change: September 2012
Change description: Documentation changes by APAR PM64743. This APAR changes the behavior of the Integrity Checker utility not to issue messages when a global option module is not found in the STEPLIB concatenation.
Topics: Changes apply to the following multiple topics.

> 3.0 Integrity Checker utility
>> 3.1 Integrity Checker Overview

Descriptions under the Function overview section has been updated as follows:

Function overview

To verify that the correct DMB is used, while DBRC is authorizing the database, Integrity Checker compares the contents of the DMB that IMS is using against the registered DMB information (registered DMB entries are referred to as RDE), which is stored in the IMS LIU Integrity Control data set (also referred to as LICON data set). This verification process is called DMB verification.

The DMB verification process runs in the background of IMS DBRC region, IMS batch programs, IMS utility programs, or IMS Tools programs when these jobs are run with DBRC active (DBRC=Y).

To activate the DMB verification function, create an Integrity Checker global option module, and locate the global option module and LIU load modules in the STEPLIB, JOBLIB, LPA or ELPA, or LNKLST libraries where z/OS searches for executable programs.

Integrity Checker also enables you to control DMB verification, which is done by the global option modules. You can specify your preference for how to do the DMB verification for both the installation level and the IMS subsystem level.

...

STEPLIB (global option module) has been added to the following figure:

Figure. How Integrity Checker prevents database corruption
(Figure 4 in PDF and BookManager formats)


---------------------------------------
>> 3.2 Integrity Checker key concepts
>>> 3.2.3 What is a global option module?

The first paragraph has been changed as follows:

A global option module controls whether to activate the DMB verification process. It provides the necessary information to run Integrity Checker.

At least one global option module must be created and be added to the STEPLIB concatenation of the job in which you want to activate the DMB verification process.


---------------------------------------
>> 3.5 Activating Integrity Checker

The description for activating Integrity Checker has been updated as follows:

Activating Integrity Checker includes several steps. ...

Before you begin

...
If you have deactivated Integrity Checker by following the instructions in "3.6.2 Deactivating LIU that is installed as a component of IMS Tools solution pack", the DSPCRTR0 alias name must be restored before activating Integrity Checker. Complete the steps in "3.7. Reactivating Integrity Checker after deactivation" before proceeding with these steps.

Procedure
  1. Create global option modules.
  2. Estimate the size of the LICON data set.
  3. Define and initialize the LICON data set.
  4. Register DMB information.
  5. Add DD statements to JCL and procedures of DBRC, IMS batch application, IMS utility, and IMS Tools.
  6. Configure the members of the IMS PROCLIB data set (required if BPE-based DBRC is used).
  7. Set up security for the LICON data set (optional step).
  8. Serialize the LICON data set (optional step).
  9. Restart IMS online and run IMS batch application, IMS utility, and IMS Tools jobs.

---------------------------------------
>>> 3.5.5 Adding DD statements to DBRC and DLIBATCH procedures

The title of this topic has been changed as follows:

Adding DD statements to JCL and procedures of DBRC, IMS batch application, IMS utility, and IMS Tools

The content of this topic has been changed as follows:

You must add DD statements to JCL and cataloged procedures for all the jobs in which you want to activate Integrity Checker. These JCL and procedures include those for DBRC, IMS batch application, IMS utility, and IMS Tools jobs that update IMS databases.

Procedure
Add the DD statements to the following cataloged procedures:
  • Online DBRC procedure for a non-BPE-based DBRC region or for a BPE-based DBRC region
  • Any cataloged procedure used for DL/I batch jobs including utility jobs

Important: To keep the integrity, ensure that all JCL and procedures that have the possibility of changing databases meet the following STEPLIB DD requirements.

Add the following DD statements:

STEPLIB DD
    First, you must add the load module data sets that contain the global option module and the LIU load module library to the STEPLIB concatenation.

    The LIU load module library must be concatenated before the IMS load module library. The load module library must be APF-authorized.

    Next, if you want Integrity Checker to detect changes in the logic of IMS user exits, which are randomizing routines, the segment edit/compression exit routines, and the HALDB partition selection exit routines, you must include the exit load modules in the STEPLIB concatenation. Integrity Checker does not check the user exit load modules in the LPA, ELPA, or LNKLST.

...
---------------------------------------
>>> 3.5.6 Configure the members of the IMS PROCLIB data set

The title of this topic has been changed as follows:

Configure the members of the IMS PROCLIB data set (required if BPE-based DBRC is used)

---------------------------------------
>>> 3.5.9 Restarting IMS online or running the batch job

The title of this topic has been changed as follows:

Restart IMS online and run IMS batch application, IMS utility, and IMS Tools jobs

The content of this topic has been changed as follows:

When you have done all the steps, you are ready to restart IMS online and to activate the DMB verification process.

Procedure
  1. Restart IMS online, and run IMS batch application jobs, IMS utility jobs, and IMS Tools jobs.
  2. Confirm that the DMB verification process is activated by locating the following WTO message:
    FABL0114I LIU INTEGRITY CHECKER ACTIVATED. IMS VERSION IS version


---------------------------------------
> 3.0 Integrity Checker utility

The following new topics have been added after "3.5 Activating Integrity Checker":

(Topic 3.6) Deactivating Integrity Checker

You can deactivate Integrity Checker if you do not want to use the DMB verification function.

About this task
The DMB verification process is activated by the existence of a global option module. Before the DMB verification process is activated, if a program runs with DBRC active (DBRC=Y), a module of Integrity Checker runs in the background to determine whether a global option module exists. To turn off Integrity Checker completely, complete either of the following procedures depending on how IMS Library Integrity Utilities is installed in your environment.
    (Topic 3.6.1) Deactivating LIU that is installed as a stand-alone product

    If IMS Library Integrity Utilities is installed as a stand-alone product (that is, not through IMS Tools solution packs), the product target load module data set (SHPSLMD0) contains only LIU modules. In such an environment, complete the following steps to deactivate Integrity Checker.

    Before you begin
    • If multiple IMS Tools product target libraries are contained in a single data set, follow the steps in "3.9.2 Deactivating LIU that is installed as a component of IMS Tools solution pack" to deactivate Integrity Checker.
    • If the LIU load module data set has been merged to the IMS RESLIB (SDFSRESL) data set, the following procedure cannot be applied. You must restore or reinstall the IMS RESLIB.

    Procedure
    1. Remove the product load module data set and the global option module from the STEPLIB concatenation in DBRC JCL, IMS batch application JCL, IMS utility JCL, and IMS Tools JCL.
      If you have not activated Integrity Checker by following the instructions in "3.5 Activating Integrity Checker", the STEPLIB concatenation does not contain a global option module. In such a case, remove only the product load module data set.
    2. If you use BPE-based DBRC, and if you have activated Integrity Checker in the past, remove the FABLBIN0 parameter from the EXITS= statement.


    (Topic 3.6.2) Deactivating LIU that is installed as a component of IMS Tools solution pack

    If IMS Library Integrity Utilities is installed as a component of IMS Database Solution Pack or IMS Fast Path Solution Pack, all the product load modules are contained in the same data set. In such an environment, complete the following procedure to deactivate Integrity Checker.

    Before you begin
    If the LIU load module data set has been merged to the IMS RESLIB (SDFSRESL) data set, the following procedure cannot be applied. You must restore or reinstall the IMS RESLIB.

    Procedure
    1. Delete the alias name DSPCRTR0, which is defined to the LIU FABLRTR0 load module. You can delete the alias name by completing the following steps:
      1. Delete the DSPCRTR0 alias name from the load module data set by running the IEHPROGM program.
      2. Delete the DSPCRTR0 alias name from SMP by using the JCLIN and UCLIN commands.
      You can use the JCL example provided in Figure x1 to run these two steps. The JCL example consists of three job steps. The first job step deletes the alias from the load module data set. The second and the third job steps delete the alias from the SMP definition.

      When the job ends, confirm that the return codes from the three job steps are zero.

      Tip: If you do not want to change your SMP definition, you can omit the second and the third job steps. However, if you omit these job steps, alias DSPCRTR0 is recreated whenever you apply an IMS Library Integrity Utilities PTF in the future. Therefore, every time you apply an IMS Library Integrity Utilities PTF, you must run the first job step to delete the alias.

    2. If you have done the steps in "3.5 Activating Integrity Checker", complete these additional steps:
      1. Remove the global option module from the STEPLIB concatenation in DBRC JCL, IMS batch application JCL, IMS utility JCL, and IMS Tools JCL. 
      2. If you use BPE-based DBRC, remove the FABLBIN0 parameter from the EXITS= statement.


    Figure x1. Removing the alias name DSPCRTR0


(Topic 3.7) Reactivating Integrity Checker after deactivation

If you removed the alias name DSPCRTR0 while deactivating Integrity Checker, but if you want to use Integrity Checker again, you must restore the DSPCRTR0 alias before reactivating Integrity Checker.

About this task
This task is required only if you removed the alias name DSPCRTR0 by completing the steps in "3.6.2 Deactivating LIU that is installed as a component of IMS Tools solution pack" and if you want to reactivate Integrity Checker.

If you deactivated Integrity Checker by completing the steps in "3.6.1 Deactivating LIU that is installed as a stand-alone product", you can skip this task. Follow the instructions in "3.5 Activating Integrity Checker" to reactivate Integrity Checker.

Procedure
Restore the alias name DSPCRTR0. You can restore the alias name by completing the following steps:
  1. Add the DSPCRTR0 alias name by link-editing the FABLRTR0 load module.
  2. Add the DSPCRTR0 alias name to SMP by using the JCLIN and UCLIN commands.

You can use the JCL example provided in Figure x2 to run these two steps. When the job ends, confirm that the return codes from the three job steps are zero.

After restoring the DSPCRTR0 alias name, follow the instructions in "3.5 Activating Integrity Checker" to activate the DMB verification process.

Figure x2. Restoring the alias DSPCRTR0

=======================================
> 13.0 Troubleshooting
>> 13.4 IMS Library Integrity Utilities messages
>>> 13.4.1 FABL messages

The following new message has been added:

FABL0114I LIU INTEGRITY CHECKER ACTIVATED. IMS VERSION IS version

Explanation: The Integrity Checker utility activated the DMB verification process. This message also notifies the version of IMS that is being used.
System action: Processing continues.
User response: None.

The following two messages have been deleted:

FABL0103W LIU INTEGRITY CHECKER DEACTIVATED

Explanation: The Integrity Checker utility has not been activated because no global option module is found.
System action: The IMS online subsystem or the IMS batch job continues processing without the Integrity Checker function.
User response: Check whether the global option module is provided for the STEPLIB concatenation of the DBRC procedure or the batch job. Supply the global option module to the STEPLIB concatenation. Restart the IMS subsystem or rerun the batch job.

FABL0113W LIU CONFIGURATION NOT FOUND

Explanation: No global option module was found. The Integrity Checker utility is not activated.
System action: The IMS batch job continues processing without running the Integrity Checker function.
User response: Determine if the global option module is provided for the STEPLIB concatenation of the batch job. Supply the global option module to the STEPLIB concatenation, and rerun the batch job.



Update 13
Date of change: August 2012
Change description: Documentation changes by APAR PM67816. This APAR changes the behavior of the Advanced ACB Generator utility. When a storage shortage problem (DFS0649W message) occurs while building a PSB, the utility resolves the problem and retries to build the PSB. 
Topics: Changes apply to the following multiple topics.

> 8.0 Advanced Application Control Block Generator utility
>> 8.5 Output from Advanced ACBGEN
>>> 8.5.8 Miscellaneous DFS Messages report

The following figure has been modified (0649 has been added to the Note section):

Figure. Miscellaneous DFS Messages report
(Figure 92 in PDF and BookManager formats)


---------------------------------------
>>> 8.5.9 DFS Messages Summary report

The following description has been added:

If PSB build fails with a message DFS0649W, which indicates that the storage is insufficient, Advanced ACBGEN resolves the storage shortage problem, issues an FABQ9993I message, and starts rebuilding the PSB. With the IMS provided ACBGEN utility (DFSUACB0), the PSB is deleted from ACBLIB when a PSB build fails with a DFS0649W message, but with Advanced ACBGEN, the PSB is not deleted from ACBLIB. A DFS0940I message is issued when PSB build succeeds.

The following figure shows an example of the DFS Messages Summary report.
...

---------------------------------------
>>> 8.5.11 Load Module Management Status (Load Module Mgmt Stats) report

The following description has been modified:

This report provides information about the modules that were loaded during the job.

The Advanced ACBGEN utility passes PSBs to the block builder modules, one PSB at a time. The DBDs for the PSB are loaded and converted to DMBs, and then discarded. The next PSB might call for some or all of the same DBDs; so they are reloaded again and processed. Advanced ACBGEN intercepts all MVS/ESA LOAD macro requests for a DBD. The first LOAD request for a given DBD is honored and a copy of the DBD load module is placed into high memory. Subsequent calls for that DBD are satisfied by moving the DBD from high memory to an area below the line, thus avoiding execution of an MVS LOAD for the second and later uses of a given DBD. This has a significant effect on the amount of I/O done, and thus reduces elapsed time.

To reduce the elapsed time, the Advanced ACBGEN utility caches the loaded DBD members in the internal work storage (DBD hold area) and reduces I/O operations. This report provides statistics about the DBD hold area.

This report is printed more than once when PSB build is retried.

Report field descriptions
This subsection provides an explanation of the Load Module Mgmt Stats report.

MAX ENTRIES FOR TOC
    First, TOC stands for Table of Contents. The value shown here is the number of entries that are kept in the DBD hold area. This number is based on the DBD members found in the IMS DD statement concatenation. --that is, the total number of PSBs and DBDs. The ACB/PSB/DBD Library Information report identifies this number. This number is the maximum number of entries that could possibly appear.

TOC SIZE
    The size of the table of contents area. This area manages the DBD hold area. is calculated by multiplying 20 by the number of entries in the table .

DBD HOLD AREA SIZE REQUESTED
    The size of the DBD hold area that is requested internally. The DBD Hold Area size requested is calculated by multiplying 32768 by the total number of tracks used by data sets in the IMS DD concatenation. The ACB/PSB/DBD Library Information report identifies this number.  
...


NBR OF DBD LOAD REQUESTS
    This value is the actual number of MVS/ESA LOAD DBD requests. issued by the IMS Block Builder modules.

NBR LOAD REQS FOUND IN HOLD
    This value is the actual number of MVS/ESA LOAD DBD requests. issued by the IMS Block Builder modules that were serviced by the Library Management feature. That is, this value is the number of MVS/ESA LOAD macro requests that were avoided.

NBR OF DBD DELETE REQUESTS
    This value is the actual number of MVS/ESA DELETE DBD requests. issued by the IMS Block Builder modules, which were serviced by the Library Management feature. That is, this value is the number of MVS/ESA DELETE macro requests that were avoided.


=======================================
> 13.0 Troubleshooting
>> 13.4 IMS Library Integrity Utilities messages
>>> 13.4.4 FABQ messages

The following message has been added:

FABQ9993I BUILD PROCESS FOR PSB psbname IS RESTARTING

Explanation: This message indicates that Advanced ACBGEN resolved the storage shortage problem (notified by a DFS0649W message) and restarted to build the indicated PSB.
System action: Restarts the build PSB process.
User response: None.



Update 12
Date of change: August 2012
Change description: Documentation changes by APAR PM68396. This APAR enhances the Consistency Checker utility, the DBD/PSB/ACB Compare utility, the DBD/PSB/ACB Mapper utility, and the DBD/PSB/ACB Reversal utility to support the enhancement that was made to the IMS catalog feature.
Topics: Changes apply to the following multiple topics.

> 4.0 Consistency Checker utility
>> 4.1 Consistency Checker overview

The "Verified library for each database organization" table has been modified as follows:
  • PHIDAM and PSINDEX rows have been updated
  • Note 7 has been added

Table. Verified library for each database organization
(Table 4 in PDF and BookManager formats)
Database organization ACBLIB
(ACBLIB data set is specified)
MODBLKS
(MODBLKS data set is specified and DRD=NO is specified)
DFSMDA
(DFSMDA data set is specified)
RECON
(CHKRECON=YES is specified)
DRD
(DRD=YES is specified)
... ... ... ... ... ...
PHIDAM ... Yes7 ... ... Yes7
PSINDEX ... Yes7 ... ... Yes7
... ... ... ... ... ...
Notes:
1. ...
...
7. There is no need to create a MODBLKS or RDDS entry for IMS catalog databases.


A note item has been added as follows (see the second note item):

Notes:
  • Consistency Checker does not verify GSAM PCBs because no ACB member is generated.
  • Consistency Checker does not verify the MODBLKS or RDDS entry when DBDs or PSBs of IMS catalog databases are processed because these entries are not required.


The following paragraph has been added after the Program structure section:

Restriction
Consistency Checker does not support verification of IMS catalog partition definition data sets. If CHKRECON=YES is specified and if the IMS catalog database is not registered to the RECON data set, Consistency Checker determines that the definition is not consistent with the DBDs of the IMS catalog database.

---------------------------------------
>> 4.6 Output from Consistency Checker
>>> 4.6.2 SYSPRINT data set
>>>> 4.6.2.1 DBD Check report

Note items have been added to the Report field descriptions for the library information part:

MODBLKS
    MODBLKS module library specified in MODBLKS DD
    Note: MODBLKS information is not printed in the following cases:
    • If DRD=YES is specified in SYSIN DD.
    • If the data set is not specified on the DD statement.
    • When an IMS catalog DBD is processed.

SYSRDDS
    System RDDS specified in SYSRDDS DD
    Note: SYSRDDS information is not printed in the following cases:
    • If DRD=NO is specified in SYSIN DD.
    • If the data set is not specified on the DD statement.
    • When an IMS catalog DBD is processed.

NSYSRDDS
    Non-system RDDS specified in NSYSRDDS DD
    Note: NSYSRDDS information is not printed in the following cases:
    • If DRD=NO is specified in SYSIN DD.
    • If the data set is not specified on the DD statement.
    • When an IMS catalog DBD is processed.

Note items have been added to the Report field descriptions for the DB information part:

MODBLKS
    DB DEF
      Whether a database definition that corresponds to the DBD is found in the specified MODBLKS module.
    Note: MODBLKS information is not printed in the following cases:
    • If DRD=YES is specified in SYSIN DD.
    • If the data set is not specified on the DD statement.
    • When an IMS catalog DBD is processed.

SYSRDDS
    DB DEF
      Whether a database definition that corresponds to the DBD is found in the specified system RDDS.
    Note: SYSRDDS information is not printed in the following cases:
    • If DRD=NO is specified in SYSIN DD.
    • If the data set is not specified on the DD statement.
    • When an IMS catalog DBD is processed.

NSYSRDDS
    DB DEF
      Whether a database definition that corresponds to the DBD is found in the specified non-system RDDS.
    Note: NSYSRDDS information is not printed in the following cases:
    • If DRD=NO is specified in SYSIN DD.
    • If the data set is not specified on the DD statement.
    • When an IMS catalog DBD is processed.

---------------------------------------
>>>> 4.6.2.2 PSB Check report

Note items have been added to the Report field descriptions for the library information part:

MODBLKS
    MODBLKS module library specified in MODBLKS DD
    Note: MODBLKS information is not printed in the following cases:
    • If DRD=YES is specified in SYSIN DD.
    • If the data set is not specified on the DD statement.
    • When an IMS catalog PSB is processed.

SYSRDDS
    System RDDS specified in SYSRDDS DD
    Note: SYSRDDS information is not printed in the following cases:
    • If DRD=NO is specified in SYSIN DD.
    • If the data set is not specified on the DD statement.
    • When an IMS catalog PSB is processed.

NSYSRDDS
    Non-system RDDS specified in NSYSRDDS DD
    Note: NSYSRDDS information is not printed in the following cases:
    • If DRD=NO is specified in SYSIN DD.
    • If the data set is not specified on the DD statement.
    • When an IMS catalog PSB is processed.

Note items have been added to the Report field descriptions for the PSB information part:

MODBLKS
    PSB DEF
      Whether an application definition that corresponds to the PSB is found in the specified MODBLKS module.
    Note: MODBLKS information is not printed in the following cases:
    • If DRD=YES is specified in SYSIN DD.
    • If the data set is not specified on the DD statement.
    • When an IMS catalog PSB is processed.

SYSRDDS
    PSB DEF
      Whether an application definition that corresponds to the PSB is found in the specified system RDDS.
    Note: SYSRDDS information is not printed in the following cases:
    • If DRD=NO is specified in SYSIN DD.
    • If the data set is not specified on the DD statement.
    • When an IMS catalog PSB is processed.

NSYSRDDS
    PSB DEF
      Whether an application definition that corresponds to the PSB is found in the specified non-system RDDS.
    Note: NSYSRDDS information is not printed in the following cases:
    • If DRD=NO is specified in SYSIN DD.
    • If the data set is not specified on the DD statement.
    • When an IMS catalog PSB is processed.

=======================================
>> 5.0 DBD/PSB/ACB Compare utility
>>> 5.5 Control statements for DBD/PSB/ACB Compare

The following parameter has been added to the description of NOCOMP=:

CATALOG
    This parameter indicates that the metadata fields in DBD, PSB, or ACB are not compared.

    The metadata fields are compared when all of the following conditions are met:
    • NOCOMP=CATALOG is not specified.
    • NOCOMP=IMSREL is not specified.
      Exception: Even if NOCOMP=IMSREL is specified, if both of the members were generated by IMS Version 12 or later, the metadata fields are compared.

The following columns have been added to the " DBD and PSB fields that are not compared when NOCOMP=IMSREL is specified" table:

Table x. DBD and PSB fields that are not compared when NOCOMP=IMSREL is specified
(Table 5 in PDF and BookManager formats)
Function Section Field description Added or removed
DBD Compare ... ... ...
DXVECT
DXDENT
DXDRET
DXSENT
DXSEXT
DXSRET
DXFDTT
DXFDOT
DXFXTT
DXFRDT
DXFRET
DXFPAT
DXFCIT
DXFCAT
DXFCRT
DXFMDT
DXFMNT
DXFMRT
DXFSAT
DXMENT
DXMPAT
DXMOVT
DXMITT
DXMUTT
DXMPOT
DXMPOE
DXMURT
DXMRET
DXLRET
DXXRET
DXTRET
DXARET
DXFEXT
DXDRET
Metadata information for DBD Added by IMS Version 12 (see note)
EXITTB NODLET OPTION (Y/N) Added by IMS Version 12
EXITTB NO BEFORE OPTION (Y/N) Added by IMS Version 12
PSB Compare ... ... ...
PXVECT
PXPCRT
PXPCXT
PXSSRT
PXSFRT
PXPSRT
Metadata information for PSB Added by IMS Version 12 (see note)
Note: When both libraries to be compared were generated by an IMS version that is at or higher than the version that introduced the fields, the fields are compared even if NOCOMP=IMSREL is specified.


---------------------------------------
>> 5.7 Output from DBD/PSB/ACB Compare
>>> 5.7.2 SYSPRINT data set
>>>> 5.7.2.1 Block level compare reports

The following columns have been added to the "Sections in DBD Compare reports" table:

Table x. Sections in DBD Compare reports
(Table 7 in PDF and BookManager formats)
Section Description
... ...
INDXMP PSL(exitname) Contains the FPSI Partition Selection exit information
DXVECT
DXDENT
DXDRET
DXSENT SEG(segname)
DXSEXT SEG(segname)
DXSRET
DXFDTT
DXFDOT
DXFXTT
DXFRDT
DXFRET
DXFPAT
DXFCIT
DXFCAT
DXFCRT
DXFMDT
DXFMNT
DXFMRT
DXFSAT
DXMENT
DXMPAT
DXMOVT
DXMITT
DXMUTT
DXMPOT
DXMPOE
DXMURT
DXMRET
DXLRET
DXXRET
DXTRET
DXARET
DXFEXT FLD(fldname)
DXDRET
Contains the metadata information for DBD
DBDGEN ...
Note: ...

The following columns have been added to the "Sections in PSB Compare reports" table:

Table x. Sections in PSB Compare reports
(Table 8 in PDF and BookManager formats)
Section Description
... ...
PXVECT
PXPCRT
PXPCXT
PXSSRT
PXSFRT
PXPSRT
Contains the metadata information for PSB
PSBGEN ...

The following columns have been added to the "Sections in ACB Compare reports" table:

Table x. Sections in ACB Compare reports
(Table 9 in PDF and BookManager formats)
Section Description
BHDR DBD... ...
Note: ACB Compare reports also contain metadata information for DBDs and PSBs. For those sections, see Table 7 (Table: Sections in DBD Compare reports) and table 8 (Table: Sections in PSB Compare reports).




Update 11
Date of change: August 2012
Change description: Documentation changes by APAR PM47963, PM52711, PM57519, PM56804, PM60149, and PM67105. This section also includes user's guide updates that are not derived by these APARs.
Topics: Changes apply to the following multiple topics.

> 5.0 DBD/PSB/ACB Compare utility
>> 5.7 Output from DBD/PSB/ACB Compare
>>> 5.7.2 SYSPRINT data set
>>>> 5.7.2.1 Block level compare reports

The following columns have been added to the " Sections in DBD Compare reports" table:

Table x. Sections in DBD Compare reports
(Table 7 in PDF and BookManager formats)
Section Description
... ...
CKTBL1 Contains the /CK search field information about DEDB DBD.
CKTBL2 Contains the /CK subsequence field information about DEDB DBD.
... ...
Note...

=======================================
> 6.0 DBD/PSB/ACB Mapper utility
>> 6.7 Output from DBD/PSB/ACB Mapper
>>> 6.7.2 SYSPRINT data set
>>>> 6.7.2.2 DBD report

The following description has been added:
  • Following the XFD line could be the following:
    • ...
    • The field name, length, and the start values. The field name shows */CK* if the SRCH= or SUBSEQ= parameter of the XDFLD statement specifies its operand in the following format:
      (/CK,start_value,length_value)

=======================================
> 7.0 DBD/PSB/ACB Reversal utility
>> 7.5 Control statements for DBD/PSB/ACB Reversal

The description of ALL (A) has been changed as follows:

Options
The following options must be specified on the control statements (the abbreviation that can be used is shown in parentheses):

ALL (A)
    This option specifies that the operation is to be performed on all DBD, PSB, or ACB members of the library depending upon the operand specified in the control record. Specifying ALL (A) causes the DBD/PSB/ACB Reversal to execute only the first data set, when the concatenated data sets are used on a DBDLIB, PSBLIB, or ACBLIB DD statement . all the members in the data sets that are concatenated to DBDLIB DD, PSBLIB DD, or ACBLIB DD.

    Note: If two or more data sets in the concatenation contain a member with the same name, DBD/PSB/ACB Reversal processes only the first one in the concatenation.

=======================================
> 10.0 MFS Reversal utility
>> 10.4 JCL requirements for MFS Reversal

A note item has been added to the following DD statement:

FORMAT DD
    This library contains the IMS MFS formats for which the source is to be generated. Check the DISP= parameter if this library is also used in the IMS Online Control Region JCL.

    Note: If two or more data sets are concatenated to the FORMAT DD, MFS Reversal processes only the first data set.

---------------------------------------
>> 10.7 Important notes about the generated source

The following description has been added:

If a literal definition that includes Double Byte Character Set (DBCS) characters is continued over multiple lines, the first byte of the DBCS character could be in column 71 and the second byte of the character could be at the beginning of the next line. In this case, even the DBCS characters are not enclosed with SO and SI control characters, this line continuation format conforms to the continuation rules of MFS source, and therefore, the source can be processed by the IMS MFS Language utility without modification.

=======================================
> 11.0 MFS Compare utility
>> 11.3 Keywords used in comparisons

The following description has been added:

DFLD
    'LITERAL'
      specifies a literal character string to be presented to the device
    G'LITERAL'
      specifies an EGCS literal character string to be presented to the device

---------------------------------------
>> 11.5 JCL requirements for MFS Compare

Note items have been added to the following DD statements:

FORMAT DD
    This library contains the first set of IMS MFS format control blocks for comparison. Change the name ims.format1 to the name used at your site. Check the DISP= parameter if this library is also used in the IMS Online Control Region JCL.

    Note: If two or more data sets are concatenated to the FORMAT DD, MFS Compare processes only the first data set.

FORMAT2 DD
    This library contains the second set of IMS MFS format control blocks for comparison. Change the name ims.format2 to the name used at your site. Check the DISP= parameter if this library is also used in the IMS Online Control Region JCL.

    Note: If two or more data sets are concatenated to the FORMAT2 DD, MFS Compare processes only the first data set.

=======================================
> 13.0 Troubleshooting
>> 13.4 IMS Library Integrity Utilities messages
>>> 13.4.1 FABL messages

The following new messages have been added:

FABL0219I RDE FORMAT LEVEL WILL BE UPGRADED AUTOMATICALLY FOR DBD: dddddddd [AREA: aaaaaaaa]

Explanation: The Integrity Checker utility detected that the format level of the RDE for the indicated resource is old. When verification of the RDE completes, the utility upgrades the format level of the RDE by resetting the reserved areas, and then issues an FABL0201I message to notify the completion. However, if the verification is done by using the VERIFY.DB command of the LICON utility, the Integrity Checker utility will not upgrade the RDE.
Until the Integrity Checker utility upgrades the RDE, that is, until the message FABL0201I is issued, the following functions are disabled:
  • Verification of logic changes in the randomizer, the compression routine, and the partition selection exit
  • Verification of the CRTE section of the indexed DEDB
  • Restoration of RDEs during database recovery jobs
System action: Processing continues.
User response: None.

---------------------------------------
FABL3015E ENQ FOR NAME/TOKEN SERVICE AND ALL RETRIES FAILED. RC= rr

Explanation: The ENQ macro for the Name/Token service failed, and retry limit has been reached. rr shows the ENQ macro return code from the last attempt.
System action: The IMS batch job ends abnormally.
User response: See the z/OS MVS Programming Assembler Services Reference, Volume 1 (ABEND-HSPSERV) for the return code and identify the cause of the ENQ failure. Correct the error, and rerun the batch job.

---------------------------------------
FABL3016E LOAD FAILED FOR MODULE DFSVC000 AND DFSBSCD0. RC= cccc RSN= ssss

Explanation: The LOAD macro failed to load the DFSVC000 module and the macro returned a return code of 0A06. Then the macro attempted to load the DFSBSCD0 module, but it failed with the return code and the reason code that are indicated in the message.
System action: The IMS batch job ends abnormally.
User response: See the z/OS MVS Programming Assembler Services Reference, Volume 2 (IARR2V-XCTLX) for the return code and identify the cause of the LOAD failure. Also, ensure that the correct program libraries are concatenated to the STEPLIB DD statement. Correct the error, and rerun the batch job.

---------------------------------------
FABL3901E NAME/TOKEN SERVICE service FAILED: nametoken RC= rc

Explanation: The process failed in the z/OS MVS Name/Token service. service shows the service name. rc shows the return code of the Name/Token service.
System action: The batch job ends abnormally.
User response: See the z/OS MVS Programming Assembler Services Reference, Volume 2 (IARR2V-XCTLX) for the return code and identify the cause of the failure. If necessary, correct the error and rerun the job.

---------------------------------------
FABL3902E GETMAIN FAILED FOR SIZE= size RC= rc

Explanation: The GETMAIN macro for storage (size= size) failed. The return code is rc.
System action: The batch job ends abnormally.
User response: Identify the cause of the GETMAIN error by referring to MVS Assembler Service Reference, Volume 1 (ABE-HSP). If the region size specified by the REGION parameter on the JOB or EXEC statement is not large enough, increase the size, and rerun the job.

---------------------------------------
>>> 13.4.4 FABQ messages

The explanation section of the following messages has been modified as follows:

FABQ9997I nnnnnnn PSBS TO BE PROCESSED BY ACBGEN

Explanation: This message is issued when the MONITOR=(PROGRESS=(Y, frequency_value)) operand is specified in the ACBSYSIN data set. nnnnnnn is the number of the members that was were specified either explicitly or implicitly in the SYSIN data set and that will be processed by the ACBGEN utility. If BUILD DBD= dbdname,BLDPSB=NO is specified and if PSBs reference the DBDs for Fast Path DEDBs or shared secondary index databases that do not change the physical structure of database, the ACBGEN utility skips rebuilding such PSBs during the PSB process. In this case, the number of members that are actually processed will be fewer than nnnnnnn.

---------------------------------------
FABQ9998I mmmmmmm OF nnnnnnn PSBS PROCESSED BY ACBGEN

Explanation: This message is issued when the MONITOR=(PROGRESS=(Y, frequency_value)) operand is specified in the ACBSYSIN data set. mmmmmmm is the number of the members that were just processed. If BUILD DBD=dbdname,BLDPSB=NO is specified and if PSBs reference the DBDs for Fast Path DEDBs or shared secondary index databases that do not change the physical structure of database, the ACBGEN utility skips rebuilding such PSBs during the PSB process. In this case, the number of members that are actually processed will be fewer than nnnnnnn.



Update 10
Date of change: May 2012
Change description: Documentation changes by APAR PM61228. This APAR enhances the Advanced ACBGEN utility to support the IMS catalog feature that has been added to IMS ACBGEN.
Topics: Changes apply to multiple topics.

>1.0 IMS Library Integrity utilities overview
>> 1.1 What does IMS Library Integrity Utilities do?

The following description has been changed:

Advanced ACB Generator

Advanced Application Control Block Generator (also referred to as Advanced ACBGEN utility) is a functional replacement for the IMS provided Application Control Blocks Maintenance utility (DFSUACB0, also referred to as IMS provided ACBGEN utility), with improvements. The Advanced ACBGEN utility can also replace the IMS provided ACBGEN utility (DFSUACB0) to generate ACB members within ACB Generation and Catalog Populate utility (DFS3UACB) jobs. It uses some of the IMS provided modules and replaces others. Additionally, several utilities are provided to display and audit the contents of an ACB library.

---------------------------------------
>> 1.5 Functional enhancements in IMS Library Integrity Utilities Version 2

The following item has been added:

Advanced ACB Generator
    Support for IMS ACBGEN enhancements for IMS catalogs
      The Advanced ACBGEN utility can replace the IMS provided ACBGEN utility (DFSUACB0) to generate ACB members within ACB Generation and Catalog Populate utility (DFS3UACB) jobs. For details, see "Advanced ACBGEN overview" in topic 8.1.

      The Advanced ACBGEN utility also supports the IMS catalog feature that has been added to the IMS provided ACBGEN utility. When an ACBCATWK DD statement is specified for an IMS provided ACBGEN utility job, the IMS provided ACBGEN utility generates a list of the ACB members in the data set that is specified by the ACBCATWK DD statement. If you specify an ACBCATWK DD for the Advanced ACBGEN utility job, the Advanced ACBGEN utility also generates a list of the ACB members in the data set that is specified by the ACBCATWK DD. For details, see "JCL requirements for Advanced ACBGEN" in topic 8.3.

=======================================
> 8.0 Advanced Application Control Block Generator utility
>> 8.1 Advanced ACBGEN overview

Description has been changed as follows:

Advanced ACBGEN utility is a functional replacement for the IMS provided ACBGEN utility (DFSUACB0), with enhancements. The Advanced ACBGEN utility can also replace the IMS provided ACBGEN utility (DFSUACB0) to generate ACB members within ACB Generation and Catalog Populate utility (DFS3UACB) jobs. It uses some of the modules provided by IMS, and replaces others. Additionally, several utilities are provided to display and audit the contents of an ACB library.

:

Ease of use is ensured by making the product JCL compatible with the existing IMS provided utility. The use of the Advanced ACBGEN utility, whether it is used alone or called within an ACB Generation and Catalog Populate utility job, can be turn on and off by simply adding and removing a STEPLIB DD JCL statement to existing JCL. Additional optional DD statements can be added to request Advanced ACBGEN utility features. These additional DD statements would be ignored: if they were present and if the IMS provided utility was run.

---------------------------------------
> 8.0 Advanced Application Control Block Generator utility

The following new topic has been added:

Using the Advanced ACBGEN utility in an ACB Generation and Catalog Populate utility job

To generate ACB members by using the Advanced ACBGEN utility in an ACB Generation and Catalog Populate utility job, you must prepare ACB Generation and Catalog Populate utility JCL, modify that JCL so that the Advanced ACBGEN utility is used, and submit the job.

Procedure
  1. Modify the DD statements in ACB Generation and Catalog Populate utility (DFS3UACB) JCL so that the Advanced ACBGEN utility is used to generate ACB members.
    Related reading: For details about ACB Generation and Catalog Populate utility (DFS3UACB) JCL, see IMS System Utilities for the version of IMS that you are using. For a description of the DD statements, see "JCL requirements for Advanced ACBGEN" in topic 8.3.
  2. Code the control statement for Advanced ACBGEN in the SYSIN data set and optionally in the ACBSYSIN data set.
    Related reading: For a description of the control statement, see "Control statements for Advanced ACBGEN" in topic 8.4.
  3. Submit the job.
  4. Check the outputs that are generated in the output data sets.
    Related reading: For a description of the Advanced ACBGEN outputs, see "Output from Advanced ACBGEN" in topic 8.5.

---------------------------------------
>> 8.3 JCL requirements for Advanced ACBGEN

The description has changed as follows:

JCL for running the Advanced ACBGEN utility, whether it is used alone or called within an ACB Generation and Catalog Populate utility job, must satisfy the following JCL requirements.

The Advanced ACBGEN utility is JCL-compatible with the IMS provided ACBGEN utility. For details about the JCL, see the IMS System Utilities for the version of IMS that you are using.

To generate ACB members by using the Advanced ACBGEN utility in an ACB Generation and Catalog Populate utility (DFS3UACB) job, also see the JCL requirements for the ACB Generation and Catalog Populate utility in the topic "ACB Generation and Catalog Populate utility (DFS3UACB)" in IMS System Utilities for the version of IMS that you are using.

Only the optional DD JCL statements that are used by the Advanced ACBGEN utility or the ACB Generation and Catalog Populate utility are contained in this topic. If you specify to run the IMS provided ACBGEN utility with these optional DD statements present, the DD statements that are exclusive to the Advanced ACBGEN utility, such as ACBSYSIN and DFSPRINT, are ignored.

EXEC statement
...

DD statements

Code the following DD statements to identify the source of input and the placement of output information.

STEPLIB
    A STEPLIB DD statement or a JOBLIB DD statement must be provided. The data set name specified in this DD statement must be the name of the load module library containing the Advanced ACBGEN utility.

    If your STEPLIB also includes The IMS RESLIB , it must be concatenated behind the DD statement containing the Advanced ACBGEN utility.

:

DFSPRINT
    A DFSPRINT DD statement can optionally be provided. The data set, if provided, contains all of the DFSnnnn messages that were issued during the process of generating ACB members and that would normally be written to the SYSPRINT data set. Because the Advanced ACBGEN utility places all of its reports in the SYSPRINT data set, the DFSPRINT DD statement can be used to separate the DFSnnnn messages from the reports.

    The reports generated by the Advanced ACBGEN utility contain all of the information found in the DFSnnnn messages. To isolate and suppress the printing of these verbose and voluminous DFS messages, you can specify a DFSPRINT DD DUMMY JCL statement.

ACBCATWK
    An ACBCATWK DD statement can optionally be provided. The Advanced ACBGEN utility generates a list of the ACB members that were written to the ACB library during ACB generation. This DD statement is the same as the ACBCATWK DD statement that is used for the IMS provided ACBGEN utility (DFSUACB0). The output written to this data set by the Advanced ACBGEN utility is identical the output written by the IMS provided ACBGEN utility.

    Related reading: For details about ACBCATWK DD, see IMS System Utilities for the version of IMS that you are using.

DFS3PPRM
    A DFS3PPRM DD statement can optionally be provided. The DFS3PPRM DD statement specifies execution parameters for the IMS Catalog Populate utility (DFS3PU00). When the Advanced ACBGEN utility is called within an ACB Generation and Catalog Populate utility (DFS3UACB) job to generate ACB members, you can use this DD statement to override the default parameters of the DFS3PU00 utility, which is automatically executed after the ACB members are generated. With the default parameters, the DFS3PU00 utility runs in update mode with DBRC and without IRLM.

    Related reading: For details about DFS3PPRM DD, see the topic "ACB Generation and Catalog Populate utility (DFS3UACB)" in IMS System Utilities for the version of IMS that you are using.

---------------------------------------
>> 8.5 Output from Advanced ACBGEN

The following note item has been added:

The Advanced ACBGEN utility generates a number of reports, some of which are optional. These reports provide all of the information provided by the utility. The information is in a more concise and organized format. Also, considerable information not previously available is generated.

Note: The same set of reports is generated when the Advanced ACBGEN utility is used in the ACB Generation and Catalog Populate utility (DFS3UACB) job.

=======================================
> 13.0 Troubleshooting
>> 13.4 IMS Library Integrity Utilities messages
>>> 13.4.4 FABQ messages

The following new message has been added:

FABQ9937E PUT FAILED FOR DDNAME: ddname

Explanation: The PUT macro failed for the indicated data set.
System action: ACBGEN ends abnormally with a user code of 1027.
User response: Check the status of the indicated data set, and by referring to the MVS system message and its programmer response, correct the error. Rerun the job.




Update 9
Date of change: February 2012
Change description: Documentation changes by APAR PM55827. This APAR adds a new function to the Consistency Checker utility. Consistency Checker can check whether DBDs and PSBs are consistent with RDDS.

> 1.0 IMS Library Integrity Utilities overview
>> 1.1 What does IMS Library Integrity Utilities do ?

Descriptions for RDDS support have been added as follows:

Consistency Checker

Consistency Checker ensures that the necessary definitions in an IMS subsystem have been created for your database or your application program. For a DBD in the DBD library, Consistency Checker verifies whether the following definitions have been created correctly in each library and whether these definitions are consistent with the DBD:
  • The ACB in the ACB library
  • The database definition entry in the MODBLKS module
  • The database definition entry in the resource definition data sets (RDDS)
  • The DFSMDA dynamic allocation member for the database data set in the MDA library
  • The DB and DSG registration record in the RECON

For a PSB in the PSB library, Consistency Checker verifies whether the following definitions have been created correctly in each library and whether these definitions are consistent with the PSB:
  • The ACB in the ACB library
  • The application program definition entry in the MODBLKS module
  • The application program definition entry in the resource definition data sets (RDDS)

---------------------------------------
>> 1.2 IMS Library Integrity Utilities solutions

Descriptions for RDDS support have been added as follows:

For DBDs:
  • The ACB in the ACB library
  • The database definition entry in the MODBLKS module
  • The database definition entry in the resource definition data sets (RDDS)
  • The DFSMDA dynamic allocation member for the database data set in the MDA library
  • The DB and DSG registration record in the RECON

For PSBs:
  • The ACB in the ACB library
  • The application program definition entry in the MODBLKS module
  • The application program definition entry in the resource definition data sets (RDDS)

---------------------------------------
>> 1.4 IMS Library Integrity Utilities terminology

The following terms have been added to the terminology table:

Table x. IMS Library Integrity Utilities terminology
(Table 1 in PDF and BookManager formats)
Abbreviation Meaning
... ...
DRD Dynamic resource definition
RDDS Resource definition data set
... ...

=======================================
> 4.0 Consistency Checker utility
>> 4.1 Consistency Checker overview

Descriptions for RDDS support have been added as follows:

Function overview

For a DBD in the DBD library, Consistency Checker verifies whether the following definitions have been created correctly in each library and whether these definitions are consistent with the DBD:
  • The ACB in the ACB library
  • The database definition entry in the MODBLKS module
  • The database definition entry in the resource definition data sets (RDDS)
  • The DFSMDA dynamic allocation member for the database data set in the MDA library
  • The DB and DSG registration record in the RECON

The "Verified library for each database organization" table has been modified as follows:
  • Header column for MODBLKS has been modified
  • New header column, DRD, has been added
  • Note 6 has been modified

Table x. Verified library for each database organization
(Table 4 in PDF and BookManager formats)
Database organization ACBLIB
(ACBLIB data set is specified)
MODBLKS
(MODBLKS data set is specified and DRD=NO is specified)
DFSMDA
(DFSMDA data set is specified)
RECON
(CHKRECON=YES is specified)
DRD
(DRD=YES is specified)
HSAM ... ... ... ... Yes
HISAM ... ... ... ... Yes
HDAM ... ... ... ... Yes
HIDAM ... ... ... ... Yes
INDEX ... ... ... ... Yes
PHDAM ... ... ... ... Yes
PHIDAM ... ... ... ... Yes
PSINDEX ... ... ... ... Yes
GSAM ... ... ... ... No6
LOGICAL ... ... ... ... No6
MSDB ... ... ... ... Yes
DEDB ... ... ... ... Yes
Notes:
1. ...
...
6. There is no need to create a MODLBKS entry or a RDDS entry for a GSAM or a LOGICAL database.

Description for RDDS support has been added as follows:

For a PSB in the PSB library, Consistency Checker verifies whether the following definitions have been created correctly in each library and whether these definitions are consistent with the PSB:
  • The ACB in the ACB library
  • The application program definition entry in the MODBLKS module
  • The application program definition entry in the resource definition data sets (RDDS)

MODBLKS and RDDS are added as input in the following description:

Data flow

The following figure shows the general data flow for Consistency Checker(FABLECHK). The input consists of the SYSIN data set(contains the control statements), the DBDLIB data set, the PSBLIB data set, the ACBLIB data set, the DFSMDA data set, the MODBLKS data set, the resource definition data set, and RECONn data sets. The output consists of reports and an activity log.

In the "Data flow for Consistency Checker" diagram, RDDS is added as an input. (Figure 11 in PDF and BookManager formats)

---------------------------------------
>> 4.3 JCL requirements for Consistency Checker

The following DD statements have been added to "JCL for checking consistency of DBDs and PSBs" (Figure 12 in PDF and BookManager formats):


//SYSRDDS  DD DSN=IMSVS.SYSRDDS,DISP=SHR
//NSYSRDDS DD DSN=IMSVS.NSYSRDDS,DISP=SHR



The MODBLKS DD description has been modified and descriptions for SYSRDDS DD and NSYSRDDS DD have been added:

DD statements
...

MODBLKS DD
    This optional input data set is the library that contains MODBLKS, which are the control block modules created by the IMS system definition. If the data set is specified and DRD=NO is specified in the SYSIN data set, Consistency Checker attempts to verify whether an entry corresponding to the specified DBD or PSB is created in the MODBLKS module and, if so, whether it is consistent with the DBD or the PSB. If this data set is not specified, Consistency Checker does not check the MODBLKS for any DBD or any PSB.

SYSRDDS DD
    This optional input data set contains the system RDDSs, which are defined in the DRD environment. If the data set is specified and DRD=YES is specified in the SYSIN data set, Consistency Checker attempts to verify whether a definition corresponding to the specified DBD or PSB is created in the RDDS and, if so, whether it is consistent with the DBD or the PSB. If this data set is not specified, Consistency Checker does not check the RDDS for any DBD or any PSB. Consistency Checker verifies only the latest RDDS even if multiple RDDSs are specified.

NSYSRDDS DD
    This optional input data set contains the non-system RDDS, which is not defined in the DRD environment. If the data set is specified and DRD=YES is specified in the SYSIN data set, Consistency Checker attempts to verify whether a definition corresponding to the specified DBD or PSB is created in the RDDS and, if so, whether it is consistent with the DBD or the PSB. If this data set is not specified, Consistency Checker does not check the RDDS for any DBD or any PSB. The data set must be created by the EXPORT TYPE(ALL) NAME(*) command to contain all the resource definitions. Concatenated data sets are not used.

---------------------------------------
>> 4.4 Control statements for Consistency Checker

The following control statement keyword descriptions have been modified as follows

Control statement keywords
...

DDIRSFX=[x|0]
    This statement specifies the alphanumeric suffix character appended to DFSDDIR of the MODBLKS module name. The default is 0. If MODBLKS data set is specified in the MODBLKS DD statement, this specification is effective. If DRD=YES is specified in the SYSIN data set, this specification is ignored.

PDIRSFX=[x|0]
    This statement specifies the alphanumeric suffix character that is appended to DFSPDIR of the MODBLKS module name. The default is 0. If MODBLKS data set is specified in the MODBLKS DD statement, this specification is effective. If DRD=YES is specified in the SYSIN data set, this specification is ignored.
...

DRD=YES|NO
    This statement specifies whether Dynamic Resource Definition (DRD) is enabled in your IMS system. The default is NO. You can specify this statement in IMS Version 10 or later. If a RDDS data set is specified in the SYSRDDS or NSYSRDDS DD statement, this specification is effective.

---------------------------------------
>> 4.6.2 SYSPRINT data set
>>> 4.6.2.1 DBD Check report

The following descriptions have been added to the Report field descriptions for the library information part:

SYSRDDS
    System RDDS specified in SYSRDDS DD
    Note: If DRD=NO is specified in SYSIN DD, the line for SYSRDDS is not shown.

NSYSRDDS
    Non-system RDDS specified in NSYSRDDS DD
    Note: If DRD=NO is specified in SYSIN DD, the line for NSYSRDDS is not shown.

The following description has been deleted from the Report field descriptions for the DB information part:

MODBLKS
    DB DEF
      Whether a database definition that corresponds to the DBD is found in the specified MODBLKS module.
      Note: When DRD=YES is specified, Consistency Checker regards this field as consistent even if the database is not found in the MODBLKS module.

The following description has been added to the Report field descriptions for the DB information part:

SYSRDDS
    DB DEF
      Whether a database definition that corresponds to the DBD is found in the specified system RDDS.

NSYSRDDS
    DB DEF
      Whether a database definition that corresponds to the DBD is found in the specified non-system RDDS.

---------------------------------------
>>>> 4.6.2.2 PSB Check report

The following descriptions have been added to the Report field descriptions for the library information part:

SYSRDDS
    System RDDS specified in SYSRDDS DD
    Note: If DRD=NO is specified in SYSIN DD, the line for SYSRDDS is not shown.

NSYSRDDS
    Non-system RDDS specified in NSYSRDDS DD
    Note: If DRD=NO is specified in SYSIN DD, the line for NSYSRDDS is not shown.

The following description has been deleted from the Report field descriptions for the PSB information part:

MODBLKS
    PSB DEF
      Whether an application definition that corresponds to the PSB is found in the specified MODBLKS module.
      Note: When DRD=YES is specified, Consistency Checker regards this field as consistent even if the application program definition is not found in the MODBLKS module.

The following description has been added to the Report field descriptions for the PSB information part:

SYSRDDS
    PSB DEF
      Whether an application program definition that corresponds to the PSB is found in the specified system RDDS.

NSYSRDDS
    PSB DEF
      Whether an application program definition that corresponds to the PSB is found in the specified non-system RDDS.

=======================================
> 13.0 Troubleshooting
>> 13.4 IMS Library Integrity Utilities messages
>>> 13.4.1 FABL messages

The following message has been deleted:

FABL2008I NO ENTRY FOUND FOR member IN [DFSDDIRx|DFSPDIRx]

The following messages have been added:

FABL2009I ddname DATA SET IS NOT USED BECAUSE DRD= parameter IS SPECIFIED

Explanation: The indicated data set was not used for the DRD= parameter.
System action: Processing continues.
User response: Ensure that the specified DD statement and the DRD= statement are correct. If necessary, correct them and rerun the job.

---------------------------------------
FABL2019E ddname DATA SET IS NOT USED BECAUSE IT DOES NOT CONTAIN ALL THE RESOURCE DEFINITIONS

Explanation: The specified data set cannot be used because it does not contain all the resource definitions.
System action: Consistency Checker ends abnormally.
User response: Ensure that the data sets specified in the DD statement are correct. If necessary, correct the data sets and rerun the job.

---------------------------------------
FABL2025E RDJFCB MACRO FAILED FOR ddname: RETURN CODE= rrrr

Explanation: RDJFCB was attempted for the indicated DD, but failed.
System action: Consistency Checker ends abnormally.
User response: Ensure that the data sets specified in the DD statement are correct. If necessary, correct the data sets and rerun the job.

---------------------------------------
FABL2026I THE DATA SET THAT IS SPECIFIED BY NSYSRDDS DD IS A SYSTEM RDDS

Explanation: The RDDS specified in NSYSRDDS is a system RDDS.
System action: Consistency Checker continues processing.
User response: None.

---------------------------------------
FABL2054E EITHER ddname1 DD OR ddname2 DD MUST BE SPECIFIED

Explanation: DBD=YES was specified; however, SYSRDDS DD or NSYSRDDS DD was not specified.
System action: Consistency Checker ends abnormally.
User response: Specify at least one of SYSRDDS DD or NSYSRDDS DD, and rerun the program.

---------------------------------------
FABL2055E A READ ERROR OCCURRED WHILE READING THE RDDS THAT WAS SPECIFIED BY ddname DD

Explanation: An error occurred while the RDDS data set was being read.
System action: Consistency Checker ends abnormally.
User response: Correct the problem, and rerun the program.

---------------------------------------
FABL2056E THE DATA SET THAT IS SPECIFIED BY ddname DD IS NOT A VALID RDDS

Explanation: The data set that is specified in the indicated DD statement is not in a valid RDDS format.
System action: Consistency Checker ends abnormally.
User response: Ensure that the data set specified in the DD statement is correct, and rerun the job.

---------------------------------------
FABL2057E THE DATA SET THAT IS SPECIFIED BY SYSRDDS DD IS NOT A SYSTEM RDDS

Explanation: RDDS that is specified in SYSRDDS is not a system RDDS.
System action: Consistency Checker ends abnormally.
User response: Ensure that the data sets specified in the DD statement are correct, and rerun the job.

---------------------------------------
Message FABL2006I has been changed as follows:

FABL2006I ddname DATA SET IS [SPECIFIED | NOT SPECIFIED]

Explanation: The ddname data set is either specified or not specified. ddname is the DD name of the ACBLIB, DFSMDA, MODBLKS, SYSRDDS, or the NSYSRDDS data set.
System action: The Consistency Checker utility continues processing.
User response: None.



Update 8
Date of change: October 2011
Change description: Documentation changes by APAR PM37150 and PM46494. By these APARs, the following changes are made to IMS Library Integrity Utilities.
  • DBD/PSB/ACB Compare/Mapper/Reversal utility and Consistency Checker can process indexed DEDBs and Fast Path secondary indexes.
  • Integrity Checker can generate RDEs for indexed DEDBs and Fast Path secondary indexes when the utility runs under Fast Path Advanced Tool of IMS HP Fast Path Utilities or IMS Database Recovery Facility.
  • Integrity Checker can verify logic changes in partition selection exits that are specified by DEDBs.

Topics: The changes apply to the following topics.

> 1.0 IMS Library Integrity Utilities overview
>> 1.5 Functional enhancements in IMS Library Integrity Utilities Version 2

The following description is added:

Integrity Checker

Enhancement of the verification option
    You can set the CHECKRV verification option for database recovery jobs by specifying the CHECKRV option in global option modules or in RDEs. For details, see "JCL requirements for the FABLPGEN program" and "INIT.DB command".

    You can verify changes in DEDB partition selection exit routines by specifying the CHKFPSEL option in global option modules or in RDEs. For details, see "JCL requirements for the FABLPGEN program" and "INIT.DB command". This option is provided by APAR PM37150 and PM46494.


=======================================
> 3.0 Integrity Checker utility
>> 3.3 Restrictions and requirements for Integrity Checker

The following restrictions, which have been added by APAR PM21961,are now deleted:

Supported database organizations

Integrity Checker does not support the following database organizations:
  • MSDB
  • GSAM
  • DEDBs that are indexed by Fast Path secondary indexes (in recovery utility jobs and in Fast Path Advanced Tool jobs of IMS High Performance Fast Path Utilities)
  • Fast Path secondary indexes (in Fast Path Advanced Tool jobs of IMS High Performance Fast Path Utilities)


=======================================
> 3.0 Integrity Checker utility
>> 3.5 Activating Integrity Checker
>>> 3.5.1 Creating global option modules
>>>> 3.5.1.1 JCL requirements for the FABLPGEN program

The CHKFPSEL keyword is added:

Control statement keywords

CHKRAND=
CHKCOMP=
CHKPSEL=
CHKFPSEL=
    Specifies the option values that are to be used in creating a new RDE. The system default value for these parameters is N. For the meaning of the keywords, see the description of the INIT.DB command or the CHANGE.DB.

---------------------------------------
>> 3.8 LICON utility reference
>>> 3.8.3 INIT.DB command
>>> 3.8.5 CHANGE.DB command

In both these topics, the syntax diagram is modified and a description is added for the new CHKFPSEL keyword:

Syntax


 _ ___________________ ______________________________
  |_CHKFPSEL(_ _Y_ _)_|                              
              |_N_|  


Parameters

CHKFPSEL (Y or N)
    Specifies the option to determine whether to verify changes in DEDB partition selection exit routines by checksum. You can specify the following options:

    Y
      Check.
    N
      Do not check.

    If CHECKON, CHECKBAT, CHECKLD, CHECKIC, or CHECKRV is set to Y, this specification is effective in each IMS environment.

---------------------------------------
>>> 3.8.12 Output from the LICON utility

The CHECK OPTION FOR FP PSEL field added to the report. The following description is added:

Report field descriptions

CONTROL SECTION:

CHECK OPTION FOR FP PSEL
    Check option used for a DEDB partition selection exit routine.

=======================================
> 4.0 Consistency Checker utility
>> 4.6 Output from Consistency Checker
>>> 4.6.2 SYSPRINT data set
>>>> 4.6.2.2 PSB Check report

The heading column in the DBPCB INFORMATION has been changed from PROCSEQ to PROCSEQ(D):

Figure x. PSB Check report
(Figure 21 in PDF and BookManager formats)


 ----------------------- PSBLIB / ACBLIB -------------------
 DBDNAME PCBNAME SENSEGS KEYLN PROCOPT PROCSEQ(D) VIEW  LIST
 ------- ------- ------- ----- ------- ---------- ----- ----


The following description has been changed:

PROCSEQ(D)
    The name of a secondary index that is used to process a database through a secondary processing sequence.

=======================================
> 5.0 DBD/PSB/ACB Compare utility
>> 5.5 Control statements for DBD/PSB/ACB Compare

The following table has been modified:

Table x. DBD and PSB fields that are not compared when NOCOMP=IMSREL is specified
(Table 5 in PDF and BookManager formats)
Function Section Field description Added or removed
DBD Compare DIR DBDGEN DONE ON IMSV12 OR LATER Added by IMS Version 12
... ... ...
DBDXTB ... ...
DBDGEN IMS RELEASE LEVEL Added by IMS Version 3
PSB Compare PRFX IMS V12 FLAG Added by IMS Version 12
... ... ...
PSBGEN IMS RELEASE LEVEL Added by IMS Version 3

---------------------------------------
>> 5.7 Output from DBD/PSB/ACB Compare
>>> 5.7.2 SYSPRINT data set
>>>> 5.7.2.1 Block level compare reports

The following t able has been modified:

Table x. Sections in ACB Compare reports
(Table 9 in PDF and BookManager formats)
Section Description
... ...
CRTE Contains DEDB secondary index cross reference table entries information.
CRTEXD Contains INDEX record partitioning information.
... ...

=======================================
> 6.0 DBD/PSB/ACB Mapper utility
>> 6.7 Output from DBD/PSB/ACB Mapper
>>> 6.7.2 SYSPRINT data set
>>>> 6.7.2.1 DBD map

Description for MULT indicator has been added as follows:

VAR or SXD in the top line of a box shows whether the segment is variable-length or has secondary index fields. The segment code is placed in the bottom line of each box.
MULT in the top line of a box shows whether the segment has multiple secondary indexes.

---------------------------------------
>>>> 6.7.2.2 DBD report

Report field description for the database information part has been changed as follows:

If the exit parameter is specified on the DBD statement, the following information is printed:
  • The exit name
  • KEY or NOKEY
  • DATA or NODATA
  • PATH or NOPATH
  • CASCADE or NOCASCADE
  • LOG or NOLOG or none
  • DLET or NODLET or none
  • BEFORE or NOBEFORE or none

Report field description for the segment information part has been changed as follows:

If the CASCADE option is specified, the following information is printed next to the CASCADE:
  • KEY or NOKEY
  • DATA or NODATA
  • PATH or NOPATH and the following information is printed on the next line:
  • LOG or NOLOG
  • DLET or NODLET or none
  • BEFORE or NOBEFORE or none

Report field description for the field information part has been changed as follows:

The following lines for the segment specify segment type, segment field, or both:
  • If the identification is for a segment, the lines contain:
    • The segment type:
      *PR*
        describes a paired segment
      *LC*
        describes a logical child
      *LP*
        describes a logical parent
    • The segment name
    • The name of the database that contains this segment
        Note: If this segment has multiple secondary indexes, names of all the index databases are printed.
    • The type of pointer:

Following the XFD line could be the following:
...
  • *NULLEXIT* is printed if a null value or an exit routine has been specified in the XDFLD statement:
    • The null value is printed as NULL=X'xx'.
    • The exit routine is printed as EXIT-name.
  • **PSELRTN** is printed if PSELRTN= is specified in the XDFLD statement. PSELOPT shows the partition selection option. The default value for PSELOPT is MULT.
  • For other index field types, the following is printed:
    • **SEARCH**
    • **SUBSEQ**
    • **SOURCE**

=======================================
> 7.0 DBD/PSB/ACB Reversal utility
>> 7.7 Output from DBD/PSB/ACB Reversal
>>> 7.7.5 SYSPRINT data set
>>>> 7.7.5.7 PCB PROCOPT report

The heading column in the PCB PROCOPT report has been changed from PROCSEQ to PROCSEQ(D):

Figure x. PCB PROCOPT report
(Figure 75 in PDF and BookManager formats)


           PCB        REF DBD                    
PSBNAME     NO  TYPE  / LTERM   PROCOPT  PROCSEQ(D)
--------  ----  ----  --------  -------  --------


Report field descriptions have been changed as follows:

PROCSEQ(D)
    This field shows the secondary index DBD name that was specified in the PCB PROCSEQ= or PROCSEQD= statement of the PSBGEN utility.




Update 7
Date of change: October 2011
Change description: Documentation changes by APAR PM37113. This is a preventive APAR that corresponds to APAR PM34353 for IMS Version 12.

Topic:
> 13.0 Troubleshooting
>> 13.4 IMS Library Integrity Utilities messages
>>> 13.4.4 FABQ messages
>>>> 13.4.4.66 FABQ9912E

The system action section in the FABQ9912E message has been changed as follows:

FABQ9912E UNABLE TO HOOK DFSDLBL0

Explanation: ...
System action: ACBGEN ends abnormally with a user code of 1011 through 1016.
User response: ...




Update 6
Date of change: October 2011
Change description: Documentation changes by APAR PM21961. This APAR enables IMS Library Integrity Utilities to run in an IMS Version 12 environment.
Topics:

IMS Version 12 has been added to the lists of supported IMS versions in the following topics:

=======================================
> 3.0 Integrity Checker utility
>> 3.3 Restrictions and requirements for Integrity Checker

The following description has been added:

Supported database organizations

Integrity Checker does not support the following database organizations:
  • MSDB
  • GSAM
  • DEDBs that are indexed by Fast Path secondary indexes (in recovery utility jobs and in Fast Path Advanced Tool jobs of IMS High Performance Fast Path Utilities)
  • Fast Path secondary indexes (in Fast Path Advanced Tool jobs of IMS High Performance Fast Path Utilities)

---------------------------------------
> 3.0 Integrity Checker utility
>> 3.4 Considerations for Integrity Checker

The following description has been added:

For details about the RACF settings for DBRC commands and the DBRC API, see the following IMS user's guide:
  • ...
  • IMS V12: "Preserving the integrity of the RECON data sets with DBRC command and API request authorization support" in the IMS System Administration

---------------------------------------
>> 3.8 LICON utility reference
>>> 3.8.12 Output from the LICON utility

Description of the CRTE field has been added as follows:

DMCB SECTION (for DEDBs)
    This section contains the information about the DMCB. It also contains the following subsections:
    SDBF
      Information related to the segments.
    DMAC
      Information related to the area.
    CRTE
      Information related to the indexes.

=======================================
> 4.0 Consistency Checker utility
>> 4.1 Consistency Checker overview

The following table has been modified:

Table x. Verified library for each database organization
(table 4 in PDF and BookManager formats)

Database organization ACBLIB MODBLKS DFSMDA RECON
... ... ... ... ...
HIDAM ... ... ... ...
INDEX (including Fast Path secondary indexes) Yes Yes Yes Yes
... ... ... ... ...

=======================================
> 13.0 Troubleshooting
>> 13.4 IMS Library Integrity Utilities messages
>>> 13.4.1 FABL messages
>>>> 13.4.1.50 FABL0109E

The explanation section in the FABL0109E message has been changed as follows:

FABL0109E LOAD FAILED FOR MODULE mmmmmmmm

Explanation: The LOAD macro failed. mmmmmmmm is FABLRTS0 or FABLRTRx (x:6,7,8,9,A,B or C).
System action: ...
User response: ...




Update 5
Date of change: October 2011
Change description: User's guide update.
Topic:

> 3.0 Integrity Checker utility
>> 3.5 Activating Integrity Checker
>>> 3.5.1 Creating global option modules

The following description has been modified to indicate that the FABLPGEN procedure is in the SHPSSAMP data set:

Procedure

To create a global option module, use the FABLPGEN procedure in the SHPSSAMP data set that is provided by the product, and provide the control statement by using the SYSIN input stream.

...
---------------------------------------
>>> 3.5.1.1 JCL requirements for the FABLPGEN program

The following subsection has been added:

JCL example

For a JCL example, see "Creating global option modules" in topic 3.5.1.

---------------------------------------
>> 3.8 LICON utility reference
>>> 3.8.1 JCL requirements for the LICON utility

The following subsection has been added:

JCL example

For JCL examples, see the relevant command topics under "LICON utility reference" in topic 3.8.

---------------------------------------
>>> 3.8.7 EXPIRE.DB command

An example has been added:

Example

In this example, the following conditions are assumed:
  • The IMS ID is taken from the batch SCD module (DFSVC000) loaded by the IMS load module library IMSVS.SDFSRESL.
  • The LICON data set is dynamically allocated by the LICON utility. The data set name is provided by one of the global option modules.

EXPIRE.DB with DBDLIB
This example expires the current RDE for any database whose name matches the DH41* pattern.


//LICJOB   JOB
//        EXEC PGM=FABLIU00
//STEPLIB   DD DISP=SHR,DSN=HPS.SHPSLMD0
//          DD DISP=SHR,DSN=IMSVS.SDFSRESL
//DBDLIB    DD DISP=SHR,DSN=IMSVS.DBDLIB
//FABLPRNT  DD SYSOUT=*
//FABLIN    DD *
  EXPIRE.DB DBD(DH41*)
/*





Update 4
Date of change: October 2011
Change description: User's guide update that pertains to APAR PM46613 documentation changes.
Topic:

> 7.0 DBD/PSB/ACB Reversal utility
>> 7.7 Output from DBD/PSB/ACB Reversal
>>> 7.7.2 SYSPUNCH data set

The "Restrictions on the generated control statements" section has been modified as follows:

When the IMS PSBGEN utility processes the control statements issued by the DBD/PSB/ACB Reversal, the following restrictions apply:
  • The PCB label and the PCBNAME parameter in the PCB statement are mutually exclusive. Whether a PCB label or a PCBNAME parameter is used to decode a PCB name depends on the version of IMS that generated the PSB:
    • For PSBs that were generated by IMS Version 3 or later, DBD/PSB/ACB Reversal uses the PCBNAME parameter to decode the PCB name.
    • For PSBs that were generated by IMS Version 2 Release 2, DBD/PSB/ACB Reversal uses the PCB label to decode the PCB name.




Update 3
Date of change: October 2011
Change description: User's guide correction. The module name for obtaining the IMS ID (LICON utility) is corrected.
Topic:

> 3.0 Integrity Checker utility
>> 3.8 LICON utility reference


In the topics under 3.8 LICON utility reference, the occurrences of "SCD module (DFSBSCD0)" have been changed to "SCD module (DFSVC000)".




Update 2
Date of change: July 2011
Change description: User's guide correction.

> 13.0 Troubleshooting
>> 13.6 Diagnostics Aid
>>> 13.6.1 How to run Diagnostics Aid with JCL

The following example is added before the EXEC statement description:

An example of the JCL that is required for the Diagnostics Aid is shown in the following figure.


//stepname EXEC PGM=FABLDIAG
//STEPLIB    DD HPS.SHPSLMD0,DISP=SHR
//SHPSLMD    DD HPS.SHPSLMD0,DISP=SHR
//SHPSMAC    DD HPS.SHPSMAC0,DISP=SHR
//SYSPRINT   DD SYSOUT=A
Figure xx. Example of JCL for the Diagnostics Aid


The following description is added before SHPSLMD DD:

JOBLIB or STEPLIB DD
    A JOBLIB DD statement or a STEPLIB DD statement must be provided. This statement defines the library containing the FABLDIAG program (usually HPS.SHPSLMD0).




Update 1
Date of change: July 2011
Change description: Documentation changes by APAR PM41075. By this APAR, the lengths of the report fields have been increased so that the Advanced ACBGEN utility and the ACBLIB Analyzer utility can display the number of members up to seven digits in the following messages and reports:
Messages:
  • FABQ9997I
  • FABQ9998I
  • FABQ9999I
Advanced ACBGEN reports:
  • Input Specification report
  • ACB/PSB/DBD Library Information report
  • Final PSB Build List report
  • DFS Messages Summary report
  • Run Summary report
ACBLIB Analyze reports:
  • Library Information report
  • Library Contents report
  • Distribution of Member Sizes report
  • Distribution of PSB Workarea Sizes report
  • Chronological History of ACBGENs report

See the attached file (IMS_LIU_Techdoc_July2011.pdf) for samples of the modified reports.
IMS_LIU_Techdoc_July2011.pdf
(IMS_LIU_Techdoc_July2011.pdf)

Topics:

> 8.0 Advanced Application Control Block Generator utility
>> 8.4 Control statements for Advanced ACBGEN
>>> 8.4.2 ACBSYSIN control statements

The description of the PROGRESS= sub operand is changed as follows:

MONITOR=
    This operand enables you to monitor the progress of the ACBGEN process. This option is especially useful during long-running ACBGEN jobs. Progress is measured by the number of PSBs processed. The valid suboperand is PROGRESS=.
    PROGRESS=
      The PROGRESS= suboperand specifies YES or NO and how often you want to be notified. For example, MONITOR=(PROGRESS=(YES,100)) would cause a notification message to be issued each time 100 PSBs have been processed. The notification message is time-stamped and sent to the MVS console and the JES job listing. The default is PROGRESS=NO. The frequency value can be blank or a one- to five seven-digit number. If PROGRESS=(YES) is specified but the frequency is not, the frequency default is 100.

=======================================
> 13.0 Troubleshooting
>> 13.4 IMS Library Integrity Utilities messages
>>> 13.4.4 FABQ messages

The length of the variables are changed in the following messages:

FABQ9997I nnnnnnn PSBS TO BE PROCESSED BY ACBGEN

Explanation: This message is issued when the MONITOR=(PROGRESS=(Y, frequency_value)) operand is specified in the ACBSYSIN data set. nnnnnnn is the number of the members that was specified either explicitly or implicitly in the SYSIN data set.
System action: This message is issued to the MVS console when the ACBGEN process begins.
User response: None.

---------------------------------------
FABQ9998I mmmmmmm OF nnnnnnn PSBS PROCESSED BY ACBGEN

Explanation: This message is issued when the MONITOR=(PROGRESS=(Y, frequency_value)) operand is specified in the ACBSYSIN data set. mmmmmmm is the number that was just processed, and nnnnnnn is the total number to be processed.
System action: This message is issued to the MVS console during the ACBGEN process.
User response: None.

---------------------------------------
FABQ9999I nnnnnnn PSBS PROCESSED BY ACBGEN

Explanation: This message is issued when the MONITOR=(PROGRESS=(Y, frequency_value)) operand is specified in the ACBSYSIN data set. nnnnnnn is the number that was actually processed.
System action: This message is issued to the MVS console when the ACBGEN process ends.
User response: None.

Publication number

SC19-2479-01

Copyright date

2003, 2011

Original publication date

2011/7/1

Rate this page:

(0 users)Average rating

Document information


More support for:

IMS Tools
IMS Library Integrity Utilities

Software version:

2.1.0

Operating system(s):

z/OS

Reference #:

7022020

Modified date:

2014-03-12

Translate my page

Machine Translation

Content navigation