CONVERT command parameters

Specifies to run the ACBGEN process during the takeover phase.

When IMS manages the ACBs (ACBMGMT=CATALOG), ACBGEN(N) is forced.

Format

(Y | N)

Default value

N

Specifies a new maximum-insert-byte for the DBD.

Format

(1 - 16777215)

Default value

If omitted, the default action is to copy from the existing DBD.

Used as a substitute for the DBD name when building partition names. See also DBDPATT, INDPATT, and FIRSTPART parameters.

Format

(constant)

Default value

None.

Specifies the name of the data class for the new SMS-managed databases and image copy data sets that IMS HALDB Toolkit dynamically allocates.

Format

(dataclass)

Default value

• For database data sets: If omitted, the default action is to copy from existing data sets.
• For image copy data sets: None.

Specifies the name of the data class for the new SMS-managed ILDS data sets that IMS HALDB Toolkit dynamically allocates.

If the database data sets of the primary database, from which the ILDS data sets are created, are encrypted OSAM data sets and have the Extended Addressability attribute, you must specify a data class without the Extended Addressability attribute for the ILDS data sets.

If the database data sets, from which the ILDS data sets are created, do not have the Extended Addressability attribute, this parameter is ignored.

Format

(dataclas)

Default value

If omitted, the default action is to copy from existing data sets.

Specifies which full-function database is to be converted.

Format

(dbdname)

Default value

None.

Backs up the existing DBD to a specified library.

This parameter includes a DDNAME that must be included in the JCL.

When IMS manages the ACBs (ACBMGMT=CATALOG), this parameter is ignored.

Format

(ddname)

Default value

None.

Copies the new DBD to your DBD library.

If NEWDBD is not specified, DBDCOPY is set to Y.

When IMS manages the ACBs (ACBMGMT=CATALOG), DBDCOPY(N) is forced.

Format

(Y | N)

Default value

Y

Creates a partition name from the DBD.

Format

(cccccccc) where c is an asterisk (*) or a period (.).

You can use a maximum of 6 asterisks (*) to identify the position in the DBD name. The default is 6 asterisks.

When 6 are specified, only 1 character is used for the partition name, which creates a limit of 36 partitions.

If fewer than 6 positions are specified, 1 - 3 characters are used for the partition name depending on the FIRSTPART parameter.

You can also use periods (.) to ignore certain characters of the DBD name.

Default value

(******..)

Generates the DBD source for the converted HALDB and places it in the specified library.

This parameter includes a DDNAME that must be included in the JCL.

The data set that you specify for dbdsource DD must be a partitioned data set (PDS) or a partitioned data set extended (PDSE) with LRECL=80 and RECFM=F. SYSOUT=* cannot be specified for this data set.

Format

(ddname)

Default value

None.

Backs up the existing DBRC to a specified library.

This parameter includes a DDNAME that must be included in the JCL.

The data set that you specify for dbrcback DD must be a partitioned data set (PDS) or a partitioned data set extended (PDSE) with LRECL=80 and RECFM=F. SYSOUT=* cannot be specified for this data set.

Format

(ddname)

Default value

None.

Specify this parameter to generate DBRC commands. You must also specify the dbrcout DD statement in the JCL.

You can specify SYSOUT=*, a sequential file, or a partitioned data set (PDS) or a partitioned data set extended (PDSE) with a member name with LRECL=80 and RECFM=F to the dbrcout DD.

Format

(ddname)

Default value

None.

Specifies the 3-character suffix of the DFSDFxxx member of the IMS PROCLIB data set that contains the settings and attributes of the IMS catalog.

Format

(ddd)

Default value

None.

Changes a database with multiple data set groups into a database with a single data set group.

Format

(Y | N)

Default value

N

Specifies the suffix portion of the new data set name that you are using.

A total of 37 characters are allowed for the entire data set name, which includes the characters used for the DSNPREF prefix and the characters used for the DSNDBD suffix.

Format

(DBD | PART | DBDPART)

DBD

Add the DBD name to DSNPREF.

PART

Add the partition name to DSNPREF.

DBDPART

Add the DBD name and the partition name to DSNPREF.

Default value

DBD

Specifies a high-level data set name to be used when building new partition data set names.

The DBRC DSNPREFX parameter is created from this specification and appended with the DBD name. The final data set name is then appended by DBRC with the DBD file letter and the partition number.

Format

(dsnprefx)

Default value

None.

Specifies a new free block frequency factor (FBFF) to be used when defining a partition.

Format

(0 - 99)

Default value

If omitted, the default action is to copy from the existing FBFF.

Identifies the partition name extension to be added to the name "stub" created by the DBDPATT and INDPATT parameters.

