Defining runtime parameters

The IIURPRMS module can be used to specify IMS Index Builder runtime parameters and to override defaults.

The IIURPRMS module allows the following:
  • Override the default procedure name that is used to start subordinate address spaces
  • Override the default job names that are used when starting subordinate address spaces
  • Override the default high-level qualifier that is used for creating data sets
  • Specify the name of the IMS Tools Knowledge Base server

You can use the JCL stream IIU.SIIUCNTL(IIUSMP10) as a sample when you replace the IIURPRMS module. It assembles the user-specified code and links it into the IMS Index Builder load library to replace IIURPRMS or into a separate load library to override it.

The following figure shows an example for coding the IIURPRMS module. Here, the procedure name to start subordinate address spaces is overridden, and the job names of the scan address spaces and the sort address space are overridden.

Figure 1. Example of an IMS Index Builder runtime parameters module 
        TITLE  'IMS INDEX BUILDER V3 R1 RUN TIME PARAMETERS MODULE'     
*---------------------------------------------------------------------* 
*       Example how to code the run time parameters module IIURPRMS   * 
*                   with IMS IB V3 R1                                 * 
*                                                                     * 
*       IIURPRMS contains the run time library dependent IB parameters* 
*       It can be replaced by users in a specific run time library    * 
*                                                                     * 
*       IIURPRMS is composed of 52 bytes long code lines, each        * 
*       starting with an eight byte key word                          * 
*       Four key words are used:                                      * 
*       IIURPRMS - at module start                                    * 
*       IIUREND  - at module end                                      * 
*       IIURSORT - to define a sort procedure name other than IIUBSRT * 
*       IIURDFLT - to set run time defaults for IB control statements * 
*                                                                     * 
*       Corresponding IIURSORT and IIURDFLT values can be provided    * 
*       anywhere in the remaining 44 bytes of the module code lines   * 
*       as shown in the commented lines below                         * 
*                                                                     * 
* APAR...  ID  PREREQ.  DATE....  DESCRIPTION......................   * 
*---------------------------------------------------------------------* 
                                                                        
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  COMPAUTH  NO'                   
*        DC    CL52'IIURDFLT  DBAUTH    YES'                             
*        DC    CL52'IIURDFLT  DFSDF     AAA'
*        DC    CL52'IIURDFLT  ILDS      INITONLY'  
*        DC    CL52'IIURDFLT  ITKBSRVR  UTILITKB'                       
*        DC   CL104'IIURDFLT  ITKBLOAD  IMSTOOLS.AAAAAAAA.AAAAAAAA.AAAA-
               AAAA.SHKTLOAD'                                           
*        DC    CL52'IIURDFLT  MAXTASKS  02'                             
*        DC    CL52'IIURDFLT  PROGMON   100000'
*        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   YES'                             
*        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'IIURDFLT  ZIIPMODE  COND'
*                                                                       
         DC    CL52'IIUREND'                                 module end 
*                                                                       
         END   IIURPRMS
The IIURPRMS module is a table.
  • Each entry in this table is 52 bytes or 104 bytes
  • The first entry must be IIURPRMS
  • The last entry must be IIUREND
  • IIURPRMS can optionally contain an IIURSORT entry
  • IIURPRMS can optionally contain multiple IIURDFLT entries
  • A complete definition minimally contains IIURPRMS and IIUREND entries
  • The keywords IIURPRMS, IIURSORT, IIURDFLT, and IIUREND must be coded in the entry's first byte
  • Blank spaces are optional following the IIURSORT and IIURDFLT keywords

The default IIURPRMS module contains only the IIURPRMS and IIUREND entries. You can add the IIURSORT entry and the IIURDFLT entries to override each default.

Subsections:

IIURSORT entry

By default, IMS Index Builder starts subordinate address spaces using the IIUBSRT procedure. The IIURSORT entry can be used to specify a different procedure name.

The following IIURPRMS example entry can be used to define IIUSAS as the procedure to start SORT and SCAN subordinate address spaces:

DC CL52'IIURSORT IIUSAS'

IIURDFLT APIP entry

By default, IMS Index Builder starts a subordinate address space for DRF interface using IIUAPIFC as job name. The IIURDFLT APIP entry can be used to specify a different job name.

The following IIURPRMS example entry can be used to define IIUAPI as the job name:

DC CL52'IIURDFLT APIP IIUAPI'

IIURDFLT CLASS entry

IMS Index Builder uses data sets to pass data between the sort, scan, and master address spaces. These data sets exist only for the duration of the run. By default, they are allocated with the high-level qualifier IIU.STRIPE. The IIURDFLT CLASS entry can be used to specify a different high-level qualifier. The maximum length is 17 characters.

The following IIURPRMS example entry can be used to define UTILITY.IB.STRIPE as the high-level qualifier for these data sets:

DC CL52'IIURDFLT CLASS UTILITY.IB.STRIPE'

Here is another example:

DC CL52'IIURDFLT CLASS IIU.STRP.%TIME'

IMS Index Builder replaces %TIME with a time stamp (Thhmmsst). The high-level qualifier is IIU.STRP.T2359599 and the maximum length is 17 characters. By specifying in this format, you can avoid duplicate data set names.

Notes that the user ID processing the IMS Index Builder requires RACF® ALTER access for these data sets.

IIURDFLT COMPAUTH entry

Use the IIURDFLT COMPAUTH entry to specify whether the segment compression exit is called in supervisor state.

For details, see COMPAUTH control statement.

IIURDFLT DBAUTH entry

Use the IIURDFLT DBAUTH entry to specify whether to issue the DBRC authorization request.

For details, see DBAUTH control statement.

IIURDFLT DFSDF entry

Use the IIURDFLT DFSDF entry to specify the 3-character suffix for the DFSDFxxx member in the PROCLIB data set.

