IBM Support

Updates to IMS Database Utility Solution V2.1: IMS HALDB Toolkit User's Guide

Product Documentation


Abstract

Updates that apply to IMS Database Utility Solution Pack V2.1: IMS HALDB Toolkit User's Guide (SC27-8779-00).

Content

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


Update 8

Date of change: September 2019

Change description: Documentation changes by APAR PH10937.  This APAR enhances IMS HALDB Toolkit to support the IMS management of ACBs for batch functions.

Topics: Changes apply to multiple topics.

------------------------------

Topic: Introduction to IMS HALDB Toolkit > IMS HALDB Toolkit overview

The following new topic has been added after “Usage and restrictions”:

Considerations for the IMS management of ACBs

When the IMS management of ACBs is enabled, IMS HALDB Toolkit can refer to database definitions in the IMS catalog directory instead of the DBD library.

IMS catalog definition is retrieved from either:

 - The IMS Catalog Definition exit routine (DFS3CDX0) in the STEPLIB concatenation.

 - The DFSDFxxx PROCLIB member specified by the DFSDF(xxx) parameter in IHCSYSIN and the PROCLIB DD statement.

The following conditions must be satisfied to use IMS managed ACBs:

 - IBM IMS Tools Base for z/OS, Version 1 Release 6 or later must be installed

 - The IMS catalog database must be registered to the RECON data sets.

 - The name of the IMS catalog database must be defined in the RECON record with the following DBRC command: CHANGE RECON CATALOG(name)

 - If the DFSMDA member with the TYPE=CATDSHLQ statement is used to specify the high-level qualifier of the IMS catalog system data sets, the library that contains the DFSMDA member must be in the STEPLIB concatenation of the IMS HALDB Toolkit job.

The following functions do not support the IMS management of ACBs:

 - Batch functions: CONVERT, IHCUDBD, IHCWPSBL, HALDBLOAD and a function to load logical children 

 - HALDB without DBRC

 - All ISPF functions

The following restrictions apply when the IMS catalog database is specified on the DBD parameter:

 - The IMS catalog is supported only by the ANALYZEPART function and the MAINTAIN function). No other function supports the IMS catalog.

 - IMS DD must be specified.

For more information, see "MAINTAIN example: Maintaining a database when the IMS management of ACBs is enabled".

------------------------------

Topic: Simulating HALDBs > Simulating HALDB using ANALYZEPART > ANALYZEPART data flow

Figure "ANALYZEPART data flow" has been updated as follows:

Figure. ANALYZEPART data flow

(Figure 1 in PDF)

ihcd0001

------------------------------

Topic: Simulating HALDBs > Simulating HALDB using ANALYZEPART > ANALYZEPART DD statements

PROCLIB DD has been added and IMS DD has been changed as follows:

Table. DD statements and record format for the ANALYZEPART command

(Table 3 in PDF)

DDname Use Format Need
... ... ... ...
IMS Input Same as IMS Optional
IMSDALIB Input Same as IMS Optional
PROCLIB Input Same as IMS Optional
RECONx Input Same as IMS Optional
... ... ... ...
...
IMS
This statement is required only if the IMS management of ACBs is not enabled.
The statement describes the library that contains the DBDs of the database that you are processing.
This data set must reside on DASD.
When the IMS management of ACBs is enabled, IMS HALDB Toolkit ignores the IMS DD statement.
PROCLIB
This statement is optional. The statement points to the IMS.PROCLIB data set. If DFSDF(ddd) is specified in the IHCSYSIN data set, you must specify this DD statement and ensure that the DFSDFddd member exists in the IMS.PROCLIB data set.

------------------------------

Topic: Simulating HALDBs > Simulating HALDB using ANALYZEPART > ANALYZEPART command parameters

New parameters DFSDF and IMSID have been added as follows:

Table. ANALYZEPART command parameters

(Table 4 in PDF)

Parameter Requirement Description
DBD ... ...
DFSDF Optional

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.
The specified member is used when the following two conditions are met:

  • IMS manages the ACBs (ACBMGMT=CATALOG).
  • The IMS Catalog Definition exit routine (DFS3CDX0) is not used.

Ensure that the CATALOG section of the DFSDFxxx member specifies CATALOG=Y, ACBMGMT=CATALOG, and the alias name for the IMS catalog.

Format: (ddd)

Default value: None.

IMSID Optional

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 value is obtained from the current SDFSRESL(DFSVC000).

INDPART ... ...

------------------------------

Topic: Maintaining HALDBs > Maintaining HALDB using MAINTAIN > MAINTAIN data flow

Figure "MAINTAIN data flow" has been updated as follows:

Figure. MAINTAIN data flow

(Figure 10 in PDF)

ihcd0003 0

------------------------------

Topic: Maintaining HALDBs > Maintaining HALDB using MAINTAIN > MAINTAIN DD statements

PROCLIB DD has been added and IMS DD has been changed as follows:

Table. DD statements and record format for the MAINTAIN command

(Table 9 in PDF)

DDname Use Format Need
... ... ... ...
IMS Input Same as IMS Optional
IMSDALIB Input Same as IMS ...
PROCLIB Input Same as IMS Optional
RECONx Input Same as IMS ...
... ... ... ...
IMS
This statement is required only if the IMS management of ACBs is not enabled.
The statement describes the library that contains the DBDs of the database that you are processing.
This data set must reside on DASD.
When the IMS management of ACBs is enabled, IMS HALDB Toolkit ignores the IMS DD statement.
PROCLIB
This statement is optional. The statement points to the IMS.PROCLIB data set. If DFSDF(ddd) is specified in the IHCSYSIN data set, you must specify this DD statement and ensure that the DFSDFddd member exists in the IMS.PROCLIB data set.
-----------------------------

Topic: Maintaining HALDBs > Maintaining HALDB using MAINTAIN > MAINTAIN command parameters

A new parameter DFSDF has been added. Also, description for parameter IMSID has been modified as follows:

Table. MAINTAIN command parameters

(Table 10 in PDF)

Parameter Requirement Description
... ... ...
DBDPATT ... ...
DFSDF Optional

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.
The specified member is used when the following two conditions are met:

  • IMS manages the ACBs (ACBMGMT=CATALOG).
  • The IMS Catalog Definition exit routine (DFS3CDX0) is not used.

Ensure that the CATALOG section of the DFSDFxxx member specifies CATALOG=Y, ACBMGMT=CATALOG, and the alias name for the IMS catalog.

Format: (ddd)

Default value: None.

DSNDBD ... ...
... ... ...
IMSID Optional

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 value is obtained from the current SDFSRESL(DFSVC000).

... ... ...

------------------------------

Topic: Maintaining HALDBs > Maintaining HALDB using MAINTAIN > MAINTAIN examples

The following new topic has been added after “MAINTAIN example: Specifying the key ranges for partitions”:

MAINTAIN example: Maintaining a database when the IMS management of ACBs is enabled

This example shows JCL statements to maintain a database in an IMS managed ACBs environment.

Figure xx. Sample JCL stream to maintain a database in an IMS managed ACBs environment

