Integrated auxiliary utility parameters for IMS Index Builder

The integrated auxiliary utility parameters for IMS Index Builder are described here.

Syntax diagram

The following syntax diagram shows the parameters which are associated with the IMS Index Builder auxiliary utility.

Integrated auxiliary utility parameters for IMS Index Builder

Read syntax diagramSkip visual syntax diagramBLD_PRIMARY,BLD_SECONDARY (ALL |  secixdbname1,secixdbname2,secixdbname3...), HALDB(ILEILEFINDEXBOTHBOTHF),IBPREF(BDRFcc ccccccccc),ICNDX(NOYES),ILDS(BUILDILEINITONLY),INPUT(IBSCAN,DBRC(YESNO)),MAXTASKS( nn)PRPREF(PDRFccccccccccc),SORTFSZ(nnnnnnnnn),SORTOPT( sortopt ),

Parameter reference

BLD_PRIMARY

Use this parameter to specify that IMS Database Recovery Facility should rebuild the primary index of the dbname specified on the ADD DB() command.

HALDB primary indexes are rebuilt using the DFSPREC0 utility. In IMS Database Recovery Facility, specifying the BLD_PRIMARY command does not rebuild HALDB primary indexes. Use the parameters in the HALDB() statement to build HALDB primary indexes.

When the DFSPREC0 routine is needed for HALDB Primary Index and ILE processing, you must modify module DFSDAPL0.

BLD_SECONDARY(ALL | secixdbname1,secixdbname2,secixdbname3...)
Use this parameter to rebuild the secondary index databases of the dbname/areaname specified on the ADD DB() command.
Important: When BLD_SECONDARY(ALL) is specified, all secondary indexes are rebuilt. It is not necessary to specify BLD_SECONDARY(secixdbname1,secixdbname2,secixdbname3).
Note: Only BLD_SECONDARY(ALL) is supported when this parameter is specified on the UTILGBL() environmental statement.
HALDB(ILE | ILEF | INDEX | BOTH | BOTHF)
When the database is HALDB, use this parameter to specify whether to rebuild only the ILE data set, the Primary Index, or both. Specify this parameter only on the ADD statements for PHIDAM database types.
ILE
The indirect list entry (ILE) is to be rebuilt.
ILEF
This parameter, which is available with IMS 10 and later, rebuilds only the ILDS of the specified partition by using the free space option.

DFSPREC0 must have five z/OS® data spaces available for processing if you select the free space option.

INDEX
The HALDB primary index is to be rebuilt.
BOTH
Specifies that both the specified ILE and the primary index are to be rebuilt.
BOTHF
This parameter, which is available with IMS 10 and later, rebuilds both the primary index and the ILDS of the specified partition.

Rebuilds the ILDS by using the free space option.

The utility must have five z/OS data spaces available for processing if you select the free space option.

Start of changeIBPREF(cc | cccc | ccccc | BDRF)End of change
Use this parameter to set the prefix of the utility address space for the IMS Index Builder job name.
cc
A 2-character alphanumeric prefix used to construct the IB started task name.
When a 2-character prefix is specified, the job name is constructed by using the format ccjjjj## where:
cc
The specified prefix.
jjjj
The JES job number associated with the master address space.
##
A number from 01 - 99, incremented with each new address space.
cccc
A 4-character alphanumeric prefix used to construct the IB started task name.
When a 4-character prefix is specified, the job name is constructed by using the format cccc####, where:
cccc
The specified prefix.
####
A number from 0001 - 0099, incremented with each new address space.
Start of changecccccEnd of change
Start of changeA 5-character alphanumeric prefix used to construct the IB started task name.
When a 5-character prefix is specified, the job name is constructed by using the format ccccchhh, where:
ccccc
The specified prefix.
hhh
A number from 001 - FFF (hexadecimal), incremented with each new address space.

When a 5-character prefix is specified, SAS names of IMS Index Builder are constructed by using the format cccccSCN, cccccSRT, and cccccAPI instead of IIUSCANS, IIUSORTS, and IIUAPIFC.

End of change
BDRF
If IBPREF() is not specified, the job name is constructed by using the format BDRF####, where #### is a number from 0001 - 0099, incremented with each new address space.
ICNDX(NO | YES)
This parameter specifies that indexes are to be image copied.

