Updates to IMS Index Builder for z/OS V3.1 User's Guide

Product documentation


Abstract

Updates that apply to IMS Index Builder Version 3 Release 1 User's Guide (SC18-9101-04).

Content

The most recent updates appear at the top of the list.



Update 3
Date of change: August 2014
Change description: Documentation changes by APAR PI21471. This APAR enhances the IMS Index Builder to support the IMS Tools Online System Interface of IBM Tools Base for z/OS. By using the IMS Tools Online System Interface, IMS Index Builder can automatically issue IMS commands (/DBD, /DBR, and /STA) so that you do not need to issue these IMS commands manually.
Topics: Changes apply to the following multiple topics.

> 1.0 Introduction and product setup
>> 1.1 IMS Index Builder overview
>>> 1.1.3 IMS Index Builder terminology

The following entry has been added to the abbreviations table:

Short name Product and function name
... ...
Start of changeIMS Tools Online System Interface, TOSI IBM Tools Base for z/OS, Version 1 Release 4 or later: IMS Tools Online System Interface (5655-V93) End of change
... ...

---------------
>> 1.2 Configuring and activating IMS Index Builder
>>> 1.2.6 Configuring IMS Tools Generic Exits

This topic has been replaced with the following topic:
Start of change
Configuring IMS Tools Online System Interface

IMS Index Builder can internally call IMS Tools Online System Interface to issue IMS commands (/DBD, /DBR, and /STA). The /DBD and /DBR commands prevent transactions or programs from updating the databases while the indexes are built and the /STA command restarts the databases after the indexes are built.

For instructions for configuring IMS Tools Online System Interface, see the Tools Base IMS Tools Common Services User's Guide.
End of change
===================================
> 2.0 Using IMS Index Builder
>> 2.1 IMS Index Builder functions

The following topic has been added after "Selecting the scan method".
Start of change
Issuing the IMS commands automatically
By using the IMS Tools Online System Interface, IMS Index Builder can issue IMS commands (/DBD, /DBR, and /STA) automatically. The /DBD and /DBR commands prevent transactions or programs from updating the databases while the indexes are built and the /STA command restarts the databases after the indexes are built.

About this task
    When building secondary indexes, IMS Index Builder issues /DBD commands for the prime database to be scanned and /DBR commands for secondary indexes to be built. After building the indexes, IMS Index Builder issues /STA commands for the prime database and the secondary indexes.