//S2     EXEC PGM=IHCHALDB,DYNAMNBR=999,REGION=80M
//STEPLIB  DD DISP=SHR,DSN=IMSTOOLS.SIHCLOAD <=== hcma loadlib
//         DD DISP=SHR,DSN=IMSTOOLS.SHPSLMD0 <=== ims tools loadlib
//         DD DISP=SHR,DSN=IMSTOOLS.SGLXLOAD <=== ims tools base loadlib
//         DD DISP=SHR,DSN=IMS.SDFSRESL      <=== ims reslib
//         DD DISP=SHR,DSN=IMS.MDALIB        <=== ims mdalib
//DFSRESLB DD DISP=SHR,DSN=IMS.SDFSRESL      <=== ims reslib
//PROCLIB  DD DISP=SHR,DSN=IMS.PROCLIB       <=== ims proclib
//SYSPRINT DD SYSOUT=*
//MSGPRINT DD SYSOUT=*
//AMSPRINT DD SYSOUT=*
//SYSUDUMP DD SYSOUT=*
//IHCLIST DD SYSOUT=*
//IHCSYSIN DD *
MAINTAIN ONLINE(N) -
PARTNUM(4) -
DBD(masterdbd) -
PARTLIST(partb,partc) -
DBDPATT(*****...) DSNPREF(DBSMS.DB) -
ICMID(3) -
ICHLQ(DBSMS.DB.IC) -
ICTRLR(2) -
IC.COMP(Y) -
IC.COMPRTN(FABJCMP2) -
PTRCHECK(Y) -
DFSDF(CAT)
  •  The DFSDF(CAT) parameter in IHCSYSIN and the PROCLIB DD statement specify the DFSDFCAT PROCLIB member that contains the IMS catalog definition.
  •  If you include the IMS Catalog Definition exit routine (DFS3CDX0) in the STEPLIB concatenation, you do not need to specify the DFSDF parameter and the PROCLIB DD statement.
  •  The SGLXLOAD library of IMS Tools Base must be in the STEPLIB concatenation.
  •  The library containing the DFSMDA member with TYPE=CATDSHLQ statement must be in the STEPLIB concatenation if the DFSMDA member is used to specify the high-level qualifier of the IMS catalog system data sets.    
  •  The IMS DD statement is not needed.

-----------------------------

Topic: HALDB utilities > Using DBRC enhancement utilities > Backing up DBRC definitions for HALDB DBD > BACKUPDBRC DD statements

PROCLIB DD has been added and IMS DD has been changed as follows:

Table. DD statements and record format for the BACKUPDBRC command

(Table 11 in PDF)

DDname Use Format Need
... ... ... ...
IMS Input Same as IMS Optional
IMSDALIB Input Same as IMS Optional
PROCLIB Input Same as IMS Optional
RECONx Input Same as IMS Optional
... ... ... ...
...
IMS
This statement is required only if the IMS management of ACBs is not enabled.
The statement describes the library that contains the DBDs of the database that you are processing.
This data set must reside on DASD.
When the IMS management of ACBs is enabled, IMS HALDB Toolkit ignores the IMS DD statement.
PROCLIB
This statement is optional. The statement points to the IMS.PROCLIB data set. If DFSDF(ddd) is specified in the IHCSYSIN data set, you must specify this DD statement and ensure that the DFSDFddd member exists in the IMS.PROCLIB data set.

-----------------------------

Topic: HALDB utilities > Using DBRC enhancement utilities > Backing up DBRC definitions for HALDB DBD > BACKUPDBRC command parameters

New parameters DFSDF and IMSID have been added as follows:

Table. BACKUPDBRC command parameters

(Table 12 in PDF)

Parameter Requirement Description
DBD ... ...
DFSDF Optional

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.
The specified member is used when the following two conditions are met:

  • IMS manages the ACBs (ACBMGMT=CATALOG).
  • The IMS Catalog Definition exit routine (DFS3CDX0) is not used.

Ensure that the CATALOG section of the DFSDFxxx member specifies CATALOG=Y, ACBMGMT=CATALOG, and the alias name for the IMS catalog.

Format: (ddd)

Default value: None.

IMSID Optional

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 value is obtained from the current SDFSRESL(DFSVC000).

INCLIC ... ...

-----------------------------

Topic: HALDB utilities > Using DBRC enhancement utilities > Cloning DBRC definitions for test environments > COPYDBRC DD statements

PROCLIB DD has been added and IMS DD has been changed as follows:

Table. DD statements and record format for the COPYDBRC command

(Table 13 in PDF)

DDname Use Format Need
... ... ... ...
IMS Input Same as IMS Optional
IMSDALIB Input Same as IMS Optional
PROCLIB Input Same as IMS Optional
RECONx Input Same as IMS Optional
... ... ... ...
...
IMS
This statement is required only if the IMS management of ACBs is not enabled.
The statement describes the library that contains the DBDs of the database that you are processing.
This data set must reside on DASD.
When the IMS management of ACBs is enabled, IMS HALDB Toolkit ignores the IMS DD statement.
PROCLIB
This statement is optional. The statement points to the IMS.PROCLIB data set. If DFSDF(ddd) is specified in the IHCSYSIN data set, you must specify this DD statement and ensure that the DFSDFddd member exists in the IMS.PROCLIB data set.

-----------------------------

Topic: HALDB utilities > Using DBRC enhancement utilities > Cloning DBRC definitions for test environments > COPYDBRC command parameters

New parameters DFSDF and IMSID have been added as follows:

Table. COPYDBRC command parameters

(Table 14 in PDF)

Parameter Requirement Description
... ... ...
DFDSSOUT ... ...
DFSDF Optional

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.
The specified member is used when the following two conditions are met:

  • IMS manages the ACBs (ACBMGMT=CATALOG).
  • The IMS Catalog Definition exit routine (DFS3CDX0) is not used.

Ensure that the CATALOG section of the DFSDFxxx member specifies CATALOG=Y, ACBMGMT=CATALOG, and the alias name for the IMS catalog.

Format: (ddd)

Default value: None.

DSNDBD ... ...
... ... ...
IDCOUT ... ...
IMSID Optional

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 value is obtained from the current SDFSRESL(DFSVC000).

INCLIND ... ...
... ... ...

-----------------------------

Topic: HALDB utilities > Using the HALDB Analyzer > CHECK DD statements

PROCLIB DD has been added and IMS DD has been changed as follows:

Table. DD statements and record format for the CHECK command

(Table 15 in PDF)

DDname Use Format Need
... ... ... ...
IMS Input Same as IMS Optional
IMSDALIB Input Same as IMS Optional
PROCLIB Input Same as IMS Optional
RECONx Input Same as IMS Optional
... ... ... ...

...

IMS
This statement is required only if the IMS management of ACBs is not enabled.
The statement describes the library that contains the DBDs of the database that you are processing.
This data set must reside on DASD.
When the IMS management of ACBs is enabled, IMS HALDB Toolkit ignores the IMS DD statement.
PROCLIB
This statement is optional. The statement points to the IMS.PROCLIB data set. If DFSDF(ddd) is specified in the IHCSYSIN data set, you must specify this DD statement and ensure that the DFSDFddd member exists in the IMS.PROCLIB data set.

-----------------------------

Topic: HALDB utilities > Using the HALDB Analyzer > CHECK command parameters

New parameters DFSDF and IMSID have been added as follows:

Table. CHECK command parameters

(Table 16 in PDF)

Parameter Requirement Description
... ... ...
DBD ... ...
DFSDF Optional

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.
The specified member is used when the following two conditions are met:

  • IMS manages the ACBs (ACBMGMT=CATALOG).
  • The IMS Catalog Definition exit routine (DFS3CDX0) is not used.

Ensure that the CATALOG section of the DFSDFxxx member specifies CATALOG=Y, ACBMGMT=CATALOG, and the alias name for the IMS catalog.

Format: (ddd)

Default value: None.

EXTENT ... ...
IMSID Optional

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 value is obtained from the current SDFSRESL(DFSVC000).

KEYS ... ...
... ... ...

-----------------------------

Topic: HALDB utilities > Reorganizing a PSINDEX > REORGIND DD statements

PROCLIB DD has been added and IMS DD has been changed as follows:

Table. DD statements and record format for the REORGIND command