The "stub" and the extension cannot exceed 7 characters.

Format

(ccc)

ccc defines the character strings that are used, where:

0

Defines a string from 0-9,A-Z. The partition number is used as an index. It creates a 1-character extension.

A

Defines a string from A-Z,0-9. The partition number is used as an index. It creates a 1-character extension.

1

Defines a string from 1-9,A-Z. The partition number is used as an index. It creates a 1-character extension.

01

Creates a 2-character numeric extension from 01-99. The partition number is used for the extension.

AA

Creates a 2-character extension from AA to 99. For example, AA,…,AZ,A0,..,A9,BA,…,Z9,0A,…

001

Creates a 3-character numeric extension from 001-999. The partition number is used for the extension.

Default value

• 0, if six asterisks (*) are specified on the DBDPATT parameter or the DBDPATT parameter is not specified.
• AA, if five asterisks are specified on the DBDPATT parameter.

Specifies a new free space percentage value per interval or block (FSPF) to be used when defining a partition.

Format

(0 - 99)

Default value

If omitted, the default action is to copy from the existing FSPF.

Specifies the maximum number of GDG (generation data group) data sets that can be associated with the GDG. This value is used only when the GDG base does not exist and a GDG is created during the job.

IMS HALDB Toolkit uses the value specified for this parameter when a GDG is requested for image copy data sets.

If you specify one of the following parameters, the existence of a GDG base is verified before the image copy data set is allocated:

• ICTRLR(1) to request that image copy data sets are GDGs
• &GDG is specified on the IC1DSN or IC2DSN parameter to request that image copy data sets are GDGs

If a GDG base does not exist, IMS HALDB Toolkit automatically defines one using the GDGLIMIT parameter value to control the number of generations to keep.

Format

(1 - 255)

Default value

20

Used for IMS High Performance Image Copy processing. This parameter specifies whether compression is used.

If the copy is a standard image copy, this parameter is ignored.

Format

(Y | N)

Default value

N

Used for IMS High Performance Image Copy processing. If IC.COMP(Y) is used, this parameter specifies the name of a compression routine.

If the copy is a standard image copy, this parameter is ignored.

Format

(comprtn)

Default value

FABJCMP1

Specifies whether a virtual image copy is taken.

Specify Y to activate IC.VIC and suppress the creation of image copies for all PSINDEXes. A NOTIFY.UIC is used instead.

Format

(Y | N)

Default value

N

Activated only when IC.VIC(Y) is also specified.

Specifies a string of up to 44 characters that are used as UDATA for the NOTIFY.UIC. The string must conform to z/OS® and IMS data set name rules.

Format

(dsname)

Default value

None.

This parameter provides an alternative to using the ICHLQ, ICID, ICMID, and ICTRLR parameters to specify the data set name for an image copy.

Format

(dsname)

The data set name can contain variables. To specify a variable, use an ampersand (&). The following variables are supported:

&JOBNAME

Name of this job.

&DBD

The DBD name. This value changes to the first partition name when not all partitions are processed.

&DDNAME

The DD name of the database data set.

&DATE1

This variable is substituted as Dyyyyddd.

&DATE2

This variable is substituted as Ddddyyyy.

&DATE3

This variable is substituted as Dddmmyy.

&DATE4

This variable is substituted as Dmmddyy.

&DATE5

This variable is substituted as Dyymmdd.

&TIME1

This variable is substituted as Thhmmss.

&TIME2

This variable is substituted as Thhmm.

&GDG

The identifier for the GDG data set.

If specified, &GDG must be the last value on the IC1DSN parameter.

where:

• yyyy is the 4-digit year
• yy is the last 2 digits of the year
• mm is the month
• ddd is the day of the year
• dd is the day of the month
• hh is the hour (24-hour clock) local time
• mm is the minute
• ss is the second

Default value

None.

Specifies the secondary image copy data set name. To create the data set name, use the same method that is described for the IC1DSN keyword.

You must specify a unique data set name.

Format

(dsname)

Default value

None.

Specifies the high-level qualifier for the image copy data sets.

Format

(ichlq)

Default value

If omitted, the action defaults to DSNPREF.

Used to override the default (IC1 or IC2) for the suffix qualifier for dual image copy data sets.

Format

(1 | 2) or (Y | N)

Y is equivalent to 1, and N is equivalent to 2.

Default value

1

Specifies the mid-level data set qualifier for image copy data sets.

Format

(1 - 4)

The ICMID parameter specifications render the following mid-level data set qualifiers:

ICMID(1)

dbdname.ddname.

ICMID(2)

dbdname.