This parameter does not apply to HALDB primary index and ILE data sets because they are not recoverable.

This parameter also does not apply to secondary indexes that are not recoverable.

However, if you specify ICNDX(YES), secondary indexes for Full Function, Fast Path and HALDB databases are image copied. For Full Function databases, recoverable primary indexes are image copied.

NO is the default.

Note: If ICNDX(YES) is coded, it does not take effect unless the IC keyword is present on the ADD command.
ILDS(BUILDILE | INITONLY)
Use this parameter to specify whether to build the ILE records or to initialize the data set without building any ILE records in the ILDS build process.
INPUT(IBSCAN,DBRC(Y | N))
The INPUT statement specifies the type of input used by IMS Index Builder to build indexes and specifies whether or not DBRC is used for both Index Builder and the Index Build function of FPA.

IBSCAN is the only option allowed in the first position.

IBSCAN does not apply to FPA and is ignored if specified. It is retained for consistency with IB control statements, but is also the default.

IBSCAN specifies that a scan of the physical data base is used as input. In IMS Database Recovery Facility, this option applies to secondary indexes for both HALDB and Full Function databases and to primary indexes for Full Function databases.

DBRC specifies whether DBRC is (DBRC(Y)) or is not (DBRC(N)) used. DBRC(Y) is the default.

MAXTASKS(nn)
Use this parameter to specify that this is a MAXTASKS statement.
nn
Valid values are from 0 to 36, with leading zeros.
Important: MAXTASKS(2) has special meaning in that it instructs IMS Index Builder to use the hierarchical HPU scan method for building indexes instead of the sequential scan method. For more information, see the IMS Index Builder User's Guide.
Start of changePRPREF(cc | cccc | ccccc | PDRF)End of change
Use this parameter to set the prefix of the utility address space for the DFSPREC0 job name.
cc
A 2-character alphanumeric prefix used to construct the DFSPREC0 started task name.
When a 2-character prefix is specified, the job name is constructed by using the format ccjjjj## where:
cc
The specified prefix.
jjjj
The JES job number associated with the master address space.
##
A number from 01 - 99, incremented with each new address space.
cccc
Start of changeA 4-character alphanumeric prefix used to construct the DFSPREC0 started task name.End of change
When a 4-character prefix is specified, the job name is constructed by using the format cccc####, where:
cccc
The specified prefix.
####
A number from 0001 - 0099, incremented with each new address space.
Start of changecccccEnd of change
Start of changeA 5-character alphanumeric prefix used to construct the DFSPREC0 started task name.
When a 5-character prefix is specified, the job name is constructed by using the format ccccchhh, where:
ccccc
The specified prefix.
hhh
A number from 001 – FFF (hexadecimal), incremented with each new address space.
End of change
PDRF
If IBPREF() is not specified, the job name is constructed by using the format PDRF####, where #### is a number from 0001 - 0099, incremented with each new address space.
Note: ALL is the only BLD_SECONDARY() option that is allowed within the UTILGBL() statement.
SORTFSZ(nnnnnnnnn)
This parameter applies to IMS Index Builder subordinate address spaces that are involved in sorting, not IMS Database Recovery Facility subordinate address spaces.

Use this parameter to specify the estimated number of records to be sorted. nnnnnnnnn is an integer from 1 to 999999999 that specifies the estimated number of records to be sorted.

The value is appended to the SORT option and is overridden if a non-zero index size is specified in the INDEX option for the DBD, or by the reused file size of the index.

If not specified, and not overridden, no FILSZ parameter is appended to the generated SORT option.

SORTOPT(sortopt...)
This parameter applies to IMS Index Builder subordinate address spaces that are involved in sorting, not IMS Database Recovery Facility subordinate address spaces. Use this parameter to specify sort parameters to be appended to the SORT OPTION command.

Only one SORTOPT parameter is allowed. Important: The FILSZ specified in the SORTOPT parameter takes precedence.

sortopt... is a string of sort options, separated by commas or blanks. The string is appended, unchanged, to the SORT OPTION command generated by IMS Index Builder.

The maximum length of the string is 34 characters, and the entire string must be on one line.

You can use this string to specify performance options or to override installation settings. For example: 
MAINSIZE(100) FILSZ(E3000000)
Do not specify any parameter related to record type, sort fields, or sort order.