Procedure
    To issue the IMS /DBD, /DBR, and /STA commands, define the JCL using the following example:


    //IIUBBLD  JOB &SYSUID,MSGCLASS=H,REGION=33M,TIME=1339,
    //             RESTART=*,CLASS=A,NOTIFY=&SYSUID
    //*********************************************************************
    //*    BUILDING SECONDARY INDEXES AND                                 *
    //*    ISSUING IMS COMMANDS AUTOMATICALLY  USING DFSURIDX             *  

    //*********************************************************************
    //* Provide values for the following variables:
    // SET SIIULMOD=                          INDEX BUILDER LOAD LIBRARY|
    // SET SFOILOAD=                          TOSI LOAD LIBRARY
    // SET SHKTLOAD=                          ITKB LOAD LIBRARY
    // SET   RESLIB=                          IMS RESLIB
    // SET   MDALIB=                          IMS MDALIB
    // SET   DBDLIB=                          DBD LIBRARY
    //* NOTE: The Index Builder load library and all other datasets
    //* concatenated to STEPLIB must be APF authorized.
    //*********************************************************************
    //IIUBSCN  EXEC PGM=IIUSTART
    //STEPLIB  DD  DISP=SHR,DSN=&SIIULMOD
    //         DD  DISP=SHR,DSN=&SFOILOAD
    //         DD  DISP=SHR,DSN=&SHKTLOAD
    //         DD  DISP=SHR,DSN=&RESLIB
    //DFSRESLB DD  DISP=SHR,DSN=&RESLIB
    //IMS      DD  DISP=SHR,DSN=&DBDLIB
    //IMSDALIB DD  DISP=SHR,DSN=&MDALIB
    //*
    //IIUIN    DD *
      PROC     BLD_SECONDARY,TSTDATA
      INPUT    IBSCAN
     VIC      YES

      TOSIXCFGRP GRP01
      TOSIDBD  YES
      TOSIDBR  YES
      TOSISTA  YES,ALL
     /*
    • TOSIXCFGRP GRP01 specifies the XCF group name of the IMS Tools Online System Interface. For more information, see "TOSIXCFGRP control statement".
    • TOSIDBD YES specifies to issue /DBD DB commands to the prime database to be scanned. For more information, see "TOSIDBD control statement".
    • TOSIDBR YES specifies to issue /DBR DB commands to the indexes to be built. For more information, see "TOSIDBD control statement".
    • TOSISTA YES,ALL specifies to issue /STA DB commands to both the prime database and indexes after building secondary indexes. For more information, see "TOSISTA control statement".
    • VIC YES specifies to issue the NOTIFY.UIC command for each built index. If TOSISTA YES is specified, this control statement must be specified to turn off the DBRC IC NEEDED flags.
End of change
---------------
>> 2.2 JCL and input control statements
>>> 2.2.1 IMS Index Builder JCL
>>>> 2.2.1.2 DD statements

Description of the STEPLIB DD statement has been updated as follows:

STEPLIB DD statement
This DD statement can contain the following libraries:
  • ...
  • Start of changeIMS Tools Online System Interface load library if you want the IMS commands issued automatically.End of change
  • IMS Tools Knowledge Base load library if writing reports to the knowledge base is enabled
  • ...

---------------
>>> 2.2.2 IMS Index Builder input control statements
>>>> 2.2.2.2 Optional control statements

Topics about the following five control statements have been added:

Start of change
TOSIDBD control statement

The TOSIDBD control statement specifies to issue the IMS /DBDUMP (/DBD) command for the prime database before the scan process starts.

The /DBD command is issued only when the IBSCAN keyword is specified on the INPUT control statement (IBSCAN is the default keyword for the INPUT control statement).

Requirement: The command is issued by using the IMS Tools Online System Interface. To specify the TOSIDBD control statement, you must also specify the TOSIXCFGRP control statement.

If the BLD_PRIMARY, BLD_ILDS, or BLD_ALL keyword is specified on the PROC control statement for a HALDB, /DBRECOVERY (/DBR) commands should be issued instead of /DBD commands. In such a case, specify the TOSIDBR control statement instead of the TOSIDBD control statement.

             _NO______________________________________
            |                                         |    
            |      _,LOCAL___________   _,NOFEOV____  |    
 >>_TOSIDBD_|_YES_|__________________|_|____________|_|__><
                  |_,GLOBAL__________| |_,LASTFEOV__|      
                           |_,NOPFA_|  |__,FEOV_____|      

TOSIDBD
    Specifies that this is a TOSIDBD statement.
NO
    IMS Index Builder does not issue /DBD commands.
YES
    IMS Index Builder issues /DBD commands.

The following keywords specify the parameters that are issued together with the /DBD commands.
LOCAL
    The /DBD command is issued to each IMS subsystem that belongs to the XCF group of the IMS Tools Online System Interface.
GLOBAL
    The /DBD command is issued with the GLOBAL keyword for one of the IMS subsystems that belongs to the XCF group.
NOPFA
    The NOPFA parameter is specified on all /DBD commands. This means that the Read Only flag in the RECON data set is not set.
NOFEOV
    The NOFEOV parameter is specified on all /DBD commands.
LASTFEOV
    The NOFEOV parameter is specified on all /DBD commands except for the last one.
FEOV
    The NOFEOV parameter is not specified on the /DBD commands.

For more information about the /DBD command and its parameters, see IMS Commands.

If this statement is not specified, NO is the default. If only TOSIDBD YES is specified, TOSIDBD YES,LOCAL,NOFEOV is used.

For a HALDB, the /DBD command is issued only for the HALDB master database.

Tip: You can override the default value in the runtime parameters module. See the explanation of the IIURDFLT TOSIDBD entry in "Defining runtime parameters".
End of change
---------------
Start of change
TOSIDBR control statement

The TOSIDBR control statement specifies to issue the IMS /DBRECOVERY (/DBR) command for each index to be built before the build process starts.

Requirement: The command is issued by using the IMS Tools Online System Interface. To specify the TOSIDBR control statement, you must also specify the TOSIXCFGRP control statement.

             _NO______________________________________
            |                                         |
            |      _,LOCAL___________   _,NOFEOV____  |
 >>_TOSIDBR_|_YES_|__________________|_|____________|_|__><
                  |_,GLOBAL_________|  |_,LASTFEOV__|
                           |_,NOPFA_|  |__,FEOV_____|

TOSIDBR
    Specifies that this is a TOSIDBR statement.
NO
    IMS Index Builder does not issue /DBR commands.
YES
    IMS Index Builder issues /DBR commands.

The following keywords specify the parameters that are issued together with the /DBR commands.
LOCAL
    The /DBR command is issued to each IMS subsystem that belongs to the XCF group of the IMS Tools Online System Interface.
GLOBAL
    The /DBR command is issued with the GLOBAL keyword for one of the IMS subsystems that belongs to the XCF group.
NOPFA
    The NOPFA parameter is specified on all /DBR commands. This means that the Prohibit Authorization flag in the RECON data set is not set. 
NOFEOV
    The NOFEOV parameter is specified on all /DBR commands.
LASTFEOV
    The NOFEOV parameter is specified on all /DBR commands except for the last one.
FEOV
    The NOFEOV parameter is not specified on the /DBR commands.

For more information about the /DBR command and its parameters, see IMS Commands.

If this statement is not specified, NO is the default. If only TOSIDBR YES is specified, TOSIDBR YES,LOCAL,NOFEOV is used.

For a HALDB, if the BLD_PRIMARY, BLD_ILDS, or BLD_ALL keyword is specified on the PROC control statement and TOSIDBR YES is specified, the /DBR command is issued for the HALDB master database. If a list of partition names is provided on the PARTNAME control statement, the /DBR command is issued for each HALDB partition in the list instead of the HALDB master database.

For each PSINDEX to be built, the /DBR command is issued for the PSINDEX master database. If a list of partition names is provided on the INDEX control statement, the /DBR command is issued for each PSINDEX partition in the list instead of the PSINDEX master database.

Tip: You can override the default value in the runtime parameters module. See the explanation of the IIURDFLT TOSIDBR entry in "Defining runtime parameters".
End of change
---------------
Start of change
TOSISTA control statement

The TOSISTA control statement specifies to issue the IMS /START (/STA) command for the prime database and each index after the build process.

Requirement: The command is issued by using the IMS Tools Online System Interface. To specify the TOSIDBD control statement, you must also specify the TOSIXCFGRP control statement.

              _NO__________________________              
             |                             |              
            |       _,INDEX_   _,LOCAL__  |              
>>__TOSISTA_|_YES__|________|_|_________]_|____________><
                   |_,ALL __| |_,GLOBAL_|                


TOSISTA
    Specifies that this is a TOSISTA statement.
NO
    IMS Index Builder does not issue /STA commands.
YES
    IMS Index Builder issues /STA commands.
INDEX
    IMS Index Builder issues /STA commands only for the built indexes.
ALL
    IMS Index Builder issues /STA commands for the prime database and the built indexes.

The following keywords specify the parameters that are issued together with the /STA commands.
LOCAL
    The /STA command is issued to each IMS subsystem that belongs to the XCF group of the IMS Tools Online System Interface.
GLOBAL
    The /STA command is issued with the GLOBAL keyword for one of the IMS subsystems that belongs to the XCF group.

If this statement is not specified, NO is the default. If only TOSISTA YES is specified, TOSISTA YES,INDEX,LOCAL is used.

If a list of partition names are specified on the PARTNAME control statement or the INDEX control statement, the /STA commands are issued for the partitions in the list. Otherwise, the /STA command is issued for the HALDB master database or PSINDEX master database.

Tip: You can override the default value in the runtime parameters module. See the explanation of the IIURDFLT TOSISTA entry in "Defining runtime parameters".
End of change
---------------
Start of change
TOSIWAIT control statement

The TOSIWAIT control statement specifies the IMS Tools Online System Interface response timeout value.


               _ 300 _                                    
 >>_TOSIWAIT__|_nnnn _|_________________________________><


TOSIWAIT
    Specifies that this is a TOSIWAIT statement.
nnnn
    Specifies the timeout value in seconds in the range of 0 - 9999.

If this statement is not specified, 300 is the default.

Tip: You can override the default value in the runtime parameters module. See the explanation of the IIURDFLT TOSIWAIT entry in "Defining runtime parameters".
End of change
---------------
Start of change
TOSIXCFGRP control statement

The TOSIXCFGRP control statement specifies the XCF group name for the IMS Tools Online System Interface.


                 __ NO ____          
 >>_TOSIXCFGRP__|_grpname _|____________________________><


TOSIXCFGRP
    Specifies that this is a TOSIXCFGRP statement.
NO
    The IMS Tools Online System Interface is not used
grpname
    The XCF group name that is defined by the XCFGROUP parameter in the IMS Tools Online System Interface PROCLIB member for each IMS subsystem. The name is a 1-5 alphanumeric character string.

If this statement is not specified, NO is the default.

Tip: You can override the default value in the runtime parameters module. See the explanation of the IIURDFLT TOSIXCFGRP entry in "Defining runtime parameters".
End of change
---------------
>> 2.4 Defining runtime parameters

The example has been updated as follows. Also, descriptions for the entries have been added after the figure.
Start of change

 ***************************************************************
 IIURPRMS CSECT                                                
 IIURPRMS RMODE 31                                              
          DC    CL52'IIURPRMS'                      module start
 *                                 alternate sort procedure name
 *        DC    CL52'IIURSORT  IIUBSRT '                        
 *                                   run time default parameters
 *        DC    CL52'IIURDFLT  APIP      IIUAPIFC'              
 *        DC    CL52'IIURDFLT  CLASS     IIU.STRIPE '          
 *        DC    CL52'IIURDFLT  DBAUTH    NO'
 *        DC    CL52'IIURDFLT  ILDS      INITONLY'            
 *        DC    CL52'IIURDFLT  ITKBSRVR  UTILITKB'              
 *        DC   CL104'IIURDFLT  ITKBLOAD  IMSTOOLS.AAAAAAAA.AAAAA
                AAAA.SHKTLOAD'                                  
 *        DC    CL52'IIURDFLT  MAXTASKS  02'                    
 *        DC    CL52'IIURDFLT  SCAN      IIUSCANS'              
 *        DC    CL52'IIURDFLT  SORTP     IIUSORTS'              
 *        DC    CL52'IIURDFLT  SIDXBUF   64,64,64'                  
 *        DC    CL52'IIURDFLT  SORTFSZ   2000000'                  
 *        DC    CL52'IIURDFLT  STRIPE    UNIT=SYSALLDA,VOLCNT=10'  
 *        DC    CL52'IIURDFLT  SVCDUMP   NO'                        
 *        DC    CL52'IIURDFLT  TMRWAIT   300'  
 *        DC    CL52'IIURDFLT  TOSIXCFGRP GRP01'
 *        DC    CL52'IIURDFLT  TOSIWAIT  300'
 *        DC    CL52'IIURDFLT  TOSIDBD   YES,LOCAL,NOFEOV'
 *        DC    CL52'IIURDFLT  TOSIDBR   YES,LOCAL,NOFEOV'
 *        DC    CL52'IIURDFLT  TOSISTA   YES,ALL,LOCAL'  
 *        DC    CL52'IIURDFLT  VIC       YES,IIU.UIC.UDATA'        
 *        DC    CL52'IIURDFLT  WFPDEL    YES'                      
 *        DC    CL52'IIURDFLT  WFPHLQ    IMSTOOLS.AAAAAAAA.WFPFILE0'
 *
          DC    CL52'IIUREND'                         module end
 *                                                              
          END   IIURPRMS                                        
End of change
Figure. Example of an IMS Index Builder runtime parameters module (Part 2 of 2)
(Figure 21 in PDF and BookManager formats)
...
Start of changeUsing IIURDFLT TOSIDBD
    Use the IIURDFLT TOSIDBD entry to specify whether the IMS /DBDUMP commands are issued automatically. For details, see "TOSIDBD control statement". End of change

Start of changeUsing IIURDFLT TOSIDBR
    Use the IIURDFLT TOSIDBR entry to specify whether the IMS /DBRECOVERY commands are issued automatically. For details, see "TOSIDBR control statement". End of change

Start of changeUsing IIURDFLT TOSISTA
    Use the IIURDFLT TOSISTA entry to specify whether the IMS /START DB commands are issued automatically. For details, see "TOSISTA control statement". End of change

Start of changeUsing IIURDFLT TOSIWAIT
    Use the IIURDFLT TOSISTA entry to specify the response timeout value. For details, see "TOSIWAIT control statement". End of change

Start of changeUsing IIURDFLT TOSIXCFGRP
    Use the IIURDFLT TOSIXCFGRP entry to specify the XCF group name for the IMS Tools Online System Interface. For details, see "TOSIXCFGRP control statement". End of change
...

===================================
> 3.0 Troubleshooting
>> 3.4 IMS Index Builder messages

The following new messages have been added:
Start of change
IIUB103I statement IS IGNORED UNLESS STAND-ALONE INDEX BUILDER

Explanation: The indicated statement is ignored because the statement is supported only in stand-alone Index Builder jobs.

System action: Processing continues.

User response: None. This message is informational.
End of change
---------------
Start of change
IIUB105W TOSI ERROR: FUNC= function RC= rc RSN= rsn

Explanation: The IMS Tools Online System Interface returned an error. The codes are shown in hexadecimal.

System action: Processing continues but IMS commands are not issued.

User response: Locate the preceding messages that were issued by the IMS Tools Online System Interface to identify the cause of the error. Messages that are issued by the IMS Tools Online System Interface are prefixed with FOI.
End of change
---------------
Start of change
IIUB106I TOSI ERROR: FUNC= function RC= rc RSN= rsn

Explanation: The IMS Tools Online System Interface returned a warning. The codes are shown in hexadecimal.

System action: Processing continues.

User response: Locate the preceding messages that were issued by the IMS Tools Online System Interface to identify the cause of the error. Messages that are issued by the IMS Tools Online System Interface are prefixed with FOI.
End of change
---------------
Start of change
IIUB107E DB= database IS IN USE. IMSID= imsid

Explanation: The indicated database is in use in the indicated IMS subsystem. The IMS /DBR command cannot be processed.

System action: Processing stops.

User response: Terminate the program that is using the database or wait until the program ends, and then rerun the IMS Index Builder job.
End of change
---------------
Start of change
IIUB108I IMS [/DBD|/DBR|/STA] COMMAND PROCESSED: IMSID= imsid
        DB= dbdname RC= rc

Explanation: The IMS /DBD, /DBR, or /STA command for the indicated database is processed in the indicated IMS subsystem.

System action: Processing continues.

User response: None. This message is informational.
End of change
---------------
Start of change
IIUB109W IMS [/DBD|/DBR|/STA] COMMAND PROCESSED: IMSID= imsid
        DB= dbdname RC= rc

Explanation: The IMS /DBD, /DBR, or /STA command for the indicated database failed in the indicated IMS subsystem.

System action: Processing continues but no more /DBD, /DBR, and /STA commands are issued.

User response: For the meaning of the return code, see the explanation of the IMS DFS0488I message.
End of change
---------------
Start of change
IIUB110W IMS [/DBD|/DBR|/STA] COMMAND NOT RETURNED:
        IMSID= imsid DB= dbdname

Explanation: The IMS /DBD, /DBR, or /STA command for the indicated database is requested to the indicated IMS subsystem, but no response is returned.

System action: Processing continues.

User response: If the system is busy, increase the IMS Tools Online System Interface response timeout value on the TOSIWAIT control statement. For more information, see "TOSIWAIT control statement".
End of change
---------------
Start of change
IIUB111W IMS /STA COMMAND CANCELED FOR DB= dbdname BECAUSE IMAGE COPY NEEDED

Explanation: The IMS /STA command cannot be issued because the IC NEEDED flag is still turned on for a data set of the indicated database.

System action: Processing stops.

User response: Create image copies of the index that was built. If you do not need an image copy of the index, specify the VIC YES control statement and rerun the job. For more information, see "VIC control statement".
End of change


Update 2
Date of change: November 2013
Change description: Documentation changes by APAR PI05347. This APAR introduces new control statements for overriding the job name of subordinate address space and the volume count for each sort stripe data set.
Topics: Changes apply to the following multiple topics.

> 2.0 Using IMS Index Builder
>> 2.2 JCL and input control statements
>>> 2.2.2 IMS Index Builder input control statements
>>>> 2.2.2.2 Optional control statements

The following four topics have been added:

Start of change
IIURSORT control statement

The IIURSORT control statement specifies the procedure name to start SORT and SCAN subordinate address spaces. By default, the IIUBSRT procedure is used.

For more information about the procedure, see "2.3 Defining the subordinate address space procedure".


                      _ IIUBSRT __              
 >>___IIURSORT_______|_ procname _|___________><


IIURSORT
    Specifies that this is an IIURSORT statement.
procname
    Specifies the 1- to 8-byte procedure name.

Tip: You can override the default value in the runtime parameters module. See the explanation of the IIURDFLT IIURSORT entry in "Defining runtime parameters" in topic 2.4.
End of change
---------------
Start of change
JOBNSCAN control statement

The JOBNSCAN control statement specifies the job name of each SCAN subordinate address space, which is started when the sequential scan method is used for HALDB partitions. By default, the jobname is IIUSCANS.


                      _ IIUSCANS__              
 >>___JOBNSCAN_______|_ jobname __|___________><


JOBNSCAN
    Specifies that this is a JOBNSCAN statement.
jobname
    Specifies the 1- to 8-byte job name of each SCAN subordinate address space.

Tip: You can override the default value in the runtime parameters module. See the explanation of the IIURDFLT SCAN entry in "Defining runtime parameters" in topic 2.4.
End of change
---------------
Start of change
JOBNSORT control statement

The JOBNSORT control statement specifies the job name of each SORT subordinate address space. By default, the jobname is IIUSORTS.


                      _ IIUSORTS__              
 >>___JOBNSORT_______|_ jobname __|___________><


JOBNSORT
    Specifies that this is a JOBNSORT statement.
jobname
    Specifies the 1- to 8-byte job name of each SORT subordinate address space.

Tip: You can override the default value in the runtime parameters module. See the explanation of the IIURDFLT SORTP entry in "Defining runtime parameters" in topic 2.4.
End of change
---------------
Start of change
STRIPE control statement

The STRIPE control statement specifies the UNIT value and the volume count for allocating stripe data sets.


 >>__STRIPE_____________________________________________><
            |        _SYSALLDA_  | |            10___ |  
            |_UNIT=_|_unitname_|_| |_,VOLCNT=_|_nnn _||  

STRIPE
    Specifies that this is a STRIPE statement.
UNIT= unit
    Specifies the device type or the device group name. The default is SYSALLDA.
VOLCNT= nnn
    Specifies the maximum number of volumes in the range of 1 - 255. The value is used to allocate the following stripe data sets:
    • Stripe data sets that contain index records when the SORTFSZ control statement is specified.
    • Stripe data sets that contain index records when duplicate key errors are detected.
    The default value is 10.

    For the following stripe data sets, VOLCNT=1 is always used:
    • Stripe data sets that contain WTO messages of each address space.
    • Stripe data sets that contain SORT messages.

Tip: You can override the default value in the runtime parameters module. See the explanation of the IIURDFLT STRIPE entry in "Defining runtime parameters" in topic 2.4.
End of change
---------------
>> 2.4 Defining runtime parameters

The figure has been updated as follows:


 ***************************************************************
 IIURPRMS CSECT                                                
 IIURPRMS RMODE 31                                              
          DC    CL52'IIURPRMS'                      module start
 *                                 alternate sort procedure name
 *        DC    CL52'IIURSORT  IIUBSRT '                        
 *                                   run time default parameters
 *        DC    CL52'IIURDFLT  APIP      IIUAPIFC'              
 *        DC    CL52'IIURDFLT  CLASS     IIU.STRIPE '          
 *        DC    CL52'IIURDFLT  DBAUTH    NO'
 *        DC    CL52'IIURDFLT  ILDS      INITONLY'
 *        DC    CL52'IIURDFLT  ITKBSRVR  UTILITKB'
 *        DC   CL104'IIURDFLT  ITKBLOAD  IMSTOOLS.AAAAAAAA.AAAAA
               AAAA.SHKTLOAD'                                  

 *        DC    CL52'IIURDFLT  MAXTASKS  02'                    
 *        DC    CL52'IIURDFLT  SCAN      IIUSCANS'              
 *        DC    CL52'IIURDFLT  SORTP     IIUSORTS'              
 *        DC    CL52'IIURDFLT  SIDXBUF   64,64,64'                  
 *        DC    CL52'IIURDFLT  SORTFSZ   2000000'                  
Start of change*        DC    CL52'IIURDFLT  STRIPE    UNIT=SYSALLDA,VOLCNT=10'End of change 
 *        DC    CL52'IIURDFLT  SVCDUMP   NO'                        
 *        DC    CL52'IIURDFLT  TMRWAIT   300'                      
 *        DC    CL52'IIURDFLT  VIC       YES,IIU.UIC.UDATA'        
 *        DC    CL52'IIURDFLT  WFPDEL    YES'                      
 *        DC    CL52'IIURDFLT  WFPHLQ    IMSTOOLS.AAAAAAAA.WFPFILE0'
 *
          DC    CL52'IIUREND'                         module end
 *                                                              
          END   IIURPRMS                                        
Figure. Example of an IMS Index Builder runtime parameters module (Part 2 of 2)
(Figure 21 in PDF and BookManager formats)

The following description has been added:

Start of changeUsing IIURDFLT STRIPE
    Use the IIURDFLT STRIPE entry to specify the UNIT value and the volume count for allocating stripe data sets. For details, see "STRIPE control statement". End of change
...



Update 1
Date of change: September 2013
Change description: Documentation changes by APAR PM92801. This APAR provides the following new functions:
  • When IMS Index Builder builds a HALDB primary index or an ILDS, it issues database authorization requests with EXCLUSIVE access intent for the HALDB partition, instead of READ access intent.
  • If the DBAUTH YES,RECOV control statement is specified, IMS Index Builder issues the CHANGE.DBDS RECOV command to turn on the RECOVERY_NEEDED flag before requesting database authorization.
Topics: Changes apply to the following multiple topics.

> 2.0 Using IMS Index Builder
>> 2.2 JCL and input control statements
>>> 2.2.2 IMS Index Builder input control statements
>>>> 2.2.2.2 Optional control statements
>>>>> 2.2.2.2.2 DBAUTH control statement

This topic has been updated as follows:

The DBAUTH control statement specifies whether IMS Index Builder issues the IMS DBRC authorization request for the prime database and the indexes to prevent transactions and programs from updating the database.
Start of change
  • Read (RD) access is requested for the prime database or the prime HALDB partitions to be scanned. If DFSURWF1, HPSRSIDX, or HPSRWFP is used as the input, no request is issued.
    If the RECOVERY NEEDED flag is turned on for the prime database or the prime HALDB partition, exclusive (EX) access is requested
  • Exclusive (EX) access is requested for each index or each PSINDEX partition to be built.

The following tables summarize the access intent requested through IMS DBRC authorization: exclusive access (EX) or read access (RD).

Table a. Access intent for prime database and indexes (non-HALDB)
PROC control statement Prime database HIDAM primary index Secondary index
BLD_SECONDARY RD (see Note) N/A EX
BLD_PRIMARY RD EX N/A
BLD_ALL RD EX EX
Note: If DFSURWF1 or HPSRSIDX is used as the input, no request is issued for the prime database.

Table b. Access intent for prime database and indexes (HALDB)
PROC control statement Prime HALDB partition PSINDEX partition
BLD_SECONDARY RD (see Note) EX
BLD_PRIMARY EX N/A
BLD_ILDS EX N/A
BLD_ALL EX EX
Note:
  • If HPSRWFP is used as the input, no request is issued for the prime HALDB partitions.
  • If the RECOVERY NEEDED flag of the primary index or ILDS is turned on, exclusive access (EX) is requested.


             _YES____________                          
            |                |                        
>>__DBAUTH__|_YES,RECOV______|_______________________><
            |                |
            |_NO_____________|
                                                       
End of change

DBAUTH
    Specifies that this is a DBAUTH statement.

YES
    IMS Index Builder issues the DBRC authorization request.
Start of change
RECOV
    IMS Index Builder issues the CHANGE.DBDS RECOV command to turn on the RECOVERY NEEDED flag to prevent access from other IMS subsystems throughout the entire process.

    The DBRC authorization for the resource is released when the IMS cleanup processing ends for the IMS region (DFS627I message indicates the end of this processing). Without the RECOV option, other IMS subsystems might access the resource after the DBRC authorization is released until the DBRC NOTIFY commands are issued. The RECOV option prevents any access during this period by turning on the RECOVERY NEEDED flag.

    Restriction: IMS Index Builder does not issue the CHANGE.DBDS RECOV command for PSINDEX partitions whose PARTITION INIT NEEDED flag is set to YES.
End of change
NO
    IMS Index Builder does not issue the DBRC authorization request.

If the DBAUTH statement is not specified, YES is the default.

If DBRC=N is specified on the INPUT control statement, no DBRC authorization request is issued even if DBAUTH YES is specified.

Note: The longest possible time that IMS Index Builder can wait for a response from DBRC is 30 minutes.

Tip: You can override the default value in the runtime parameters module. See the explanation of the IIURDFLT DBAUTH entry in "Defining runtime parameters" in topic 2.4.


===================================
> 3.0 Troubleshooting
>> 3.3 IMS Index Builder reason codes
>>> 3.3.2 IMS Index Builder initialization phase primary reason codes

The following reason code has been added:

Start of change
131 DBRC API FAILURE

Explanation: An error occurred in the IMS DBRC API call.

User response: See the IIUB063E message.
End of change
---------------
>> 3.4 IMS Index Builder messages

The explanation, system action, and the user response sections of the following message have been updated as follows:

IIUB063E DBRC API ERROR: FUNC= function RC= xxxxxxxx RSN= yyyyyyy
Start of change
Explanation: An error is detected in an IMS DBRC API call. xxxxxxxx and yyyyyyyy are return and reason codes of each function of the IMS DBRC API, in hexadecimal. The meanings of the codes are described in the IMS System Programming APIs. DBRC messages (DSPxxxxx) might be printed in the IIUSNAP data set or the IIUSTAT data set.

System action: Processing stops.

User response: Correct the error and rerun the job.
End of change
---------------
The following two new messages have been added:
Start of change
IIUB092I DBD=[ dbdname|(RECON)]

Explanation: This message follows the IIUB063E message and shows the database for which the IMS DBRC API call failed.

System action: None.

User response: None.
End of change
---------------
Start of change
IIUB093I COMMAND= command

Explanation: This message follows the IIUB063E message and shows the DBRC command for which the IMS DBRC API call failed.

System action: None.

User response: None.
End of change

Publication number

SC18-9101-04

Copyright date

2000, 2012

Original publication date

2013/9/25

Cross reference information
Segment Product Component Platform Version Edition
Information Management IMS Database Solution Pack for z/OS
Information Management IMS Recovery Solution Pack for z/OS

Rate this page:

(0 users)Average rating

Document information


More support for:

IMS Tools
IMS Index Builder

Software version:

3.1.0

Operating system(s):

z/OS

Reference #:

7039676

Modified date:

2014-08-12

Translate my page

Machine Translation

Content navigation