(Table 17 in PDF)

DDname Use Format Need
... ... ... ...
IMS Input Same as IMS Optional
IMSDALIB Input Same as IMS Optional
PROCLIB Input Same as IMS Optional
RECONx Input Same as IMS Optional
... ... ... ...

...

IMS
This statement is required only if the IMS management of ACBs is not enabled.
The statement describes the library that contains the DBDs of the database that you are processing.
This data set must reside on DASD.
When the IMS management of ACBs is enabled, IMS HALDB Toolkit ignores the IMS DD statement.
PROCLIB
This statement is optional. The statement points to the IMS.PROCLIB data set. If DFSDF(ddd) is specified in the IHCSYSIN data set, you must specify this DD statement and ensure that the DFSDFddd member exists in the IMS.PROCLIB data set.

-----------------------------

Topic: HALDB utilities > Reorganizing a PSINDEX > REORGIND command parameters

New parameters DFSDF and IMSID have been added as follows:

Table. REORGIND command parameters

(Table 18 in PDF)

Parameter Requirement Description
DBD ... ...
DFSDF Optional

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.
The specified member is used when the following two conditions are met:

  • IMS manages the ACBs (ACBMGMT=CATALOG).
  • The IMS Catalog Definition exit routine (DFS3CDX0) is not used.

Ensure that the CATALOG section of the DFSDFxxx member specifies CATALOG=Y, ACBMGMT=CATALOG, and the alias name for the IMS catalog.

Format: (ddd)

Default value: None.

IMSID Optional

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 value is obtained from the current SDFSRESL(DFSVC000).

PARTITN ... ...

-----------------------------

Topic: HALDB utilities > Splitting an unload file into single partition files > IHCUSPLT DD statements

PROCLIB DD has been added and IMS DD has been changed as follows:

Table. DD statements and record format for the IHCUSPLT command

(Table 19 in PDF)

DDname Use Format Need
... ... ... ...
IMS Input Same as IMS Optional
IMSDALIB Input Same as IMS Optional
PROCLIB Input Same as IMS Optional
RECONx Input Same as IMS Optional
... ... ... ...

...

IMS
This statement is required only if the IMS management of ACBs is not enabled.
The statement describes the library that contains the DBDs of the database that you are processing.
This data set must reside on DASD.
When the IMS management of ACBs is enabled, IMS HALDB Toolkit ignores the IMS DD statement.
PROCLIB
This statement is optional. The statement points to the IMS.PROCLIB data set. If DFSDF(ddd) is specified in the IHCSYSIN data set, you must specify this DD statement and ensure that the DFSDFddd member exists in the IMS.PROCLIB data set.

-----------------------------

Topic: HALDB utilities > Splitting an unload file into single partition files > IHCUSPLT command parameters

New parameters DFSDF and IMSID have been added as follows:

Table. IHCUSPLT command parameters

(Table 20 in PDF)

Parameter Requirement Description
DBD ... ...
DFSDF Optional

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.
The specified member is used when the following two conditions are met:

  • IMS manages the ACBs (ACBMGMT=CATALOG).
  • The IMS Catalog Definition exit routine (DFS3CDX0) is not used.

Ensure that the CATALOG section of the DFSDFxxx member specifies CATALOG=Y, ACBMGMT=CATALOG, and the alias name for the IMS catalog.

Format: (ddd)

Default value: None.

IMSID Optional

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 value is obtained from the current SDFSRESL(DFSVC000).

-----------------------------

Topic: HALDB utilities > Recovering by using the ILK reset utility > RESETILK DD statements

PROCLIB DD has been added and IMS DD has been changed as follows:

Table. DD statements and record format for the RESETILK command

(Table 21 in PDF)

DDname Use Format Need
... ... ... ...
IMS Input Same as IMS Optional
IMSDALIB Input Same as IMS Optional
PROCLIB Input Same as IMS Optional
RECONx Input Same as IMS Optional
... ... ... ...

...

IMS
This statement is required only if the IMS management of ACBs is not enabled.
The statement describes the library that contains the DBDs of the database that you are processing.
This data set must reside on DASD.
When the IMS management of ACBs is enabled, IMS HALDB Toolkit ignores the IMS DD statement.
PROCLIB
This statement is optional. The statement points to the IMS.PROCLIB data set. If DFSDF(ddd) is specified in the IHCSYSIN data set, you must specify this DD statement and ensure that the DFSDFddd member exists in the IMS.PROCLIB data set.

-----------------------------

Topic: HALDB utilities > Recovering by using the ILK reset utility > RESETILK command parameters

New parameters DFSDF and IMSID have been added as follows:

Table. RESETILK command parameters

(Table 22 in PDF)

Parameter Requirement Description
DBD ... ...
DFSDF Optional

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.
The specified member is used when the following two conditions are met:

  • IMS manages the ACBs (ACBMGMT=CATALOG).
  • The IMS Catalog Definition exit routine (DFS3CDX0) is not used.

Ensure that the CATALOG section of the DFSDFxxx member specifies CATALOG=Y, ACBMGMT=CATALOG, and the alias name for the IMS catalog.

Format: (ddd)

Default value: None.

IMSID Optional

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 value is obtained from the current SDFSRESL(DFSVC000).

-----------------------------

Topic: HALDB utilities > Healing index pointers > PTRHEAL DD statements

PROCLIB DD has been added and IMS DD has been changed as follows:

Table. DD statements and record format for the PTRHEAL command

(Table 23 in PDF)

DDname Use Format Need
... ... ... ...
IMS Input Same as IMS Optional
IMSDALIB Input Same as IMS Optional
PROCLIB Input Same as IMS Optional
RECONx Input Same as IMS Optional
... ... ... ...

...

IMS
This statement is required only if the IMS management of ACBs is not enabled.
The statement describes the library that contains the DBDs of the database that you are processing.
This data set must reside on DASD.
When the IMS management of ACBs is enabled, IMS HALDB Toolkit ignores the IMS DD statement.
PROCLIB
This statement is optional. The statement points to the IMS.PROCLIB data set. If DFSDF(ddd) is specified in the IHCSYSIN data set, you must specify this DD statement and ensure that the DFSDFddd member exists in the IMS.PROCLIB data set.

-----------------------------

Topic: HALDB utilities > Healing index pointers > PTRHEAL command parameters

New parameters DFSDF and IMSID have been added as follows:

Table. PTRHEAL command parameters

(Table 24 in PDF)

Parameter Requirement Description
DBD ... ...
DFSDF Optional

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.
The specified member is used when the following two conditions are met:

  • IMS manages the ACBs (ACBMGMT=CATALOG).
  • The IMS Catalog Definition exit routine (DFS3CDX0) is not used.

Ensure that the CATALOG section of the DFSDFxxx member specifies CATALOG=Y, ACBMGMT=CATALOG, and the alias name for the IMS catalog.

Format: (ddd)

Default value: None.

IMSID Optional

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 value is obtained from the current SDFSRESL(DFSVC000).

-----------------------------

Topic: Application support > Testing partition selection exits > PSEXIT DD statements

PROCLIB DD has been added and IMS DD has been changed as follows:

Table. DD statements and record format for the PSEXIT command

(Table 29 in PDF)

DDname Use Format Need
... ... ... ...
IMS Input Same as IMS Optional
IMSDALIB Input Same as IMS Optional
PROCLIB Input Same as IMS Optional
RECONx Input Same as IMS Optional
... ... ... ...

...