ICMID(3)

ddname.

ICMID(4)

None.

Default value

3

Specifies single or dual image copies.

Format

(1 | 2)

Default value

1

Specifies that no image copies are to be taken, and turns off the ICNEEDED parameter.

Format

(Y | N)

Default value

N

Specifies whether to use another final suffix qualifier for image copy data sets.

Format

(1 - 6)

The ICTRLR parameter specifications render the following final suffix qualifiers:

ICTRLR(1)

GDG

ICTRLR(2)

Dyymmdd.Thhmmss

ICTRLR(3)

Dmmddyy.Thhmmss

ICTRLR(4)

Dddmmyy.Thhmmss

ICTRLR(5)

None.

ICTRLR(6)

Dyyddd.Thhmmss

Default value

2

Use this keyword to specify the number of volumes to allocate for image copy data sets.

If an image copy data set requires more space than is available on a single volume, specify a value larger than 1.

The ICVOLCT value is applied to all image copy data sets that are dynamically defined in the IMS HALDB Toolkit job.

Format

(1 - 20)

Default value

1

Specifies the IMS ID to use when updating the IMS Library Integrity Utilities partition description.

IMSID must be specified when the IMS catalog is enabled by the IMS Catalog Definition exit routine and IMSID is referred to in the exit routine.

Format

(nnnn)

Default value

If omitted, the default is obtained from the current SDFSRESL (DFSVC000).

Specifies the number of index partitions.

Cannot be used with INDSIZE.

Format

(1 - 999)

Default value

None.

Creates a partition name "stub" from the DBD name of a secondary index.

Format

(cccccccc) where c is an asterisk (*) or a period (.)

This parameter is similar to DBDPATT. The "*" positions of the DBD name are kept to create the "name stub."

You can use a maximum of 6 asterisks (*) to identify the position. The default is 6 asterisks.

Default value

DBDPATT is used. If neither DBDPATT nor INDPATT is specified, the default is (******..).

Specifies whether a secondary index is partitioned the same as the primary database.

The following restrictions apply:

• The index key must be the root segment key.
• The primary database must be partitioned using the KEYS parameter.

Format

(Y | N)

Default value

N

Specifies the size of each index partition.

Cannot be used with INDPART.

Format

(1 - 4095)

Default value

1024

DDNAME in JCL that allows parameters to be added to the DBRC INIT.DB command, which are not currently specified by the product.

This parameter can be specified in stream or in a data set.

If no parameters are added, the defaults for the Global Service Group (GSG) are used.

If specified, this parameter requires a DDNAME which must be included in the JCL.

Any DBRC statements that you specify on the initdb_dd DD statement are included in the statements that are generated by the product. DBRC statements coded on the initdb_dd DD statement must conform to the syntax of the INIT.DB command. For the syntax rules, see the topic "INIT.DB command" in IMS Commands.

Format

(initdb_dd)

Default value

None.

DDNAME in JCL that allows parameters to be added to the DBRC INIT.PART command, which are not currently specified by the product.

IMS HALDB Toolkit uses the defaults for GENMAX, DFLTJCL, ICJCL, OICJCL, RECOVJCL, RECOVPD, RECVJCL, and NOREUSE.

Any DBRC statements that you specify on the initpart_dd DD statement are included in the statements that are generated by the product. DBRC statements coded on the initpart_dd DD statement must conform to the syntax of the INIT.PART command. For the syntax rules, see the topic "INIT.PART command" in IMS Commands.

Format

(initpart_dd)

Default value

None.

The key label can be up to 64 bytes.

Format

(keylabel)

Default value

• For database data sets: If omitted, the default action is to copy from existing data sets.
• For image copy data sets: None.

Specifies the length of the subkey when IHCPSEL0 is used.

For example, to partition by country, using a country code that is 3 characters in position 7-9 of your key, specify the following:

KEYLEN(3) KEYOFF(6)

Format

(nnn) where nnn is 1 to root keylen -1

Default value

None.

Specifies the offset within the root segment key to be used when IHCPSEL0 has been specified as PARTSEL.

The offset must be at least 1.

Offset 0 does not need a partition selection exit.

For example, to partition by country, using a country code that is 3 characters in position 7-9 of your key, specify the following:

KEYLEN(3) KEYOFF(6)

Format

(nnn) where nnn is 1 to root keylen -1

Default value

None.

Specifies a DD statement which contains records for the high keys; cannot be used with PARTNUM or PARTSIZE.

This parameter can be specified as a character or hexadecimal.

Specifying KEYS results in as many partitions as there are keys specified in the file. The specifications are analyzed to determine whether the requested partitioning is feasible.