For details, see DFSDF control statement.

IIURDFLT ILDS entry

Use the IIURDFLT ILDS entry to specify whether to build ILE records or to initialize the data set without building any ILE records.

For details, see ILDS control statement.

IIURDFLT ITKBLOAD entry

Use the IIURDFLT ITKBLOAD entry to specify the name of the load module library for IMS Tools Knowledge Base.

This entry is 104 bytes to contain a library name up to 44 characters. The following IIURPRMS example entry can be used to specify a library name.

DC CL104'IIURDFLT ITKBLOAD IMSTOOLS.SHKTLOAD'

For details, see ITKBLOAD control statement.

IIURDFLT ITKBSRVR entry

Use the IIURDFLT ITKBSRVR entry to specify the XCF group name of the IMS Tools Knowledge Base server where the IMS Index Builder reports are to be stored and viewed. The server name is a 1- to 8-byte value.

The following IIURPRMS example entry can be used to specify UTILITKB as the server name:

DC CL52'IIURDFLT ITKBSRVR UTILITKB'

For details, see ITKBSRVR control statement.

IIURDFLT MAXTASKS entry

Use the IIURDFLT MAXTASKS entry to customize the IMS Index Builder run.

For details, see MAXTASKS control statement.

IIURDFLT PROGMON entry

Use the IIURDFLT PROGMON entry to specify the interval for issuing WTO IIUB119I messages, which are messages to indicate the progress of the load process for each secondary index.

For details, see PROGMON control statement.

IIURDFLT SCAN entry

When processing HALDB databases, IMS Index Builder starts scanning subordinate address spaces by using the default job name IIUSCANS. You can use the IIURDFLT SCAN entry to specify a different job name.

The following IIURPRMS example entry can be used to define IIUSCNAS as the job name for non-HALDB scan address spaces:

DC CL52'IIURDFLT SCAN IIUSCNAS'

IIURDFLT SIDXBUF entry

Use the IIURDFLT SIDXBUF entry to specify the number of buffers that are to be used in the load process of secondary indexes.

For details, see SIDXBUF control statement.

You can also change this value by adding the SIDXBUF control statement to each job.

IIURDFLT SORTP entry

By default, IMS Index Builder starts sort subordinate address spaces using IIUSORTS as a job name. The IIURDFLT SORTP entry can be used to specify a different job name.

The following IIURPRMS example entry can be used to define IIUSRTAS as the sort address space job name:

DC CL52'IIURDFLT SORTP IIUSRTAS'

IIURDFLT SORTFSZ entry

Use the IIURDFLT SORTFSZ entry to specify striped sort mode and the number of records in each sort stripe.

For details, see SORTFSZ control statement.

You can also change this value by adding the SORTFSZ control statement to each job.

IIURDFLT STRIPE entry

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.

IIURDFLT SVCDUMP entry

Use the IIURDFLT SVCDUMP entry to specify whether an SVC dump file is needed.

For details, see SVCDUMP control statement.

IIURDFLT TMRWAIT entry

Use the IIURDFLT TMRWAIT entry to specify the IIUTMRXT timeout value in seconds. The default value is 300.

You can also change this value by adding the TMRWAIT control statement to each job.

For details, see TMRWAIT control statement.

IIURDFLT TOSIDBD entry

Use the IIURDFLT TOSIDBD entry to specify whether the IMS /DBDUMP commands are issued automatically.

For details, see TOSIDBD control statement.

IIURDFLT TOSIDBR entry

Use the IIURDFLT TOSIDBR entry to specify whether the IMS /DBRECOVERY commands are issued automatically.

For details, see TOSIDBR control statement.

IIURDFLT TOSISTA entry

Use the IIURDFLT TOSISTA entry to specify whether the IMS /START DB commands are issued automatically.

For details, see TOSISTA control statement.

IIURDFLT TOSIWAIT entry

Use the IIURDFLT TOSIWAIT entry to specify the response timeout value.

For details, see TOSIWAIT control statement.

IIURDFLT TOSIXCFGRP entry

Use the IIURDFLT TOSIXCFGRP entry to specify the XCF group name for the IMS Tools Online System Interface.

For details, see TOSIXCFGRP control statement.

IIURDFLT VIC entry

Use the IIURDFLT VIC entry to specify whether the DBRC NOTIFY.UIC command is needed.

For details, see VIC control statement.

You can also change this value by adding the VIC control statement to each job.

IIURDFLT WFPDEL entry

Use the IIURDFLT WFPDEL entry to specify whether the WFP data sets are deleted after loading indexes.

For details, see WFPDEL control statement.

IIURDFLT WFPHLQ entry

Use the IIURDFLT WFPHLQ entry to specify the high-level qualifier of the WFP data sets.

For details, see WFPHLQ control statement.

IIURDFLT ZIIPMODE entry

Use the IIURDFLT ZIIPMODE entry to specify whether IMS Index Builder offloads eligible workloads to zIIP processors.

For details, see ZIIPMODE control statement.

IIURDFLT entries not supported in IMS Index Builder 3.1

Some IIURDFLT entries that were supported in IMS Index Builder 2.3 are incompatible with IMS Index Builder 3.1. The following are not supported in IMS Index Builder 3.1:
  • IIURDFLT ALTER
  • IIURDFLT CATLG
  • IIURDFLT DUMP
  • IIURDFLT EXEC
  • IIURDFLT NDXIOBUF
  • IIURDFLT NOFIX
  • IIURDFLT PRTROOT
  • IIURDFLT SCANH
  • IIURDFLT SORTE15
  • IIURDFLT SORTE35
  • IIURDFLT SORTOUT
  • IIURDFLT SORTSTAT
  • IIURDFLT STEPLIB
  • IIURDFLT TRACE