IMS
This statement is required only if the IMS management of ACBs is not enabled.
The statement describes the library that contains the DBDs of the database that you are processing.
This data set must reside on DASD.
When the IMS management of ACBs is enabled, IMS HALDB Toolkit ignores the IMS DD statement.
PROCLIB
This statement is optional. The statement points to the IMS.PROCLIB data set. If DFSDF(ddd) is specified in the IHCSYSIN data set, you must specify this DD statement and ensure that the DFSDFddd member exists in the IMS.PROCLIB data set.

-----------------------------

Topic: Application support > Testing partition selection exits > PSEXIT command parameters

New parameters DFSDF and IMSID have been added as follows:

Table. PSEXIT command parameters

(Table 30 in PDF)

Parameter Requirement Description
DBD ... ...
DFSDF Optional

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.
The specified member is used when the following two conditions are met:

  • IMS manages the ACBs (ACBMGMT=CATALOG).
  • The IMS Catalog Definition exit routine (DFS3CDX0) is not used.

Ensure that the CATALOG section of the DFSDFxxx member specifies CATALOG=Y, ACBMGMT=CATALOG, and the alias name for the IMS catalog.

Format: (ddd)

Default value: None.

IMSID Optional

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 value is obtained from the current SDFSRESL(DFSVC000).

KEYLEN ... ...
... ... ...

-----------------------------

Topic: Application support > Creating a DFSHALDB statement > IHCUDFSH DD statements

PROCLIB DD has been added and IMS DD has been changed as follows:

Table. DD statements and record format for the IHCUDFSH command

(Table 31 in PDF)

DDname Use Format Need
... ... ... ...
IMS Input Same as IMS Optional
IMSDALIB Input Same as IMS Optional
PROCLIB Input Same as IMS Optional
RECONx Input Same as IMS Optional
... ... ... ...

...

IMS
This statement is required only if the IMS management of ACBs is not enabled.
The statement describes the library that contains the DBDs of the database that you are processing.
This data set must reside on DASD.
When the IMS management of ACBs is enabled, IMS HALDB Toolkit ignores the IMS DD statement.
PROCLIB
This statement is optional. The statement points to the IMS.PROCLIB data set. If DFSDF(ddd) is specified in the IHCSYSIN data set, you must specify this DD statement and ensure that the DFSDFddd member exists in the IMS.PROCLIB data set.

-----------------------------

Topic: Application support > Creating a DFSHALDB statement > IHCUDFSH command parameters

New parameters DFSDF and IMSID have been added as follows:

Table. IHCUDFSH command parameters

(Table 32 in PDF)

Parameter Requirement Description
DBD ... ...
DFSDF Optional

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.
The specified member is used when the following two conditions are met:

  • IMS manages the ACBs (ACBMGMT=CATALOG).
  • The IMS Catalog Definition exit routine (DFS3CDX0) is not used.

Ensure that the CATALOG section of the DFSDFxxx member specifies CATALOG=Y, ACBMGMT=CATALOG, and the alias name for the IMS catalog.

Format: (ddd)

Default value: None.

IMSID Optional

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 value is obtained from the current SDFSRESL(DFSVC000).

PCB ... ...

-----------------------------

Topic: Application support > Merging two databases into one HALDB > HALDBCOPY DD statements

PROCLIB DD has been added and IMS DD has been changed as follows:

Table. DD statements and record format for the HALDBCOPY command

(Table 37 in PDF)

DDname Use Format Need
... ... ... ...
IMS Input Same as IMS Optional
IMSDALIB Input Same as IMS Optional
PROCLIB Input Same as IMS Optional
RECONx Input Same as IMS Optional
... ... ... ...

...

IMS
This statement is required only if the IMS management of ACBs is not enabled.
The statement describes the library that contains the DBDs of the database that you are processing.
This data set must reside on DASD.
When the IMS management of ACBs is enabled, IMS HALDB Toolkit ignores the IMS DD statement.
PROCLIB
This statement is optional. The statement points to the IMS.PROCLIB data set. If DFSDF(ddd) is specified in the IHCSYSIN data set, you must specify this DD statement and ensure that the DFSDFddd member exists in the IMS.PROCLIB data set.

-----------------------------

Topic: Application support > Merging two databases into one HALDB > HALDBCOPY command parameters

New parameters DFSDF and IMSID have been added as follows:

Table. HALDBCOPY command parameters

(Table 38 in PDF)

Parameter Requirement Description
DFSDF Optional

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.
The specified member is used when the following two conditions are met:

  • IMS manages the ACBs (ACBMGMT=CATALOG).
  • The IMS Catalog Definition exit routine (DFS3CDX0) is not used.

Ensure that the CATALOG section of the DFSDFxxx member specifies CATALOG=Y, ACBMGMT=CATALOG, and the alias name for the IMS catalog.

Format: (ddd)

Default value: None.

FROMDBD ... ...
IMSID Optional

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 value is obtained from the current SDFSRESL(DFSVC000).

TODBD ... ...

-----------------------------

Topic: Troubleshooting > Messages and codes > Batch messages

The following new messages have been added:

IHC01701E HPSCCATI API failed RC=rc, RSN=rsn

Explanation: Received an error from the HPSCCATI API. rc and rsn are the return code and the reason code in decimals.

System action: Processing terminates.

User response: Contact IBM Software Support.

---

IHC01702I IMS management of ACBs is enabled

Explanation: The IMS management of ACBs is enabled.

System action: Processing continues.

User response: None. This message is informational.

---

IHC01703E GEX$CATQ API failed RC=rc, RSN=rsn, DBD=dbd

Explanation: Received an error from the GEX$CATQ API. The return code from the macro call was rc and the reason code was rsn. For the reason of the error, see the preceding messages with the GEX prefix that were issued by GEX$CAQ API.

System action: Processing terminates.

User response:  Locate preceding error messages and identify the cause of the error.

---

IHC01704E The specified DBD is for an IMS catalog database. IMS DD statement is required.

Explanation: The database specified on the DBD parameter is the IMS catalog database, and the IMS management of ACBs is enabled.

System action: Processing terminates.

User response:  If you want to process the IMS catalog database, disable the IMS management of ACBs, specify the IMS DD statement and rerun the job.


Update 7

Date of change: June 2019

Change description: Documentation changes by APAR PH11848.  This APAR enhances IMS HALDB Toolkit to support encrypted VSAM database data sets and encrypted image copy data sets.

Topics: Changes apply to multiple topics.

------------------------------

Topic: Converting to a HALDB > Converting to HALDB using CONVERT > CONVERT command parameters

A new parameter KEYLABEL has been added. Also, descriptions for parameters DATACLAS, MGMTCLAS, and STORCLAS have been modified as follows:

Table. CONVERT command parameters

(Table 8 in PDF)

Parameter Requirement Description
... ... ...
DATACLAS Optional
image-20180716101203-34Specifies the name of the data class for the new SMS-managed databases and image copy data sets that IMS HALDB Toolkit dynamically allocates.end of change
Format: (dataclass)
Default value:
  • image-20180716101203-34For database data sets: If omitted, the default action is to copy from existing data sets.end of change
  • image-20180716101203-34For image copy data sets: None.end of change
... ... ...
INITPART ... ...
image-20180716101203-34KEYLABELend of change image-20180716101203-34Optionalend of change
image-20180716101203-34Specifies the encryption key label for encrypting dynamically allocated database data sets and image copy data sets.
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.end of change
KEYLEN ... ...
... ... ...
MGMTCLAS Optional
Specifies a new SMS management class.
Format: (mgmtclas)
Default value:
  • image-20180716101203-34For database data sets: If omitted, the default action is to copy from existing data sets.end of change
  • image-20180716101203-34For image copy data sets: None.end of change