If the number of partitions has been specified, IMS HALDB Toolkit verifies that no partition is larger than 4 GB.

If the high keys are created during analysis, there must be at least as many database records as there are requested partitions.

Format

(ddname)

Default value

If none of the parameters PARTNUM, PARTSIZE, or KEYS are specified, the default setting PARTSIZE(2048) is used.

Specifies a new SMS management class.

Format

(mgmtclas)

Default value

• For database data sets: If omitted, the default action is to copy from existing data sets.
• For image copy data sets: None.

Specifies the DDNAME of the data set that contains the changed HALDB DBDs. This parameter is a DDNAME, which must be included in the JCL.

If NEWDBD is not specified, a temporary data set is used. DBDCOPY is then reset to Y.

When IMS manages the ACBs (ACBMGMT=CATALOG), this parameter is ignored.

Format

(ddname)

Default value

None.

Specifies whether the batch conversion is to be performed while the databases remain online.

ONLINE(Y) is not supported by IMS Database Utility Solution.

Format

(Y | N)

Default value

N

Converts VSAM to OSAM.

Format

(Y | N)

Default value

N

Increases HDAM overflow area by a number of blocks.

Format

(0 - 9999999)

Default value

None.

Specifies the number of partitions to be created.

PARTNUM cannot be used with PARTSIZE or KEYS. Specifying this parameter causes IMS HALDB Toolkit to find the high keys. The specifications are analyzed to determine whether the requested partitioning is feasible.

PARTNUM might not result in the exact number of partitions specified because a root segment and all of its dependent segments must be written to the same partition. Therefore, fewer than PARTNUM partitions might be created so that hierarchical integrity is preserved.

If the number of partitions has been specified, IMS HALDB Toolkit verifies that no partition is larger than 4 GB.

If the high keys are created during analysis, there must be at least as many database records as there are requested partitions.

Format

(1 - 999)

Default value

If none of the parameters PARTNUM, PARTSIZE, or KEYS are specified, the default setting PARTSIZE(2048) is used.

Specifies a partition selection routine to be used.

This parameter must be used with the KEYS parameter.

IMS HALDB Toolkit provides an exit for partition selection (IHCPSEL0). When you use this exit, the database is partitioned using a subset of the key.

If you use IHCPSEL0, you must also select the KEYOFF and KEYLEN parameters.

Format

(partition_selection_routine)

Default value

None.

Specifies the size of partitions that are created.

PARTSIZE cannot be specified with PARTNUM or KEYS.

Specifying the PARTSIZE parameter causes IMS HALDB Toolkit to find the high keys. The specifications are analyzed to determine whether the requested partitioning is feasible.

Format

(1 - 8191)

• For a VSAM, 1 - 4095.
• For a VSAM with the OSAM(Y) parameter, 1 - 8191.
• For an OSAM, 1 - 8191.

Default value

If none of the parameters PARTNUM, PARTSIZE, or KEYS are specified, the default setting PARTSIZE(2048) is used.

Performs pointer checking during image copy.

This parameter is ignored when using the standard IMS image copy.

Format

(Y | N)

Default value

N

Increases HDAM root addressable area (RAA) by a specified number of blocks.

Format

(0 - 26777215)

Default value

None.

Specifies new PHDAM root anchor points (RAPs).

Format

(1 - 255)

Default value

If omitted, the default action is to copy from the existing RAPs.

Used for IMS High Performance Load processing. Specifies the number of tracks for the access method (VSAM or BSAM) buffers that are used for one database data set group when the database is read or written to.

If the load is a standard HD Load, this parameter is ignored.

For details, see the IMS High Performance Load User's Guide.

Format

(1 - 999)

Default value

30

Used for IMS High Performance Load processing. Specifies the number of database buffers (the number of tracks) to be used for one database data set group when the database is read or written to.

If the load is a standard HD Load, this parameter is ignored.

For details, see the IMS High Performance Load User's Guide.

Format

(1 - 999)

Default value

45

Used for IMS High Performance Load processing. Specifies whether IMS HP Load secures free space according to the specification of the FRSPC parameter in DBD.

If the load is a standard HD Load, this parameter is ignored.

For details, see the IMS High Performance Load User's Guide.

Format

(YES | NO)

Default value

YES

Used for IMS High Performance Load processing. Specifies whether IMS HP Load uses the High Performance I/O Driver for output database data sets.

If the load is a standard HD Load, this parameter is ignored.

For details, see the IMS High Performance Load User's Guide.

Format

(YES | NO)

Default value

YES

