IBM Support

Updates to IMS Database Utility Solution V1.1 Overview and Customization

Product Documentation


Updates that apply to IMS Database Utility Solution V1.1 Overview and Customization (SC27-9006-00).


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

Update 3

Date of change: September 2019

Change description: Documentation updates

Topic: Customizing the tools of IMS Database Utility Solution > Configuring Tools Base

The following table has been updated as follows:

IMS Tools IMS Tools Common Services IMS Tools Knowledge Base Policy Services
IMS Database Reorganization Expert Optional Optional Optional
IMS HP Unload image 7001Optionalimage 7002 Optional -
IMS HP Load image 7001Optionalimage 7002 Optional -
IMS Index Builder Optional Optional -
IMS HP Image Copy Optional Optional Optional
IMS HALDB Toolkit image 7001Optionalimage 7002 - -
Database Sensor Optional Optional Optional

Update 2
Date of change: March 2017
Change description: Documentation update.
Topic: IMS Database Utility Solution for z/OS overview > Installation requirements

Operational requirements

IMS Database Utility Solution operates with the following IMS versions:

  • image 7001IMS Version 15 Release 1 (5635-A06) image 7002

Update 1
Date of change: February 2017
Change description: Documentation update.
Topic: The following new topic has been added after “Installing IMS Database Utility Solution”.

image 7001

Initial product customization using IMS Tools Setup

IMS Tools Setup is a function that helps you quickly and efficiently perform the required post-SMP/E-installation customization process for the products included in the IMS Tools solution packs that you have installed. IMS Tools Setup is provided by IBM Tools Base Version 1 Release 6 and later releases.

What does IMS Tools Setup do?

After the selected IMS Tools solution pack products have been installed into SMP/E data sets, you must complete customization tasks for all the IMS Tools included in the packs in order to begin using the tools. The goal of IMS Tools Setup is to greatly ease the time and effort it takes to have IMS Tools products up and running in your environment.

The IMS Tools Setup function (HKTQSETU) provides a step-by-step structured process (ISPF) that partially automates many of the normally time-consuming manual customization tasks. IMS Tools Setup generates JCL members that you then submit as jobs, or perform as tasks, that will complete the customization process.

IMS Tools Setup is intended for initial product installations, first-time users, and product evaluations. IMS Tools Setup is not intended for maintenance purposes.

IMS Tools products that can use IMS Tools Setup

The following IMS Tools solution packs can make use of IMS Tools Setup:

    • IBM IMS Database Solution Pack for z/OS
    • IBM IMS Fast Path Solution Pack for z/OS
    • IBM IMS Recovery Solution Pack for z/OS
    • IBM IMS Database Utility Solution for z/OS

IBM Tools Base components are also configured and customized during the IMS Tools Setup process. IBM Tools Base provides important supporting components and infrastructure that are required for the operation of many IMS Tools functions, such as storage repositories, autonomics, and interaction with IMS.

Starting IMS Tools Setup

The IMS Tools Setup function can be found in IBM Tools Base Version 1 Release 5 and later releases. You can start the function by executing the following REXX EXEC:

EXEC ‘smpehlq.SHKTCEXE(HKTQSETU)’ ‘HLQ(smpehlq)’

The IMS Tools Setup ISPF panels provide an organized and logical approach to the customization tasks. The panels explain the operation and sequence of each member that is generated in the CUSTJCL data set. The correct JCL job and task operation order is very important.

Each panel contains embedded panel-context and individual field-context Help information. All information about using IMS Tools Setup is contained in the embedded Help. There is no separate user guide.

IMS Tools Setup output

IMS Tools Setup produces the following output:
    • JCL to optionally combine all selected IMS Tools libraries
    • JCL to APF-authorize load library(s) (dynamic and permanent)
    • JCL to add MVS PPT entries to SYS1.PARMLIB (dynamic and permanent)
    • JCL to add load modules to LPA (dynamic and permanent)
    • JCL to add Subsystem entries to MVS (dynamic and permanent)
    • JCL to add RACF security for all tools that require security
    • Parameters (IMS Tools Generic Exits, IMS Tools Online System Interface, configuration members)
    • JCL to create global options modules and members
    • PROCs, address spaces, other required data sets
    • DBDs, PSBs, ACBs, MDAs, DB Initialization for IVPs

Completing IMS Tools Setup

After you execute the HKTQSETU REXX EXEC, locate member $$READ in the generated CUSTJCL data set. This member explains the JCL members that were just generated for informational purposes only. The $$READ member contains a table of member names, the associated role types, and short descriptions.

Each of the generated JCL members begin with "#" and are named in the logical sequence of operation. Any members ending with "@" require manual steps. You must begin with the first #xxxx member and submit the JCL job or perform the task. After that job or task completes, you continue on to the next member and submit that JCL job or perform that task, and so forth.

The first few members are all SYSPROG related (APF, LPA, SSN, MVSPPT), followed by security related members, TPNS ADMIN related members, DBA related members, and others.

You must process all members in the correct order to complete the full customization task properly.

Each JCL member has its own descriptive comment section that explains what the member does and which group it might belong to.
image 7002

Publication Number


[{"Line of Business":{"code":"LOB35","label":"Mainframe SW"},"Business Unit":{"code":"BU054","label":"Systems w\/TPS"},"Product":{"code":"SSCLV2","label":"IMS Database Utility Solution for z\/OS"},"ARM Category":[],"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Version(s)"}]

Document Information

Modified date:
25 March 2021