... ... ...
STORCLAS Optional
image-20180716101203-34Specifies the name of the storage class for the new SMS-managed databases and image copy data sets that IMS HALDB Toolkit dynamically allocates.end of change
Format: (storclas)
Default value:
  • image-20180716101203-34For database data sets: If omitted, the default action is to copy from existing data sets.end of change
  • image-20180716101203-34For image copy data sets: None.end of change
... ... ...

------------------------------

Topic: Maintaining HALDBs > Maintaining HALDB using MAINTAIN > MAINTAIN command parameters

A new parameter KEYLABEL has been added. Also, descriptions for parameters DATACLAS, MGMTCLAS, and STORCLAS have been modified as follows:

Table. MAINTAIN command parameters

(Table 12 in PDF)

Parameter Requirement Description
... ... ...
DATACLAS Optional
image-20180716101203-34Specifies the name of the data class for the new SMS-managed databases and image copy data sets that IMS HALDB Toolkit dynamically allocates.end of change
Format: (dataclass)
Default value:
  • image-20180716101203-34For database data sets: If omitted, the default action is to copy from existing data sets.end of change
  • image-20180716101203-34For image copy data sets: None.end of change
... ... ...
INITPART ... ...
image-20180716101203-34KEYLABELend of change image-20180716101203-34Optionalend of change
image-20180716101203-34Specifies the encryption key label for encrypting dynamically allocated database data sets and image copy data sets.
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.end of change
KEYLEN ... ...
... ... ...
MGMTCLAS Optional
Specifies a new SMS management class.
Format: (mgmtclas)
Default value:
  • image-20180716101203-34For database data sets: If omitted, the default action is to copy from existing data sets.end of change
  • image-20180716101203-34For image copy data sets: None.end of change
... ... ...
STORCLAS Optional
image-20180716101203-34Specifies the name of the storage class for the new SMS-managed databases and image copy data sets that IMS HALDB Toolkit dynamically allocates.end of change
Format: (storclas)
Default value:
  • image-20180716101203-34For database data sets: If omitted, the default action is to copy from existing data sets.end of change
  • image-20180716101203-34For image copy data sets: None.end of change
... ... ...

------------------------------

Topic: HALDB utilities > Using DBRC enhancement utilities > Cloning DBRC definitions for test environments > COPYDBRC command parameters

A new parameter KEYLABEL has been added. Also, descriptions for parameters DATACLAS and STORCLAS has been modified as follows:

Table. COPYDBRC command parameters

(Table 16 in PDF)

Parameter Requirement Description
... ... ...
DATACLAS Optional
Represent the SMS constructs to be used for the IDCAMS statements.
Format: (dataclas)
image-20180716101203-34Default value:  If omitted, the default action is to copy from existing data sets.end of change
... ... ...
INCLIND ... ...
image-20180716101203-34KEYLABELend of change image-20180716101203-34Optionalend of change
image-20180716101203-34Specifies the encryption key label to be used in IDCAMS processing.
The key label can be up to 64 bytes.
Format: (keylabel)
Default value: If omitted, the default action is to copy from existing data sets.end of change
STORCLAS Optional
Represent the SMS constructs to be used for the IDCAMS statements.
Format: (storclas)
image-20180716101203-34Default value: If omitted, the default action is to copy from existing data sets.end of change
... ... ...


Update 6

Date of change: April 2019

Change description: User's guide updates.

Topic: Reference

The following new topic has been added:

image-20180716101203-34

Performance tips and considerations
Use the following information to learn the techniques for improving the performance of ANALYZEPART, CONVERT, and MAINTAIN function jobs.
Generally, the performance of an IMS HALDB Toolkit job is not affected by IHCSYSIN command parameters. However, you can improve the IMS HALDB Toolkit job performance by tuning the processes of other IMS tools products that IMS HALDB Toolkit calls. Such IMS tools products include IMS High Performance Unload, IMS High Performance Load, and IMS High Performance Image Copy.
The following table summarizes the IMS tools products that IMS HALDB Toolkit functions call.
IMS Tools product ANALYZEPART CONVERT MAINTAIN
IMS HP Unload X X X
IMS HP Load - X X
IMS HP Image Copy
- X X
Improving the performance of the unload process (IMS HP Unload)
If IMS High Performance Unload is used for unloading data, you can tune and improve the performance of the unload process. To do so, create an IMS High Performance Unload default option table (FABHOPT) with HSSROPT control statements that improve the performance of the HSSR Engine and concatenate the FABHOPT to the STEPLIB DD of the IMS HALDB Toolkit JCL job.
For more information about creating an IMS High Performance Unload default option table, see the topic "Site default options" in the IMS High Performance Unload User's Guide.
Improving the performance of the load process (IMS HP Load)
If IMS High Performance Load is used for loading data, you can tune and improve the performance of the load process. To do so, provide IMS High Performance Load control statements with the following methods:
  • Specify RELOAD.xxxx parameters in the IHCSYSIN DD. RELOAD.xxxx parameters are applied to the load process as FRRIN control statement keywords to control the behavior of the load processing.
  • Create an IMS High Performance Load default option table (HPSROPT) with FRRIN control statements that improve the performance of the load processing and concatenate the HPSROPT to the STEPLIB DD of the IMS HALDB Toolkit JCL job.
HPSROPT, if concatenated to the STEPLIB DD, is always referred to. All RELOAD.xxxx parameters in IHCSYSIN DD and applicable FRRIN control statement keywords in HPSROPT are applied to the load process. If the same parameter is present in both IHCSYSIN DD and HPSROPT, for example, RELOAD.HPIO(YES) in IHCSYSIN DD and HPIO=N in HPSROPT, the parameter in IHCSYSIN is applied.
For more information about creating an IMS High Performance Load default option table, see the topic “Setting installation default options” in the IMS High Performance Load User’s Guide.

Improving the performance of the image copy process (IMS HP Image Copy)
If IMS High Performance Image Copy is used for creating image copies, you can tune and improve the performance of the image copy process. To do so, provide IMS High Performance Image Copy control statements with the following methods:
  • Specify IC.xxxx parameters in the IHCSYSIN DD. IC.xxxx parameters are applied to the image copy process as ICEIN control statement keywords to control the behavior of the image copy processing.
  • Create an IMS High Performance Image Copy default option table (FABJGLI0) with ICEIN control statements that improve the performance of the image copy processing and concatenate the FABJGLI0 to the STEPLIB DD of the IMS HALDB Toolkit JCL job.
FABJGLI0, if concatenated to the STEPLIB DD, is always referred to. All IC.xxxx parameters in IHCSYSIN DD and applicable ICEIN control statement keywords in FABJGLI0 are applied to the load process. If the same parameter is present in both IHCSYSIN DD and FABJGLI0, for example, IC.VIC(Y) in IHCSYSIN DD and VIC=N in FABJGLI0, the parameter in IHCSYSIN is applied.

For more information about creating an IMS High Performance Image Copy default option table, see the topic “Setting default values for the FABJMAIN program” in the IMS High Performance Image Copy User’s Guide.
end of change

Update 5

Date of change: February 2019

Change description: Documentation changes by APAR PH04245. The ANALYZEPART function can simulate HALDB conversion and report the structure of the converted DBD by printing DBD source (DBDGEN utility control statements). DBD source helps you understand the structure of the converted DBD and prevent unexpected conversion failure that may occur during HALDB conversion.

Topics: Changes apply to multiple topics.

------------------------------

Topic: Simulating HALDBs > Simulating HALDB using ANALYZEPART > ANALYZEPART data flow

Figure "ANALYZEPART data flow" has been updated as follows:

Figure. ANALYZEPART data flow

(Figure 1 in PDF)

image-20180716101203-34

image-20190225084120-1
 