Used for IMS High Performance Load processing. Specifies whether IMS HP Load reduces the usage of data space when processing the overflow area by using the High Performance I/O driver or by using an OVERFLOW DD. This specification is valid only for HDAM or PHDAM databases.

If the load is a standard HD Load, this parameter is ignored.

For details, see the IMS High Performance Load User's Guide.

Format

(YES | NO)

Default value

NO

Used for IMS High Performance Load processing. Specifies whether IMS HP Load is to format HDAM or PHDAM RAA blocks regardless of the number of blocks used. Once the overflow area is used, this parameter is ignored and the entire RAA is formatted. This specification is valid only for HDAM or PHDAM databases.

If the load is a standard HD Load, this parameter is ignored.

For details, see the IMS High Performance Load User's Guide.

Format

(YES | NO)

Default value

YES

Used for IMS High Performance Load processing. Specifies the limit value for a space search algorithm that finds a segment that does not fit in its home block. This specification is valid for HDAM or PHDAM databases.

If the load is a standard HD Load, this parameter is ignored.

For details, see the IMS High Performance Load User's Guide.

Format

(0 - 999)

Default value

0

Used for IMS High Performance Load processing. Specifies whether to run the physical sequential sort processing before loading. This specification is valid only for HDAM and PHDAM databases.

If the load is a standard HD Load, this parameter is ignored.

For details, see the IMS High Performance Load User's Guide.

Format

(YES | NO)

Default value

NO

Used for IMS High Performance Load processing. Specifies whether to run the sort processing before loading a HIDAM or a PHIDAM.

If the load is a standard HD Load, this parameter is ignored.

For details, see the IMS High Performance Load User's Guide.

Format

(YES | NO)

Default value

NO

Used for IMS High Performance Load processing. Specifies whether IMS HP Load invokes a user exit routine.

If the load is a standard HD Load, this parameter is ignored.

For details, see the IMS High Performance Load User's Guide.

Format

(user_exit)

Default value

None.

Specifies the estimated number of database records.

The value is specified as FILSZ=Ex of OPTION control statement when calling sort processing.

If SORTFSZ is not specified, IMS HALDB Toolkit estimates the number of database records.

Format

(1 - 999999999)

Default value

None.

Specifies the name of the storage class for the new SMS-managed databases and image copy data sets that IMS HALDB Toolkit dynamically allocates.

Format

(storclas)

Default value

• For database data sets: If omitted, the default action is to copy from existing data sets.
• For image copy data sets: None.

Saves the takeover statements (DBRC and IDCAMS) to a specified data set.

You can specify SYSOUT=*, a sequential file, or a partitioned data set (PDS) or a partitioned data set extended (PDSE) with LRECL=80 and RECFM=F.

Format

(ddname)

Default value

None.

Specifies a 4-digit numeric space allocation value for temporary data set allocations, for example, the unload file. Specify a numeric value for the number of cylinders to allocate to each temporary data set.

If the number of cylinders to allocate to each temporary data set is omitted, IMS HALDB Toolkit determines the optimal value.

The number of data sets that are allocated is determined by IMS HALDB Toolkit.

Format

(0 - 3000)

Default value

None.

Specifies any valid direct-access 8-character unit name for temporary data set allocations, for example, the unload file. These files are temporary files that default to SYSALLDA, unless otherwise specified.

Format

(unitname)

Default value

SYSALLDA

Used to override the space allocation when creating the database data sets.

Format

(nn,pppp,ssss)

nn

The number of volumes to be used. This parameter is for SMS controlled allocations.

If nn is greater than 1, candidate volumes are defined. If nn is zero, VOLALLO is ignored.

pppp

The number of cylinders for the primary allocation. The maximum is 2000.

ssss

The number of cylinders for the secondary allocation. The maximum is 2000.

Default value

• nn: 0
• pppp: 300
• ssss: 300

Used to override the space allocation when creating the ILDS data sets.

Format

(nn,pppp,ssss)

nn

The number of volumes to be used. This parameter is for SMS controlled allocations.

If nn is greater than 1, candidate volumes are defined. If nn is zero, VOLALLOL is ignored.

pppp

The number of cylinders for the primary allocation.

ssss

The number of cylinders for the secondary allocation.

Default value

• nn: 0
• pppp: None.
• ssss: None.

Used to override the space allocation when creating the primary index data sets.

Format

(nn,pppp,ssss)

nn

The number of volumes to be used. This parameter is for SMS controlled allocations.

If nn is greater than 1, candidate volumes are defined. If nn is zero, VOLALLOX is ignored.

pppp

The number of cylinders for the primary allocation.

ssss

The number of cylinders for the secondary allocation.

Default value

• nn: 0
• pppp: None.
• ssss: None.