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 (SC18-9101-04).

Content

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



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

Add comments

Document information


More support for:

IMS Tools
IMS Index Builder

Software version:

3.1.0

Operating system(s):

z/OS

Reference #:

7039676

Modified date:

2013-11-25

Translate my page

Machine Translation

Content navigation