image-20180716101203-34The simulation result is written to the Collect DBDs report in the IHCLIST data set.
  • If you request to generate DBRC commands, the DBRC commands are written to the data set pointed to from the dbrcout DD statement.
  • If you request to generate DBD source, DBDGEN utility control statements are written to the data set pointed to from the dbdsource DD statement.end of change
------------------------------

Topic: Simulating HALDBs > Simulating HALDB using ANALYZEPART > Simulating conversion to a HALDB

This topic has been updated as follows:

Procedure

  1. ...
  2. ...
  3. ...
    You can also refer to the following examples to code ANALYZEPART JCL statements and command parameters:
  • "ANALYZEPART example: Specifying the number of partitions"
  • "ANALYZEPART example: Specifying the partition size"
  • "ANALYZEPART example: Specifying the key ranges for partitions"
  • "ANALYZEPART example: Generating DBRC commands"
  • image-20180716101203-34"ANALYZEPART example: Generating DBD source"end of change

------------------------------

Topic: Simulating HALDBs > Simulating HALDB using ANALYZEPART > Simulating conversion or repartitioning using unloaded data sets as input

This topic has been updated as follows:

Restriction:  image-20180716101203-34When you simulate conversion from a full-function database to a HALDB by supplying unloaded data sets as input, the ANALYZEPART function processes only the primary DBD that is specified on the DBD parameter. It does not process any secondary index databases.  If DBD source generation is requested, IMS HALDB Toolkit generates DBD source for secondary index databases as well as for the primary DBD.end of change

Procedure

  1. ...
  2. ...
  3. ...
  4. image-20180716101203-34Specify the ANALYZEPART command parameters. For a list of ANALYZEPART command parameters, see "ANALYZEPART command parameters". For examples, see "ANALYZEPART example: Using unloaded data sets as input" and "ANALYZEPART example: Generating DBD source".end of change
    ...
------------------------------
Topic: Simulating HALDBs > Simulating HALDB using ANALYZEPART > ANALYZEPART DD statements

SYSPRINT DD has been added as follows:

Table. DD statements and record format for the ANALYZEPART command

(Table 3 in PDF)

DD name Use Format Need
... ... ... ...
IHCSYSIN Input ... ...
image-20180716101203-34SYSPRINT Output LRECL=133 Optionalend of change
MSGPRINT Output ... ...
... ... ... ...
...
image-20180716101203-34SYSPRINT
This statement is optional. This statement defines the statistics output data set and output from other utilities that are executed under the control of IMS HALDB Toolkit.
The data set can reside on DASD, or it can be routed through the output job. IMS HALDB Toolkit dynamically allocates this data set if you do not provide it.end of change
------------------------------

Topic: Simulating HALDBs > Simulating HALDB using ANALYZEPART > ANALYZEPART command parameters

New parameter, OSAM, has been added. Also, a new section has been added as follows:

The following parameters are available to use with ANALYZEPART command simulation tasks.

IMS HALDB Toolkit ignores any parameters that are unavailable for the requested process.

Subsections:

  • ANALYZEPART command parameters
  • ANALYZEPART command parameters for generating DBRC commands
  • image-20180716101203-34ANALYZEPART command parameters for generating DBD sourceend of change
...

ANALYZEPART command parameters for generating DBRC commands

...

Table. ANALYZEPART command parameters for generating DBRC commands

(Table 5 in PDF)

Parameter Requirement Description
... ... ...
KEYSORDR ... ...
image-20180716101203-34OSAM Optional
This parameter is effective only for non-HALDBs. IMS HALDB Toolkit ignores this parameter if this parameter is specified for a HALDB.
Converts VSAM to OSAM.
Format: (Y | N)
Default value: N
end of change
RAAINCR ... ...
... ... ...
image-20180716101203-34ANALYZEPART command parameters for generating DBD source
Use the following additional parameters to generate DBD source. DBD source, which are a series of DBDGEN utility statements, help you understand the structure of the converted database and prevent unexpected failures that may occur during HALDB conversion. If you do not need to generate DBD source, do not use these parameters. These parameters are effective only when the DBDSOURCE parameter, which specifies to generate DBD source, is specified.

The parameters in the following table are effective only for non-HALDBs. If any of these parameters are specified for a HALDB, IMS HALDB Toolkit ignores these parameters.

Table. ANALYZEPART command parameters for generating DBD source
Parameter Requirement Description
DBDSOURCE Required
   
Generates the DBD source for the converted HALDB and places it in the specified library.
You must also specify the dbdsource DD statement 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.
DBDSRCONLY Optional
Generates the DBD source without simulating HALDB conversion. No reports are generated in the IHCLIST data set.
Format: (Y | N)
Default value: N
DSG1 Optional
Changes a database with multiple data set groups into a database with a single data set group.

Format: (Y | N)
Default value: N
OSAM Optional
Converts VSAM to OSAM.

Format: (Y | N)
Default value: N
end of change
------------------------------

Topic: Simulating HALDBs > Simulating HALDB using ANALYZEPART > ANALYZEPART examples

The following new topic has been added:

image-20180716101203-34ANALYZEPART example: Generating DBD source


When you simulate conversion to a HALDB by using the ANALYZEPART command, you can optionally specify the DBDSOURCE parameter to generate a set of DBD sources for the Database Description (DBD) Generation (DBDGEN) utility.
If you also specify the DBDSRCONLY(Y) parameter, you can generate a set of DBD sources without simulating HALDB conversion. When DBDSRCONLY(Y) is specified, IMS HALDB Toolkit ignores all the parameters that are not used for generating the DBD source and creates no reports in the IHCLIST data set.

To generate DBD source, add the DBDSOURCE parameter to the ANALYZEPART command and the dbdsource DD statement, as shown in the following example:
//dbdsource DD DISP=(,CATLG),DSN=your.DBDSRC,
//             UNIT=SYSDA,SPACE=(TRK,(3,1,5)),DCB=(RECFM=FB,LRECL=80,BLKSIZE=8000)
//IHCSYSIN DD *
  ANALYZEPART DBD(xxxx) -
              PARTNUM(3) -
              DBDSOURCE(dbdsource)
The DBDSOURCE parameter value (dbdsource) specifies the name of the DD to which IMS HALDB Toolkit writes the DBD sources.

Example 1
If you want to generate DBD source without simulating HALDB conversion, specify the DBDSRCONLY(Y) parameter, as shown in the following example:
//DBDSRC DD DISP=(,CATLG),DSN=your.DBDSRC,
//          UNIT=SYSDA,SPACE=(TRK,(3,1,5)),DCB=(RECFM=FB,LRECL=80,BLKSIZE=8000)
//IHCSYSIN DD *
  ANALYZEPART DBD(xxxx) -
              DBDSRCONLY(Y) -
              DBDSOURCE(DBDSRC)

Example 2
If you want to change a database with multiple data set groups into a database with a single data set group and convert VSAM to OSAM, specify DSG1(Y) and OSAM(Y).
For more information about these parameters, see "ANALYZEPART command parameters for generating DBD source".
//DBDSRC DD DISP=(,CATLG),DSN=your.DBDSRC,
//          UNIT=SYSDA,SPACE=(TRK,(3,1,5)),DCB=(RECFM=FB,LRECL=80,BLKSIZE=8000)
//IHCSYSIN DD *
  ANALYZEPART DBD(xxxx) -
              PARTNUM(3) -
              DSG1(Y) -
              OSAM(Y) -
              DBDSOURCE(DBDSRC)

Example 3
If you want to use an unload data set as input and generate DBD source, specify the INPUT(UNLOAD) and the DBDSOURCE parameters, as shown in the following example:
//DFSUINPT DD DISP=SHR,DSN=your.hd.unload.dataset
//DBDSRC DD DISP=(,CATLG),DSN=your.DBDSRC,
//          UNIT=SYSDA,SPACE=(TRK,(3,1,5)),DCB=(RECFM=FB,LRECL=80,BLKSIZE=8000)
//IHCSYSIN DD *
  ANALYZEPART DBD(xxxx) -
              INPUT(UNLOAD) -
              PARTNUM(3) -
              DBDSOURCE(DBDSRC)
end of change
------------------------------

Topic: Converting to a HALDB > Converting to HALDB using CONVERT > CONVERT command parameters

Description of parameters DBDSOURCE and DBRCBACK has been modified as follows:

Table. CONVERT command parameters

(Table 7 in PDF)

Parameter Requirement Description
... ... ...
DBDPATT ... ...
DBDSOURCE Optional
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.

image-20180716101203-34

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.end of change
Format: (ddname)
Default value: None.
DBRCBACK Optional
Backs up the existing DBRC to a specified library.
This parameter includes a DDNAME that must be included in the JCL.

image-20180716101203-34

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.end of change
Format: (ddname)
Default value: None.
... ... ...
------------------------------

Topics: 

Figure "Main menu panel" has been updated with the following figure:

Figure. Main menu panel

(Figure 63 and 64 in PDF)

image-20180716101203-34

------------------------------ IMS HALDB Toolkit -----------------------------
Command ===>                                                                  
                                                                              
                                                                              
                                                                              
     _  Select Function                    Current Settings                   
                                           Environment:                       
                                           Version: IMS 14  Tool 1100         
     0  Setup Utilities                                                       
                                                                              
     1  Add-Delete-Change Environment                                         
     2  Select an Environment                                                 
     3  Projects in Progress                                                  
                                                                              
     4  Convert from Full Function to HALDB                                   
     5  Convert entire DBD library to HALDB                                   
     6  Split or Consolidate HALDB Partitions                                 
                                                                              
     7  Database Utilities                                                    
     8  Other Utilities                                                       
     9  DBRC for HALDB                                                        
end of change
------------------------------

Topic: Using the ISPF user interface > Processing a project > Selecting a project

Descriptions for option 5 have been added as follows:

You can use the IMS HALDB Toolkit main menu to select conversion and maintenance options for projects.

You must select an environment before beginning a conversion so that IMS HALDB Toolkit knows which data sets and RECONs to use. If you do not currently have an environment or you want to switch to a different environment, select option 2 (Add-Delete-Change Environment) from the IMS HALDB Toolkit main menu.

To begin a conversion project from an existing environment, select option 4 (Convert from Full Function to HALDB) from the IMS HALDB Toolkit main menu.

image-20180716101203-34To begin an entire DBD library conversion project from an existing environment, select option 5 (Convert entire DBD library to HALDB) from the IMS HALDB Toolkit main menu.end of change

To begin a maintenance project from an existing environment, select option 6 (Split or Consolidate HALDB Partitions) from the IMS HALDB Toolkit main menu.

Alternatively, you can select option 3 (Projects in Progress) to obtain a list of all projects for this environment. From this list, you can select the appropriate project.

Choosing a new or "last active" conversion project
To begin a conversion project from an existing environment, select option 4 (Convert from Full Function to HALDB) from the IMS HALDB Toolkit main menu.
The Convert Full Function to HALDB panel is displayed.

Figure. Convert Full Function to HALDB panel

(Figure 91 in PDF)

image-20180716101203-34

------------------------------ IMS HALDB Toolkit -----------------------------
Command ===>                                                                  
                                                                              
                        Convert Full Function to HALDB                        
                                                                              
     4  Select Function                    Current Settings                   
                                           Environment: online                
                                           Project: O-HDO2                    
                                           IMS Version: 14                    
                                                                              
     1  Add-Delete-Change Project                                             
     2  Projects in Progress                                                  
     3  Select a Project                                                      
                                                                              
     4  Start or Continue with the Current Project                            
                                                                              
     5  Rebuild old DBD                                                       
     6  Rebuild old dataset allocation                                        
     7  Rebuild old DBRC                                                      
     8  UNDO conversion     
end of change
image-20180716101203-34Choosing a new or "last active" entire DBD library conversion project
To begin an entire DBD library conversion project from an existing environment, select option 5 (Convert entire DBD library to HALDB) from the IMS HALDB Toolkit main menu.
The Convert entire DBD library to HALDB panel is displayed.
Figure. Convert entire DBD library to HALDB panel
 ------------------------------ IMS HALDB Toolkit -----------------------------
Command ===>                                                                 
                                                                             
                         Convert DBD library to HALDB                        
                                                                             
        Select Function                    Current Settings                  
                                           Environment: online              
                                           Project: O-HDO2                
                                           IMS Version: 14                   
                                                                             
     1  Add-Delete-Change Project                                            
     2  Projects in Progress                                                 
     3  Select a Project                                                     
                                                                             
     4  Start or Continue with the Current Project                           

     5  DBD source generation only      
Selecting option 4 or option 5 on this panel automatically connects IMS HALDB Toolkit to the last active project.
Note: If no connection can be made, the message no project selected is displayed. In that case, select option 3 to select a project.end of change

Choosing a new or "last active" maintenance project

...

...

------------------------------

Topic: Troubleshooting > Messages and codes > Batch messages

The following new messages have been added:

image-20180716101203-34
IHC01207I DBD is a HALDB. DBDSRCONLY(Y) is ignored.

Explanation: DBDSRCONLY(Y) is specified. However, IMS HALDB Toolkit ignored this parameter because the DBD is for a HALDB.
System action: None.
User response: None. This message is informational.
end of change
---
image-20180716101203-34
IHC01208I DBDSRCONLY(Y) is specified.

Explanation: DBDSRCONLY(Y) is specified. Because the DBD is for a non-HALDB, the parameter is effective and IMS HALDB Toolkit generates DBD source without simulating HALDB conversion.
System action: None.
User response: None. This message is informational.
end of change
---
image-20180716101203-34
IHC01209I Parameters not related to DBD source generation are ignored.
Explanation: Because DBDSRCONLY(Y) and DBDSOURCE parameters are specified, IMS HALDB Toolkit generates DBD source without simulating HALDB conversion. IMS HALDB Toolkit ignores all the parameters that are not related to DBD source generation. This message is issued even when such parameters are not specified.
System action: None.
User response: None. This message is informational.
end of change
---
image-20180716101203-34
IHC01210E DBDSOURCE is not specified.

Explanation: DBDSRCONLY(Y) parameter is specified without the DBDSOURCE parameter. DBDSRCONLY parameter must be used with the DBDSOURCE parameter.
System action: Processing stops.
User response: Specify the DBDSOURCE parameter and rerun the job.
end of change
---
image-20180716101203-34
IHC01211I DBD is a HALDB. DBDSOURCE is ignored.

Explanation: DBDSOURCE parameter is specified. However, IMS HALDB Toolkit ignored this parameter because the DBD is for a HALDB.
System action: None.
User response: None. This message is informational.
end of change

Update 4

Date of change: September 2018

Change description: Documentation change by APAR PH01710. By this APAR, the user's guide has been updated to include a post conversion step to remove dynamic allocation members.

Topics: Changes apply to multiple topics.

------------------------------

Topic: Converting to a HALDB > Converting to HALDB using CONVERT > Converting databases offlline

Step 5 has been added as follows:


The procedure has been updated as follows:


Procedure

1. Locate the sample JCL for this task in the SIHCSAMP file, member IHCECVTN.

...

4. Manually /DBR your databases before running the conversion job.

image-20180716101203-345. After the conversion process is complete and you are certain that you will not need to revert the database to its non-HALDB state, you can delete any DFSMDA members for the old database.end of change

------------------------------

 Topic: Using the ISPF user interface > Converting to HALDB > Converting HALDB using the ISPF user interface

Step 7 has been added as follows:


Procedure

1. To display the DBD Conversion Selection panel, select option 1 (Continue with

Current Project) from the Project Work panel. If you did not select DBDs, or if you cleared the project data set, this step is necessary.

...

6. Continue processing the project as described in Chapter 21, “Processing a project".

image-20180716101203-347. After the conversion process is complete and you are certain that you will not need to revert the database to its non-HALDB state, you can delete any DFSMDA members for the old database.end of change

------------------------------

Topic: Troubleshooting > Messages and codes > Batch messages

The following message has been updated as follows:

IHC01042E Subtask task id has terminated abnormally.


Explanation: image-20180716101203-34The functions of IMS HALDB Toolkit run as subtasks.end of change

Some of them might be in parallel. The subtask did not complete normally.

----

The following new messages have been added:

image-20180716101203-34
IHC01212I  Any DFSMDA members can be deleted for the old database


Explanation: The conversion process is complete. If you are certain that you will not need to revert the database to its non-HALDB state, you can delete any DFSMDA members for the old database. This message is also issued when the original_dbds DD is specified in CONVERT function JCL.

System action: None.

User response: None. This message is informational.

end of change
---

image-20180716101203-34

IHC01584E  Unexpected return code from TOSI client, MOD=module, FUNC=function, RC=rc, RSN=rsn


Explanation:  The IMS Tools Base IMS Tools Online System Interface (TOSI) client returned an unexpected return code. module is the module name, function is the function code, and rc is the return code.

System action:  Processing terminates.

User response:  Report the problem to IBM Software Support.

end of change
---

image-20180716101203-34

IHC01585E  TOSI command security check failed for imsid, CLASS=class, COMMAND=command


Explanation:  The IMS HALDB Toolkit job is not authorized to execute the indicated command on the IMS subsystem imsid. class is the security class that is used on the IMS subsystem.

System action:  Processing terminates.

User response:  Make sure that your user ID has the required authority to issue the command.

end of change


Update 3

Date of change: August 2018

Change description: Documentation changes by APAR PH00721. The CONVERT and MAINTAIN functions support new parameters,  UNLSPAC and UNLUNIT.

Topics: Changes apply to multiple topics.

------------------------------

Topic: Converting to a HALDB > Converting to HALDB using CONVERT > CONVERT command parameters

UNLSPAC and UNLUNIT parameters have been added to the following table:

Table. CONVERT command parameters

(Table 7 in PDF)

Parameter Requirement Description
... ... ...
TAKEOVER.FILE ... ...
image-20180712124334-5UNLSPAC Optional

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: (1 - 3000)

Default value: None.

image-20180712124334-4

image-20180712124334-5UNLUNIT Optional

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

image-20180712124334-4

VOLALLO ... ...
... ... ...

------------------------------

Topic: Maintaining HALDBs > Maintaining HALDB using MAINTAIN > MAINTAIN command parameters

UNLSPAC and UNLUNIT parameters have been added to the following table:

Table. MAINTAIN command parameters

(Table 10 in PDF)

Parameter Requirement Description
... ... ...
TAKEOVER.FILE ... ...
image-20180712124334-5UNLSPAC Optional

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: (1 - 3000)

Default value: None.

image-20180712124334-4

image-20180712124334-5UNLUNIT Optional

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

image-20180712124334-4

VOLALLO ... ...
... ... ...


Update 2

Date of change: July 2018

Change description: Documentation change by APAR PI99707. The CONVERT and MAINTAIN functions support the GDGLIMIT parameter, which controls the number of maximum data sets that can be associated with a GDG.

Topics: Changes apply to multiple topics.

Topic: Converting to a HALDB > Converting to HALDB using CONVERT > CONVERT command parameters

GDGLIMIT parameter has been added to the following table:

Table. CONVERT command parameters

(Table 7 in PDF)

Parameter

Requirement

Description

...

...

...

FSPF

Optional

...

image-20180712124900-1GDGLIMIT

Optional

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

image-20180712124900-6

...

...

...

IC1DSN parameter has been updated as follows:

IC1DSN

...

&JOBNAME

Name of this job.

...

...

&TIME2

...

image-20180723144935-1&GDG

The identifier for the GDG data set.

If specified, &GDG must be the last value on the IC1DSN parameter. image-20180723144935-2

where:

  • yyyy is the 4-digit year
  • ...

Topic: Maintaining HALDBs > Maintaining HALDB using MAINTAIN > MAINTAIN command parameters

GDGLIMIT parameter has been added to the following table:

Table. MAINTAIN command parameters

(Table 10 in PDF)

Parameter

Requirement

Description

...

...

...

FSPF

Optional

...

image-20180712124900-9GDGLIMIT

Optional

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

image-20180723145103-4

...

...

...

IC1DSN parameter has been updated as follows:

IC1DSN

...

&JOBNAME

Name of this job.

...

...

&TIME2

...

image-20180712124900-15

&GDG

The identifier for the GDG data set.

If specified, &GDG must be the last value on the IC1DSN parameter. image-20180723144935-2

where:

  • yyyy is the 4-digit year
  • ...

Topic: Troubleshooting > Messages and codes > Batch messages

The following new message has been added:

image-20180712124900-17

IHC01206I A GDG base entry is being created. NAME: GDG_base, LIMIT: nnn

Explanation: The IDCAMS utility is creating a GDG base entry. GDG_base shows the name of the GDG base entry data set, and nnn shows the maximum number of data sets that can be associated with the GDG.

System action: None.

User response: None. This message is informational.

image-20180712124900-18



Update 1
Date of change: June 2018
Change description: Documentation changes by APAR PI97681.
Topics: Changes apply to multiple topics.

Topic: Simulating HALDBs > Simulating HALDB using ANALYZEPART > ANALYZEPART command parameters for generating DBRC commands

The following changes were made to table “ANALYZEPART command parameters for generating DBRC commands”:
  • INDPATT parameter has been added
  • CONST and FIRSTPART parameters have been updated

Table. ANALYZEPART command parameters for generating DBRC commands
(Table 5 in PDF)

Parameter Requirement Description
CONST Optional Used as a substitute for the DBD name when building partition names. See also DBDPATT, INDPATT, and FIRSTPART parameters.
Format: (constant)
Default value: None.
FBFF Optional
FIRSTPART Optional 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.
...
FSPF Optional
INDPATT Optional Creates a partition name "stub" from the DBD name of a secondary index.
This parameter is effective only when you simulate conversion from a full-function database to a HALDB.

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 (******..).
Topic: Maintaining HALDBs > Maintaining HALDB using MAINTAIN > MAINTAIN command parameters

CONST and FIRSTPART parameters have been updated as follows:

Table. MAINTAIN command parameters
(Table 10 in PDF)
Parameter Requirement Description
BYTELIM Optional
CONST Optional Used as a substitute for the DBD name when building partition names. See also DBDPATT and FIRSTPART parameters.
Format: (constant)
Default value: None.
FBFF Optional
FIRSTPART Optional Identifies the partition name extension to be added to the name "stub" created by the DBDPATT parameter.
The "stub" and the extension cannot exceed 7 characters.

Publication Number

SC27-8779-00

[{"Business Unit":{"code":"BU011","label":"Systems - zSystems"},"Product":{"code":"SSV7D2","label":"IMS Tools"},"Component":"IMS Database Utility Solution: IMS HALDB Toolkit","Platform":[{"code":"PF035","label":"z/OS"}],"Version":"2.1.0","Edition":"SC27-8779-00"}]

Document Information

Modified date:
29 September 2019

UID

swg27051183