0% found this document useful (0 votes)
680 views212 pages

Tad 4 Z

Download as pdf or txt
Download as pdf or txt
Download as pdf or txt
You are on page 1/ 212

Tivoli IBM Tivoli Asset Discovery for z/OS

Version 7.2 


Version 7 Release 2

IBM Confidential

Administration Guide and Reference

SC23-9991-00
Tivoli IBM Tivoli Asset Discovery for z/OS

Version 7.2 


Version 7 Release 2

IBM Confidential

Administration Guide and Reference

SC23-9991-00
IBM Confidential

Note
Before using this information and the product it supports, read the information in Notices on page 193.

Edition Notice
Beta draft version (May 7, 2009)
This edition applies to Tivoli Asset Discovery for z/OS, Version 7, Release 2 (product number 5698B39) and to all
subsequent releases and modifications until otherwise indicated in new editions.
Copyright International Business Machines Corporation 2009.
US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
IBM Confidential

Contents
Figures . . . . . . . . . . . . . . . v Verifying your installation . . . . . . . . 31
Tivoli Common Reporting User Roles . . . . 31
About this document . . . . . . . . vii
Chapter 7. Migration . . . . . . . . . 33
Chapter 1. Overview of Tivoli Asset TLCMz conversion . . . . . . . . . . . . 33
Migration from Dorana Version 5 Release 4. . . . 35
Discovery for z/OS . . . . . . . . . . 1 Migration from Hardware and Software
Data Capture phase tasks . . . . . . . . . . 3 Identification for z/OS Version 7 Release 1 . . . . 37
Running the Inquisitor . . . . . . . . . . 3 DB2 objects affected by migration . . . . . . . 39
Running the Usage Monitor . . . . . . . . 4
Computation phase tasks . . . . . . . . . . 4
Importing the Inquisitor captured data . . . . 4
Chapter 8. Inquisitor for z/OS . . . . . 43
Matching captured data to the Knowledge Base . 4 Inquisitor JCL . . . . . . . . . . . . . 43
Loading the matched information into the Files used by the Inquisitor . . . . . . . . . 44
Repository . . . . . . . . . . . . . . 5 Functions performed by the Inquisitor . . . . . 45
Importing the Usage captured data . . . . . . 5 Syntax of Inquisitor requests. . . . . . . . . 46
Running Utilities . . . . . . . . . . . . 5 Control statement specification . . . . . . . 47
Reporting phase tasks . . . . . . . . . . . 5 Examples . . . . . . . . . . . . . . 52
Designing requests . . . . . . . . . . . . 54
Processing migrated libraries . . . . . . . . 55
Chapter 2. Deployment Scenarios. . . . 7 Collection of Inquisitor output . . . . . . . . 56
Inquisitor for z/OS UNIX . . . . . . . . . 57
Chapter 3. Installation requirements . . 13 Inquisitor JCL for z/OS UNIX . . . . . . . 57
Hardware requirements . . . . . . . . . . 13 Files used by the Inquisitor for z/OS UNIX . . 58
Processors . . . . . . . . . . . . . . 13 Security considerations when running the
Software requirements . . . . . . . . . . . 13 Inquisitor against z/OS UNIX files . . . . . 59
z/Architecture software . . . . . . . . . 13
Tivoli Common Reporting Software . . . . . 14 Chapter 9. Usage Monitor. . . . . . . 61
Security and authorization . . . . . . . . 14 Usage Monitor JCL . . . . . . . . . . . . 61
Files used by the Usage Monitor . . . . . . . 61
Chapter 4. Installation . . . . . . . . 15 The use of exclusion masks to reduce data . . . . 62
Installing Tivoli Asset Discovery for z/OS . . . . 15 Program name exclusion masking . . . . . . 62
Installing Tivoli Common Reporting . . . . . . 15 Data set name exclusion masking . . . . . . 62
Starting the Usage Monitor . . . . . . . . . 63
Chapter 5. Post-installation Stopping the Usage Monitor . . . . . . . . . 63
customization. . . . . . . . . . . . 17 Refreshing Usage Monitor settings. . . . . . . 64
z/OS Customization . . . . . . . . . . . 17 Usage Monitor commands . . . . . . . . . 65
DB2 customization . . . . . . . . . . . . 17
Installing DB2 Connect (if required) . . . . . 18 Chapter 10. Inquisitor Import . . . . . 85
Creating post-installation jobs . . . . . . . . 18 Running Inquisitor Import . . . . . . . . . 85
Running post-installation jobs . . . . . . . 26 TPARAM parameters . . . . . . . . . . 85
Customizing tasks for Japanese messages . . . . 26
Chapter 11. The Match Engine. . . . . 87
Chapter 6. Post-installation tasks for Running the Match Engine . . . . . . . . . 87
Tivoli Common Reporting . . . . . . 29 TPARAM parameters . . . . . . . . . . 87
Installing the DB2 JDBC driver and license JARs . . 29
Starting Tivoli Common Reporting . . . . . 29 Chapter 12. Load to Repository . . . . 89
Transferring the Tivoli Common Reporting report Continuous Inventory . . . . . . . . . . . 89
package from the host system . . . . . . . 30 Adding Inquisitor data to an existing Inventory . . 89
Importing the Tivoli Common Reporting report Running Load to Repository. . . . . . . . . 90
package . . . . . . . . . . . . . . 30 TPARAM parameters . . . . . . . . . . 90
Determining Tivoli Common Reporting JDBC
data sources . . . . . . . . . . . . . 30 Chapter 13. Usage Import. . . . . . . 91
Configuring the Tivoli Common Reporting Running Usage Import . . . . . . . . . . 91
Report Data Sources for JDBC . . . . . . . 30 TPARAM parameters . . . . . . . . . . 91

Copyright IBM Corp. 2009 iii


IBM Confidential

Chapter 14. Reporting . . . . . . . . 93 Repository Merge . . . . . . . . . . . . 122


TCR reporting . . . . . . . . . . . . . 93 Destination Repository . . . . . . . . . 123
Batch reporting . . . . . . . . . . . . . 99 Running Repository Merge . . . . . . . . 123
Running the sample HSISBATR Batch Reporting TPARAM table update . . . . . . . . . . 123
JCL. . . . . . . . . . . . . . . . 100 Running TPARAM table update . . . . . . 124
SCRT Import Utility . . . . . . . . . . . 124
Chapter 15. Utilities . . . . . . . . . 103 Running SCRT Import Utility . . . . . . . 124
XML Export Utility . . . . . . . . . . . 124
Knowledge Base Updates . . . . . . . . . 103
Running XML Export Utility . . . . . . . 124
Running the Knowledge Base Updates . . . . 103
HSISZCAT . . . . . . . . . . . . . . 125
Automation Server for z/OS . . . . . . . . 104
Running HSISZCAT . . . . . . . . . . 126
Automation Server JCL . . . . . . . . . 104
Deleting HSISZCAT Input data sets . . . . . 126
Files used by the Automation Server . . . . 104
Starting the Automation Server . . . . . . 106
Stopping the Automation Server . . . . . . 106 Appendix A. Messages . . . . . . . 127
Action processing . . . . . . . . . . . 106 HSIA - Automation Server messages . . . . . 127
Automation Server control data set cleanup . . 108 HSII - Utility messages . . . . . . . . . . 129
Automation Server request control statements 108 HSIP - Inquisitor for z/OS messages and codes 136
Product Tagging Utility . . . . . . . . . . 111 HSIT - Product Tagging messages . . . . . . 149
Running the Tagger . . . . . . . . . . 113 HSIX - Inquisitor for z/OS UNIX messages and
Tagger control statements . . . . . . . . 113 codes . . . . . . . . . . . . . . . . 155
Region Association Utility . . . . . . . . . 116 HSIZ - Usage Monitor messages . . . . . . . 156
Running Region Association utility . . . . . 116 HSIC - Globalization messages . . . . . . . 171
Inventory Association . . . . . . . . . . 118 Return codes . . . . . . . . . . . . 174
Creating an association . . . . . . . . . 119
Running Inventory Association . . . . . . 119 Appendix B. Repository table layouts 181
Usage Summary . . . . . . . . . . . . 119
Running Usage Summary . . . . . . . . 120 Notices . . . . . . . . . . . . . . 193
Usage Deletion . . . . . . . . . . . . . 121 Trademarks . . . . . . . . . . . . . . 195
Running Usage Deletion. . . . . . . . . 121
Delete Inventory . . . . . . . . . . . . 121
Running Delete Inventory . . . . . . . . 121
Index . . . . . . . . . . . . . . . 197
High Level Qualifier listing for Usage Monitor . . 122
Running High Level Qualifier for Usage
Monitor . . . . . . . . . . . . . . 122

iv Administration Guide and Reference


IBM Confidential

Figures
1. Tivoli Asset Discovery for z/OS workflow 2 7. Tivoli Common Reporting navigation tree 94
2. Hierarchical view of Inventory association 7 8. Tivoli Common Reporting Right-click View As 95
3. Four LPARS, each with own set of DASD 9 9. Tivoli Common Reporting Example Parameter
4. Four LPARs, all with Shared DASD, Prompt . . . . . . . . . . . . . . 96
Non-Sysplex . . . . . . . . . . . . 10 10. Tivoli Common Reporting Edit User
5. Sysplex of four LPARs all with Shared DASD 11 Preferences. . . . . . . . . . . . . 97
6. Four LPARs, one set of shared DASD, plus a 11. Tivoli Common Reporting Example Trend
set of nonshared DASD for each LPAR . . . 12 Chart with Hyperlinks . . . . . . . . . 98

Copyright IBM Corp. 2009 v


IBM Confidential

vi Administration Guide and Reference


IBM Confidential

About this document


The Tivoli Asset Discovery Administration Guide and Reference explains how to
install, configure, and use the Tivoli Asset Discovery .

Who should read this document

This document is intended for system administrators who install and configure
Tivoli Asset Discovery, or who perform daily system management tasks such as
inventory gathering and reporting of software distribution.

What this Guide contains


v Chapters 1 - 6
Provide information on installation and migration processes are a Reference
Guide to the product.
v Chapters 7 - 15
Provides general reference information.
v Appendix A Messages
Provides a reference for the messages.
v Appendix B Repository table layouts
Provides a reference for the Repository table layouts

Copyright IBM Corp. 2009 vii


IBM Confidential

viii Administration Guide and Reference


IBM Confidential

Chapter 1. Overview of Tivoli Asset Discovery for z/OS


Tivoli Asset Discovery for z/OS runs on z/Architecture mainframes executing the
z/OS operating system. Its purpose is to
v discover and identify services for the z/OS platform
v monitor software usage and trends
v report on the MIPS capacity of each LPAR under which the product runs
v provide reporting for assets and usage

The benefits of using this software are:


v used and unused software are identified
v users of software are identified
v obsolete versions of software are identified and the usage of these versions
determined
v usage trends of software and libraries are identified

In an IBM z/OS environment, software is contained within load libraries as load


modules, also known as LMODS, or in executable files in the z/OS UNIX file
system. The software products installed, and usage of those products, is accurately
determined by scanning the content of these libraries and files. Tivoli Asset
Discovery for z/OS contains a number of components designed to carry out this
task. In addition, the scanned load libraries, load modules, and z/OS UNIX files
are checked against a database of product information supplied by this software.
This database allows the product to infer, from the contents of the load libraries
and z/OS UNIX files, what products are installed on a system, or made available
to the system to use. The database component is known in the product as the
Global Knowledge Base, or GKB. In addition there is a Local Knowledge Base,
or LKB, in which you can define your own software or occasional changes to the
GKB. In specific circumstances, the LKB information is used in preference to the
GKB.

This diagram shows the Tivoli Asset Discovery for z/OS workflow.

Copyright IBM Corp. 2009 1


IBM Confidential

Capture phase

1b 1a
Usage IQ Scan Product
Monitor PDS/UNIX tagger
Tagged data

Usage Scanned data


raw data PDS/UNIX

Computation phase

5 2
Usage IQ Import
Import PDS/UNIX
IQ filters
Tagged data

IQ Data LKB
PDS/UNIX

3
Match Engine
PDS/UNIX
GKB

Match
4 Engine
Load to
Repository
PDS/UNIX
Repository

Repor ting phase

6 Batch
TCR

Leg end
Note:
IQ - Inquisitor 1.The data as described in the Computation Phase
LKB - Local Knowledge Base belongs to the same database. They are just different
GKB - Global Knowledge Base sets of DB2 tables.
TCR - Tivoli Common Reporting 2.Inquisitor scan and Usage Monitor can be run concurrently.

Figure 1. Tivoli Asset Discovery for z/OS workflow

Inquisitor
A set of programs which find load modules and UNIX System Services
load modules. One program locates load libraries on z/OS DASD devices,

2 Administration Guide and Reference


IBM Confidential

opens these load libraries, and captures information from the load modules
located in the libraries. This program is targeted to specific devices,
libraries, or groups of libraries. It creates a compressed data set, which is
then used as input to the Inquisitor Import process.
Another program locates and scans z/OS UNIX directories for executable
files, and captures this information. It creates a compressed data set, which
is then used as input to the Inquisitor Import for z/OS UNIX processing.
Product Tagger
A utility that allows the identification of software, which has not been
predefined in the Global Knowledge Database. It can also be used to
supersede GKB entries without changing the GKB contents.
Usage Monitor
A program which attaches to the z/OS program management functions,
using standard IBM attachment protocols. It is able to monitor the
execution of load modules and to record these events.
Inquisitor Import
A set of programs that load raw Inquisitor data into DB2 tables on z/OS,
for both z/OS load modules and z/OS UNIX load modules.
Match Engine
The process whereby the imported Inquisitor data is matched against a
Global Knowledge Database. This database is provided by IBM. The Local
Knowledge Database, populated by the user, can also be used during the
match process.
Load to Repository
The process whereby the matched Inquisitor data is copied into the
Repository. The Repository is where all data resides.
Usage Import
The process whereby the raw Usage Monitor data is copied into the
Repository against matching load modules. Once completed, the user
views the Usage results by way of the TCR reports, or by submitting batch
reports.
TCR/Batch
Also known as Tivoli Common Reporting, and Batch Reporting provide
the basis for reporting the results of the scanned systems. The product
provides several reports that are accessed from TCR or Batch. These
reports determine what and where the products are located on the system.

Data Capture phase tasks


The Data Capture phase consists of running the Inquisitor and the Usage Monitor
on the target system, or systems, that the information is required from. The Data
Capture phase does not require DB2. The data sets created by Data Capture are
then used by the Computation phase.

Running the Inquisitor


For each of the schemas specified, submit the ZIQ* members and the UIQ*
members. If you have NJE, you can submit the jobs from a single system. It is
important that the job runs on the appropriate system. For sysplex or shared

Chapter 1. Overview of Tivoli Asset Discovery for z/OS 3


IBM Confidential

system schemas, you only have to run one job for each sysplex or shared system.
The job can run on any member of the sysplex, or any system, in the shared
systems.

The output of the Inquisitor PDS/E for the ZIQ* members, and z/OS UNIX for
UIQ* members, are data sets that contain the results of the scan.

Running the Usage Monitor


The Usage Monitor can be started depending on how you have deployed your
system. If you have NJE, you can submit the jobs from a single system. However,
make sure that the job runs on the appropriate system. If the schema is for a
sysplex or shared system, you can run the same job on every member of the
sysplex or on each shared system. If the systems are in a Multi-Access Spool
environment, you might have to change the job name in each system in order to
get the jobs to run.

The monitor runs continuously, capturing data on what programs the system is
running. This information is written to a data space. The data is available for
further processing whenever it is off-loaded to a data set from the data space. This
occurs by default at midnight, or you can set a switch to force the offload to occur.

Computation phase tasks


The Computation phase consists of importing the data captured by the Data
Capture phase into DB2 tables, and then matching that captured data with the
information in the GKB and LKB. The result is a database of found installed
products with optional usage information. The result of the matched imported data
is then loaded to the Repository where the Reporting phase can use it.

The computation phase tasks all run on the DB2 system. They involve:
1. Importing the Inquisitor captured data.
2. Matching the captured data with known product information from the Global
and Local Knowledge bases.
3. Loading the matched information into the Repository.
4. Importing the Usage captured data into the Repository.
5. Running Utilities to manage and maintain your data. These tasks are optional.

Importing the Inquisitor captured data


This task can only be run when the Inquisitor has captured data. This captured
data is then loaded into DB2 tables, which are defined with unique schema names.

Matching captured data to the Knowledge Base


Matching captured data can only be run when the Importing Inquisitor captured
data task has been completed. The imported Inquisitor is matched against the
Global and Local Knowledge Base to determine identified and unidentified
modules.

4 Administration Guide and Reference


IBM Confidential

Loading the matched information into the Repository


Loading the matched information can only be run when the Matching captured
data to the Knowledge Base task has been completed. This process copies your
matched Inquisitor data into the Repository where all the Inventory data is stored.

When this has been done, you can run the various reports to see what products are
installed on your various systems.

Importing the Usage captured data


Importing the Usage captured data can only be run after the Repository has been
populated, at lease once, by the Loading the matched information into the
Repository task. In this function, data captured from the Usage Monitor is
imported into the Repository.

Running Utilities
Utility jobs are provided to manage and maintain data that has been captured and
loaded into the system. These jobs are mainly for housekeeping and are optional.

Reporting phase tasks


The report phase tasks all run against the DB2 system. They involve:
1. Using Tivoli Common Reporting to view your data.
2. Running batch SQL queries to view your data.

Chapter 1. Overview of Tivoli Asset Discovery for z/OS 5


IBM Confidential

6 Administration Guide and Reference


IBM Confidential

Chapter 2. Deployment Scenarios


When deploying Tivoli Asset Discovery for z/OS, there are some concepts you
need to understand in order to comprehend the data and correctly utilize the
product.
Inquisitor data
The Inquisitor scans DASD volumes for libraries containing load modules
and HFS/zFS volumes for z/OS UNIX executable programs. The Match
Engine associates these libraries and executable programs with a Vendor,
Product, Option, and Release. The Load to Repository then loads this
information into the DB2 Repository. This group of information forms the
basis for an Inventory.
Usage Event
A Usage Event describes a unique load of a Load Module or UNIX
executable, and can contain extra details such as Job name, Username, and
Account code. The Usage Monitor records these usage events as they occur
on a particular operating system. When the Usage data is imported to the
Repository, the SMF ID, or Sysplex name on which the Load Module was
loaded, is associated with an Inventory. Once this is accomplished, Usage
events are associated with Load Modules based on Load Module Name,
Data Set Name, and Volume.
Region
A Region is a logical group of inventories.

This diagram explains the Hierarchical view of these Tivoli Asset Discovery for
z/OS concepts.

Region

Inquisitor data

Inventory Inventory

SMFID SMFID SMFID SMFID SMFID SMFID Monitor data

Figure 2. Hierarchical view of Inventory association

An Inventory consists of:


v all the load modules, load libraries, and UNIX for z/OS executable programs
that exist on a set of scanned DASD
v the products that these load modules and UNIX for z/OS executable programs
are associated with
v the Usage Events for these load modules and UNIX for z/OS executable
programs for each z/OS system that is being monitored

Copyright IBM Corp. 2009 7


IBM Confidential

It utilizes the concepts mentioned in the preceding paragraph for each Inventory to
run in three distinct modes. A Repository can have any number of Inventories
running in any combination of modes.
Single or stand-alone mode
Single or stand-alone mode Inventory represents a single z/OS system
with access to a set of nonshared DASD. For example, if you have one
z/OS system that has access to a set of nonshared DASD, then you would
run the resulting Inventory in stand-alone mode. There would be an
Inquisitor and a Usage Monitor running on the single z/OS system.
Sysplex mode
A sysplex mode Inventory represents a group of z/OS systems running in
a sysplex configuration. There would be one z/OS system running the
Inquisitor and all systems running the Usage Monitor. All Inquisitor and
Usage Monitors would need to be run in sysplex mode, and Usage Data
would be matched to an Inventory using the sysplex name instead of the
SMF ID.
Shared DASD mode
A Shared DASD mode Inventory represents a group of z/OS systems that
have a shared pool of DASD, but are not in a sysplex environment and do
not have a common sysplex name. As in sysplex mode, a single system can
run the Inquisitor scan on behalf of all the other systems, and all systems
would also run the Usage Monitor. However, the Usage data would be
matched to the Inventory based upon SMF ID, instead of the sysplex name.
For more information, refer to Inventory Association on page 118.

It is recommended to have a central DB2 subsystem that contains the Repository of


the entire enterprise. The DB2 subsystem that contains this Repository, and which
the Computation phase is run on, does not need to reside on the same systems that
you are collecting information from. The Usage data and Inquisitor data that
requires processing can be transmitted to this centralized DB2 subsystem using the
Tivoli Asset Discovery for z/OS Automation server or equivalent automation
product.

In all the examples shown below, no centralized DB2 subsystem is displayed


because there will be one for the entire enterprise, and this can reside on any
system.

8 Administration Guide and Reference


IBM Confidential

SYSA SYSB

IQ IQ

Nonshared Nonshared
DASD DASD

UMON UMON

SYSC SYSD

IQ IQ

Nonshared Nonshared
DASD DASD

UMON UMON

Legend

IQ - Inquisitor
UMON - Usage monitor

Figure 3. Four LPARS, each with own set of DASD

In this example there are four Inventories, with one SMF ID associated to each
Inventory. The Usage Monitor and the Inquisitor run on all four z/OS systems and
DASD, respectively. In this case all four inventories are run in the Single or
Stand-alone mode

Chapter 2. Deployment Scenarios 9


IBM Confidential

SYSA SYSB

IQ

UMON

UMON

Shared
DASD
SYSC SYSD

UMON UMON

Legend

IQ - Inquisitor
UMON - Usage monitor

Figure 4. Four LPARs, all with Shared DASD, Non-Sysplex

In this example, there is one Inventory, the shared DASD, and four SMF IDs that
are linked to that Inventory. The Usage Monitor runs on all four z/OS systems, but
there is only a need for one Inquisitor, as all the z/OS systems have access to the
same Load Modules. In this case the Inventory is in the Shared DASD mode, as
the z/OS systems are not in a Sysplex configuration.

10 Administration Guide and Reference


IBM Confidential

SYSA SYSB

IQ

UMON

UMON
Coupling
facility

SYSC SYSD
Shared
DASD

UMON UMON

Legend

IQ - Inquisitor
UMON - Usage monitor

Figure 5. Sysplex of four LPARs all with Shared DASD

In this example there is one Inventory, the shared DASD, and as this is a sysplex
configuration, the Usage data is linked to the Inventory through the SYSPLEX
name. The Usage Monitors and the Inquisitor are run in PLX=Y mode. Only one
Inquisitor needs to be run on the Shared DASD. The Usage Monitor needs to be
run on each z/OS system. In this case the inventory is run in the Sysplex mode

Chapter 2. Deployment Scenarios 11


IBM Confidential

SYSA SYSB

IQ IQ

Nonshared Nonshared
DASD DASD

UMON UMON

Shared
DASD
SYSC SYSD

IQ IQ

Nonshared Nonshared
DASD DASD

UMON UMON

Legend

IQ - Inquisitor
UMON - Usage monitor

Figure 6. Four LPARs, one set of shared DASD, plus a set of nonshared DASD for each LPAR

This diagram shows four z/OS systems, all with access to shared DASD, as well as
a set of non shared DASD. There will be five Inventories, one for the shared
DASD, and one for each of the nonshared DASD. Each z/OS system would be
associated with the shared DASD Inventory through the SMF ID, and also with the
nonshared DASD, in a single or stand-alone mode, also through the SMF ID. The
Usage Monitor and the Inquisitor both run on all four systems. Three of the
systems need to run the Inquisitor against just the nonshared DASD, and one
system needs to run the Inquisitor against the shared and its nonshared DASD. In
this case there is one shared DASD mode Inventory and four single or stand-alone
mode Inventories.

12 Administration Guide and Reference


IBM Confidential

Chapter 3. Installation requirements


Hardware requirements
The basic hardware requirements to install Tivoli Asset Discovery for z/OS are:

Processors
Data Capture and Computation phases
These phases require a z/Architecture machine capable of running z/OS
Version 1 Release 8 or later.
Reporting phase
The Batch Reports require a z/Architecture machine capable of running
z/OS Version 1 Release 8 or later. The Tivoli Common Reporting systems
requires either an Intel x86 architecture server, or z/Linux LPARs, in
which case a z/Architecture machine is used.

Software requirements
The software requirements for running Tivoli Asset Discovery for z/OS are:

z/Architecture software
Installation v z/OS Version 1 Release 8 or later
v SMP/E Version 3 Release 3 or later
v DFSMSDSS Version 1 Release 8 or later
Data Capture phase v z/OS Version 1 Release 8 or later
Computation phase v z/OS Version 1 Release 8 or later
v Language Environment for z/OS
v DB2 Version 8 Release 1 or later
v DDF enabled for DB2
v CLI (ODBC) enabled for DB2
v REXX enabled for DB2
Reporting phase v z/OS Version 1 Release 8 or later
v DB2 Version 8 Release 1 or later
v DDF enabled for DB2
v CLI (ODBC) enabled for DB2
v REXX enabled for DB2
If the TCR component is to run on
z/Linux:
v z/Linux (SUSE Version 10 or later)

Copyright IBM Corp. 2009 13


IBM Confidential

Tivoli Common Reporting Software


Operating system:
Supported operating systems are 32-bit only:
v Solaris Version 9, 10 or 11
v Red Hat Enterprise Linux Version 4 or 5
v Red Hat Enterprise Linux 5 on System z
v SUSE Linux Version 9 or 10
v SUSE Linux 10 on System z
v HP-UX Version 11iv2 or 11iv3
v IBM AIX Version 5 Release 3 or Version 6 Release 1
v Microsoft Windows 2003 Server
v Microsoft Windows XP
v Microsoft Windows 2008
Reporting Tool Tivoli Common Reporting Version 1 Release 2, or later

Supported browsers are Internet Explorer and Firefox


Database DB2 Connect Personal Edition Version 8 Release 1, or Version 9
Communications Release 1

DB2 Connect Enterprise Edition Version 8 Release 1, or Server


Version 9 Release 1

Security and authorization


TSO user ID

You require a TSO user ID with the appropriate RACF access to run jobs in the
Data Capture phase, Computation phase, and Reporting phase.

DB2 authorization IDs

You need DB2 privileges to perform the following:


v DBADMIN authority to assess the product database - you need to drop and
create DB2 resources
v BIND plans and packages
v EXECUTE authority - you need to execute plans and packages
v SELECT access to the product tables
v DISPLAY authority - you need to issue DISPLAY DDF command

APF

It is recommended that load library SHSISMOD1 be APF authorized. This is


required for running the Inquisitor scan and Usage Monitor.

z/OS UNIX security

For more information refer to Security considerations when running the Inquisitor
against z/OS UNIX files on page 59.

Administrator authority for Tivoli Common Reporting server

Your require Administrator authority to install TCR on the server.

14 Administration Guide and Reference


IBM Confidential

Chapter 4. Installation
Installing Tivoli Asset Discovery for z/OS
See the Program Directory for details of how to install Tivoli Asset Discovery for
z/OS.

Installing Tivoli Common Reporting


Installation of Tivoli Common Reporting, otherwise known as TCR, depends on
where the tool is to be installed. Tivoli Common Reporting can be installed on
many different operating environments.

See the Tivoli Common Reporting Users Guide for details of the process required to
install Tivoli Common Reporting.

Copyright IBM Corp. 2009 15


IBM Confidential

16 Administration Guide and Reference


IBM Confidential

Chapter 5. Post-installation customization


After you have installed Tivoli Asset Discovery for z/OS, there are some
customization tasks that need to be completed.

z/OS Customization
Tivoli Asset Discovery for z/OS requires some post-installation tasks to enable the
product to run efficiently in the z/OS environment.
APF Authorization
Some of the products components use z/OS authorized system services
and can only be run from an APF authorized library. It is recommended
that the load library SHSIMOD1 is APF authorized. Alternatively, the
modules listed here can be copied to an APF authorized library.
The Monitor module HSIZMON can only be run from an APF library.
The Inquisitor module HSIPINQ, by default, requires APF. However, it can
be run from a non-APF library when using the NOAPF parameter. When
using NOAPF mode, the Inquisitor bypasses the use of z/OS authorized
system services and is only able to collect a subset of the data. APF mode
is recommended for scanning accuracy and speed.
All other modules can be run from an APF library or non-APF library.
MAXCAD parameter
The Usage Monitor uses a SCOPE=COMMON data space for its repository.
For this reason, it is necessary to have available at least two additional
system wide data space PASN entries. Tivoli Asset Discovery for z/OS
uses one data space, but after a switch, a new one is created. The older
data space is not deleted until it has been processed by the writer task.
To allow the creation of the Usage Monitor data spaces, the MAXCAD
system parameter must be set to a large enough value. The MAXCAD
parameter, if specified, is located in the IEASYSxx member of the systems
PARMLIB library. Consult the relevant MVS Initialization and Tuning
Reference manual for the default and valid value range. The default value
must be considered as the minimum value for practical purposes. Other
products also make use of this facility, and the MAXCAD value used must
take into account all the various product requirements for this facility.

DB2 customization
Tivoli Asset Discovery for z/OS requires post-installation tasks to enable DB2
functions and define DB2 resources for the product to use. An authorized database
personnel with the appropriate authorities needs to perform these tasks:
v Bind Call level interface/ODBC support
The product uses the DB2 supplied DSNACLI plan. Bind the DSNACLI plan
using the job hlq.SDSNSAMP(DSNTIJCL).
v Bind REXX language support
uses the DB2 supplied DSNREXX plan. Bind the DSNREXX plan using the job
hlq.SDSNSAMP(DSNTIJRX)..
v DB2 accesses
Copyright IBM Corp. 2009 17
IBM Confidential

It is necessary for the product administrator to have DBADM access to the DB2
database, as the computation phase utilities require write and drop access to the
schemas and tables.
For TCR and Batch Reporting accesses to DB2 resources, the definitions are
found in HSISGRNT, GI*, and GX*. See Customizing job outputs
post-installation.

Installing DB2 Connect (if required)


DB2 driver and license JARs are required to create a JDBC connection between
Tivoli Common Reporting and the Tivoli Asset Discovery for z/OS Repository.
Installing DB2 Connect provides these JARs. DB2 Connect is part of the
Management Client CD when you purchase DB2 for z/OS.

Note: This product is to be installed on a Windows or UNIX platform.

If DB2 Connect is already installed, a separate instance of this product is not


required. If not, install DB2 Connect using these steps:
1. On the installation media select and run the DB2 Connect setup.exe
2. Select Install a Product from the left menu.
3. Select Install Now to begin the DB2 Connect installation.
4. Follow the default options in the wizard to install DB2 Connect.
5. Once the DB2 First Steps wizard appears, select Exit from the left menu to
complete the installation.
6. Binding the DB2 CLI bind files to DB2 on z/OS:
a. Ensure you connect to the DB2 subsystem on z/OS
b. Run the bind process either:
a. by the Configuration Assistant (CA) ; or
b. from the Command Processor issue bind @db2cli.lst messages

Creating post-installation jobs


In order to create a customized version of the post-installation JCLLIB and
PARMLIB, take a copy of the job in member HSISCUST in the hlq.SHSISAMP
data set and edit it. These data sets contain parameters to define DB2 objects, and
jobs to run the product on the system. These jobs are then used to gather
information and to define DB2 tables, which are used to report on the information
gathered. Change the following parameters in HSISCUST as required:

Parameter Description
SET HSI This JCL parameter must be set to the high level qualifiers of the
target libraries created by the SMP/E installation process. These
data sets all have low level qualifiers beginning with SHSI.
SET ISP The Customization tool uses ISPF services to customize the
parameters and JCL for the user.

This parameter specifies the high level qualifiers for the ISPF target
libraries. These libraries all have low level qualifiers beginning
with SISP.

18 Administration Guide and Reference


IBM Confidential

MODE The parameter is set in the PARM option of the EXEC statement.
MODE=POST
Members beginning with HSIS are replaced. They are not
related to IQ schemas.
MODE=IQ
Members not beginning with HSIS are replaced. These are
related to IQ schemas.
MODE=ALL
All members are replaced. No members are ever deleted.

Run with MODE=ALL for the first time after installation.


HSIINST The HSIINST parameter is in the //SYSIN part of the job.

This parameter specifies the high level qualifiers of the JCLLIB and
PARMLIB data sets that are created by running the HSISCUST job.

If the JCLLIB and PARMLIB data sets already exist, they are reused
and members can be replaced with updated information.

The name specified for this parameter must be less than or equal
to 18 characters in length.
DB2LOAD The DB2LOAD parameter is in the //SYSIN part of the job.

This parameter specifies the fully qualified SDSNLOAD data set


name.
DB2EXIT The DB2EXIT parameter is in the //SYSIN part of the job.

This parameter specifies the fully qualified SDSNEXIT data set


name.

If the DB2EXIT library does not exist, use the same value as the
DB2LOAD parameter.
DB2RUN The DB2RUN parameter is in the //SYSIN part of the job.

This parameter specifies the fully qualified RUNLIB data set name.
CEERUN The CEERUN parameter is in the //SYSIN part of the job.

This parameter specifies the fully qualified Language Environment


data set.
CBCDLL The CBCDLL parameter is in the //SYSIN part of the job.

This parameter specifies the fully qualified Language Environment


C++ runtime data set.
DBSSID The DBSSID parameter is in the //SYSIN part of the job.

This parameter specifies the DB2 subsystem ID on the z/OS


system.
LOC The LOC parameter is in the //SYSIN part of the job.

This parameter specifies the ODBC(CLI) location for the DB2


subsystem ID on the z/OS system.

You can use the DB2 DISPLAY DDF command to determine the
location.

Chapter 5. Post-installation customization 19


IBM Confidential

TIADPLAN The TIADPLAN parameter is in the //SYSIN part of the job.

This parameter specifies the name of the DB2 PLAN used by the
DSNTIAD utility.

This utility allows for the execution of dynamic SQL in a batch job
and is required by the post- installation jobs. The name of this
PLAN is obtained from the DB2 Administrator.
SGTABCAT The SGTABCAT parameter is in the //SYSIN part of the job.

This parameter specifies the prefix of the DB2 table space data set
names for small tables in the database. Consult your DB2
administrator for security implications and disk storage
requirements.

See the SQL statement CREATE STOGROUP for more information.


This parameter specifies the storage group name. It is compulsory
to use the storage group name, SGHSITAB, as supplied with this
product.
SGTABVOL The SGTABVOL parameter is in the //SYSIN part of the job.

This parameter specifies the names of the volumes that the table
space data sets, for small tables, are allocated on.

See the SQL statement CREATE STOGROUP for more information.


This parameter specifies the volumes.
SGBIGCAT The SGBIGCAT parameter is in the //SYSIN part of the job.

This parameter specifies the prefix of the DB2 table space data set
names for large tables in the database. Consult your DB2
administrator for security implications and disk storage
requirements.

See the SQL statement CREATE STOGROUP for more information.


This parameter specifies the storage group name. This parameter
specifies the storage group name. It is compulsory to use the
storage group name, SGHSIBIG, as supplied with this product.
SGBIGVOL The SGBIGVOL parameter is in the //SYSIN part of the job.

This parameter specifies the names of the volumes that the table
space data sets, for large tables, are allocated on.

See the SQL statement CREATE STOGROUP for more information.


This parameter specifies the volumes.
SGIDXCAT The SGIDXCAT parameter is in the //SYSIN part of the job.

This parameter specifies the prefix of the DB2 table space data set
names for table indexes in the database. Consult your DB2
administrator for security implications and disk storage
requirements.

See the SQL statement CREATE STOGROUP for more information.


This parameter specifies the storage group name. This parameter
specifies the storage group name. It is compulsory to use the
storage group name, SGHSIIDX, as supplied with this product.

20 Administration Guide and Reference


IBM Confidential

SGIDXVOL The SGIDXVOL parameter is in the //SYSIN part of the job.

This parameter specifies the names of the volumes that the table
space data sets, for table indexes, are allocated on.

See the SQL statement CREATE STOGROUP for more information.


This parameter specifies the volumes.
DB The DB parameter is in the //SYSIN part of the job.

This parameter specifies the name of the DB2 database that the
product uses to store all the information that it gathers.
DBADMIN The DBADMIN parameter is in the //SYSIN part of the job.

This parameter specifies the list of user IDs that are to be granted
ADMIN access to the database and its contents.

This parameter is optional. Specify an empty string if you do not


want to grant ADMIN access to user IDs for the database specified
in DB.
KBMGMTC The KBMGMTC parameter is in the //SYSIN part of the job.

This parameter specifies SMS management class for allocation of


the data sets created when loading the Global Knowledge Base
(and z/OS UNIX GKB). This class name is optional but the
parameter must be specified. Specify a null () if it is not used.

The KBMGMTC and KBSTORC parameters are used to specify


where the data sets are to be allocated. If SMS is not enabled, or
you wish to specify volumes to be used, specify nulls for both
KBMGMTC and KBSTORC and specify the volume names in
KBVOLS.
KBSTORC The KBSTORC parameter is in the //SYSIN part of the job.

This parameter specifies SMS storage class for allocation of the


data sets created when loading the Global Knowledge Base (and
z/OS UNIX GKB). This class name is optional, but the parameter
must be specified. Specify a null () if it is not used.

See the KBMGMTC entry for details.


KBVOLS The KBVOLS parameter is in the //SYSIN part of the job.

This parameter specifies DASD volumes to allocate the data sets


involved in the loading of the Global Knowledge Base (and z/OS
UNIX GKB). The volumes specification is optional, but the
parameter must be specified. Specify a null () if it is not used. The
format of data in this parameters is (volume) [,(volume)].... This
parameter is placed in the DFSMSDSS RESTORE command
OUTDYNAM() parameter.

See the KBMGMTC entry for details. You must specify either
KBMGMTC or KBSTORC, or KBVOLS
KBCPYPND The KBCPYPND parameter is in the //SYSIN part of the job.

This parameter specifies whether to run a DB2 utility to turn the


COPY PENDING flag off for Knowledge Base Schemas after
reloading the schema tables with the latest.

Chapter 5. Post-installation customization 21


IBM Confidential

ASMGMTC The ASMGMTC parameter is in the //SYSIN part of the job.

This parameter specifies SMS management class for allocation of


the Automation Server Control file. This class name is optional, but
the parameter must be specified. Specify a null () if it is not used.

The ASMGMTC and ASSTORC parameters are used to specify


where the data sets are to be allocated. If SMS is not enabled or
you wish to specify volumes to be used, specify nulls for both
ASMGMTC and ASSTORC and specify the volume names in
ASVOLS.
ASSTORC The ASSTORC parameter is in the //SYSIN part of the job.

This parameter specifies SMS storage class for allocation of the


Automation Server Control file. This class name is optional, but the
parameter must be specified. Specify a null () if it is not used.

See the ASMGMTC entry for details.


ASVOLS The ASVOLS parameter is in the //SYSIN part of the job.

This parameter specifies DASD volumes for allocation of the


Automation Server Control file. The volumes specification is
optional, but the parameter must be specified. Specify a null () if
it is not used. The format of data in this parameters is
(volume)[,(volume)].... This parameter is placed in the DFSMSDSS
RESTORE command OUTDYNAM() parameter.

See the ASMGMTC entry for details. You must specify either
ASMGMTC or ASSTORC, or ASVOLS.
GKBSCHMA The GKBSCHMA parameter is in the //SYSIN part of the job.

This parameter specifies the DB2 Schema name for the tables
holding the Global Knowledge Base.

The schema names must be less than or equal to seven characters


in length. The first character must be an alphabetic character.
GKBUSCHM The GKBUSCHM parameter is in the //SYSIN part of the job.

This parameter specifies the DB2 Schema name for the tables
holding the z/OS UNIX Global Knowledge Base.

The schema names must be less than or equal to seven characters


in length. The first character must be an alphabetic character.
LKBSCHMA The LKBSCHMA parameter is in the //SYSIN part of the job.

This parameter specifies the DB2 Schema name for the tables
holding the Local Knowledge Base.

The schema names must be less than or equal to seven characters


in length. The first character must be an alphabetic character.
LKBUSCHM The LKBUSCHM parameter is in the //SYSIN part of the job.

This parameter specifies the DB2 Schema name for the tables
holding the z/OS UNIX Local Knowledge Base.

The schema names must be less than or equal to seven characters


in length. The first character must be an alphabetic character.

22 Administration Guide and Reference


IBM Confidential

REPSCHMA The REPSCHMA parameter is in the //SYSIN part of the job.

This parameter specifies the DB2 Schema name for the tables
holding the Repository.

The schema names must be less than or equal to seven characters


in length. The first character must be an alphabetic character.
MESCHMA The MESCHMA parameter is in the //SYSIN part of the job.

This parameter specifies the DB2 Schema name for the tables
holding the Match Engine data.

The schema names must be less than or equal to seven characters


in length. The first character must be an alphabetic character.
FLSCHMA The FLSCHMA parameter is in the //SYSIN part of the job.

This parameter specifies the DB2 Schema name for the tables
holding the Inquisitor Import Filter data.

The schema names must be less than or equal to seven characters


in length. The first character must be an alphabetic character.
IQSCHEMAS The IQSCHEMAS parameter is in the //SYSIN part of the job.

You can specify multiple IQSCHEMAS values for this parameter.


For example, you can set IQSCHEMAS = TFQ1 TFQ2 and the
customization job creates members DITFQ1, DITFQ2, and DXTFQ1,
DXTFQ2. Besides using the IQSCHEMAS values for creating
schema names, they are also used for creating table spaces and
tables in DB2. For example, using value TFQ1 will result in
creating these DB2 objects (example below is for one table space
and one table only):
tablespace WSTFQ1
tablespace WSUTFQ1 (for z/OS UNIX)
table TFQ1.TSYSTEM
table UTFQ1.TSYSTEM (for z/OS UNIX)

The schema names must be less than or equal to five characters in


length. The first character must be an alphabetic character.

This parameter is dependent on the value specified for the MODE


parameter.
IQWMPRI The IQWMPRI parameter is in the //SYSIN part of the job.

This parameter specifies the primary allocation amount (in


kilobytes) for the TMODULE table.
IQWMSEC The IQWMSEC parameter is in the //SYSIN part of the job.

This parameter specifies the secondary allocation amount (in


kilobytes) for the TMODULE table.
IQWLPRI The IQWLPRI parameter is in the //SYSIN part of the job.

This parameter specifies the primary allocation amount (in


kilobytes) for the TLIBRARY table.
IQWLSEC The IQWLSEC parameter is in the //SYSIN part of the job.

This parameter specifies the secondary allocation amount (in


kilobytes) for the TLIBRARY table .

Chapter 5. Post-installation customization 23


IBM Confidential

IQWMUPRI The IQWMUPRI parameter is in the //SYSIN part of the job.

This parameter specifies the primary allocation amount (in


kilobytes) for the TMODULE table for z/OS UNIX.
IQWMUSEC The IQWMUSEC parameter is in the //SYSIN part of the job.

This parameter specifies the secondary allocation amount (in


kilobytes) for the TMODULE table for z/OS UNIX.
IQWLUPRI The IQWLUPRI parameter is in the //SYSIN part of the job.

This parameter specifies the primary allocation amount (in


kilobytes) for the TLIBRARY table for z/OS UNIX.
IQWLUSEC The IQWLUSEC parameter is in the //SYSIN part of the job.

This parameter specifies the secondary allocation amount (in


kilobytes) for the TLIBRARY table for z/OS UNIX.
BGKBTS, BGKBTS1, These Bufferpool parameters are in the //SYSIN part of the job.
BGKBIX, BGKBIX1A,
BGKBIX1B, These parameters specify the Bufferpool definitions for the table
BGKBIX1C, BGKUTS, spaces and indexes.
BGKUIX , BLKBTS ,
BLKUTS For specific definitions of each bufferpool parameter, refer to the
HSISCUST in the hlq.SHSISAMP data set.
BMETS, BMEIX

BREPTS, BREPTS1,
BREPTS2, BREPIX,
BREPIX1A,
BREPIX1B, BREPIX1C,
BREPIX1D,
BREPIX2A,
BREPIX2B, BREPIX2C,
BREPIX2D,
BREPIX2E, BREPIX2F,
BREPIX2G

BIQFTS, BIQFIX,
BIQTS, BIQTS1 BIQIX,
BIQIX1A, BIQIX1B,
BIQIX1C, BIQIX1D,
BIQIX1E, BIQIX1F,
BIQIX1G, BIQIX1H,
BIQIX1I, BIQIX1J,
BIQIX1K, BIQUTS,
BIQUIX

The job must create or reuse two output libraries. These are:
JCLLIB
The library contains JCL jobs to create DB2 resources, and to run the
products functions.
PARMLIB
The library is referenced by jobs in the JCLLIB, and contains pre-tailored
parameters.

Once you have made the appropriate changes to the copy of the customization job,
submit it to run.

24 Administration Guide and Reference


IBM Confidential

Use these JCLLIB members to submit jobs to implement the product:


Table 1. JCLLIB members
HSISDB00 JCL SET statements to set symbols for data set high level qualifiers.
This is included by other jobs.

Table 2. Post-installation jobs


HSISDB01 Job to define DB2 Storage Groups and the Database name.
HSISDB02 Job to create the DB2 table spaces for the Global Knowledge Base.
HSISDB03 Job to load the Global Knowledge Base.
HSISDB04 Job to create the DB2 table spaces for the z/OS UNIX Global
Knowledge Base.
HSISDB05 Job to load the z/OS UNIX Global Knowledge Base.
HSISDB06 Job to create the DB2 resources for the Local Knowledge Base and
z/OS UNIX Local Knowledge Base.
HSISDB07 Job to create the DB2 resources for the Repository.
HSISDB10 Job to create the DB2 resources for the Match Engine.
HSISDB11 Job to create the DB2 resources for the Inquisitor Filters and to
load the filters.
DI* Jobs (per IQ schema) to create DB2 resources for the Inquisitor
Import.
DX* Jobs (per IQ schema) to create DB2 resources for the z/OS UNIX
Inquisitor Import.
HSISGRNT Job to grant general (non IQ schema) access to DB2 resources.
GI* Jobs (per IQ schema) to grant access to DB2 resources.
GX* Jobs (per IQ schema) to grant access to DB2 resources for z/OS
UNIX.

Table 3. Capture phase


ZIQ* Jobs (per IQ schema) to run the Inquisitor.
UIQ* Jobs (per IQ schema) to run the z/OS UNIX Inquisitor.
HSISUMON Job to run the Usage Monitor.

Table 4. Computation Phase


ZIM* Jobs (per IQ schema) to run the Inquisitor Import.
UIM* Jobs (per IQ schema) to run the z/OS UNIX Inquisitor Import.
ZME* Jobs (per IQ schema) to run the Match Engine.
UME* Jobs (per IQ schema) to run the z/OS UNIX Match Engine.
ZLR* Jobs (per IQ schema) to run the Load to Repository.
ULR* Jobs (per IQ schema) to run the z/OS UNIX Load to Repository.
HSISUIMP Job to run the Usage Import.

Table 5. Reporting phase


HSISTCRR Job to list the TCR Data Source and JDBC URL.
HSISBATR Job to produce ad hoc reports.

Chapter 5. Post-installation customization 25


IBM Confidential

Table 6. Housekeeping/Utilities
HSIASALC Job to allocate the Automation Server control file.
HSIASSCT Job to run the Automation Server Scout Utility.
HSISPTAG Job to run the Product Tagging Utility.
HSISREGN Job to run the Region Association Utility.
HSISINVA Job to run the Inventory Association.
HSISUSUM Job to run the Usage Summary.
HSISUDEL Job to run the Usage Deletion.
HSISDINV Job to Delete an inventory from the Repository.
HSISLLST Job to create an HLQ listing for the Usage Monitor.
HSISMERG Job to merge Repositories.
HSISTPRM Job to update the Repository TPARAM table.
HSISMCMP Job to compile Japanese messages for MMS.
HSISSCRT Job to read SCRT CSV files and populate the Repository.
HSISKBT Job to run the XML Export Utility.
Note: The XML output is for Tivoli Asset Management for IT
(TAMIT).
HSISZCAT Job to concatenate Usage Monitor data sets..

Running post-installation jobs


If you are a new user, start by submitting job HSISDB01 from the JCLLIB. These
jobs must be run on the system that contains the DB2 subsystem the database is to
be defined on. Once that job has completed, continue submitting and running the
jobs HSISDB02 through to HSISDB07, HSISDB10, and HSISDB11. DI*, DX*,
HSISGRNT, GI* and GX*. Submit the next job after successful completion of the
previous job. Completion codes of 4 are acceptable in these jobs.

After the completion of the customization jobs, the product must be made
available to all systems that the various phases are run on.

Note: The APF authorization of the SHSIMOD1 library must be done on all
systems that the product is to be run on

If changes are made to the JCLLIB and PARMLIB data sets, either manually or by
rerunning the HSISCUST customization job, they must be redistributed to all
systems that run the product.

Customizing tasks for Japanese messages


MVS Message Service (MMS) message information will be provided for the
Japanese language.

MMS message information for each language will be contained in the following
PDS:
1. hlq.SHSIMJPN (Japanese)

The MMS message file must be compiled using the MMS message compiler. See
the MVS Assembler Services Guide for more information on loading MMS messages.

26 Administration Guide and Reference


IBM Confidential

The HSISCUST post-installation customization job creates JCL jobs in the JCLLIB to
compile MMS files. Member HSISMCMP contains JCL to run the job.

You must install the latest system runtime message file.

Here is an example of how to create a new Japanese system runtime message file
and install it:
1. Compile MMS files into system runtime message file hlq.MMSJPN99
2. Create a new entry in PARMLIB called MMSLSTJ9
DEFAULTS LANGCODE(JPN)
LANGUAGE LANGCODE(JPN) DSN(SYS2.MMSJPN99) CONFIG(CNLJPN00)
3. Install the latest system runtime message file using the following MVS system
command
SET MMS=J9

Note:

The following components of the product do not use the MVS message service
MMS.
v Inquisitor Import
v Match Engine
v Load to Repository
v Usage Import
v Usage Summary
v Usage Deletion
v Delete Inventory
v Delete Repository

Japanese customers can enable Japanese messages to the MSGFILE for these
components if the Language Environment NATLANG(JPN) option is in effect. For
more information on the Language Environment MSGFILE and NATLANG
options, refer to the Language Environment Programming Reference (SA227562).
For more information on specifying Language Environment runtime options, refer
to the Language Environment Programming Guide (SA227561). For more
information on setting NATLANG(JPN) as an installation default, refer to the
Language Environment Customization (SA22-7564). When the NATLANG(JPN)
option is not in effect, the components listed above will always output messages in
mixed case English.

For example the Inquisitor import JCL can be modified to produce Japanese
messages (assuming the default installation NATLANG is not already set to
Japanese) by modifying the following line in members beginning with ZIM (UIM
for z/OS UNIX) and suffixed with the schema name :
//IMPORT EXEC PGM=HSICIQIM,REGION=0M,TIME=1440

to :
//IMPORT EXEC PGM=HSICIQIM,REGION=0M,TIME=1440,PARM='NATLANG(JPN)/'

Chapter 5. Post-installation customization 27


IBM Confidential

28 Administration Guide and Reference


IBM Confidential

Chapter 6. Post-installation tasks for Tivoli Common


Reporting
These tasks need to be performed post-installation in order to use the reporting
component in Tivoli Common Reporting.

Installing the DB2 JDBC driver and license JARs


See Installing DB2 Connect (if required) on page 18 on how to install DB2
Connect.

Before installing the JDBC JARs, ensure the Tivoli Integrated Portal (TIP) service is
stopped.

To install the DB2 JDBC Driver and License JARs, copy the required JARs from the
source directory to the destination directory.

DB2 JARs required are:


db2jcc.jar
The DB2 Universal JDBC Driver.
db2jcc_license_cisuz.jar
The license file, db2jcc_license_cisuz.jar, contains licenses for Linux,
Unix, Windows iSeries and zSeries. The zSeries license is required in
order to establish a JDBC connection to DB2 running on z/OS.
The Personal Edition installations of DB2 Connect do not contain the
license db2jcc_license_cisuz.jar. They contain the alternate license
db2jcc_license_cu.jar. This alternate license is not sufficient to connect to
DB2 running on z/OS. To avoid this issue, ensure you install the
Enterprise or Server editions of DB2 Connect that matches the DB2 z/OS
versions.

Source directory:
C:\Program Files\IBM\SQLLIB\java

Destination directory (Windows):


C:\IBM\tivoli\tip\products\tcr\lib\birts-runtime-
2_2_1\ReportEngine\plugins\org.eclipse.birt.report.data.oda.jdbc_2.2.
r22x_v20070919\drivers

Destination directory (Linux):


/opt/IBM/tivoli/tip/products/tcr/lib/birt-runtime-
2_2_1/plugins/org.eclipse.birt.report.data.oda.jdbc_2.2.
1.r22x_v20070919/drivers

Starting Tivoli Common Reporting


From the Start menu:
1. Start the Tivoli Common Reporting server.
2. Start the Tivoli Common Reporting Browser.

Copyright IBM Corp. 2009 29


IBM Confidential

3. Login to the Tivoli Common Reporting Browser using the userid and password
configured when Tivoli Common Reporting was installed.

The above applies only to the Windows environment. For other platforms see the
Tivoli Common Reporting Users Guide

Transferring the Tivoli Common Reporting report package


from the host system
Connect to the host system and copy the Tivoli Common Reporting report
package.
1. C:\> ftp host name (Using command line FTP connect to the host system)
2. When prompted enter your user name and password.
3. ftp > binary (Switch the FTP mode to binary)
4. ftp > get hlq.SHSITCR1(HSITCR) HSITCR.zip
(Download the reports member)
5. ftp > exit
(Close the FTP connection)

Importing the Tivoli Common Reporting report package


Import the HSITCR.zip report package from the previous step into TCR. In the
Import Report Package Advanced Options, ensure these options are specified:
1. Overwrite: checked
2. Security Set: Tivoli Asset Discovery for z/OS

Determining Tivoli Common Reporting JDBC data sources


During the customizing of Tivoli Common Reporting, JDBC URLs must be
provided to the Report Data Source Dialogue.

The HSISCUST post-installation customization job creates JCL jobs in JCLLIB to list
the JDBC URLs. Member HSISTCRR contains JCL to run the job. Listed here is the
output you can expect
DATA_SOURCE JDBC_URL_______________________________________________________
HSIzREP jdbc:db2://exampsys.ibm.com:5000/QXPOMU1DE81:currentSchema=SI1;

The sample above contains the JDBC URL for a Repository schema. Tivoli
Common Reporting is configured to connect to this schema in the next
step,Configuring the Tivoli Common Reporting Report Data Sources for JDBC

Configuring the Tivoli Common Reporting Report Data


Sources for JDBC
1. Click on Tivoli Common Reporting window
2. Click on Report Sets
3. In the Reports window to the right of the menu, right click on the Installation
Verification Report and select Data Sources.
4. Select the HSIzREP report data source from the Report Data Source dialogue
and click Edit.
5. Enter the required data:

30 Administration Guide and Reference


IBM Confidential

v Display Name - leave blank or default


v JDBC Driver - default
v User ID (TSO userID)
v JDBC URL
(only jdbc:db2://exampsys.ibm.com:5000/QXPOMU1DE81:currentSchema=SI1;
is required)
v Password (TSO password)
v JNDI Name - leave blank
6. Save your changes and exit the Report Data Sources dialogue.

Verifying your installation


1. In the report navigation window, go to the navigation tab.
2. Navigate to the Installation Verification Report: Report Sets Tivoli Products
Reports Admin Reports
3. Click the icon just to the left of the Installation Verification Report.
4. Another browser window opens containing the Installation Verification Report.
If this browser window displays an error message, recheck your
post-installation of Tivoli Common Reporting.

Tivoli Common Reporting User Roles


Tivoli Common Reporting can be configured to provide access to different
combinations of reports and functions to each user. During Tivoli Common
Reporting installation an administrator role is created by default. Logging in with
this role allows you to access the user and group administration and report set
authorizations features.

Two groups need to be created for Tivoli Asset Discovery for z/OS users to select
the reports relevant to their job role.

Repository View Group: These reports are concerned with the software products
discovered, where they are located, and who has been using them.

Administration View Group: These reports show the information relating to the
Tivoli Asset Discovery for z/OS components. The data source verification. The
data captured by the Inquisitor. The Knowledge Bases used by the Match Engine,
and user software that is yet to be fully identified. This view will also have access
to all repository view reports.

For the repository view add a group called TADzREP using the Manage Group
functions. For the Administration view add a group called TADzADMIN. Then
using the Administrative Group Roles function, add the two groups and provide
each of them with the tcrOperator role. This will allow members of these groups to
log on to Tivoli Common Reporting. Add Users using the Manage Users function
and then add them to their relevant job role group.

At this stage your new users can login to the Tivoli Integrated Portal but can not
see any reports when they select Common Reporting. The groups need to be
authorized to access the nodes in the report hierarchy. Right mouse click on each
node in the report hierarchy and select Authorizations from the popup menu. Add
the group to the authorized user and groups list. When a group is added to the
authorization list it has a default role of tcrReportViewer. Select each added group
and set the roles as described in the table below.
Chapter 6. Post-installation tasks for Tivoli Common Reporting 31
IBM Confidential

Table 7. TADzREP
Report Navigation Hierarchy Roles
Report Sets tcrSetViewer 1
Tivoli Products tcrSetViewer
Tivoli Asset Discovery for z/OS tcrSetViewer
Advanced Reports tcrSnapshotAuthor, tcrReportDistributor 2
Asset Reports tcrSnapshotAuthor, tcrReportDistributor
Standard reports tcrSnapshotAuthor, tcrReportDistributor
Tivoli Common Reporting tcrReportViewer 3

Table 8. TADzADMIN
Report Navigation Hierarchy Roles
Report Sets tcrSetViewer 1
Tivoli Products tcrSetViewer
Tivoli Common Reporting tcrReportViewer 3

1 Allows the user to navigate to a report set. Using this role will allow a user
access to a child report set without granting full access to the parent sets.

2 Allows the user to view, but not modify the reports, create and distribute
snapshots and schedule a report.

3 Allows the user to view, but not modify the report set.

For further details on Users and Groups see Administering users in the Tivoli
Common Reporting Users Guide.

32 Administration Guide and Reference


IBM Confidential

Chapter 7. Migration
If your site is currently running Hardware and Software Installation for z/OS
Version 7 Release 1, Dorana Version 5 Release 4 or TLCMz, and if you want to
migrate your application data to Tivoli Asset Discovery for z/OS Version 7.2., then
you should follow the instructions as listed below.

TLCMz conversion
The data conversion process converts MONDETL and SURVDATA files from
TLCMz; Version 3 Release 2, Version 4 Release 1, and Version 4 Release 2, to the
format required by Tivoli Asset Discovery for z/OS. No other data is converted.

The conversion process allows you to control when each system within the
enterprise is to be converted from TLCMz to Tivoli Asset Discovery for z/OS. This
staged approach to conversion allows TLCMz and Tivoli Asset Discovery for z/OS
to run concurrently until you decide to cut over to Tivoli Asset Discovery for
z/OS. Tivoli Asset Discovery for z/OS and DB2 can be installed on the system of
your choice, with TLCMz continuing to run on all existing systems within the
enterprise.

Conversion allows you to start using the new product database and reporting
capabilities against your entire enterprise without having to uninstall TLCMz and
install Tivoli Asset Discovery for z/OS on every system. It enables the data
generated by your existing TLCMz data gatherers to be used by the new product.
Once you are satisfied with the converted data, you can discontinue the TLCMz
data analysis and reporting process that runs on each system where TLCMz is
installed,

The record format of the TLCMz SURVDATA file has changed between Version 3
Release 2, and Version 4 Release 1. The Surveyor conversion process only converts
TLCMz Version 4 Release 1 format SURVDATA files into Tivoli Asset Discovery for
z/OS Version 7 Release 2 format.

For TLCMz SURVDATA Version 3 Release 2 files, an intermediate step called the
UPGRADER is required and is already included in the conversion job. The
UPGRADER converts TLCMz SURVDATA Version 3 Release 2 format files into
TLCMz SURVDATA Version 4 Release 1 format.

By default, the SURVOUT DD is a temporary PDS/E data set. This is adequate for
most conversions. For a larger Surveyor file that needs to be converted by the
UPGRADER, increase the size of the SURVOUT data set by approximately 40% of
the SURVIN data set.

Releases prior to Version 3 Release 2 cannot be upgraded, and therefore cannot be


converted.

Before you migrate to the new product, you need to step through the sections,
Creating post-installation jobs on page 18 and Running post-installation jobs
on page 26. Once you have completed the customization jobs as described in the
two sections, you now have a product ready for use.

Copyright IBM Corp. 2009 33


IBM Confidential

For the migration implementation, use the JCLLIB members to submit jobs in the
sequence as listed here:

HSISDB01 Job to define DB2 Storage Groups and the Database name.
HSISDB02 Job to create the DB2 table spaces for the Global Knowledge Base.
HSISDB03 Job to load the Global Knowledge Base.
HSISDB04 Job to create the DB2 table spaces for the z/OS UNIX Global
Knowledge Base.
HSISDB05 Job to load the z/OS UNIX Global Knowledge Base.
HSISDB06 Job to create the DB2 resources for the Local Knowledge Base and
z/OS UNIX Local Knowledge Base.
HSISDB07 Job to create the DB2 resources for the Repository.
HSISDB10 Job to create the DB2 resources for the Match Engine.
HSISDB11 Job to create the DB2 resources for the Inquisitor Filters and to
load the filters.
DI* Jobs (per IQ schema) to create DB2 resources for the Inquisitor
Import.
DX* Jobs (per IQ schema) to create DB2 resources for the z/OS UNIX
Inquisitor Import.
HSISGRNT Job to grant general (non IQ schema) access to DB2 resources..
GI* Job (per IQ schema) to grant access to DB2 resources.
GX* Job (per IQ schema) to grant access to DB2 resources for z/OS
UNIX.

Running the conversion jobs:

HSISM2D Monitor conversion


HSISS2D1 Surveyor conversion for TLCMz Version 4 Release 1 or Version 4
Release 2
HSISS2D2 Surveyor conversion for TLCMz Version 3 Release 2. Note that this
job contains an intermediate step called the UPGRADER.

Loading the converted TLCMz data to Tivoli Asset Discovery for z/OS:

ZIM* Job (per IQ schema) to run the Inquisitor Import. Input data is
from output of HSISS2D1 or HSISS2D2
HSISUIMP Job to run the Usage Import. Input data is from output of
HSISM2D

Post-conversion tasks
v You can continue to run your existing Monitor and Surveyor as before.
v Convert and import TLCMz Monitor and Surveyor data into the new Tivoli
Asset Discovery for z/OS Version 7 Release 2.
v When Tivoli Asset Discovery for z/OS Version 7 Release 2 has been fully
implemented, and the new Usage Monitor and Inquisitor Scan are ready for use,
the TLCMz version of the Monitor and Surveyor can be discontinued.

34 Administration Guide and Reference


IBM Confidential

v Once you have discontinued using the previous product, you can proceed to run
the remaining jobs as described in the Capture, Computation, and Reporting
phases.

TLCMz Exporter compatibility


To provide similar functionality as the Exporter, four members are provided in
SHSIEXEC data set. These members query information stored in DB2, and return
output stored in the four TLCMz Exporter DSECT formats.
Table 9. SHSIEXEC queries
REXX samples in Exporter TLCMz DSECT Description
SHSIEXEC
HSIIXPMO XPMODS Installed Load Modules
HSIIXPPR XPPRODS Installed Products
HSIIXPUM XPUSAGEM Load Module use
HSIIXPUP XPUSAGEP Product use

Some fields cannot be generated as they were in TLCMz. These fields are marked
with a question mark (?) to signify this.

The description, function, and JCL required to run these samples is documented in
each member.

The REXX samples TRNMODS, TRNUSGM, and TRNUSGP are provided with
TLCMz. They transform each record into transaction file format for import into a
spreadsheet. If you run these during migration, the date fields not available from
Tivoli Asset Discovery for z/OS are displayed as 6F; the hexadecimal EBCDIC
representation of ?.

Before using these samples, ensure the DB2 REXX environment for the target DB2
system has been successfully set up .

Migration from Dorana Version 5 Release 4


Pre-migration recommendations

For improved migration performance, it is recommended that the tasks listed here
are run on the existing Dorana database.
v Run the Usage Summary job
v Run the Usage Deletion job
v Reorganize the Repository table spaces

Migration tasks

To migrate Dorana Version 5 Release 4 to Tivoli Asset Discovery for z/OS Version
7 Release 2, complete the step as explained in section Creating post-installation
jobs on page 18. The HSISCUST parameters listed below must be customized with
different values as used in your Dorana Version 5 Release 4 system. This is to
avoid any duplicate names that have already been used.
1. DB - database
2. Schema Names

Chapter 7. Migration 35
IBM Confidential

GKBUSCHM
LKBSCHMA
LKBUSCHM
REPSCHMA
MESCHMA
FLSCHMA

Note: For this migration.:


v data is unloaded from Dorana
v data is loaded into Tivoli Asset Discovery for z/OS
v a new table space is created
v new tables and indexes are created
v columns are added to existing tables
v column sizes are modified

Once you have made the appropriate changes to HSISCUST, submit this job to run.

The job must create or reuse two output libraries. These are:
1. JCLLIB - The library contains JCL jobs to create DB2 resources, and to run the
products functions.
2. PARMLIB - The library is referenced by jobs in the JCLLIB, and contains
pre-tailored parameters.

For the migration implementation, use the JCLLIB members to submit jobs in the
sequence as listed here:

HSISDB01 Job to define DB2 Storage Groups and the Database name.
HSISDB02 Job to create the DB2 table spaces for the Global Knowledge Base.
HSISDB03 Job to load the Global Knowledge Base.
HSISDB04 Job to create the DB2 table spaces for the z/OS UNIX Global
Knowledge Base.
HSISDB05 Job to load the z/OS UNIX Global Knowledge Base.
HSISDB06 Job to create the DB2 resources for the Local Knowledge Base and
z/OS UNIX Local Knowledge Base.
HSISDB07 Job to create the DB2 resources for the Repository.
HSISDB10 Job to create the DB2 resources for the Match Engine.
HSISDB11 Job to create the DB2 resources for the Inquisitor Filters and to
load the filters.
DI* Jobs (per IQ schema) to create DB2 resources for the Inquisitor
Import.
DX* Jobs (per IQ schema) to create DB2 resources for the z/OS UNIX
Inquisitor Import.
HSISGRNT Job to grant general (non IQ schema) access to DB2 resources.
GI* Job (per IQ schema) to grant access to DB2 resources.
GX* Job (per IQ schema) to grant access to DB2 resources for z/OS
UNIX.

If your site does not have any data from LKB and LKU to migrate, then ignore
running the following 4 jobs (HSISMI20, HSISMI21,HSISMI22, and HSISMI23).

36 Administration Guide and Reference


IBM Confidential

HSISMI20 LKB - Unload from Dorana


HSISMI21 LKB - Reload to Tivoli Asset Discovery for z/OS
HSISMI22 LKU - Unload from Dorana
HSISMI23 LKU - Reload to Tivoli Asset Discovery for z/OS

HSISMI24 Repository - Unload 24 tables from Dorana


HSISMI25 Repository - Reload 24 tables to Tivoli Asset Discovery for z/OS
HSISMI30 Populate the newly defined tables in the Repository for the Tivoli
Asset Discovery for z/OS
Note: Job HSISMI30 might take a long time to run if the
recommended tasks listed in the pre migration section are not
followed.

Post-migration tasks
v You can continue to run your existing Usage Monitor and Inquisitor Scan as
before.
v Importing Dorana Version 5 Release 4 Usage and Inquisitor data into the new
Tivoli Asset Discovery for z/OS Version 7 Release 2 is tolerated, as the data
structures are compatible.
v When Tivoli Asset Discovery for z/OS Version 7 Release 2 has been fully
implemented, and the new Usage Monitor and Inquisitor Scan are ready for use,
the previous version of the Usage Monitor and Inquisitor Import can be
discontinued.
v Once you have discontinued using the previous product, you can proceed to run
the remaining jobs as described in the Capture, Computation, and Reporting
phases.
v Reorganization and backup of the new database is also recommended.

Migration from Hardware and Software Identification for z/OS Version 7


Release 1
Pre-migration recommendations

For improved migration performance, it is recommended that the tasks listed here
are run on the existing Hardware and Software Identification for z/OS database.
v Run the Usage Summary job
v Run the Usage Deletion job
v Reorganize the Repository table spaces

Migration tasks

To migrate Hardware and Software Identification for z/OS V7.1 to Tivoli Asset
Discovery for z/OS V7.2, complete the step as explained in section Creating
post-installation jobs on page 18. The HSISCUST parameters listed below must be
customized with identical values as used in your Hardware and Software
Identification for z/OS system:
1. DB - database
2. Schema Names

Chapter 7. Migration 37
IBM Confidential

GKBUSCHM
LKBSCHMA
LKBUSCHM
REPSCHMA
MESCHMA
FLSCHMA

Note: For this migration:


v no application data is migrated from the previous release
v a new table space is created
v new tables and indexes are created
v index is modified
v columns are added to existing tables
v column sizes are modified

Once you have made the appropriate changes to HSISCUST, submit this job to run.

The job must create or reuse two output libraries. These are:
1. JCLLIB - The library contains JCL jobs to create DB2 resources, and to run the
products functions.
2. PARMLIB - The library is referenced by jobs in the JCLLIB, and contains
pre-tailored parameters.

For the migration implementation, use the JCLLIB members to submit jobs in the
sequence as listed here:

HSISMI10 Create/Alter DB2 resources

a) Add new column in Local Knowledge Base and Local


Knowledge Base for z/OS UNIX.

b) Expand sizes of existing column in Local Knowledge Base and


Local Knowledge Base for z/OS UNIX.

c) For the Repository:


v Create new table space VAGGR
v Create 11 new tables and associated indexes
v Add new columns to existing tables
v Add new column to an existing index
v Expand size of an existing column
Note: Table spaces VSHARE, VUSEMTD, WLOCLKB5.
WLOCLKBU, and indexes REPschema.IUSEMTD1 and
REPschema.IVENDOR1, are set to advisory REORG-pending status
(AREO*).
HSISMI11 Drop DB2 Resources in GKB, GKU, IQF

a) Drop table spaces for Global Knowledge Base

b) Drop table spaces for Global Knowledge Base for z/OS UNIX

c) Drop table space for Inquisitor filters


HSISDB02 Job to create the DB2 table spaces for the Global Knowledge Base.
HSISDB03 Job to load the Global Knowledge Base.
HSISDB04 Job to create the DB2 table spaces for the z/OS UNIX Global
Knowledge Base.

38 Administration Guide and Reference


IBM Confidential

HSISDB05 Job to load the z/OS UNIX Global Knowledge Base.


HSISDB11 Job to create the DB2 resources for the Inquisitor Filters and to
load the filters.
HSISMI30 Populate the newly defined tables in the Repository
Note: Job HSISMI30 might take a long time to run if the
recommended tasks listed in the pre migration section are not
followed.
HSISGRNT Job to grant general (non IQ schema) access to DB2 resources.
GI* Job (per IQ schema) to grant access to DB2 resources.
GX* Job (per IQ schema) to grant access to DB2 resources for z/OS
UNIX.

Post-migration tasks
v You can continue to run your existing Usage Monitor and Inquisitor Scan as
before.
v Importing Hardware and Software Identification for z/OS Version 7 Release 1
Usage and Inquisitor data into the new Tivoli Asset Discovery for z/OS Version
7 Release 2 is tolerated, as the data structures are compatible.
v When Tivoli Asset Discovery for z/OS Version 7 Release 2 has been fully
implemented, and the new Usage Monitor and Inquisitor Scan are ready for use,
the previous version of the Usage Monitor and Inquisitor Import can be
discontinued.
v Once you have discontinued the previous release, you can proceed to run the
remaining jobs as described in the Capture, Computation, and Reporting phases.
v Some table spaces and indexes are set to advisory REORG-pending (AREO*)
status as a result of the migration. To set the table spaces and indexes back to
their normal (RW) state, a reorganization of these resources needs to be
performed.
v Reorganization and backup of the new product is also recommended.

DB2 objects affected by migration


The table lists DB2 resources affected by application data migration. It is provided
as a reference, and definitions for these DB2 objects can be found in the PARMLIB
members.

Dorana V5.4 HSIz V7.1 TADz V7.2


Schema Table Name T/S T/S T/S
GKBSchema TPRODUCT WPDTGKB WPDTGKB WPDTGKB
GKBSchema TPARAM WRULGKB WRULGKB WRULGKB
GKBSchema TPRSMAP WRULGKB WRULGKB WRULGKB
GKBSchema TPTFFMID WRULGKB WRULGKB WRULGKB
GKBSchema TRULES WRULGKB WRULGKB WRULGKB
GKBSchema TSCORPAT WSCPGKB WSCPGKB WSCPGKB
GKBSchema PRODUCT WVDRGKB WVDRGKB WVDRGKB
GKBSchema TPRODLINK WVDRGKB WVDRGKB WVDRGKB
GKBSchema TVENDOR WVDRGKB WVDRGKB WVDRGKB
GKBSchema TVERSION WVERGKB WVERGKB WVERGKB

Chapter 7. Migration 39
IBM Confidential

Dorana V5.4 HSIz V7.1 TADz V7.2


Schema Table Name T/S T/S T/S

GKUSchema TPRODUCT WPDTGKU WPDTGKU WPDTGKU


GKUSchema TPARAM WRULGKU WRULGKU WRULGKU
GKUSchema TPTFFMID WRULGKU WRULGKU WRULGKU
GKUSchema TRULES WRULGKU WRULGKU WRULGKU
GKUSchema TSCORPAT WSCPGKU WSCPGKU WSCPGKU
GKUSchema TVENDOR WVDRGKU WVDRGKU WVDRGKU
GKUSchema TVERSION WVERGKU WVERGKU WVERGKU

LKBSchema TPARAM WLOCLKB WLOCLKB WLOCLKB


LKBSchema TPRODUCT WLOCLKB WLOCLKB WLOCLKB
LKBSchema TPTFFMID WLOCLKB WLOCLKB WLOCLKB
LKBSchema TRULES WLOCLKB WLOCLKB WLOCLKB
LKBSchema TSCORPAT WLOCLKB WLOCLKB WLOCLKB
LKBSchema TVENDOR WLOCLKB WLOCLKB WLOCLKB
LKBSchema TVERSION WLOCLKB WLOCLKB WLOCLKB

LKUSchema TPARAM WLOCLKU WLOCLKU WLOCLKU


LKUSchema TPRODUCT WLOCLKU WLOCLKU WLOCLKU
LKUSchema TPTFFMID WLOCLKU WLOCLKU WLOCLKU
LKUSchema TRULES WLOCLKU WLOCLKU WLOCLKU
LKUSchema TSCORPAT WLOCLKU WLOCLKU WLOCLKU
LKUSchema TVENDOR WLOCLKU WLOCLKU WLOCLKU
LKUSchema TVERSION WLOCLKU WLOCLKU WLOCLKU

IQSchema TCSECT WC* WC* WC*


IQSchema TDECISION WD* WD* WD*
IQSchema TLIBRARY WL* WL* WL*
IQSchema TMODULE WM* WM* WM*
IQSchema TMIGREPORT WR* WR* WR*
IQSchema TPARAM WS* WS* WS*
IQSchema TSYSTEM WS* WS* WS*

IQUSchema TDECISION WDU* WDU* WDU*


IQUSchema TLIBRARY WLU* WLU* WLU*
IQUSchema TMODULE WMU* WMU* WMU*
IQUSchema TMIGREPORT WRU* WRU* WRU*
IQUSchema TPARAM WSU* WSU* WSU*
IQUSchema TSYSTEM WSU* WSU* WSU*

40 Administration Guide and Reference


IBM Confidential

Dorana V5.4 HSIz V7.1 TADz V7.2


Schema Table Name T/S T/S T/S
MESchema TIDENTLMOD WIDENTLM WIDENTLM WIDENTLM
MESchema TINTERLIBPRODUCTID WINTLPDT WINTLPDT WINTLPDT
MESchema TINTERVERPRODUCTID WINTVPDT WINTVPDT WINTVPDT
MESchema TXLIBSTOP WXLIBSTP WXLIBSTP WXLIBSTP

IQFSchema TCOMPILERS WIQFILTR WIQFILTR WIQFILTR


IQFSchema TIQFILTERS WIQFILTR WIQFILTR WIQFILTR
IQFSchema TPARAM WIQFILTR WIQFILTR WIQFILTR
IQFSchema TUXFILTERS WIQFILTR WIQFILTR WIQFILTR
IQFSchema TXPCMODULES WIQFILTR WIQFILTR WIQFILTR
IQFSchema TXPCSPEC WIQFILTR WIQFILTR WIQFILTR
IQFSchema TXVENDORS WIQFILTR WIQFILTR WIQFILTR

REPSchema NODE N/A N/A VAGGR


REPSchema NODE_CAPACITY N/A N/A VAGGR
REPSchema PRODUCT N/A N/A VAGGR
REPSchema PRODUCT_INSTALL N/A N/A VAGGR
REPSchema PRODUCT_NODE_CAPACIT N/A N/A VAGGR
REPSchema PRODUCT_USE N/A N/A VAGGR
REPSchema PRODUCT_USE_DETAIL N/A N/A VAGGR
REPSchema SYSTEM N/A N/A VAGGR
REPSchema SYSTEM_NODE N/A N/A VAGGR
REPSchema TACCOUNT N/A N/A VSHARE
REPSchema TUSEPRS N/A N/A VSHARE
REPSchema TJOBDATA VJOBDATA VJOBDATA VJOBDATA
REPSchema TMODULE VMODULE VMODULE VMODULE
REPSchema TUSEMTD VUSEMTD VUSEMTD VUSEMTD
REPSchema TINVCTL VINVCTL VSHARE VSHARE
REPSchema TINVREG VINVREG VSHARE VSHARE
REPSchema TIQHISTORY VIQHIST VSHARE VSHARE
REPSchema TLIBRARY VLIBRARY VSHARE VSHARE
REPSchema TLPAR VLPAR VSHARE VSHARE
REPSchema TPARAM VPARAM VSHARE VSHARE
REPSchema TPERIODS VPERIOD VSHARE VSHARE
REPSchema TPOVINV VPOVINV VSHARE VSHARE
REPSchema TPOVLIB VPOVLIB VSHARE VSHARE
REPSchema TPRODUCT VPRODUCT VSHARE VSHARE
REPSchema TREGCLASS VREGCLAS VSHARE VSHARE
REPSchema TREGION VREGION VSHARE VSHARE
REPSchema TREGLEAF VREGLEAF VSHARE VSHARE

Chapter 7. Migration 41
IBM Confidential

Dorana V5.4 HSIz V7.1 TADz V7.2


Schema Table Name T/S T/S T/S
REPSchema TUIMPORTCTRL VUIMPCTL VSHARE VSHARE
REPSchema TUSELIB VUSELIB VSHARE VSHARE
REPSchema TUSEPO VUSEPO VSHARE VSHARE
REPSchema TUSEPOV VUSEPOV VSHARE VSHARE
REPSchema TUSEPOVLIB VUPOVLIB VSHARE VSHARE
REPSchema TUSERDATA VUSRDATA VSHARE VSHARE
REPSchema TVENDOR VVENDOR VSHARE VSHARE
REPSchema TVERSION VVERSION VSHARE VSHARE

42 Administration Guide and Reference


IBM Confidential

Chapter 8. Inquisitor for z/OS


The Inquisitor provides the ability to scan PDS and PDSE load libraries, and to
extract information regarding the contents of those libraries. Data output by the
Inquisitor becomes input to the Software Inventory creation.

While the simplest Inquisitor request is to scan all online load libraries, facilities
are provided to limit processing to specific subsets of libraries.

Inquisitor JCL
The HSISCUST post-installation customization job creates JCL jobs in the JCLLIB to
run the z/OS Inquisitor. Members beginning with ZIQ, and suffixed with the
Inquisitor schema name contain JCL to run the Inquisitor for a given schema.

To allocate the MCDS, if any requests contain the REMIGRATE or NOML2


operands, supply an additional DD statement like this one:
//MCDS DD DSN=DFHSM.MCDS,DISP=SHR

Multiple MCDS files are now supported by using additional DD statements


MCDS2, MCDS3, and MCDS4. The MCDS is the migration control data set of
IBMs Hierarchical Storage Manager data management, DFHSM or DFSMShsm,
hereafter referred to as HSM.

To allocate the necessary files required to interface to FDRABR, if any requests


contain the ABRMIG or ABRARC operands, supply these two additional DD
statements:
//ABRPRINT DD SYSOUT=*
//ABRIN DD UNIT=VIO,SPACE=(TRK,1)

Modify the JOB statement to suit the installation standards. Selection of a


MSGCLASS which is held is useful.

Specifying a generous REGION in the job statement is recommended to remove


region size as a possible cause of problems. MCDS processing uses about 700
kilobytes more region storage than might otherwise be used.

If you choose to run SCANPGM requests, ensure that the MEMLIMIT value is
large enough to permit the relevant Program Binder processing of the largest
program object that the Inquisitor will encounter.

The optional program parameter allows the specification of a report message level,
a job run identifier, and an override to the system identifier.

The program parameter details are:


v If more than one parameter setting is specified, the settings must be separated
by a comma.
v DSNMSG requests that messages relating to processed data sets, which might
otherwise be suppressed, are to be logged in the SYSPRINT report.
v PGMMSG requests that messages relating to processed programs, which might
otherwise be suppressed, are to be logged in the SYSPRINT report.

Copyright IBM Corp. 2009 43


IBM Confidential

v ALLMSG requests both DSNMSG and PGMMSG message logging.


v NOAPF specifies that the Inquisitor is to run in an environment which is not
APF authorized.
v The SID value is up to four characters long, and specifies the system identifier to
be contained in the Inquisitors output data. If the SID identifier override is
omitted, the system SMF identifier is used. The SID parameter setting is for use
when the SMF system identifier of a system is not unique.
Syntax:
SID=SYS2
v The RUN value is up to eight characters long, and specifies an optional run
identifier, which is contained in the output header record.
Syntax:
RUN=SPECIAL
v The PLX parameter is used to identify if the Inquisitor data being collected is a
SYSPLEX. The value is either Y or N. If the PLX parameter is not used, the
default value of N is created in the Inquisitor header record.
Syntax:
PLX=Y | N

Modify the high level qualifier of the STEPLIB DSNAME so that the correct load
library is referenced. If FDRABR is used, ensure the load library contains the
HSIPINQ and HSIPINQA programs.

Ensure the HSIPZIP output file has an appropriate data set name specified, and the
UNIT and SPACE are correct.

The output volumes of an Inquisitor run are large, depending on the data present
in the installation and the scope of specified requests.

It might be necessary to experiment with a limited scan before estimating the


requirements of a complete scan.

Use control statement operands to limit the scope of Inquisitor requests, as


appropriate.

Files used by the Inquisitor


SYSPRINT
The report file. The minimum LRECL is 81, plus 4 for the RDW, if
variable-length records are used. The maximum LRECL is 255. The flexible
DCB support means the report can be easily redirected to a data set if the
need arises.
HSIPZIP
The output file containing compressed Inquisitor data. It is written using a
variable-length record format. DCB information is to be provided in order
to ensure optimal use of DASD space.
v For a 3390, the use of RECFM=VB,LRECL=27994,BLKSIZE=27998 is
advised.
v For a 3380, the use of RECFM=VB,LRECL=23472,BLKSIZE=23476 is
advised.

44 Administration Guide and Reference


IBM Confidential

The HSIPZIP file must not undergo any translation when being
transferred, whatever the architecture of the target system. Only BINARY
transfers are to be used to transport the file.
HSIPOUT
The optional output file containing uncompressed Inquisitor data. It is not
specified in the packaged sample, as the use of HSIPZIP is preferred due
to its reduced space requirements. HSIPOUT also contains variable-length
records. The program supplies the appropriate LRECL. By default, system
determined block size is used.
If the Inquisitor output is to be directed to a compressible extended-format
data set, then the HSIPOUT file must be used. The HSIPZIP file employs
some update-in-place processing which prevents the use of DFSMS
compression.
SYSIN
The request input file. Fixed-length, variable-length, and undefined record
formats are processed. Short records are extended to 72-bytes in length
with blanks, if necessary.
MCDS
This file allocates the HSM MCDS data set, and is required if any requests
contain the REMIGRATE or NOML2 operands. Further, if supplied for
other requests, it is used to avoid the recall of data sets which are not load
libraries. If the HSM MCDS is spread over more than one data set, the DD
names MCDS2, MCDS3, and MCDS4 are to be used consecutively to
allocate all the MCDS data sets in key range order.
ABRIN
The SYSIN file of the FDRABRP utility program is required if any requests
contain the ABRMIG or ABRARC operands. It is primed by the Inquisitor
during execution. For this reason, a single track VIO file is an ideal
allocation.
ABRPRINT
The SYSPRINT file of the FDRABRP utility program is required if any
requests contain the ABRMIG or ABRARC operands. It is an output-only
file, and is not processed by the Inquisitor.

Functions performed by the Inquisitor


The Inquisitor is a program run in a batch job which collects information about
executable software existing in a z/OS DASD subsystem. The resulting file is used
as input for data import postprocessing.

The Inquisitor can process many requests in a single program run. Output from all
requests of a given run is contained in the same file. For example:
SCANDIR STOGROUP(*)
SCANDIR NONSMS

In an installation where some DASD volumes are SMS-managed, these two


requests produce, in a single request, a file with the same size and data content as
this example:
SCANDIR

These function request verbs are currently available:

Chapter 8. Inquisitor for z/OS 45


IBM Confidential

SCANCMD
The SCANCMD verb is used to allow command syntax and operand
consistency to be checked by the Inquisitor without initiating Load Library
processing. It performs a parse only operation, although output files are
opened.
Error messages relating to syntax and operand errors are produced as
usual. This verb is of use while users are formulating the best request
combination to implement for any given system.
SCANDIR
The SCANDIR verb is used to collect data from program library directory
entries. Contents of program members are not accessed.
Compared to SCANPGM, its reduced data collection allows it to run faster.
Although all syntactically correct operands are allowed, some operands
relating to data from member contents are ignored during processing.
SCANDIR collects all of the information needed for automated software
identification, and is the verb of choice for a production environment.
SCANPGM
The SCANPGM verb collects all data collected by SCANDIR, as well as
information from member contents. Such information relates to program
structure and history.
Your IBM representative may request SCANPGM output data to assist with
problem diagnosis and resolution.
SCANMOD
The SCANMOD verb performs the same function as SCANPGM, except
that PDSEs are excluded from processing. Only the load modules in the
PDSes are processed.
SCANOBJ
The SCANOBJ verb is used to collect data from program library directory
entries. Contents of program members are not accessed.
Compared to SCANPGM, its reduced data collection allows it to run faster.
Although all syntactically correct operands are allowed, some operands
relating to data from member contents are ignored during processing.
SCANDIR collects all of the information needed for automated software
identification, and is the verb of choice for a production environment.

Note: In a production environment, it is anticipated that only the SCANDIR verb


is used, as it provides the necessary data to perform software identification with
the minimum resource consumption.

Syntax of Inquisitor requests


This section details the syntax rules and values of request control statements input
into the Inquisitor.

Syntax rules are as follows:


v Only the first 72 bytes of an input record are ever scanned.
v Short records are extended to 72 bytes with blanks, if necessary.
v A continuation on to the next record is requested by a plus or dash.
v A continuation cannot be requested in the middle of a word or value.

46 Administration Guide and Reference


IBM Confidential

v The part of the record following a continuation character is ignored and can be
used for comments.
v Blanks, commas, parentheses, and continuation characters, are the only
delimiters.
v Blanks and commas are equivalent.
v Records beginning with an asterisk are comment records.
v Records containing only blanks or commas are comment records.
v Comment records are ignored by syntax parsing logic, and do not alter
continuation status.
v If the input record contains an ampersand, the system symbol substitution
routine ASASYMBM is called to perform symbol substitution processing.
v All input requests are parsed and stored before the first request is processed. If a
syntax error is encountered, no requests are processed. This is to reduce the
instance of incorrect or unproductive requests triggering lengthy DASD
subsystem scans. The error is in the last record echoed in SYSPRINT.
v TSO conventions apply to abbreviations. That is, operands can be abbreviated to
the minimum unambiguous length. Verbs cannot be abbreviated.
v Subparameters of value operands are specified in parentheses.
v Value masks are character strings which are compared to data found at run time.
Comparison is performed one byte at a time, from left to right. For a match, the
characters must compare equal, unless a generic mask character is found.
v System static symbols can be used to construct value masks.
v Valid generic mask characters are a percent (%), to flag a match for any single
character, and an asterisk (*), to flag a match for any character string segment of
zero or greater length.

Control statement specification


This syntax diagram details Inquisitor request verbs and operands:

Chapter 8. Inquisitor for z/OS 47


IBM Confidential

Syntax (Inquisitor request verbs and operands)

 SCANCMD 
SCANDIR DATASET (dsn-mask) XDATASET (dsn-masks)
SCANPGM DSNAME XDSNAME
SCANMOD
SCANOBJ

 
VOLUME (volser-masks) XVOLUME (volser-masks)

 
PROGRAM (pgmname-masks) XPROGRAM (pgmname-masks)
PGM XPGM

 
MODULE (modname-masks) XMODULE (modname-masks)
CSECT XCSECT

 
STOGROUP (storage-group-masks)
SG

 
XSTOGROUP (storage-group-masks) NONSMS LINKLIST
XSG

 
AUTHLIBS NOALIAS CATALOG NORECALL FULLIDR

 
SYMVOL REMIGRATE NOML2 ABRMIG ABRARC

 
NOTAGDATA

Defaults are:
v DSNAME(*) VOLUME(*) PROGRAM(*)
v No operands are required.
v All operands are optional.

Possible operands:
DATASET Alias: DSNAME
This operand specifies one or more 1 to 44 byte data set name masks. Only
data sets with names matching any masks specified here are processed.
Data sets with names not matching any masks specified here are not
processed. Multiple masks must be separated by one or more delimiters.
This operand can be specified more than once in a request, whereupon all
masks specified in all occurrences of this operand are checked for selection
matching. The precise treatment of asterisks in these masks is altered by
the presence of the CATALOG keyword in the request. When CATALOG is
specified, mask matching becomes qualifier aware and a single asterisk
represents one, or part of, one qualifier only. When CATALOG is specified,
use a double asterisk to specify any number of qualifiers. The data set

48 Administration Guide and Reference


IBM Confidential

name selection mask is the only mask affected by the CATALOG keyword.
When the CATALOG keyword is present, exactly one DSNAME mask
must be specified.
XDATASET Alias: XDSNAME
This operand specifies one or more 1 to 44 byte data set name masks. Data
sets with names matching any mask specified here are not processed.
Multiple masks must be separated by one or more delimiters. This operand
can be specified more than once in a request, whereupon all masks
specified in all occurrences of this operand are checked for exclusion
matching. If this operand is used, each mask must specify a subset of a
DATASET mask.
VOLUME
This operand specifies one or more 1 to 6 byte volume serial number
masks. Only volumes with serial numbers matching any mask specified
here are processed. Volumes with serial numbers not matching any mask
specified here, are not processed. Multiple masks must be separated by one
or more delimiters. This operand can be specified more than once in a
request, whereupon all masks specified in all occurrences of this operand
are checked for selection matching. A volume serial number mask of six
asterisks specifies the current IPL volume, which is ascertained during
execution.
XVOLUME
This operand specifies one or more 1 to 6 byte volume serial number
masks. Volumes with serial numbers matching any mask specified here are
not processed. Multiple masks must be separated by one or more
delimiters. This operand can be specified more than once in a request,
whereupon all masks specified in all occurrences of this operand are
checked for exclusion matching. If this operand is used, each mask must
specify a subset of a VOLUME mask. A volume serial number mask of six
asterisks specifies the current IPL volume, which is ascertained during
execution.
PROGRAM Alias: PGM
This operand specifies one or more 1 to 8 byte program name masks. Only
programs with names matching any mask specified here are processed.
Programs with names not matching any mask specified here, are not
processed. Multiple masks must be separated by one or more delimiters.
This operand can be specified more than once in a request, whereupon all
masks specified in all occurrences of this operand are checked for selection
matching.
XPROGRAM Alias: XPGM
This operand specifies one or more 1 to 8 byte program name masks.
Programs with names matching any mask specified here are not processed.
Multiple masks must be separated by one or more delimiters. This operand
can be specified more than once in a request, whereupon all masks
specified in all occurrences of this operand are checked for exclusion
matching. If this operand is used, each mask must specify a subset of a
PROGRAM mask.
MODULE Alias: CSECT
This operand specifies one or more 1 to 8 byte module name masks. The
presence of this operand means that extra information about program
routines is collected. Only CSECTs with names matching at least one mask
encountered in processed programs can have this extra information
collected. Multiple masks must be separated by one or more delimiters.

Chapter 8. Inquisitor for z/OS 49


IBM Confidential

This operand can be specified more than once in a request, whereupon all
masks specified in all occurrences of this operand are checked for selection
matching. This operand is ignored for a SCANDIR request.
XMODULE Alias: XCSECT
This operand specifies one or more 1 to 8 byte module name masks.
CSECTs with names matching any mask specified here cannot have extra
information collected. Multiple masks must be separated by one or more
delimiters. This operand can be specified more than once in a request,
whereupon all masks specified in all occurrences of this operand are
checked for exclusion matching. If this operand is used, each mask must
specify a subset of a MODULE mask. This operand is ignored for a
SCANDIR request.
STOGROUP Alias: SG
This operand specifies one or more 1 to 8 byte storage group name masks.
SMS-managed volumes in a storage group with a name matching any
mask specified here is processed. SMS-managed volumes in a storage
group with a name that does not match any mask specified here, are not
processed. Multiple masks must be separated by one or more delimiters.
This operand can be specified more than once in a request, whereupon all
masks specified in all occurrences of this operand are checked for selection
matching. Volumes which are not SMS-managed are not processed unless
the NONSMS keyword operand is specified.
XSTOGROUP Alias: XSG
This operand specifies one or more 1 to 8 byte storage group name masks.
SMS-managed volumes in a storage group with a name matching any
mask specified here are not processed. Multiple masks must be separated
by one or more delimiters. This operand can be specified more than once
in a request, whereupon all masks specified in all occurrences of this
operand are checked for exclusion matching. If both this mask and a
STOGROUP mask are used, then each mask must specify a subset of a
STOGROUP mask.
NONSMS
This keyword operand specifies that volumes which are not SMS-managed
are eligible for processing. The presence of this operand means that
SMS-managed volumes are not processed unless the STOGROUP operand
was used to supply a storage group name mask.
LINKLIST
This keyword operand specifies that all linklist data sets are to be
unconditionally included for processing.
AUTHLIBS
This keyword operand specifies that all APF authorized data sets are to be
unconditionally included for processing.
NOALIAS
This keyword operand specifies that any program member marked as an
alias is to be excluded from processing.
CATALOG
This keyword operand specifies that data sets to be processed are located
from a catalog search rather than VTOC searches. Data set alias names are
not processed. The Inquisitor triggers and waits for a RECALL operation
for each migrated data set which passes data set name mask processing,
unless NORECALL is also specified.

50 Administration Guide and Reference


IBM Confidential

NORECALL
This keyword specifies that migrated data sets are not to be recalled and
are excluded from processing. This operand only has effect when the
CATALOG operand is also specified. Data sets with a catalog entry
indicating a volume serial number of MIGRAT, or ARCIVE, are deemed to
be migrated.
FULLIDR
This keyword operand specifies that a full scan of CESD and IDR records
is to be performed, even when a module would not have been selected for
such processing. Depending upon the exact nature of the request being
run, this operand can significantly elongate the elapsed time of Inquisitor
runtime.
SYMVOL
This keyword operand specifies that when a load library resides on the IPL
volume, or on a volume with a serial number which matches the value of a
system static symbol, then the output does not contain the actual volume
serial number, but six asterisks for the IPL volume or the symbol name for
other volumes. Only symbols with names which are six characters long,
including the leading ampersand and excluding the trailing period, are
considered for this processing.
If you use this keyword to collect your data, then you must also use the
corresponding keyword SYM in the Usage Monitor. You cannot use the
SYMVOL parameter in the Inquisitor without using the SYM keyword in
Usage Monitor. This way the Inquisitor data match the Usage Data,
otherwise the usage data is not imported to the correct products.
REMIGRATE
This keyword operand specifies that when a data set which had to be
recalled has been processed, HSM is requested to migrate the data set
again asynchronously. Migrated data sets can only be processed when the
CATALOG operand is also specified. Only data sets with a catalog entry
indicating a volume of MIGRAT are remigrated.
The presence of this operand requires that the MCDS file is allocated to the
HSM MCDS. Access to the MCDS allows the Inquisitor to avoid recalls for
data sets which are not partitioned, do not have an undefined record
format, and do not have a block size of at least 1024.
NOML2
This keyword operand specifies that data sets migrated to level two are not
to be recalled and are excluded from processing. Migrated data sets can
only be processed when the CATALOG operand is also specified. Only
data sets with a catalog entry indicating a volume of MIGRAT are checked
for level two status.
The presence of this operand requires that the MCDS file is allocated to the
HSM MCDS. Access to the MCDS allows the Inquisitor to avoid recalls for
data sets which are not partitioned, do not have an undefined record
format, and do not have a block size of at least 1024.
ABRMIG
This keyword operand indicates that when a catalog entry with a volume
of MIGRAT is encountered, the FDRABR product is to be invoked to
determine whether a recallable archived copy of the data sets is available
or not. If it is, then the data set is processed. If not, then the data set is not
processed.

Chapter 8. Inquisitor for z/OS 51


IBM Confidential

The NORECALL operand takes precedence over this operand.


The effect of ABRMIG is not effected by the ABRARC operand.
The presence of this operand requires that the ABRIN and ABRPRINT files
are allocated.
ABRARC
This keyword indicates that, when a cataloged data set cannot be found on
the volume, the FDRABR product is to be invoked in order to determine
whether a recallable archived copy of the data set is available. If it is, then
the data set is processed. If not, the data set is not processed.
The NORECALL operand takes precedence over this operand.
The effect of ABRARC is not effected by the ABRMIG operand.
The presence of this operand requires that the ABRIN and ABRPRINT files
are allocated.
NOTAGDATA
This keyword indicates that data written to program libraries by the
Product Tagger is not to be collected and written to the Inquisitor output
file. Use this operand only when you do not want to update the Local
Knowledge Base during the import process with the latest Tagger data that
could be found by the Inquisitor.

Examples
These examples are provided to illustrate some possible scenarios where the scope
and type of processing is customized. The first three examples are equivalent, and
request data collection for all programs on all online DASD volumes.

Example 1:
SCANDIR
SCANDIR DA(*) PGM(*)
SCANDIR VOL(*) DS(*)

Example 2:

To scan all SMS-managed volumes except volumes in storage group SGWORK use:
SCANDIR STOGROUP(*) XSTOGROUP(SGWORK)

Example 3:

To scan all volumes except volumes in storage groups with names beginning with
SGW use:
SCANDIR XSTOGROUP(SGW*)

Example 4:

To scan all volumes with serial numbers beginning with TSO and WRK, these two
requests are used in a single program run:
SCANDIR VOLUME(TSO*)
SCANDIR VOLUME(WRK*)

Example 5:

52 Administration Guide and Reference


IBM Confidential

To scan all volumes except those with serial numbers beginning with TSO and
WRK use:
SCANDIR XVOLUME(TSO* WRK*)

Example 6:

To scan all volumes with serial numbers beginning with USR, which are also in
SMS storage groups with names beginning with SG. Also, to scan for programs
with names beginning with UTIL, and to collect extra information about CSECTs
with names beginning with DATE, except DATENCOD, use:
SCANDIR VOLUME(USR*) STOGROUP(SG*) +
PROGRAM(UTIL*) MODULE(DATE*) XMODULE(DATENCOD)

Example 7:

To scan all data sets with high level qualifiers of SYS1, SYS2, SYS3, except z/OS
distribution libraries, use:
SCANDIR DSNAME(SYS%.*) XDSNAME(SYS1.A*)

Example 8:

To restrict this examples data to cataloged data sets, use:


SCANDIR DSNAME(SYS%.**) XDSNAME(SYS1.A*) CATALOG

Note: Note the extra asterisk in the data set name selection mask. Without this,
only data set names with two qualifiers are selected. Data set name exclusion
processing is not changed by the CATALOG operand.

Example 9:

To scan the current IPL volume, and any other link, list, and APF authorized
libraries use:
SCANDIR VOLUME(******) LINKLIST AUTHLIBS

Example 10:

To scan the single cataloged data set SYS1.PPLIB without a lengthy DASD
subsystem scan use:
SCANDIR DATASET(SYS1.PPLIB) CATALOG

Example 11:

To scan all cataloged SYS1 and SYS2 data sets use (a) two requests in a single
program run, or (b) a single request. The two approaches exhibit similar resource
consumption:
SCANDIR DA(SYS1.**) CAT

SCANDIR DA(SYS2.**) CAT


SCANDIRDS(SYS%.**) CAT XDSN(SYS3.*,SYS4.*,SYSA.*)

Where the XDSN operand lists all 4-character high-level qualifiers in the system
beginning with SYS except for SYS1 and SYS2.

Note: SCANDIR DS(SYS1.**,SYS2.**) CAT is not allowed.

Chapter 8. Inquisitor for z/OS 53


IBM Confidential

Example 12:

These examples are all equivalent. They scan the entire DASD subsystem for all
data sets with a first qualifier of SYS1 or SYS2, excluding those with a second
qualifier beginning with A.

(a)
SCANDIR DA(SYS1.*,SYS2.*) XDA(SYS1.A*,SYS2.A*)

(b)
SCANDIR DA(SYS1.* +
SYS2.*) +
XDA(SYS1.A* +
SYS2.A*)

(c)
SCANDIR DA(SYS1.*) +
DA(SYS2.*) +
XDA(SYS1.A*) +
XDA(SYS2.A*)

(d)
SCANDIR DA(SYS1.*) XDA(SYS1.A*) +
DA(SYS2.*) XDA(SYS2.A*)

(e)
SCANDIR DA(SYS1.*) XDSN(SYS1.A* SYS2.A*) DS(SYS2.*)

Example 13:

Here, the entire DASD subsystem is processed, but the volume serial numbers are
replaced in the output data by the name of a corresponding symbol, if one is
defined, or by six asterisks for the IPL volume.
SCANDIR SYMVOL

The SYMVOL operand must be used in conjunction with the SYM command of the
Usage Monitor otherwise the Usage data does not match the Inquisitor data.

Designing requests
For an individual Inquisitor request, a given volume is never scanned more than
once. When a series of requests is based upon separate groups of volumes, using
volume serial number or SMS storage group selection criteria, it also follows that a
volume would not be scanned more than once. However, when a series of requests
for separate groups of data sets based solely upon data set name selection criteria
is made, a volume is scanned once for each request.

As a result, it might be preferable to combine all selection and exclusion criteria


into a single request to ensure that a volume is scanned only once. This
consolidation of numerous criteria into a single request is not always possible if
data sets are to be located by catalog search. This is because the use of the
CATALOG keyword prevents the specification of multiple data set name selection
masks. However, if catalog search is used, then the issue of scanning any VTOC
more than once does not arise.

54 Administration Guide and Reference


IBM Confidential

A volume with no program libraries is processed quite quickly. Alternatively, for


systems with large numbers of volumes known to not have any program libraries
of interest, processing duration is noticeably reduced by excluding such volumes
from an Inquisitor scan.

For example, volumes exclusively containing databases or temporary data sets do


not have any files suitable for Inquisitor processing, but the VTOCs of those
volumes are still read unless excluded by the appropriate selection criteria.

To illustrate this further, consider a system with these DASD subsystem usage
elements:
System platform
Non-SMS and storage group SYSTEM
Work pool
Storage group TEMP containing temporary and short-lived (two days)
permanent files
TSO Storage groups TSOONE and TSOTWO
Non-DB application
Non-SMS and storage groups BATCH1 and BATCH2
Databases
Non-SMS volumes DBA001 to DBA099 and SMS storage groups DB01,
DB02 and DB03

This list makes these assumptions:


v No need for data from libraries which does not exist for more than two days.
v No program libraries on database volumes.
v Applications intermix their program libraries and non-DB files.
v TSO users can have program libraries.
v Management want information regarding all potentially permanent executable
software.

To acquire Inquisitor data from all useful sources without processing volumes
more than once, and without processing irrelevant volumes, these requests could
be specified in a single Inquisitor run. For example:
SCANDIR SG(SYSTEM)
SCANDIR SG(TSO*)
SCANDIR SG(BATCH*)
SCANDIR NONSMS XVOL(DB*)

This is consolidated into a single request giving the same result. For example:
SCANDIR SG(SYSTEM TSO* BATCH*) NONSMS XVOL (DB*)

Processing migrated libraries


For systems using IBMs Hierarchical Storage Manager data management product
DFSMShsm, referred to here as HSM, to perform space management, several
request keywords are of interest when performing CATALOG requests.

Unless CATALOG is specified, only program libraries on primary volumes are


processed by the Inquisitor.

Chapter 8. Inquisitor for z/OS 55


IBM Confidential

With the CATALOG operand specified, migrated program libraries are eligible for
processing, unless the NORECALL operand is also coded. Specifying NORECALL
causes libraries cataloged on volumes MIGRAT or ARCHIVE (if no MCDS DD
statement is present) to be considered as migrated by the Inquisitor. These are
consequently not processed, thereby avoiding their recall to primary volumes.

The presence of a usable HSM MCDS data set allocated to the MCDS file informs
the Inquisitor the system has HSM installed. As a consequence, the data sets
cataloged on a volume called ARCIVE are not considered to be migrated.

When REMIGRATE or NOML2 is specified, the HSM MCDS is required to be


accessible by the MCDS JCL DD statement. No combination of REMIGRATE,
NOML2, and NORECALL is considered an error.

When NORECALL is not specified, and REMIGRATE or NOML2 is specified, the


MCDS is read to fetch the details of data sets cataloged on volume MIGRAT.
ARCIVE is treated as a primary volume. A recall for Inquisitor processing only
occurs if the MCDS record indicates that the data set is partitioned with an
undefined record format and a block size of at least 1024.

If a specific data set record cannot be read from the MCDS, then it is assumed that
the migrated data set does not exist and it is not processed.

The NOML2 keyword forces the exclusion of data sets migrated to level 2.

The REMIGRATE keyword specifies that after a recalled data set has been
processed by the Inquisitor, the Inquisitor requests HSM to remigrate the data set.
The Inquisitor does not wait for the migration, but begins to process the next data
set immediately after making the request to HSM. Migration level two is never
specified by the Inquisitor for the migration, even if the data set was recalled from
ML2. However, it might be selected by HSM as a result of SMS management class
settings.

If none of the NORECALL, REMIGRATE, and NOML2 keywords are present for a
catalog request, then the HSM MCDS is not required to be allocated. However, if
the MCDS file is allocated, the Inquisitor can use it to avoid recalling data sets
which are not program libraries. If the MCDS file is not present, a CATALOG
request without the NORECALL operand can trigger recalls for data sets of any
data set organization and record format. In all cases, generation data sets are not
recalled for Inquisitor processing.

Collection of Inquisitor output


The output from the Inquisitor is listed here as :
v Spooled output including the job log and SYSPRINT file.
v The sequential file containing the extracted information.

The SYSPRINT file contains statistics of processing carried out by the Inquisitor,
and the status on any errors encountered.

A program parameter of PGMMSG is specified to request messages reporting


member-level anomalies found by the Inquisitor.

56 Administration Guide and Reference


IBM Confidential

All SYSOUT data sets created by the job, including the job log, JCL, and message
streams accumulated by the system, form a key resource in problem determination.
If there is a problem with the Inquisitor, these files are required in order to
diagnose the problem.

The creation of an output file is the main purpose of an Inquisitor execution run. It
contains detailed information about programs encountered, as well as audit data
which is used in problem diagnosis.

As the size of the HSIPOUT data set is 200MB or more, it is recommended that the
HSIPOUT file is replaced by the HSIPZIP file. HSIPZIP data is HSIPOUT data that
has been translated from EBCDIC to ASCII and compressed by the ZIP process.
This reduces the space and time required on z/OS to contain and transfer the file.

Using a compressed form of the data set not only reduces the space used on the
DASD, but reduces the transfer time when the file needs to be transmitted to other
systems.

The ZIP process used by the Inquisitor requires some update-in-place processing,
so the HSIPZIP file must be allocated to a DASD sequential data set which is not
compressible. To collect the output in a compressible extended-format sequential
data set, allocate the data set to the HSIPOUT file.

Inquisitor for z/OS UNIX


The Inquisitor for z/OS UNIX is a batch job which collects information about
executable software existing in HFS and zFS data sets currently mounted and
accessible to z/OS UNIX. The resulting file can then be postprocessed for data
import.

The Inquisitor for z/OS UNIX produces a set of record types which is different
from that produced by the Inquisitor for z/OS. Nonetheless, both jobs collect the
same types of information about executable programs.

The Inquisitor for z/OS UNIX processes the HFS root directory, as well as all
subdirectories. For this reason it needs to run with a UID, which allows access to
all directories and programs which need to be examined. If the Inquisitor for z/OS
UNIX does not have permission to access a directory, then no information is
collected from that directory, or any of its subdirectories.

The HSIXROOT file is used to nominate one or more directories to be considered


root directories. When specified, only the nominated directories and their
subdirectories is processed. This facility is useful when only a subset of the file
hierarchy needs to be scanned.

Apart from the HSIXROOT file, there are no inputs which can restrict, alter, or
filter the type of processing to be carried out. Unlike the Inquisitor for partitioned
data sets, the Inquisitor for z/OS UNIX does not have any control statements.

Inquisitor JCL for z/OS UNIX


The HSISCUST post-installation customization job creates JCL jobs in the JCLLIB to
run the Inquisitor for z/OS UNIX. Members beginning with UIQ and suffixed with
the Inquisitor schema name contain JCL to run the Inquisitor for a given schema.

Chapter 8. Inquisitor for z/OS 57


IBM Confidential

Note: In order to collect all relevant z/OS UNIX data, the user running the
Inquisitor for z/OS UNIX must have access to all HFS directories, including the
root. This ensures that all z/OS UNIX data is collected.

Program parameter details are:


v If a program parameter is specified, it must start with a slash.
v If more than one parameter setting is specified, the settings must be separated
by a comma.
v If a message level setting keyword of PTHMSG, PGMMSG, or ALLMSG is
specified, it must be at the start of the parameter after the slash.
v PTHMSG requests that a message is written to HSIXMSG each time a directory
is opened and closed.
v PGMMSG requests that the processing of every program is logged to the
HSIXMSG report.
v ALLMSG requests both PTHMSG and PGMMSG message logging.
v The SID value is up to four characters long and specifies the system identifier to
be contained in the Inquisitors output data.
v If the SID identifier override is omitted, then the system SMF identifier is used.
The SID parameter setting is for use when the SMF system identifier of a system
is not unique.
v The RUN value is up to eight characters long and specifies an optional run
identifier which is contained in the output header record.
v The PLX parameter is used to identify if the Inquisitor data being collected is a
SYSPLEX. The value is either Y or N. If the PLX parameter is not used, then the
default value of N is created in the Inquisitor header record. For example:
Syntax: PLX=Y | N
v The parameter OUT is used to control the format of the output files:
OUT=Z
Zipped output requiring ddname HSIXZIP
OUT=T
Text output requiring ddname HSIXOUT
OUT=B
Both zipped and text output requiring both ddnames
The default is OUT=Z

The program parameter is omitted from the JCL.

Modify the STEPLIB DSNAME statement with the correct high-level qualifier so
that it points to the correct load library.

Ensure the HSIXZIP output file has an appropriate data set name specified, and
that the UNIT and SPACE are correct.

Files used by the Inquisitor for z/OS UNIX


UNIX System Services for z/OS uses the Hierarchical File System (HFS) to store
the physical files it processes. Even though HFS files are housed in data sets which
are cataloged and have VTOC entries, an individual HFS or zFS data set cannot be
accessed by the usual access methods. A single HFS or zFS data set contains an
entire structure, consisting of a root directory or a hierarchy of subdirectories, with
any one directory containing any number of separate files.

58 Administration Guide and Reference


IBM Confidential

HFS files are designed to be accessed by UNIX applications. A program is usually


an individual HFS file. The Inquisitor for z/OS UNIX is the product component
used to discover UNIX programs in the z/OS UNIX file system.

The files needed to run the Inquisitor for z/OS UNIX are:
HSIXMSG
Report file used by HSIXINQ.
SYSPRINT
Used by Language Environment (LE), which is required to be in the
standard module search path.
SYSOUT
Used by Language Environment (LE), which is required to be in the
standard module search path.
HSIXZIP
The output file containing compressed Inquisitor for z/OS UNIX data. It is
written using a variable-length record format. DCB information must be
provided to ensure optimal use of DASD space.
For a 3390, the use of RECFM=VB,LRECL=27994,BLKSIZE=27998 is
advised.
For a 3380, the use of RECFM=VB,LRECL=23472,BLKSIZE=23476 is
advised.
The HSIXZIP file must never undergo any translation when being
transferred, whatever the architecture of the target system. That is, only
BINARY transfers are to be used to transport the file.
HSIXOUT
The output file containing uncompressed Inquisitor for z/OS UNIX data,
although the use of HSIXZIP is preferred due to its reduced space
requirements. HSIXOUT also contains variable-length records. The program
supplies the appropriate LRECL. By default, system determined block size
is used.
HSIXROOT
HSIXROOT can contain one or more optional 80byte records, each of
which specifies a directory path to be considered, and a root directory to
be processed. If HSIXROOT is empty, then slash (/) is considered to be the
only root directory to be processed. Any HSIXROOT record that is present
must contain a path name beginning with a slash in column one, and end
with one or more blanks or the end of the record. If the specified path does
not end in a slash, one is added. HSIXROOT records with a blank in
column one are discarded.

The points made earlier when discussing the Inquisitor output files about the
update-in-place file I/O performed by the ZIP process, and its consequences for
compressible files, also apply to the Inquisitor z/OS UNIX output files.

Security considerations when running the Inquisitor against


z/OS UNIX files
To allow the Inquisitor Batch Job unrestricted read access to all z/OS UNIX files,
consider using the UNIXPRIV RACF Resource Class which alleviates the need for
UID(0).

Chapter 8. Inquisitor for z/OS 59


IBM Confidential

This sample definition could be used by your Security Administrator to Define,


Permit, Activate, and RACLIST the RACF UNIXPRIV Class:
RDEL UNIXPRIV SUPERUSER.FILESYS.**
RDEF UNIXPRIV SUPERUSER.FILESYS.** UACC(NONE) OWNER(MACNIVE)
PE SUPERUSER.FILESYS.** CLASS(UNIXPRIV) RESET
PE SUPERUSER.FILESYS.** CLASS(UNIXPRIV) ID(JKATNIC) ACCESS(READ)
SETR CLASSACT(UNIXPRIV)
SETR RACLIST(UNIXPRIV)
SETR RACLIST(UNIXPRIV) REFR

60 Administration Guide and Reference


IBM Confidential

Chapter 9. Usage Monitor


The Usage Monitor is a server address space which runs as a started task. Work is
queued to it from all address spaces where programs are used. The Usage Monitor
address space needs to be given a reasonably high dispatching priority. While it
would be safe to run it at the highest possible dispatching priority, you might
choose to give it a priority below those of other high priority workloads, such as
z/OS monitors, IRLM, and VTAM. It is important to note that it needs to be
dispatched frequently to process work queue elements in a timely manner.

Two different types of work can run in the server address space. The first is the
moving of captured data into the data space repository. This is CPU bound, but of
short duration. The second is the writing of the accumulated program usage data
from the data space to a sequential file by the writer task, which is usually I/O
bound.

The Usage Monitor runs APF authorized and is nonswappable.

Usage Monitor JCL


The HSISCUST post-installation customization job creates JCL jobs in the JCLLIB to
run the Usage Monitor. Member HSISUMON contains JCL to run the Usage
Monitor.

Parameters for the Usage Monitor job are found in PARMLIB member
HSISMNPM.

Files used by the Usage Monitor


Apart from files normally associated with running a background process under
z/OS, the Usage Monitor has three product specific files which must be allocated
in the task JCL. They are:
HSIZIN
a sequential file consisting of fixed-length 80 byte records. It contains initial
commands which are run before data collection becomes active. This file
must contain the data set prefix to be used for dynamically created output
files. This prefix can be changed subsequently by an operator MODIFY
command.
HSIZIN is opened, read, and closed during initialization processing. Do
not specify FREE=CLOSE in the JCL for HSIZIN, or refresh processing is
not possible.
HSIZMSG
an initial status report file. The report contains the initial commands issued
and indicates their degree of success, as well as regular status reports,
refresh reports when appropriate, and a termination report. It consists of
fixed-length 121 byte records. The ANSI carriage control is used. You
should consider keeping the report file with the Usage Monitor
MSGCLASS output in order to simplify diagnostic procedures.
SYSOUT
is a report file used by the SORT program. Its attributes are determined by
the SORT program. It is not used unless sorted output data is requested.

Copyright IBM Corp. 2009 61


IBM Confidential

The SRT command controls whether or not output is sorted. Sorted data is
imported into the appropriate databases more quickly than unsorted data.

Output files containing program usage data are dynamically allocated by the
Usage Monitor. The data set name prefix, the allocation unit, and the primary and
secondary space allocation quantities (in tracks) need to be customized for the
target system.

Output data sets have names with Dyyyyddd.Thhmmsst appended to the specified
prefix. The yyyyddd is the Julian calendar date, and hhmmsst is the time to tenths
of a second that the writer task is initiated.

The use of exclusion masks to reduce data


The data from a significant number of program usage events does not contribute
meaningfully to the task of managing the software inventory. To reduce the
processing of this unnecessary data, two mechanisms which allow some data to be
excluded from collection have been provided. They are exclusion masking based
on program name, and exclusion masking based on data set name.

Program name exclusion masking


A program name exclusion table exists which contains program name masks.
When a program usage event is detected by the Usage Monitor, the program name
is checked against entries in the program name exclusion table. When a match is
found, the usage event data is discarded. No further processing for that event is
performed by Tivoli Asset Discovery for z/OS.

Each table entry contains a program name compare string up to eight bytes long.
The string is either an eight-byte program name, or a shorter program name prefix.
When entering these strings with the EXC command, a prefix is denoted by using
an asterisk as the last character.

The program name exclusion table resides in key zero common storage, and its
size is always a multiple of 4,096 bytes. The minimum table size can house up to
339 entries, and the table size increases dynamically as required. The default
program name exclusion table contains entries to exclude data pertaining to usage
of many programs which are part of the operating system.

Use the EXC command to add entries to the program name exclusion table, or to
reset the table to its default contents.

Use the DEL command to remove some, or all, entries from the table.

Use the D-X command to display the current contents of the table.

Data set name exclusion masking


Once the Usage Monitor has ascertained the name of the data set from which a
used program was fetched, the data set name is used to decide if the usage data
for the event is retained for collection or discarded. To perform this process, two
lists of data set name masks are scanned. The first is the data set name inclusion
mask list, and the second is the data set name exclusion mask list.

To avoid excessive storage and processor resource consumption, it is preferable to


keep the number of elements in each list to a minimum. This is achieved by using
generic masks to cover many data set names. The inclusion mask list is provided

62 Administration Guide and Reference


IBM Confidential

so that specific exceptions to broad exclusion rules may be specified. Unless data
set name exclusion is to be used, the inclusion list cannot provide any useful
function.

Elements of both lists reside in key zero common storage. Each element occupies
48 bytes, and contains a data set name mask up to 44 bytes in length. The mask
can contain a percent sign in any location, which signifies that any character in
that position is considered a match. The mask can end with an asterisk, which
signifies that no more characters need be tested in the left-to-right comparison scan
of the captured data set name and the data set name mask.
v Use the XDS command to add a data set name mask to the exclusion list.
v Use the IDS command to add a data set name mask to the inclusion list.
v Use the XDD command to deactivate a data set name exclusion mask.
v Use the IDD command to deactivate a data set name inclusion mask.
v Use the D-D command to display the currently active masks in both lists.

Both lists have no elements until an XDS or IDS command is processed. Storage is
dynamically acquired for each element as required. To ensure system integrity,
XDD and IDD commands do not cause the storage of a deactivated element to be
freed, but simply mark the element as inactive. When a deactivated mask is
reactivated, the existing entry is marked as active without the further acquisition of
storage.

When the Usage Monitor address space first initializes, all elements of both lists
left in storage from a previous run of the Usage Monitor are freed before the
processing of initial commands and the commencement of data collection. There is
no requirement to use either data set name mask list at any stage.

Starting the Usage Monitor


A Usage Monitor member named HSIJMON is provided in proclib SHSIPROC. You
need to customize this member according to your sites requirements, and may
need to copy it to an authorized PROCLIB.

To start the Usage Monitor in normal mode issue:


S HSIJMON

To start it in passive mode issue:


S HSIJMON,PARM=PASSIVE

Note: PASSIVE is the only valid value of the optional program parameter.
PASSIVE mode means that the Usage Monitor is running, but not collecting any
usage data.

Stopping the Usage Monitor


To stop the Usage Monitor, issue any of these commands:
P HSIJMON
F HSIJMON,STOP
F HSIJMON,END

Chapter 9. Usage Monitor 63


IBM Confidential

These commands cause the address space to stop data collection, attach a writer
task to process the existing data in the repository, wait for the writer task to
complete, sort the data, and then terminate.
F HSIJMON,QUICK

This command causes the server address space to stop collecting data, attach a
writer task to process the existing data in the data space, wait for the writer task to
complete, and then terminate without sorting the data. For immediate termination,
issue:
F HSIJMON,CAN

This command causes the server address space to stop data collection, detaches
any running writer task which renders the output data set unusable, deletes the
current data space without writing out its contents, and terminates.

Refreshing Usage Monitor settings


The Usage Monitor has a range of commands to alter processing, any of which
may be issued dynamically. However, these commands only have an effect for the
duration of the current Usage Monitor session.

It is often desirable to implement a change, both to the running Usage Monitor


and to the initialization commands to be used by subsequent Usage Monitor
sessions on startup. The refresh facility is available to assist with the
implementation of these permanent changes.

Refresh processing involves the execution of the command stream placed in the
HSIZIN file without the requirement of stopping and restarting the Usage Monitor.
As a result, refresh processing can verify the validity of the initialization command
stream so that changes are made and tested dynamically, ensuring that future
Usage Monitor sessions do not encounter initialization command stream errors.

The response to each command in the HSIZIN file is written to the HSIZMSG file.
A summary WTO message, indicating whether any errors are found or not, is
issued after refresh processing has finished.

Some commands set a switch for logic control, or set a numerical value to be used
during some processing. These commands specify the values to be used in the
future. Other commands pertaining to inclusion and exclusion masking add a
mask to, or remove a mask from, the active mask list, and so are part of an
accumulation of commands which specify future processing.

Consider the case where several exclusion masks are active, and a change to
deactivate one of the masks is required. A command to deactivate the mask is
issued dynamically, but if this change is to be made permanent, then the HSIZIN
file needs to be updated. This update would usually consist of deleting the
command which specifies the exclusion mask in question.

In this scenario, simply issuing the commands remaining in HSIZIN would not
deactivate the mask now omitted from the command stream in the general case.
So, to allow such a change to be implemented by deleting a masking command
from HSIZIN and performing a refresh, the Usage Monitor performs extra actions
before executing the commands in HSIZIN.

64 Administration Guide and Reference


IBM Confidential

Before the first HSIZIN command is run during refresh processing, the program
mask exclusion list is set to the default list. Further, all data set name exclusion
masks are deactivated, and all data set name inclusion masks are deactivated. This
order of deactivation ensures that there is no loss of data that would otherwise be
collected. However, there is the possibility that data which would have been
excluded is collected during the short window between the reset of the mask lists
and the processing of the HSIZIN commands.

Stopping the Usage Monitor and restarting it, produces the same active exclusion
masks as a refresh. It also produces a data collection outage. See the section
detailing the REF command for a list of the processes performed during a refresh
operation.

Usage Monitor commands


The Usage Monitor commands are passed to the Usage Monitor from the HSIZIN
input file, or by an operator MODIFY command.

Syntax rules are as follows:


v All commands are three characters long.
v Operands or sub parameters are specified in parentheses.
v Multiple sub parameters are separated by commas.
v The command must not contain any embedded blanks.
v Commands must start in column one.

Details of each command are:


CAP - Set hardware capacity collection status
CAP is used to specify if the Usage Monitor is to output records containing
information about the hardware capacity of the system. Collecting this
information is important when hardware capacity changes dynamically.
A change to this setting will not take effect until the next data space
repository switch.

Syntax

 CAP(Y) CAP(N) 

Y specifies that hardware capacity data is collected and output.


N specifies that hardware capacity is not collected or output.
If no CAP command is issued, then hardware capacity data will be
collected. CAP(Y) is the default.
Example 1
Collect hardware capacity data.
F HSIJMON,CAP(Y)
Example 2
Do not collect hardware capacity data.
F HSIJMON,CAP(N)

Chapter 9. Usage Monitor 65


IBM Confidential

CSA - Set the (E)CSA queuing storage limit


CSA is used to specify a limit to the quantity of (E)CSA storage used to
queue work. If the Usage Monitor address space is not dispatched in a
timely fashion, then a large number of work elements can exist
concurrently before being processed. Such work is queued in ECSA until it
is transferred to the Usage Monitor repository.
If ECSA is exhausted, then CSA is used.
Data from program usage events occurring while this limit has been
reached might not be collected.
An active CSA limit setting stays in force unless overridden, even if the
Usage Monitor is stopped and restarted.

Syntax

 CSA(limit) 

limit specifies a number of kilobytes from 0 to 200,000.


If no CSA command is issued then CSA(0) is in force. CSA(0) specifies that
the Usage Monitor does not attempt to limit the (E)CSA storage used by
work elements awaiting processing.
Example 1
Limit queuing in (E)CSA to 50,000KB (almost 50MB).
F HSIJMON,CSA(50000)
Example 2
Allow no explicit (E)CSA limit for storing queued data.
F HSIJMON,CSA(0)
D-A - Display output allocation parameters
D-A is used to verify dynamic allocation details to be used in the creation
of output data files. The data set name, primary and secondary space
quantities, and unit and optional volume serial number are shown.

Syntax

 F HSIJMON,D-A 

It is advantageous to have this command in the HSIZIN file, after the DSN
command, to confirm initial allocation values.
Example 1
Display the current dynamic allocation values.
F HSIJMON,D-A
D-C - Display the counters and statistics
D-C is used to show the Usage Monitor activity and status indicators. The
purpose of this command is to assist IBM technical support in problem

66 Administration Guide and Reference


IBM Confidential

diagnosis. The meaning of the output generated by this command is not


published.

Syntax

 F HSIJMON,D-C 

Example 1
Display the current value of internal Usage Monitor counters.
F HSIJMON,D-C
D-D - Display the data set name inclusion/exclusion lists
D-D is used to show the data set name masks in the inclusion list,
followed by the data set name masks in the exclusion list.
If the program library of a program is ascertained when the program usage
is detected, the inclusion list is scanned for a match. If no match is found,
then the exclusion list is scanned for a match. If a match is found then the
program usage data is discarded, otherwise it is collected.
Neither list need be populated in order to collect data. The absence of any
entries in the exclusion list means that data collection is not affected by
program library data set names.

Syntax

 F HSIJMON,D-D 

It is advantageous to have this command in the HSIZIN file to confirm


system settings.
Example 1
Display the current data set name inclusion and exclusion lists.
F HSIJMON,D-D
D-I - Display the system Identifier
D-I is used to verify the system identifier, which is written in the output
header record. This can be altered by the SID command.

Syntax

 F HSIJMON,D-I 

It is advantageous to have this command in the HSIZIN file to confirm


system settings.
Example 1

Chapter 9. Usage Monitor 67


IBM Confidential

Display the current the current system identifier used by the Usage
Monitor.
F HSIJMON,D-I
D-S - Display the Status settings
D-S is used to verify several miscellaneous settings. Other commands are
used to alter the individual settings, but this command provides a
convenient way to list the current values.

Syntax

 F HSIJMON,D-S 

It is advantageous to have this command in the HSIZIN file to confirm


system settings.
Example 1
Display the current values of settings which are altered by the CSA, TRG,
z/OS UNIX, LPA, PLX, SYM, SRT, UNK, and ZIP commands.
F HSIJMON,D-S
D-T - Display the automatic switch-and-write Time setting
D-T is used to verify the time-of-day specified for automatic data space
switching and consequent writer task creation. When data from after this
time-of-day is detected, data collection is automatically switched to a new
data space, and write-out of data in the old data space is initiated.
The UTC or GMT switch time is calculated using local time current at data
space creation time. That is, the time when a data space will be terminated
us set when it is created. Changes to the system local time offset, such as
those caused by a change to Daylight Saving Time, do not alter the UTC or
GMT time that the current data space will be closed. The time of the
switch after the next switch is calculated using the new local time.

Syntax

 F HSIJMON,D-T 

It is advantageous to have this command in the HSIZIN file to confirm


system settings.
Example 1
Display the current automatic switch-and-write time setting.
F HSIJMON,D-T
D-X - Display the active exclude list
D-X is used to display the active program name mask exclude list. Data is
not collected for programs with names that match the mask in any active
entry in the exclude list.

68 Administration Guide and Reference


IBM Confidential

Syntax

 F HSIJMON,D-X 

It is advantageous to have this command as the last command in the


HSIZIN file, so that the initial exclude list is verified.
Example 1
Display the current exclude list entries.
F HSIJMON,D-X
DCB - Set output DCB attributes
DCB is used to set DCB attributes, which are optimal for a specific device
type.

Syntax

 DCB(3390) DCB ( 3380 ) DCB(UNKN) 

Note: If no DCB command is issued, DCB(3390)is used.


DCB(3390) sets the output DCB to
RECFM=VB,LRECL=27994,BLKSIZE=27998

Use this when the output device has 3390 compatible geometry.
DCB(3380) sets the output DCB to
RECFM=VB,LRECL=23472,BLKSIZE=23476

Use this when the output device has 3380 compatible geometry.
DCB(UNKN) sets the output DCB to
RECFM=VBS,LRECL=32756,BLKSIZE=0

so that the system determines the optimal block size for the device chosen
by dynamic allocation. Use this when the output device type is not known
until allocation time.
Some third party FTP products do not process a file with RECFM=VBS
correctly, even when no records are actually spanned.
DEL - Deleting Program Mask Entries
DEL can be used to remove program name masks from filter tables. Both
default and user-added entries can be removed. The required operand
specifies one or more program name masks.

Chapter 9. Usage Monitor 69


IBM Confidential

Syntax

 DEL(mask ) DEL(*ALL*) 
,mask
,mask...

mask specifies a one to eight character program name mask. If the mask
ends in an asterisk, only characters before the asterisk are
compared, otherwise an exact program name is deemed to have
been specified.
*ALL* specifies every currently active mask. This mask cannot be
specified with any other mask.
Except for short test periods, it is expected that default exclusion masks
such as IGG* remain active.
Example 1
Remove all entries, so that all possible programs are monitored.
F HSIJMON,DEL(*ALL*)

Example 2
Remove an exclusion mask to allow the monitoring of LE and REXX
modules.
F HSIJMON,DEL(CEE*,IRX*)

Example 3
Remove an exclusion mask to allow the monitoring of the program called
CEE.
F HSIJMON,DEL(CEE)
DSN - Setting the Data Set Name prefix
DSN is used to specify the first part of the data set names used for the
output files. The prefix is specified in the required operand.
Symbols are employed in the construction of the data set name prefix.
Available symbols include all z/OS static symbols, as well as &SMF, the
systems SMF identifier, and &SYSLPAR, the systems logical partition
name.

Syntax

 F HSIJMON,DSN(dsnpref) 

Dsnpref
specifies a 1 to 26 character data set name prefix. It can contain one
or more data set qualifiers, and must not end in a period after any
symbol substitution.
Example 1
To get output files with names of the form

70 Administration Guide and Reference


IBM Confidential

SYS3.HSIz.HSIJMON.Dyyyyddd.Thhmmsst

use
F HSIJMON,DSN(SYS3.HSIz.HSIJMON)
EXC - Adding program mask exclusion entries
EXC is used to add program name masks to the exclusion table. The
required operand specifies one or more program name masks.

Syntax

 F HSIJMON,EXC(mask ) EXC(*DFLT*) 
,mask
,mask...

mask specifies a one to eight character program name mask. If the mask
ends in an asterisk only, characters before the asterisk are
compared. Otherwise, an exact program name is deemed to have
been specified.
*DFLT*
specifies every supplied default entry in the exclusion table is to be
made active, and that all user-added entries are to be removed
from the exclusion table. This mask cannot be specified with any
other mask.
Except for short test periods, it is expected that default exclusion masks
such as IGG* would remain active
Example 1
Reset the exclusion table to its default status.
F HSIJMON,EXC(*DFLT*)

Example 2
Exclude the collection of data for Language Environment modules and
REXX modules.
F HSIJMON,EXC(CEE*,IRX*)

Example 3
Exclude the collection of data for the program CEE.
F HSIJMON,EXC(CEE)
IDD - Deleting data set name inclusion entries
IDD is used to remove data set name masks previously added by the IDS
command.

Syntax

 F HSIJMON,IDD(mask) 

Chapter 9. Usage Monitor 71


IBM Confidential

mask specifies a 1 to 44 character data set name mask. If the mask ends
in an asterisk only, characters before the asterisk are compared.
Percent signs in the mask indicate that any character in that
location is considered a match.
Example 1
Deactivate the SYS3.LINKLIB inclusion mask.
F HSIJMON,IDD(SYS3.LINKLIB)
IDL - Control Idle Work Element usage
IDL is used to control whether the Usage Monitor allows idle work
elements. When the data in a work element has been processed, the
element is normally freed in order to return the storage to the system.
Allowing idle elements means that processed elements are retained on the
idle chain, which is used before acquiring more storage when a new work
element is needed.
Allowing idle elements is beneficial as it reduces system storage
management overhead. The storage used by idle elements is included in
the storage limit set by the CSA command.

Syntax

 IDL(Y) IDL(N) 

Y specifies the Usage Monitor will retain processed elements for


reuse subject to the CSA limit setting.
N specifies that all processed work elements are to be freed.
If no IDL command is issued, then the idle chain will be used. That is,
IDL(Y) is the default setting.
Example 1
Enable use of the idle element chain.
F HSIJMON,IDL(Y)

Example 2
Prevent further additions to the idle element chain.
F HSIJMON,IDL(N)
IDS - Adding Data Set Name inclusion entries
IDS is used to supply data set name masks, which specify data set names
to be excluded from exclusion processing. Program usage data fetched
from data sets with names matching inclusion masks, is collected without
reference to the data set name mask exclusion list.
Inclusion masks are only useful if there are active exclusion masks. An
inclusion mask is normally expected to match a subset of data set names,
w hich would match an exclusion mask.

72 Administration Guide and Reference


IBM Confidential

Syntax

 F HSIJMON,IDS(mask) 

mask specifies a 1 to 44 character data set name mask. If the mask ends
in an asterisk only characters before the asterisk are compared.
Percent signs in the mask indicate that any character in that
location is considered a match.
Example 1
Consider the case where the intention is to not collect program usage data
for data sets with a high level qualifier of SYS3, except for SYS3.LINKLIB.
SYS3.LINKLIB is the only data set with a high level qualifier of SYS3 for
which program usage data is to be collected. Given an active exclusion
mask of SYS3.*, this command would satisfy the requirement.
F HSIJMON,IDS(SYS3.LINKLIB)
JAC - Set job account collection status
JAC can be used to specify if the Usage Monitor is to consider the account
code of jobs significant when aggregating data. The Usage Monitor
normally aggregates data based on the program name, the job name, and
the user ID. The JAC setting is used to add the job account, truncated after
20 characters, to the aggregation key.
Do not instruct the Usage Monitor to collect and preserve all job account
codes if they are not important to the administration of your system.
Collecting and preserving job accounts increases data volumes.
A change to this setting will not take effect until the next data space
repository switch.

Syntax

 JAC(N) JAC(Y) 

N specifies that job account codes will be ignored.


Y specifies that job account codes will be collected and output.
If no JAC command is issued then job accounts will not be collected.
JAC(N) is the default.
Example 1
Collect and preserve job account codes.
F HSIJMON,JAC(Y)

Example 2
Ignore job account codes.
F HSIJMON,JAC(N)
LLC - Link List Correction
LLC can be used where sites make a number of dynamic link list changes.

Chapter 9. Usage Monitor 73


IBM Confidential

This command updates the HSIJMON data to point to the correct load
library. Only use this command if you allow dynamic link list updates,
which alter the relative concatenation numbers of persisting libraries.

Syntax

 F HSIJMON,LLC(Y) LLC(N) 

Y a BLDL is performed at write time by the writer task and, if found,


the data set name is overlaid.
N do not check for dynamic list updates.
LPA - Set Link Pack Area program monitoring status
LPA is used to specify whether the monitoring of programs residing in the
Link Pack Area (LPA) is to occur or not. All types of LPA are included in
this category.

Syntax

 F HSIJMON,LPA(Y) LPA(N) 

Y specifies that LPA program usage is to be monitored.


N specifies that LPA program usage is not to be monitored.
If no LPA command is issued then LPA program usage data is collected.
That is, LPA(Y) is the default setting.
Example 1
Collect usage data about LPA programs.
F HSIJMON,LPA(Y)

Example 2
Stop the collecting LPA program usage information.
F HSIJMON,LPA(N)
MOD - Alter the operational Mode
MOD is used to set the Usage Monitor into passive mode where no data is
collected, or collect mode where data collection is active.

Syntax

 F HSIJMON,MOD(mode) 

Mode specifies PAS for passive mode, or COL for collect mode.
If no MOD command is issued the Usage Monitor operates in collect
mode.

74 Administration Guide and Reference


IBM Confidential

Example 1
Stop the collection of program usage data.
F HSIJMON,MOD(PAS)

Example 2
Allow the collection of program usage data.
F HSIJMON,MOD(COL)
PLX - Alter the Sysplex-Wide software flag
PLX is used to set the sysplex-wide software flag. This flag is copied to the
header record of each program usage data output data set. It is used by
later database processing to indicate that usage data is matched against a
single software inventory, as all sysplex members share DASD volumes.

Syntax

 F HSIJMON, PLX(Y) PLX(N) 

Y specifies that all software is accessible sysplex-wide.


N specifies that each OS image has its own software inventory.
If no PLX command is issued, then a blank is contained in the header
record, which means that the sysplex-wide flag has to be set at data import
time.
Example 1
Set the sysplex-wide common software inventory flag.
F HSIJMON,PLX(Y)

Example 2
Reset the sysplex-wide common software inventory flag.
F HSIJMON,PLX(N)
PRI - Set the data set space Primary Allocation
PRI is used to specify the primary space allocation quantity in tracks. This
is used for output data set allocations.

Syntax

 F HSIJMON,PRI(trks) 

trks specifies a number of tracks from 0 to 150,000.


If no PRI command is issued, the primary space allocation is 750 tracks.
Tivoli Asset Discovery for z/OS uses the RLSE space allocation attribute.
Example 1
Set the primary space allocation to 900 tracks.
F HSIJMON,PRI(900)

Chapter 9. Usage Monitor 75


IBM Confidential

PRS - Set registered software activity data collection status


PRS is used to specify if the Usage Monitor is to output records containing
information about registered software activity. This data contains
information about the usage of software which uses the systems Register
service, and information about registered product PARMLIB settings.
A change to this setting will not take effect until the next data space
repository switch.

Syntax

 PRS(Y) PRS(N) 

Y specifies that registered software information will be collected and


output.
N specifies that registered software information will not be collected
or output.
If no PRS command is issued, then registered software data will be
collected. PRS(Y) is the default.
Example 1
Collect registered software data.
F HSIJMON,PRS(Y)

Example 2
Do not collect registered software data.
F HSIJMON,PRS(N)
REF - Refresh Usage Monitor settings
REF is used at any time to reset Usage Monitor settings according to
commands in the HSIZIN file, without having to stop and start the Usage
Monitor. The detailed results of the refresh operation are written to the
HSIZMSG file.
The processes of a refresh operation include:
v Verify that HSIZIN is still allocated.
v Open HSIZIN.
v Set the program exclusion list to the default list.
v Deactivate all data set exclusion list elements.
v Deactivate all data set inclusion list elements.
v Process the commands in HSIZIN.
v Close HSIZIN.
v Issue either HSIZ059I or HSIZ060I, as appropriate.

76 Administration Guide and Reference


IBM Confidential

Syntax

 F HSIJMON,REF 

Example 1
Change Usage Monitor settings to updated values from HSIZIN.
F HSIJMON,REF
SEC - Set the data set space secondary allocation
SEC is used to specify the secondary space allocation quantity in tracks.
This is used for output data set allocations.

Syntax

 F HSIJMON,SEC(trks) 

trks specifies a number of tracks from 0 to 150,000.


If no SEC command is issued, the secondary space allocation is 300 tracks.
Tivoli Asset Discovery for z/OS uses the RLSE space allocation attribute.
Example 1
Set the secondary space allocation to 600 tracks.
F HSIJMON,SEC(600)
SID - Set the Usage Monitor System Identifier
SID is used to override the system identifier contained in the output
header record. The SMF system identifier is used as a norm, but an
override allows the data from separate systems to be differentiated in all
instances where duplicate SMF identifiers are in use. Symbols can be
employed in the construction of the system identifier. Available symbols
include all z/OS static symbols, as well as &SMF, the systems SMF
identifier, and &SYSLPAR, the systems logical partition name.

Syntax

 F HSIJMON,SID(sid) 

sid specifies an identifier from 1 to 4 bytes in length.


Example 1
Set the output system identifier to PROD.
F HSIJMON,SID(PROD).
SIZ - Set the data space repository size
SIZ is used to specify the maximum number of entries that the data space
repository can hold.

Chapter 9. Usage Monitor 77


IBM Confidential

Syntax

 F HSIJMON,SIZ(entries) 

entries specifies a number of entries from 100 to 6,000,000.


If no SIZ command is issued, a data space capacity of 200,000 entries is
used. Each entry occupies 272 bytes. As each data space page has data
placed in it for the first time, that page has to be backed physically by the
system. When a data space is full, a repository switch is triggered
automatically. A repository switch also occurs when data stamped after the
switch time is detected. Keep these points in mind when customizing the
data space capacity..
Example 1
Set the size of future data spaces to one million entries.
F HSIJMON,SIZ(1000000)
SRT - Set output data Sort status
SRT is used to specify whether or not the output data is to be sorted to
optimize database import . While sorted data can be processed more
quickly, the Usage Monitor address space uses more resources if sorting is
requested. You need to check the customization of the SORT product for
suitability, especially in relation to the dynamic allocation of SORTWORK
disk space. If sorting is to be performed, ensure that the SYSOUT DD
statement is in the Usage Monitor JCL.

Syntax

 F HSIJMON, SRT(Y) SRT(N) 

Y specifies that the output data is to be sorted.


N specifies that the SORT program is not to be invoked.
If no SRT command is issued, then sorted data is written. That is, SRT(Y) is
the default setting.
Example 1
Enable the sorting of the output data.
F HSIJMON,SRT(Y)
Example 2
Disable the sorting of the output data.
F HSIJMON,SRT(N)
SWI - Switch to a new data space repository
SWI causes a new data space repository to be created and used for
subsequent data collection. The data space current at the time of SWI
command has its data contents processed by a writer task.
The SWI command has no operands. The SWI command is invalid in the
HSIZIN initial command file. As well as the switch caused by an explicit

78 Administration Guide and Reference


IBM Confidential

SWI command, automatic switches occur when a repository becomes full,


and when data stamped after the switch time is detected. A SWI command
might be rejected if the writer task is busy.

Syntax

 F HSIJMON,SWI 

Example 1
Manually switch to a new repository.
F HSIJMON,SWI
SYM - Set the Symbolic volume serial on output switch
SYM allows the logged volume serial number of a load library to be either
the actual volume serial number or a symbolic value. When symbolic
volume serial numbers are allowed, the IPL volume is always reported as
six asterisks. For other volumes, if the serial number is found to match the
value of a static system symbol, then the name of the symbol is reported
instead of the actual volume serial number. Only symbols with names
exactly six characters long are considered for this processing. For the
purposes of this discussion, the symbol name includes the leading
ampersand (&), but excludes the trailing period (.).

Syntax

 F HSIJMON,SYM(Y) SYM(N) 

Y the actual volume serial number is replaced by a symbolic value.


N the actual volume serial number is always output.
If no SYM command is issued, then the actual volume serial number
collected is always output; SYM(N) is the default setting.
SYM(Y) is usually used in conjunction with the SYMVOL operand of the
Inquisitor.
Example 1
Allow the output of symbolic volume serial numbers.
F HSIJMON,SYM(Y)

Example 2
Disallow the output of symbolic volume serial numbers.
F HSIJMON,SYM(N)
TRG - Set the cache trigger event count
TRG allows the setting of the program usage event cache trigger.
Repository entries with usage counts less than the trigger value are not
cached. When usage events are captured for cached entries, usage of
common storage and cross-memory POST processing is avoided.

Chapter 9. Usage Monitor 79


IBM Confidential

When the cache is full, no additional entries can be cached. About every
two hours, a status report, indicating cache usage, is written to the
HSIZMSG file. After this the cache is emptied, if at least half full. The
cache is also emptied when the collection for a repository is terminated.
That is, when the repository is switched or when the Usage Monitor is
shutdown.
The cache trigger value is not to be set too low, or little benefit results. The
maximum benefit of the cache occurs when the cache contains the entries
which are collecting the most frequent program usage events.
The regular status reports in the HSIZMSG file should be examined to help
determine the optimal cache trigger count which is often orders of
magnitude larger than the default value.

Syntax

 F HSIJMON,TRG(count) 

count a number in the range from 0 to 999,999,999.


If no TRG command is issued, then the trigger count is set at 1000. TRG(0)
specifies that the cache is to be filled as quickly as possible from the next
captured program usage event data.
Example 1
Set the cache trigger event count to twelve hundred.
F HSIJMON,TRG(1200)
UNK - Set the Unknown event collection switch
UNK is used to specify whether events with incomplete data are to be
collected or not. Database content is not effected. Collecting extra data is
useful in determining why some usage events are not captured. This needs
to be set only when requested by Tivoli Asset Discovery for z/OS technical
support.

Syntax

 F HSIJMON,UNK(Y) UNK(N) 

Y specifies that the unknown events are to be collected.


N specifies that the unknown events are not to be collected.
UNK(N) is the default setting.
Example 1
Start the collection of unknown events.
F HSIJMON,UNK(Y)
UNM - Set user name collection status
Software security packages, such as RACF, have a name field for each user
ID defined to the system. The Usage Monitor collects the user ID (up to 8

80 Administration Guide and Reference


IBM Confidential

characters long), and the contents of the name field (up to 20 characters
long),as part of the data collection performed when programs are used.
UNM is used to specify whether the names of users collected from the
security package will be output. The user ID is always output. This setting
is checked by the writer task when the data in a data space repository is
being processed for output.

Syntax

 UNM(Y) UNM(N) 

Y specifies that collected user names will be written to the output


file.
N specifies that collected user names will be discarded.
If no UNM command is issued, then user names will be collected. That is,
UNM(Y) is the default.
Example 1
Transmit user names to Usage Import.
F HSIJMON,UNM(Y)

Example 2
Prevent user names from appearing in any program usage reports.
F HSIJMON,UNM(N)
UNT - Set the data set allocation Unit
UNT is used to specify the allocation unit to be used for output data set
allocations.

Syntax

 F HSIJMON,UNT(unitname) 

Unitname
specifies a 1 to 8 character long unit name.
If no UNT command is issued, SYSALLDA is used.
Example 1
Set the allocation unit to WORKDA.
F HSIJMON,UNT(WORKDA)
USS - Set UNIX Program monitoring status
USS is used to determine whether or not the monitoring of programs
retrieved from Hierarchical File System (HFS) files is to occur.

Chapter 9. Usage Monitor 81


IBM Confidential

Syntax

 USS(Y) USS(N) 

Y programs fetched from HFS files are to be monitored.


N programs fetched from HFS files are not to be monitored.

Note: If no USS command is issued, then programs retrieved from HFS


files are not monitored. USS(N) is the default setting.
Example 1
Collect maximal information about z/OS UNIX programs.
F HSIJMON,USS(Y)

Example 2
Stop collecting HFS program usage information.
F HSIJMON,USS(N)
VOL - Set the data set allocation Volume
VOL is used to specify the allocation volume to be used for output data set
allocations. The explicit nomination of a specific volume is necessary when
there are no PUBLIC or STORAGE volumes in the allocation unit pool.

Syntax

 F HSIJMON,VOL(volume) 

volume specifies a 1 to 6 character long volume serial number.


If no VOL command is issued, a specific volume is not explicitly requested.
Example 1
Set the allocation volume to SCR001.
F HSIJMON,VOL(SCR001)
WRT- Set the automatic switch-and-Write time of day
WRT is used to specify a time-of-day to end data collection for the current
data space, and automatically switch to a new data space. The data
write-out for the closed data space is also initiated. These events are
triggered when data from after the specified time is detected.
The UTC or GMT switch time is calculated using local time current at data
space creation time. That is,the time that a data space will be terminated is
set when it is created. Changes to the system local time offset, such as
those caused by a change to Daylight Saving Time status, do not alter the
UTC or GMT time that the current data space will be closed. The time of
the switch after the next switch will be calculated using the new local time.

82 Administration Guide and Reference


IBM Confidential

Syntax

 F HSIJMON,WRT(hhmm) 

hhmm specifies a 24-hour time-of-day in hour and minute notation. The


value must be four (4) decimal digits. The first two digits (hh)
must be in the 00 to 23 range. The last two digits (mm) must be in
the 00 to 59 range.
If no WRT command is issued, the automatic switch time of midnight is
used. That is, WRT(0000) is the default.
Example 1
Set the automatic switch-and-write time to noon.
F HSIJMON,WRT(1200)

Example 2
Set the automatic switch-and-write time to ten minutes before midnight.
F HSIJMON,WRT(2350)
XDD - Deleting data set name Exclusion entries
XDD is used to remove data set name masks which were added by the
XDS command.

Syntax

 F HSIJMON,XDD(mask) 

mask specifies a 1 to 44 character data set name mask. If the mask ends
in an asterisk, then only characters before the asterisk are
compared. Percent signs in the mask indicate that any character in
that location is considered a match.
Example 1
Deactivate the SYS3.* exclusion mask.
F HSIJMON,IDD(SYS3.*)
XDS - Adding data set name Exclusion entries
XDS is used to supply data set name masks which specify data set names
to be excluded from data collection. Program usage data for programs
fetched from data sets with names matching exclusion masks is discarded.
When the captured data set name has been matched to an inclusion mask,
set by the IDS command, the data is collected without reference to the
exclusion mask list.

Chapter 9. Usage Monitor 83


IBM Confidential

Syntax

 F HSIJMON,XDS(mask) 

mask specifies a 1 to 44 character data set name mask. If the mask ends
in an asterisk, only characters before the asterisk are compared.
Percent signs in the mask indicate that any character in that
location is considered a match.
Example 1
Exclude program usage data from collection for programs fetched from
data sets with a high level qualifier.
F HSIJMON,XDS(SYS3.*)
ZIP - Set the compressed output data switch
ZIP is used to control whether the writer task is to compress output data
or not. Compressing the output data reduces data volumes which
subsequently reduces data transfer time and storage space requirements.

Syntax

 F HSIJMON,ZIP(Y) ZIP(N) 

Y specifies that output data is to be compressed.


N specifies that output data is not to be compressed.
If no ZIP command is issued, then compressed data is output. That is,
ZIP(Y) is the default setting.
Example 1
Ensure that compressed data is being output.
F HSIJMON,ZIP(Y)

84 Administration Guide and Reference


IBM Confidential

Chapter 10. Inquisitor Import


Inquisitor Import is the process where the Inquisitor data collected previously in
jobs beginning with ZIQ (UIQ for z/OS UNIX), and suffixed with the schema
name, is imported into DB2 Inquisitor tables.

The three tables TSYSTEM, TLIBRARY, and TMODULE, are the core Inquisitor
tables created by DIiqschemas
IQschema.TSYSTEM
A one-row table with system details.
IQschema.TLIBRARY
A small to medium-sized table with one row for each load library, and a
row length of 185 bytes.
IQschema.TMODULE
A larger table with one row for each load module, and a row length of
between 398 and 652 bytes.

Choosing a good naming convention for IQSCHEMAS is very important. As the


IQSCHEMAS values are used in creating schema names and table spaces in DB2,
there are certain restrictions. The value must have no special characters, and be
less than, or equal to, five alphanumeric characters. The first character must be an
alphabetic character.

For example, IQSCHEMAS=FF888 would result in creating these DB2 objects:


tablespace WSFF888
tablespace WSUF888 for z/OS UNIX
table FF888.TSYSTEM
table UFF888.TSYSTEM for z/OS UNIX

Running Inquisitor Import


The HSISCUST post-installation customization job creates JCL jobs in the JCLLIB to
import the Inquisitor data into DB2. Members beginning with ZIM (UIM for z/OS
UNIX), and suffixed with the schema name contain JCL to run the Inquisitor
Import function for a given schema.

Note: Data created from the previous Inquisitor import has to be deleted. For
performance reasons, Inquisitor tables are dropped and then recreated when this
job is run.

TPARAM parameters
SSID= DB2 subsystem name. Value assigned, as defined in job HSISCUST.
DSN= DB2 location. Value assigned, as defined in job HSISCUST.
DATABASE=
Name of database. Value assigned, as defined in job HSISCUST.
IQSCHEMA=
Inquisitor schemas. Value assigned, as defined in job HSISCUST.

Copyright IBM Corp. 2009 85


IBM Confidential

GKBSCHEMA=
Default is GKB7. Global Knowledge Base schema. No value specified for
Inquisitor Import for z/OS UNIX.
LKBSCHEMA=
Default is LKB7. Local Knowledge Base schema. No value specified for
Inquisitor Import for z/OS UNIX.
FILTERSCHEMA=
Default is IQF7. Inquisitor Filter schema.
COMMIT=
Default is 1000. Number of records stored before issuing a COMMIT.

86 Administration Guide and Reference


IBM Confidential

Chapter 11. The Match Engine


The Match Engine uses the Global Knowledge Base (GKB), and the Local
Knowledge Base (LKB) to match load modules in the Inquisitor tables to products
at the Version Release Modification (VRM) level. The Match process has four
phases:
v Perfect Match - this phase looks for an exact match of a product in one library.
v Volser Match - this phase matches products over multiple libraries but on the
same volume.
v Interlib Match - this phase matches libraries not matched previously an tries to
match over multiple libraries in different volumes.
v Rules Match - this phase identifies a product for a library. It overrides any
previously matched information.
Schemas and scorecards
The Match Engine program uses a scorecard algorithm to recognize groups
of LMODs as program products. It uses temporary scorecard tables as
working space. These scorecard tables must have been allocated by the
user prior to running the Match Engine.
In addition to the predefined Match Engine tables, it also uses DB2s
temporary work files as intermediate work areas. By default, DB2s Global
Temporary Tables are used. This means that temporary tables and indexes
are created and dropped after each Match Engine session.

Note: In DB2 Version 8, Declare Global Temporary Table requires 8K TEMP table
space, which is not automatically defined as part of the work file database.

Running the Match Engine


The HSISCUST post-installation customization job creates JCL jobs in the JCLLIB to
run the Match Engine. Members beginning with ZME (UME for z/OS UNIX), and
suffixed with the schema name, contain JCL to run the Match Engine for a given
schema.

TPARAM parameters
SSID= DB2 subsystem name. Value assigned, as defined in job HSISCUST.
DSN= DB2 location. Value assigned, as defined in job HSISCUST.
DATABASE=
Name of Tivoli Asset Discovery for z/OS database. Value assigned, as
defined in job HSISCUST.
IQSCHEMA=
Inquisitor schemas. Value assigned, as defined in job HSISCUST.
GKBSCHEMA=
Default is GKB7. Global Knowledge Base schema.
LKBSCHEMA=
Default is LKB7. Local Knowledge Base schema.

Copyright IBM Corp. 2009 87


IBM Confidential

MESCHEMA=
Default is ME7. Match Engine schema.
COMMIT=
Default is 1000. Number of records stored before issuing a COMMIT.
LOGPERCENTAGE=
Default is 7. Amount of detail produced in ME report.
MECLEAROPTIONS=
Default is 2. This will clear all matches from the Inquisitor. A value of 0
means you should not clear the Inquisitor. A value of 1 means clear
unknowns only.
UDAMBUFSIZE=
Default is 153600000. This is the amount of REAL memory that will be
allocated to the Match Engine in order to store the scorecard entries. The
size of this parameter determines the performance of the Match Engine.
SPILLPFX=
Default is DB2I81. High level qualifier for temporary flat files. This is used
when the memory defined in UDAMBUFSIZE is exceeded.
IXBUFFERPOOL=
Default is BP1. Bufferpool for Indexes created on declared temporary
tables.

88 Administration Guide and Reference


IBM Confidential

Chapter 12. Load to Repository


Load to Repository is the process of copying your matched Inquisitor data into the
Repository, where all the Inventory data is stored. Once an Inquisitor has been
matched by the Match Engine, it is ready to be loaded to the Repository. Load to
Repository copies the Inventory information from the Inquisitor into the
Repository, making it available for standard queries and for viewing alongside
other systems inventories.

Continuous Inventory
It is possible to replace an already existing Inventory in the Repository, with data
from an updated Inquisitor. You might have added a new version of a product to
production, and because the product resides in the same library as the old one did,
it is much easier to just do an Inquisitor of the updated library and then replace
the old version in the Repository, without losing the usage data from the previous
version.

A check is done by the system to see if a library in the Inquisitor matches one
currently in the Repository. If it is an exact match, a further check is performed to
see if the load module names match. If the two matches agree, then rename the old
modules with an extension of VRM, for example, HSICKBME_4.1.0, and copy in
the new modules from the Inquisitor. This enables you to only update a single
Inventory, rather than create a new one each time you run an Inquisitor. This forms
the basis of having a Continuous Inventory where the INVNAME you specify is
used to check if an Inventory already exists. The Inventory name specified here
must be identical to the Inventory name you want to replace, otherwise a new
Inventory name is created.

If you need to refresh your Repository with a complete Inquisitor data, then use
parameter REPLACEFULL=Y. This parameter marks as deleted any products that
no longer exist in the Inquisitor data, but an entry still exists in the Repository.
This allows you to report on products that have been deleted.

Note: REPLACEFULL is only to be used when a complete Inquisitor and match


has been done. If you are just adding extra Inquisitor data to the Repository, then
make sure REPLACEFULL is equal to N. The default value is N.

Adding Inquisitor data to an existing Inventory


In Tivoli Asset Discovery for z/OS you can add Inquisitor data to an existing
Inventory, as long as the Inquisitor data you want to add has not been loaded
before. To do this you must first determine the name of the Inventory you wish to
add to. Run this SQL statement:
SELECT * FROM REPschema.TINVCTL.

This lists the Inventories currently in the selected repository. Make a note of the
Inventory name.

Edit the ZLRschema (ULRschema for z/OS UNIX) job and add the keyword
INVNAME=, and the name of the Inventory you wish to add to the TPARAM DD
statement. The name has to be exactly the same as an existing Inventory name.

Copyright IBM Corp. 2009 89


IBM Confidential

Modify the other statements as required. Submit the job. This adds new Inquisitor
data to an existing Inventory in the Repository.

Running Load to Repository


The HSISCUST post-installation customization job creates JCL jobs in the JCLLIB to
run the Load to Repository function. Members beginning with ZLR (ULR for z/OS
UNIX), and suffixed with the schema name, contain JCL to run the Load to
Repository for a given schema.

TPARAM parameters
SSID= DB2 subsystem name. Value assigned, as defined in job HSISCUST.
DSN= DB2 location. Value assigned, as defined in job HSISCUST.
DATABASE=
Name of database. Value assigned, as defined in job HSISCUST.
INVNAME=
Default value is the same as the IQ schema name. This is the name of the
Inventory.
IQSCHEMA=
Inquisitor schemas. Value assigned, as defined in job HSISCUST.
GKBSCHEMA=
Default is GKB7. Global Knowledge Base schema.
REPSCHEMA=
Default is SI7. Repository schema.
COMMIT=
Default is 1000. Number of records stored before issuing a COMMIT.
REPLACEFULL
Default is N. Y means that you wish to replace the current Inventory with
a complete Inquisitor.
MIGUNIDENT=
Default is N. Y means that you wish to load all modules, including
unidentified modules.
SKIPAUXREBUILD=
Default is N. Change to Y if you do not wish to rebuild Summary tables.
For performance reasons, set to Y to import a large amount of usage data.
Subsequently, you need to run the HSISMERG job to recreate the Summary
tables.
Summary tables used are TUSEPO, TUSEPOV, and TUSEPOVLIB.

90 Administration Guide and Reference


IBM Confidential

Chapter 13. Usage Import


Usage Import is the process of importing usage data into the Repository. This
process matches usage data to Products that have been defined in the Repository.

Running Usage Import


The HSISCUST post-installation customization job creates JCL jobs in the JCLLIB to
run the Usage Import function. Member HSISUIMP contains JCL to run the job.

TPARAM parameters
SSID= DB2 subsystem name. Value assigned, as defined in job HSISCUST.
DSN= DB2 location. Value assigned, as defined in job HSISCUST.
DATABASE=
Name of database. Value assigned, as defined in job HSISCUST.
REPSCHEMA=
Default is SI7. Repository schema.
SYSPLEX=
Default is N. Change to Y if you are in a sysplex environment.
COMMIT=
Default is 1000. Number of records stored before issuing a COMMIT.
SKIPAUXREBUILD=
Default is N. Change to Y if you do not wish to rebuild Summary tables.
For performance reasons, set to Y to import a large amount of usage data.
Subsequently, you need to run the HSISMERG job to recreate the Summary
tables.
Summary tables used are TUSEPO, TUSEPOV, and TUSEPOVLIB.

Copyright IBM Corp. 2009 91


IBM Confidential

92 Administration Guide and Reference


IBM Confidential

Chapter 14. Reporting


TCR reporting
The Tivoli Asset Discovery for z/OS Report set in Tivoli Common Reporting has
the following branches:
Asset Reports
These reports focus on Hardware and Software Assets. Note, that software
product discovery is performed at a release level for accuracy. This data is
then aggregated up to the product version level, at which products are
licensed and information is displayed in the Asset Reports. Tivoli Asset
Management for IT also queries the product version aggregated data.
Discovery Standard Reports
Standard reports about discovered products at a release level.
Discovery Advanced Reports
Advanced reports about discovered products at a release level.
Discovery Administrator Reports
Administrator reports about discovered products at a release level

Copyright IBM Corp. 2009 93


IBM Confidential

Figure 7. Tivoli Common Reporting navigation tree

The reports are generated by clicking on the icon next to the report title. By
default, the reports are shown in your HTML Browser. These reports can be saved
by using your Browser Menu File + Save.

All reports can also be generated in PDF and Excel formats by right-clicking the
report and selecting View As.

94 Administration Guide and Reference


IBM Confidential

Figure 8. Tivoli Common Reporting Right-click View As

Most reports have parameter prompts, including drop down selection lists that are
dynamically generated from queries of the database.

Chapter 14. Reporting 95


IBM Confidential

Figure 9. Tivoli Common Reporting Example Parameter Prompt

Click on the / icon on the top right to change the default settings. For clearer
parameter prompting, it is recommended to un-check the Show dialog description
area setting. The settings are saved using Tivoli Common Reporting user ID.

96 Administration Guide and Reference


IBM Confidential

Figure 10. Tivoli Common Reporting Edit User Preferences

Most reports have hyper links than can be clicked to drill down for more details.
This is particularly valuable for inspecting trend charts.

Chapter 14. Reporting 97


IBM Confidential

Figure 11. Tivoli Common Reporting Example Trend Chart with Hyperlinks

Asset Reports
Hardware and Software Assets reports.
Table 10.
Report Title Report Description
Product Inventory Product version inventory, with drill down to trend charts
and details
Product Inventory Global Knowledge Base catalog showing what has been
Verification discovered
Product Use Trend Product version use trend chart, with drill down to details
Product Use by Machine Cross Reference of Product versions used per Machine, with
hyperlink to Product Use Trend
Product Use by System Cross Reference of Product versions used per System, with
hyperlink to Product Use Trend
SCRT Summary by Sub-Capacity Reporting Tool (SCRT) data summary, with
Machine hyperlink to Product Use Trend
Machine Inventory System z machine inventory, with drill down to trend charts
and details
Machine Capacity Trend System z machine capacity trend chart, with drill down to
trend charts and details

98 Administration Guide and Reference


IBM Confidential

Discovery Standard Reports


Standard reports about discovered products at a release level.
Table 11.
Report Title Report Description
Product Summary Summary of discovered product releases
Product Detail Details of discovered product releases
Products by Machine Discovered product releases per machine
System Enterprise Browse Browse Regions, with drill down for more details

Discovery Advanced Reports


Advanced reports about discovered products at a release level.
Table 12.
Report Title Report Description
Search for Product Usage Search product release use data
Low Product Usage Product releases with low usage
APF Authorized Libraries APF library summary
Deleted Libraries Reports libraries that have been deleted
Deleted Products Reports products that have been deleted
Unused Modules Reports libraries with unused modules
Unused Products Reports unused product releases
Unused Products and Libraries Reports unused product releases and libraries

Discovery Administrator Reports


Administrator reports for Tivoli Asset Discovery for z/OS.
Table 13.
Report Title Report Description
Installation Verification Verify the connections to the databases are okay
IQ Database Report Browse IQ libraries and modules
IQ Filters List of IQ filters
Knowledge Base Reports Knowledge Base catalog
Not Identified Modules Modules with usage for not identified products, for
example customer applications
Products with unknown release Modules with unknown product release

Batch reporting
Ad hoc batch reports are provided as part of this product, and are run from a
supplied batch job. SQL queries to produce these reports are supplied as members
in the PARMLIB data set.

As part of online reporting, you can also run the same SQL queries using SPUFI or
QMF.

The reports are listed here, some of which might be familiar if you are a user of
TLCMz:

Chapter 14. Reporting 99


IBM Confidential

Table 14. Tivoli Asset Discovery for z/OS ad hoc reports


Member Description
HSISIPID INSTALLED-PRODUCT-IDENTIFICATION-DETAIL
HSISIPV INSTALLED-PRODUCT-SUMMARY
HSISLLID LOAD-LIBRARY-IDENTIFICATION-DETAIL
HSISLLS LOAD-LIBRARY-SUMMARY
HSISLMD LOAD-MODULE-DETAIL
HSISMUSL MODULE-USE-SUMMARY-BY-LIBRARY-AND-PRODUCT
HSISMUSP MODULE-USE-SUMMARY-BY-PRODUCT-AND-LIBRARY
HSISPDLP PRODUCT-USE-DETAIL-BY-LIBRARY-AND-PRODUCT
HSISPDPL PRODUCT-USE-DETAIL-BY-PRODUCT-AND-LIBRARY
HSISPJD PRODUCT-USE-DETAIL-BY-JOBNAME-PRODUCT-AND-LIBRARY
HSISPJP PRODUCT-USE-SUMMARY-BY-JOBNAME-AND-PRODUCT
HSISPJPL PRODUCT-USE-SUMMARY-BY-JOBNAME-PRODUCT-AND-
LIBRARY
HSISPSLP PRODUCT-USE-SUMMARY-BY-LIBRARY-AND-PRODUCT
HSISPSP PROD-USE-SUMMARY-BY-PRODUCT
HSISPSPL PRODUCT-USE-SUMMARY-BY-PRODUCT-AND-LIBRARY
HSISPUD PRODUCT-USE-DETAIL-BY-USERID-PRODUCT-AND-LIBRARY
HSISPUP PRODUCT-USE-SUMMARY-BY-USERID-AND-PRODUCT
HSISPUPL PRODUCT-USE-SUMMARY-BY-USERID-PRODUCT-AND-
LIBRARY
HSISPV PRODUCTS-BY-VENDOR
HSISVS VERSION-SUMMARY
HSISLINV List all inventories in DB2 Repository

When running in batch, ensure that the DB2 REXX environment for the target DB2
system has been successfully setup before using the samples.

Running the sample HSISBATR Batch Reporting JCL


The HSISCUST post-installation customization job creates JCL jobs in the JCLLIB to
run Batch Reporting. These reports are generated from the data held in the product
DB2, using a combination of DB2, REXX, and SQL.

Before running this job, ensure it has been updated with the following information:
1. The DB2 target subsystem name where Tivoli Asset Discovery for z/OS is
defined.
2. Remove the comments in the SYSIN DD for the report that you wish to run.
Note that multiple reports can be executed in a single job.
3. Ensure that DB2 has been bound for REXX language support.

In order to avoid producing large amounts of data, a ceiling of 1000 rows has been
set as an output limit for all reports. This can be removed or modified by editing
the SYSIN member corresponding to the report you would like to run.

Delete or modify the following SQL statement at the bottom of each member:

100 Administration Guide and Reference


IBM Confidential

FETCH FIRST 1000 ROWS ONLY

The supplied samples are designed to demonstrate how to report on a subset of


the data that has been collected by the Inquisitor and the Usage Monitor in order
to reduce the amount of resources required by DB2.

For example, several samples have the this SQL inserted:


AND TPRODUCT.FPRODUCTNAME LIKE '%IBM%'
AND TLIBRARY.FLIBNAME LIKE 'SYS%'

This restricts the output to only product names containing the string IBM, and data
set names that begin with the string SYS. You may wish to review the SQL before
running.

For performance reasons, when running SQL queries in DB2 that produce a lot of
output, you have to increase the sizes of the table spaces of the work file database.

Chapter 14. Reporting 101


IBM Confidential

102 Administration Guide and Reference


IBM Confidential

Chapter 15. Utilities


There are a number of utility jobs that are run in batch that enable you to
administer the Repository.

Knowledge Base Updates


The products knowledge databases are updated monthly. In order to have the
latest updates installed on your system, you will need to download the updates
from the IBM FTP server. The file that contains the updates contains z/OS, USS,
and Inquisitor Filter updates. Each needs to be loaded separately. The reload jobs
will drop the Knowledge Base tables and then reload the updates into empty
tables.

Running the Knowledge Base Updates


The name of the file that contains the updates is TADZKB.XMI.

Download this file as Binary. You will then need to upload this file to the
mainframe to a preallocated file with attributes FB 80.

Once uploaded you will need to receive the file: RECEIVE


INDATASET(tadzkb.xmit)

When prompted for additional information enter: DA(name of file)

The name of the file is important as it will be used as input to the KB load jobs.

This will restore the KB file making it ready to be used to update the Knowledge
bases.

Once you have restored the KB, you now need to run the KB load jobs.
1. Before you submit any job, ensure that the input file is changed to the name of
the file you have received from.
2. For HSISDB03 in the JCLLIB
v uncomment STEP3 - this will drop the Global Knowledge Base tables
v submit HSISDB03
3. For HSISDB05 in the JCLLIB
v uncomment STEP3 - this will drop the Global Knowledge Base for z/OS
UNIX tables
v submit HSISDB05
4. For HSISDB11 in the JCLLIB (optional)
v comment STEP1 - prevents creation of table space
v uncomment STEP3 - this will drop the IQ Filter tables
v submit HSISDB11
5. If you want to be notified about Knowledge Base updates by email, send an
email to [email protected] and we will include you in the mailing
list.

Copyright IBM Corp. 2009 103


IBM Confidential

Automation Server for z/OS


The Automation Server is a feature provided with Tivoli Asset Discovery for z/OS
which is used to automate the processing of data sets created by computer
processing.

Even though it is supplied to assist in the administration of Tivoli Asset Discovery


for z/OS created files, there is no requirement that the processed data sets contain
Tivoli Asset Discovery for z/OS data.

The Automation Server runs in its own address space as a started task. Ensure that
the user ID used by the Automation Server has an OMVS segment and UID, or use
of a default UID.

Input control statements define the actions to be performed by the Automation


Server. Currently two types of actions are supported:
1. FTP which causes the FTP utility to be invoked to perform a file transfer.
2. JOB which causes a batch job to be submitted.

Associated with each action definition is one or more data set name masks.
Periodically, a catalog search is performed to determine if any data sets with
names matching the mask need to be processed. When a new data set is found, the
associated action is performed.

A VSAM control data set is updated with the status of each data set action to
allow for FTP retries, and to ensure that each data set action is only performed
once for each data set.

Automation Server JCL


The Automation Server is started directly from the JCL procedure supplied in the
SHSIPROC data set. The member HSIJAUTO is used to start the Automation
Server. The JCL procedure is to be copied to a library in the JCL PROCLIB
concatenation. Changes are to be made to the procedure to minimize the Start
Command parameter overrides.

The following parameters are used to tailor the JCL for the Automation Server in
the Start Command:

HSI High Level Qualifiers for the Installation


Target Libraries months
HSIINST High Level Qualifiers for the
&HSIINST..PARMLIB data set created by the
HSISCUST job.
ACDS Data set Name of the ACDS (Automation
Control Data Set).

Files used by the Automation Server


The Automation Server uses several files. They are:
STEPLIB
specifies the program library containing the product software. Depending
upon installation methodology, STEPLIB is not required if Tivoli Asset
Discovery for z/OS is installed into the system linklist.

104 Administration Guide and Reference


IBM Confidential

HSIACNTL
specifies a partitioned data set containing fixed- length 80-byte records.
This is usually the control library. Member HSIAPARM contains the
Automation Server control statements, which specify the actions to be
performed. For each action named in the HSIAPARM member, there is a
member with the same name as the action name which contains the
template data for that action. The template data is to be JCL or an FTP
command stream, containing symbolic references to be resolved by
Automation Server whenever the action is performed.
HSIACDS
specifies a VSAM KSDS used by the Automation Server to keep track of
the action processing status of each eligible data set.
HSIAMSG
specifies the message report file for the Automation Server. Initialization
statements, error messages, and activity logging messages are written to
this file.
SYSPRINT
specifies the message report file for PL/I.
SYSOUT
specifies the message report file for Language Environment.
OUTPUT
specifies the message report file for the FTP program. Its contents are
determined by the FTP program installed in the system.
INPUT
specifies a fixed-length 120-byte record file containing FTP commands read
by the FTP program. The FTP commands are written to this file before FTP
is attached by the Automation Server whenever an FTP action is to be
performed.
INTRDR
specifies a fixed-length 80 byte record file to be directed to the systems
internal reader. The Automation Server writes a job stream to this file
whenever a JOB action is to be performed.

Creating the Automation Server control data set


The HSISCUST post-installation customization job creates a JCL job in the JCLLIB
to create the Automation Server Control data set. Member HSIASALC contains JCL
and IDCAMS definition commands to create the control data set already
customized for your environment.

The Automation Server control data set is a VSAM KSDS which the Automation
Server accesses by way of the HSIACDS file name.

Note: If the resulting VSAM data set is not automatically SMS-managed, then
extra operands would normally be required on the DEFINE CLUSTER command.
For example, the MGMTCLAS operand could be used to specify that the new
cluster is to be SMS-managed, or the VOLUME operand could be used to specify
the target volume serial number for the data set allocation.

The Automation Server control data set must have sufficient space allocated to
handle the workload required by the installation. One 96-byte record including the
52-byte key is required for each data set processed by the Automation Server. The

Chapter 15. Utilities 105


IBM Confidential

priming record is only required so that the file is opened for UPDATE, even when
the file has no data set records, and is not required for subsequent processing.

Preinstalling the Automation Server control data set


In the HSIAPARM member of the HSISPARM library you define actions to be
performed, and supply data set name masks specifying the subject data sets to be
processed. At times, data sets with these name patterns already exist, and have
been processed by other means before the implementation of the Automation
Server is ready. In this case, you need to inform the Automation Server that these
pre-existing data sets are not to be processed.

Any data set you want excluded from the Automation Server processing, even if
its name satisfies a selection mask pattern, must have a record in the Automation
Server control data set indicating that the data set has already been processed. The
easiest way to do this is to use the Automation Server Data Set Name Scouting
program.

The HSIADSN program can read the HSIAPARM member of the HSISPARM
library and perform catalog searches for every specified data set name mask. It
writes a record for every data set it finds which, after being sorted into key order,
is copied into the VSAM control data set.

Every record loaded into the control data set in this way indicates a specific action
name and data set name, and has the action flagged as complete.

You can edit the sequential before the data is copied into the control data set to
manually delete any records for data sets which, although pre-existing, have not
been processed, and which you therefore want processed by the Automation
Server.

The HSISCUST post-installation customization job creates a JCL job in the JCLLIB
to preinstall the Automation Server Control data set. Member HSIASSCT contains
JCL to run a job to discover and register data sets to be added to the control data
set.

Starting the Automation Server


When installed as a started task, the Automation Server must be started by an
operator START or S command. Ensure that the user ID assigned to the
Automation Server has RACF CONTROL access to the VSAM data set.

Stopping the Automation Server


Whether running as a started task or as a batch job, the Automation Server is
stopped by an Operator STOP or P command.

Action processing
Currently the Automation Server can perform two different actions, FTP and JOB.
In both cases, when an action is to be performed, the nominated template member
is used as input. If the template member cannot be found, an error message is
written to the HSIAMSG file. The Automation Server checks every 10 minutes to
see if there is any work to perform.

106 Administration Guide and Reference


IBM Confidential

Each 80-byte record is read from the template member and searched for the
ampersand character, the presence of which triggers a call to the systems symbol
substitution routine ASASYMBM.

It is by using symbols that the name of the specific data set, found in the catalog
search which triggered the action, is fed into the output stream.

After any necessary symbol substitution, the records are written to a sequential file
which is closed when the end of the template data is reached. For the FTP action,
the file is INPUT. For the JOB action, the file is INTRDR.

For the FTP action, the FTP utility is attached as a subtask. FTP scans the INPUT
file and processes the FTP requests therein. FTP writes its report messages to the
OUTPUT file. For the Automation Server, the INPUT file must be a temporary data
set. VIO is ideal for this purpose.

When the FTP subtask completes, the Automation Server examines the completion
code. If the FTP program ended normally with a zero return code, then the
Automation Server deems the action to have been successful and, as a result,
updates the action status in the HSIACDS file. This way, the action is not repeated
for the data set.

If the FTP program abends, or does not end normally with a return code of zero,
the Automation Server deems the action to have failed. A failed transfer is retried
at a later time.

Retries are subject to any specified time-of-day window constraints. You should
examine the OUTPUT FTP report file to determine the exact cause of any transfer
failure.

For the JOB action, it is expected that the INTRDR file is directed to the systems
internal reader. When this is done, the jobs submitted by the Automation Server
become available for JCL conversion as soon as the INTRDR file is closed, or
another JOB card image is encountered by the reader.

Note: A job stream can contain more than one job.

The Automation Server deems all job submissions successful so there are no retries
performed for JOB actions. There is no feedback from the job execution to the
Automation Server.

It is expected that installations have various software packages, such as job re-run
products, and the appropriate procedures in place to handle any failures in jobs
submitted by the Automation Server.

In principle, an action to invoke FTP to transfer a file can be implemented as a JOB


action with the corresponding template containing an FTP batch job stream.
However, such an implementation removes the ability of the Automation Server to
track the success of the transfer, thereby precluding the Automation Server
initiated retries.

Note: The Automation Server does not check the validity of JOB or FTP streams,
but copies the records from the template member to the file appropriate for the
action type, performing symbol substitution where necessary. In particular, if JOB
action templates do not contain valid JOB statements, the data submitted to the
internal reader can disappear from the system with little or no indication.

Chapter 15. Utilities 107


IBM Confidential

Automation Server control data set cleanup


A record is kept for every data set processed by the Automation Server in the
Automation Server control data set (ASCDS). The primary purpose of this record is
to prevent the repeated processing of a data set for the same data set name mask.
As records accrue, the size of the data in the ASCDS continues to grow.

If a processed data set is deleted, then there is no reason to keep a record of that
data set in the ASCDS. Similarly, if a data set name mask is removed from the set
of masks processed by the Automation Server, there is no need to keep a record of
the data sets processed.

To provide a mechanism where space occupied by needless data is reclaimed, the


Automation Server performs a cleanup cycle for the ASCDS on a daily basis. The
cleanup action is only performed when all active data set name masks have had a
catalog search performed by the current Automation Server task in the current
calendar month.

The cleanup cycle consists of reading the ASCDS sequentially, and deleting records
for data sets which have not been found by any catalog search; based on the
relevant data set name mask in the current calendar month, or in the calendar
month prior to the current month.

As with most VSAM data sets with ongoing record insertion and deletion activity,
it is advisable to reorganize the ASCDS from time to time.

A backup regime for the ASCDS must have the robustness and frequency which
corresponds with the adverse consequences of reprocessing any already processed
data set.

Automation Server request control statements


The Automation Server action requests are specified in the HSIAPARM member of
the SHSIPARM file.

Syntax rules are as follows:


v Records beginning with an asterisk are comments.
v Blank records are comments.
v Verbs and operands must begin before column 72.
v No blanks are allowed between a verb or operand and its opening parenthesis.
v A subparameter in parentheses can have leading or trailing blanks.
v Continuations on to subsequent records are not allowed.
Action statement
Function
Each action statement requests that an action is performed for a
data set whenever it matches an associated data set name mask.
An action is only performed once for each match, but the presence
of a data set triggers the action for each mask it matches.
An optional time-of-day window is specified for each action. Such
a window indicates that searches of the catalog for data sets
matching associated masks are only to occur during the nominated
time-of-day window. The time-of-day window is used to restrict

108 Administration Guide and Reference


IBM Confidential

job submission and file transfers to administratively appropriate


times, such as overnight, or outside peak processing times.
Syntax

Action statement syntax

 action( template ) 
TIME(hhmm-hhmm)

action FTP or job


template
name of a member in the SHSIPARM file.
hhmm-hhmm
specifies a time-of-day range.
TIME this operand is optional, and the default is
TIME(00002400), which specifies no time-of-day
constraint. When specified, hhmm-hhmm must be 9
contiguous characters made up of four decimal digits, a
dash, and four decimal digits. Each hhmm value specifies a
time-of-day in 24-hour hours and minutes. The minimum
value is 0000 and the maximum value is 2400, while the
last 2 digits cannot exceed 59. The first hhmm specifies the
time-of-day window start, and the second hhmm specifies
the time-of-day window close. The second hhmm value
must be greater than the first hhmm value.
Data set name mask statement
Function
Each data set name mask statement associates the specified data
set name mask with the preceding action statement. It is therefore
invalid for the HSIAPARM member to begin with a data set name
mask statement. When a data set with a name matching the
specified mask is first located, the action specified in the preceding
action statement is triggered.
The data set name mask of NULLFILE is a special case. When a
data set name mask with this exact value is processed by the
Automation Server, no catalog search is performed, but the
associated action is triggered as if a new cataloged data set
matching the mask has been located. The AS symbols for the
complete data set name and the first data set name qualifier both
have values of the 8-byte string NULLFILE. Use the data set name
mask of NULLFILE to trigger daily actions which do not depend
on the creation of any particular data set.
Syntax

Chapter 15. Utilities 109


IBM Confidential

Data set name syntax

 DSN(data-set-name-mask ) 

data-set-name-mask
where data-set-name-mask does not exceed 44 characters in
length, and specifies a data set name mask pattern
acceptable to the Catalog Search Interface. The generic
match mask for a single character is the percent sign. The
generic match mask variable number of characters is the
asterisk, and a double asterisk can be used to match a
variable number of data set name qualifiers.
Control statement examples
Example 1:
Files created by the Usage Monitor are to undergo two
independent processes, both within the 8:00 p.m. to 11:30 p.m.
window. First, they will be processed by a job based on the JCL
template member HSISJOB1 of the HSIACNTL file, and then they
will be transferred be transferred to a z/OS system using the FTP
commands in member HSISFTP1 of the HSIACNTL file.
* TRANSFER USAGE MONITOR FILES TO Z/OS SYSTEM
JOB(HSISJOB1) TIME(0800-2330)
DSN(USER.OMU*.D*.T*)
FTP(HSISFTP1) TIME(0800-2330)
DSN(USER.OMU*.D*.T*)
* COMMENTS
Example 2:
Files created by the Usage Monitor are to be imported to the appropriate
database.
* PERFORM USAGE MONITOR IMPORT
JOB(HSISUIMP)
DSN(hlq.UMON.*.*)

In this example HSISUIMP is a member of the JCLLIB file containing all


the necessary JCL to run the Usage Import on a z/OS system.

Note: The JCL can route the job to any connected NJE node, or specify
affinity to any system sharing the SPOOL. Therefore, the job does not have
to run on the z/OS system where the Automation Server is running. The
template name, HSISUIMP in this example, need not match the job name
submitted by the Automation Server action.
Automation Server symbol processing
Whenever an action is performed, the contents of the template
member are written to an appropriate output file. Each 80-byte
record is written unchanged, unless symbol substitution is
required. If an ampersand character is present in a record from the
template member, the system symbol substitution routine
ASASYMBM is invoked to process the record before it is written.

110 Administration Guide and Reference


IBM Confidential

More than one symbol is allowed in a record. If an ampersand


character does not denote the start of a recognized symbol, then
that part of the data remains unchanged.
Symbols available for use in template members include all z/OS
system static symbols and symbols defined locally by the
Automation Server.
Automation Server local symbols are derived from the data set
name of the catalog entry found which triggered the particular
instance of the action.
Automation Server local symbols are:

&DATASETNAME. The entire data set name.


&QUAL1. The first qualifier of the data set name.
&QUAL2. The second qualifier of the data set name.
&QUAL3. The third qualifier of the data set name.
&QUAL4. The fourth qualifier of the data set name.
&QUAL5. The fifth qualifier of the data set name.
&QUAL6. The sixth qualifier of the data set name.
&QUAL7. The seventh qualifier of the data set name.
&QUAL8. The eighth qualifier of the data set name.
&QUAL9. The ninth qualifier of the data set name.

Note: The &QUALn symbols where n is greater than the number


of qualifiers of the data set name have a length of zero.
In this example the data set triggering a job action is hlq.IQ.ZIP
which has three qualifiers in its name. As a result a JCL DD
statement referencing the data set in a template member could look
like this:
IQDATADD DD DSN=&DATASETNAME.,DISP=SHR

or equally:
IQDATADD DD DSN=&QUAL1..&QUAL2..&QUAL3.,DISP=SHR

both of which would be resolved by symbol substitution to:


IQDATADD DD DSN=hlq.IQ.ZIP,DISP=SHR

which would be the JCL statement output to the internal reader.

Note: As symbol substitution is performed before the job is


submitted, z/OS system symbols that are not allowed in batch job
JCL are in the Automation Server templates.

Product Tagging Utility


The Product Tagging Utility, referred to as the Tagger, provides a means of
identifying software which has not been predefined in the Global Knowledge Base
(GKB). It can also be used to supersede GKB entries, without changing the GKB
contents.

Chapter 15. Utilities 111


IBM Confidential

Product tagging is currently a manual process where the details of the product,
such as name and vendor, are provided, together with the location of the products
programs. The Tagger scans the programs in a similar fashion to the Inquisitor, and
records the results for later collection and storage into the Local Knowledge Base
(LKB), where it is used for software identification.

The SYSIN file contains several control statements describing the program product
to be tagged, such as its name, the vendors name, the product identifier, and
version information. There is also one or more TAGLIBS statements supplied,
which provide the Tagger with the information needed to find the program
libraries containing the products executable software.

The Tagger uses the TAGLIBS specifications to locate the relevant program libraries
which are dynamically allocated and analyzed. Data sufficient to perform software
identification for each relevant program is extracted.

Information about all of the discovered programs pertaining to the nominated


program product is compiled into a single object module, which is either written to
all of the relevant program libraries containing the products programs, or written
to the single program library allocated to the HSIREDIR file.

Installations can choose to keep all tag data separate from executable program
product software by using the optional HSIREDIR file. If this is done, ensure that
all relevant HSIREDIR file data sets are included in the normal Inquisitor scan
processing, even if those data sets contain no other programs.

The Tagger can only process one software product or optional feature of a product
in a single execution run.

All program object and load module libraries, excluding distribution libraries, of a
product or product optional feature, are to be processed in the same Tagger
execution run.

You can choose to overwrite the default output member name of @HSIPTAG by
specifying a TAGMEM statement. All Tagger output members are flagged with an
SSI value of XD7E3C1C7, which is PTAG in EBCDIC.

If there is no preexisting member of the same name, a new program member is


created by the Tagger to contain the tag data. If a member already exists, the new
tag data is added to the pre-existing data pertaining to other products or optional
features. Any data pertaining to the same software piece identified by {VENDOR +
PRODUCT + OPTION + VERSION} is replaced. Internally, the data relating to each
software piece resides in its own control section. Tag data members contain no
executable code and are bound with the only-loadable attribute. They are also
bound as reentrant with a residence mode of ANY to minimize the impact of being
placed in a library which is loaded into the Link Pack Area.

To erase the effects of Tagger processing, simply delete the tag data members
which can be identified by their SSI value. If you are using ISPF to achieve this,
the SORT SSI member list command is useful.

The tag data members created by the Tagger are recognized by the Inquisitor (by
their SSI value) during normal program library scanning activity. The Inquisitor
extracts the tag data from the member contents and writes it to its output file. The
Inquisitor Import process uses these program tags to maintain entries for the
programs in the Local Knowledge Base, thus enabling accurate identification by

112 Administration Guide and Reference


IBM Confidential

the Match Engine for the tagged product level, no matter which library the
product is deployed to, and which system the Inventory data is collected from.

The software piece processed in a Tagger execution run is considered to have a key
of {VENDOR + PRODUCT + OPTION + VERSION}. This means that, if non-key
data items such as the values specified in the PPNUM, or LICENSED statements,
are incorrect, they can be corrected by fixing the input statement values and
rerunning the Tagger job, thereby replacing all non-key tag data.

It also means that if a key data item is incorrect, it cannot simply be erased by
running a Tagger job with the correct data.

If a product has multiple program libraries, there is no requirement for them to be


processed under a single generic data set name mask. It is acceptable to have
multiple TAGLIBS statements, with each selecting a single specific data set. It is
also acceptable to have some TAGLIBS statements triggering catalog searches, and
others triggering VTOC searches in the same Tagger execution run.

When processing libraries which are not dedicated to a single program product,
use member name masking to prevent the tagging of programs not related to the
specified product. Some installations deploy multiple software products in a
combined common library. If the products are tagged before they are combined,
use different tag data member names to allow all the tag data to reside in the
common library.

Running the Tagger


The HSISCUST post-installation customization job creates JCL in the JCLLIB to run
the Tagger. Member HSISPTAG contains JCL to run the job.

Tagger control statements


Control statements are input using the SYSIN file. General syntax rules are listed
here::
v Fixed-length, variable-length and undefined record formats are processed.
v Short records are extended to 72 bytes of data with blanks if necessary.
v Only the first 72 bytes of data for each record are processed by the Tagger.
v Records beginning with an asterisk are treated as comments and do not alter
continuation status.
v The first nonblanks of a statement must identify the statement type.
v One or more blanks must follow the statement type.
v A statement with no value or operand specified is invalid.
v For statement types other than TAGLIBS, the specified value is deemed to start
with the first nonblank after the statement type name.
v Statements are input in any order. All statements are processed before any
tagging activity commences.
v TAGLIBS is the only statement type which can be supplied more than once in an
input file.
v TAGLIBS is the only statement type which can be continued over more than one
record.
v TAGLIBS is the only statement type where symbol substitution can be
performed.

Chapter 15. Utilities 113


IBM Confidential

Here is a table of value-oriented statement types detailing all Tagger statement


types except TAGLIBS. It shows the statement type name, a description of the
meaning of its value, whether it is a mandatory or optional statement, the default
value of optional input, and the maximum acceptable byte count.
Table 15. Tagger Statement Types
Statement Value Default Value Required Maximum
Type length
VENDOR Products vendor name - Yes 30 bytes
PRODUCT Products name - Yes 50 bytes
PPNUM Program product number blanks No 16 bytes
OPTION Optional feature name BASE No 30 bytes
VERSION Software level - Yes 8 bytes
LICENSED Separately licensed feature? NO No 3 bytes
(YES or NO)
TAGMEM Output member name @HSIPTAG No 8 bytes

Note: The symbol @ represents the X7Ccode point.

TAGLIBS is not a value-oriented statement type, but has operands which have
values specified in parentheses much like Inquisitor control statements. TAGLIBS
does not currently have any keyword operands.

Operands can be abbreviated to the minimum unambiguous length, which


currently means in practice that selection mask operands can be abbreviated to a
single character, and exclusion mask operands can be abbreviated to two
characters.

If the Tagger finds an ampersand (&) in a TAGLIBS statement record it invokes the
system symbol substitution routine ASASYMBM to perform symbol substitution.

The Tagger stops parsing a TAGLIBS record and expects the current statement to
continue on the next record whenever a continuation character is encountered.
Valid continuation characters are plus (+) and dash (-). Continuation characters
also function as delimiters, so a continuation cannot occur within an operand
name, or a value mask.

The syntax description of TAGLIBS follows.

114 Administration Guide and Reference


IBM Confidential

Syntax

 TAGLIBS DATASET DSNAME ( dsname-mask list ) 

 
XDATASET VOLUME ( volume-mask list )
XDSNAME ( dsname-mask list )

 
XVOLUME ( volume-mask list ) PROGRAM
PGM ( member-mask list )

 
XPROGRAM
XPGM ( member-mask list )

dsname-mask
a string up to 44 bytes in length, representing one or more possible data
set names.
volume-mask
is a string up to 6 bytes in length, representing one or more possible
volume serial numbers. A mask of six asterisks is deemed to represent the
IPL volume, which is ascertained during execution.
member-mask
is a string up to 8 bytes in length representing one or more possible
member names of a PDS and/or PDSE.

Masks in a mask list within the same set of parentheses must be separated by at
least one delimiter. Acceptable delimiter characters are a blank, a comma, and a
continuation character.

Multiple masks are allowed in each mask list. At least one data set name selection
mask must be specified on each TAGLIBS statement. If an operand is specified
more than once, then all masks specified in all occurrences of the operand are
processed.

Program libraries are located either by invoking the Catalog Search Interface, or by
scanning the VTOC of each volume which passes the volume selection and
exclusion criteria. VTOC scans are performed if VOLUME or XVOLUME is
specified; otherwise the catalog is searched.

The Tagger allocates a potential program library before determining if it is a


program library. This is to ensure that it is on a primary volume, and that its
VTOC entry is accessible. As a result, you need to check that the data set name
masks used in a catalog search do not trigger excessive data set recalls.

Catalog searches are limited to entry type A non-VSAM entries, so data set aliases
and GDG members are not processed. The Tagger does not process a data set
unless it has partitioned organization, an undefined record format, and a block size
of at least 1024. A PDSE is only processed if it is a program library.

Chapter 15. Utilities 115


IBM Confidential

When using generic masks, use percent to signal that any single character is to be
considered a match in that exact location of the compared character string, and use
an asterisk to signal that any zero or more characters are a match, with one
exception now described.

Data set name mask matching performed by the Catalog Search Interface is
qualifier-aware. The Catalog Search Interface treats an asterisk as part or whole of
a single data set name qualifier. To specify any number of data set name qualifiers,
use the double-asterisk. Only the masks specified in a DATASET or DSNAME
operand are ever passed to the Catalog Search Interface by the Tagger.

When using generic data set name selection masks, you need to adjust the mask,
depending on whether the data sets are to be located by catalog or VTOC searches.
Do not use double asterisks in any mask other than data set name selection masks.

Region Association Utility


The utility enables you to create region names and to associate the various
inventories in the Repository with a region. Regions can contain other region.
Creating regions allows you to group together many inventories under a single
name. This simplifies reporting based on a region, rather than individual
inventories. You can create region names based on geographic location; a city or
state.

Running Region Association utility


The HSISCUST post-installation customization job creates JCL jobs in the JCLLIB to
run the Region Association utility. Member HSISREGN contains JCL to run the job.

TPARAM parameters
SSID= DB2 subsystem name. Value assigned, as defined in job HSISCUST.
REPSCHEMA=
Default is SI7. Repository schema.
DBNAME=
Name of database. Value assigned, as defined in job HSISCUST.

SYSIN commands
The SYSIN commands specified in the SYSIN DD.

The syntax rules are:


1. Comments begin with a * in column 1.
2. Blank lines are allowed and are ignored.
3. Each statement must be terminated by a period (.).

The statements are:


LIST List region or inventory information.

116 Administration Guide and Reference


IBM Confidential

Syntax

 LIST 
REGion region
INVentory inventory

region specifies the name of a region and can be ALL, a region name, or
a region name including masking characters. If a region name
includes spaces, enclose the name in quotes ().
inventory
specifies the name of an inventory and can be ALL, an inventory
name, or an inventory name including masking characters.
Masking characters are:
* for one or more characters of any value.
% for exactly one character of any value.
The keywords REGION and INVENTORY can be abbreviated to REG or
INV.
DEFINE
The Define command creates region names that can be used to group
inventories or other regions.

Syntax

 DEFINE REGion region 

region specifies the name of a region. If a region name includes spaces,


enclose the name in quotes ().
The keyword REGION can be abbreviated to REG.
ASSIGN
The Assign command will assign an inventory to a region, or a region to a
region. Assigning a region to another region will make the assigned region
a child of the assigning region.

Syntax

 ASSIGN TO region2 
REGion region1
INVentory inventory

region 1
specifies the name of a region to be assigned.

Chapter 15. Utilities 117


IBM Confidential

region 2
specifies the name of a region that the region or inventory is to be
assigned to.
inventory
specifies the name of an inventory.
If a region name includes spaces, enclose the name in quotes().
The keywords REGION and INVENTORY can be abbreviated to REG or
INV.
REMOVE
The Remove command will remove an inventory assignment to a region.

Syntax

 REMOVE INVentory inventory FROM region 

inventory
specifies the name of an inventory that might have masking
characters.
region specifies the name of a region that the inventory is to be removed
from.
Masking characters are:
* for one or more characters of any value.
% for exactly one character of any value.
If a region name includes spaces, enclose the name in quotes().
The keyword INVENTORY can be abbreviated to INV.
DELETE
The Delete command will delete a region name.

Syntax

 DELETE REGion region 

region specifies the name of a region. If a region name includes spaces,


enclose the name in quotes ().
The keyword REGION can be abbreviated to REG.

Inventory Association
When an inventory is run in Shared DASD-mode, all systems that provide usage
data for the Inventory need to be manually associated with an Inventory.

118 Administration Guide and Reference


IBM Confidential

Creating an association
In order to create an association ,you must first ascertain what Inventories have
already been loaded into the Repository, and the corresponding Inventory ID. Use
the sample member HSISBATR from the customized JCLLIB data set. Uncomment
the SYSIN DD statement which uses member HSISLINV from the customized
PARMLIB data set as input. You can expect output similar to the output shown in
this example:

REPORT: List all Tivoli Asset


Discovery for z/OS inventories in DB2 Repository 2008-11-18 20.51.08

FINVID FINVNAME FVERSIONGKBID FIQDATE FIQDATEFIRST


______ ________ _____________ __________________________ __________________________
1 PLEXD 36.15 2008-09-16-17.22.15.000000 2008-09-16-17.22.15.000000
2 PLEXE 36.15 2008-09-16-17.00.51.000000 2008-09-16-17.00.51.000000
3 PLEXR 36.15 2008-09-16-17.03.56.000000 2008-09-16-17.03.56.000000

FSYSPLEXID FSYSFMID FSMFID FPREVINVID FIQSYSPLEXUSE FVENDORCNT FPRODUCTCNT FLIBCNT FINVCONT FINVTYPE FIQNAME
__________ ________ ______ __________ _____________ __________ ___________ _______ ________ ________ ______
SYSPLEXD HBB7730 ISD1 0 0 7 435 7523 Y 1 IQ33
SYSPLEXE HBB7730 FAE1 0 0 6 235 1701 Y 1 IQ34
SYSPLEXR HBB7730 BMR1 0 0 5 300 1281 Y 1 IQ35

Complete these two steps to associate an SMFID with an Inventory:


1. Identify the FINVID associated with the Inventory name (FINVNAME) that
you want to update.
2. Update and submit member HSISINVA in the customized JCLLIB data set with
your desired association.

For example, using the output produced by the SQL in member HSISLINV, it
associates the SMFID FAE1 to the Inventory ID of two, in this case Inventory
Name PLEXE.
INSERT INTO REPschema.TUIMPORTCTRL VALUES(2,0,0,0,0,0,0,0, ' ', 'FAE1');

With this utility, you can associate a single SMFID to eight different Inventories.
Usage import checks the first Inventory to see if it has matching data. If so, then
the usage data is added to that Inventory. If not, then the next Inventory is
checked.

Running Inventory Association


The HSISCUST post-installation customization job creates JCL jobs in the JCLLIB to
run the Inventory Association. Member HSISINVA contains JCL to run the job.

SYSIN Parameter
INSERT INTO &REPSCHMA..TUIMPORTCTRL VALUES(2, 0, 0, 0, 0, 0, 0, 0, ' ', 'AAV1');

Usage Summary
Usage Summary is the process of summarizing usage data in the Repository. This
can save you space and time by reducing the number of DB2 rows used to
represent your older data. This process deletes detail usage records and creates
monthly summary records.

We recommend that you keep 3 months of Usage data. This is to minimize space
utilization and improve SQL query performance.

Chapter 15. Utilities 119


IBM Confidential

Running Usage Summary


The HSISCUST post-installation customization job creates JCL in the JCLLIB to run
Usage Summary. Member HSISUSUM contains JCL to run the job.

TPARAM parameters
DSN= DB2 location. Value assigned, as defined in job HSISCUST.
DATABASE=
Name of Tivoli Asset Discovery for z/OS database. Value assigned, as
defined in job HSISCUST.
REPSCHEMA=
Default is SI7. Repository schema.
SUMBY=
The parameter is used to summarize the usage data by either Consumer
(SUMBY=1), by Module (SUMBY=2), or both (SUMBY= 3).
SUMBY=1
Summarize by Consumers. Consumer information (JOB NAME &
USER ID) is ignored, with usage events being attributed to the JOB
TYPE (BATCH, TSO, DB2...)
SUMBY=2
Summarize by Module. Load module (=program) names are
ignored, with the value *MODULE* as a placeholder.
SUMBY=3
Summarize by both Consumers and Modules. The rules for
SUMBY=1 and SUMBY=2 apply.
Note: You can choose to summarize by module only, and later on
summarize the same data, except this time you choose consumer.If
you choose to summarize by consumer, then all usage queries
would no longer display the Consumer name, but the type of
process that the user was using. For example, you would have
Consumer names like TSO, DB2, and Batch . For module usage,
queries would only have a Module name of *MODULE* as the
name.
FIRSTDATE=
Start of the first date range. This is in the form YYYYMM. Only complete
months are chosen.
LASTDATE=
End of the last date range. This is in the form YYYYMM.

Note: The date range of summarization is inclusive of the month specified


in the FIRSTDATE and LASTDATE parameters.
MINUSAGETHRESHOLD
Default is 1000. Sets a value for Usage Summary to ignore summarization
of usage records. If this parameter is set to 1000, then any product with a
usage count of 1000 or less for any given month, does not have its detail
data summarized. This allows you to view the detail data for low usage
products.
COMMIT=
Default is 1000. Number of records stored before issuing of COMMIT.

120 Administration Guide and Reference


IBM Confidential

Usage Deletion
Usage Deletion is the process of deleting Usage data in the Repository. This
process deletes detail and summary Usage records for the period specified for all
inventories in the Repository.

We recommend that you run this job on a periodic basis to minimize space
utilization and improve SQL query performance.

Running Usage Deletion


The HSISCUST post-installation customization job creates JCL jobs in the JCLLIB to
run the Usage Deletion. Member HSISUDEL contains JCL to run the job.

TPARAM parameters
DSN= DB2 location. Value assigned, as defined in job HSISCUST.
DATABASE=
Name of database. Value assigned, as defined in job HSISCUST.
REPSCHEMA=
Default is SI7. Repository schema.
UDELINVID=
Value must be specified. Inventory ID where you need to delete Usage
data from. If UDELINVID=0, then all inventories are deleted if it falls
between the FIRSTDATE and LASTDATE.
FIRSTDATE=
Start of the first date range. This is in the form YYYYMM. Only complete
months are chosen.
LASTDATE=
End of the last date range. This is in the form YYYYMM.

Note: The date range of deletion is inclusive of the month specified in the
FIRSTDATE and LASTDATE parameters.
COMMIT=
Default is 1000. Number of records stored before issuing of COMMIT.

Delete Inventory
Delete Inventory is a facility where you can delete an individual Inventory from a
Repository. A Repository is made up of many individual Inventories that do or do
not contain usage data. Deleting an Inventory means all data associated with an
Inventory is deleted. This includes usage data if it has been imported.

We recommend that you run this job on a periodic basis to minimize space
utilization and improve SQL query performance.

Running Delete Inventory


The HSISCUST post-installation customization job creates JCL jobs in the JCLLIB to
run the Delete Inventory utility. Member HSISDINV contains JCL to run the job.

TPARAM parameters
DSN= DB2 location. Value assigned, as defined in job HSISCUST.

Chapter 15. Utilities 121


IBM Confidential

REPSCHEMA=
Default is SI7. Repository schema.
DELINVID=
Value must be specified. Inventory ID to be deleted.

High Level Qualifier listing for Usage Monitor


This job will create a High Level Qualifier listing for Usage Monitor.

With the large amounts of Usage Data that is collected, it is best practice to only
monitor products that are identified, and to exclude data that is not identified. In
order to do this, the Usage Monitor has been modified to only include libraries
that identify products. This is done by creating a utility that scans the Repository
in order to create a list of high level qualifiers for products that are identified.
Using this list as input to the Usage Monitor control file, HSIZIN, you are able to
exclude all usage events, except for those that have been included by way of the
high level qualifier.

Here is an example of an HSIZIN control file that excludes all usage, but includes
usage for the specified high level qualifiers.
EDS(**)
IDS(SYS1.*)
IDS(SYS2.*)
IDS(SYS3.*)
IDS(SYS4.*)

Running High Level Qualifier for Usage Monitor


The HSISCUST post-installation customization job creates JCL jobs in the JCLLIB to
run the High Level Qualifier for the Usage Monitor utility. Member HSISLLST
contains JCL to run the job.

TPARAM parameters
DSN= DB2 location. Value assigned, as defined in HSISCUST.
REPSCHEMA=
Default is S17. Repository schema.
COMMIT=
Default is 1000. Number of records stored before issuing a COMMIT.

Repository Merge
Repository Merge is a facility where the Source Repository is merged or combined
with another existing Repository, known as the Destination Repository. Running
Repository Merge facility repeatedly, with the same destination Repository, but
different source repositories, enables the combining of several separate repositories
into one.

Both Load to Repository and Usage Import have a parameter that allows you to
skip the summary table rebuild. This saves time when you have many loads or
usage imports to perform. After completing the loads and imports, you must run
the Repository Merge to rebuild the summary tables.

122 Administration Guide and Reference


IBM Confidential

Destination Repository
The Destination Repository after a merge contains all the information it contained
prior to the merge, plus all the information contained in the Source Repository.

Some particular cases are:


v If the Destination Repository does not already contain an inventory with the
same name as an Inventory in the Source Repository, then that entire Inventory
is copied to the Destination Repository, including all libraries, all modules, all
products and versions, and all usage associated with that Inventory.
v If the Destination Repository does contain an Inventory with the same name as
an Inventory in the Source Repository, then any additional libraries, modules
and products and versions, are copied to the relevant Inventory in the
Destination Repository.
v Any usage for this Inventory in the Source Repository is copied across to the
Destination Repository. If a usage event for an identical library, module, product,
version, user, job, and LPAR already exists in the Destination Repository, then
the event count is summed. Otherwise, a new usage record is created. Statistics
such as last usage date are updated in order to reflect the later date of the
source and the original Destination Repositories.
v Repository Merge merges all Inventories in the Source Repository into the
Destination Repository.
v Another function of this facility is its ability to rebuild the summary tables in a
Repository. Do this if you have elected not to rebuild the summary tables after
you have done a Load to Repository or Usage Import. To do this, you must
point the SRCSCHEMA and REPSCHEMA to the same Repository schema.

Running Repository Merge


The HSISCUST post-installation customization job creates JCL jobs in the JCLLIB to
run the Repository Merge function. Member HSISMERG contains JCL to run the
job.

TPARAM parameters
SSID= DB2 subsystem name. Value assigned, as defined in job HSISCUST.
DSN= DB2 location. Value assigned, as defined in job HSISCUST.
SRCSCHEMA=
Schemas for the source Repositories.
REPSCHEMA=
Schema for the target Repository.
DBNAME=
Name of Tivoli Asset Discovery for z/OS database. Value assigned, as
defined in job HSISCUST.
COMMIT=
Default is 1000. Number of records stored before issuing a COMMIT.

TPARAM table update


In certain situations, the TPARAM table in the Repository might have been set to
an inconsistent state, due to failures in jobs that update the Repository tables. To
rectify this inconsistent state, a parameter in the TPARAM table has to be reset.

Chapter 15. Utilities 123


IBM Confidential

Running TPARAM table update


The HSISCUST post-installation customization job creates JCL jobs in the JCLLIB to
run the TPARAM update. Member HSISTPRM contains JCL to run the job.

SYSIN parameter
UPDATE &REPSCHMA.TPARAM SET FVALUE = '0' WHERE FKEY = 'PROCRUN';

SCRT Import Utility


The Tivoli Asset Discovery for z/OS SCRT utility reads data created by the IBM
Subcapacity Reporting Tool. This comes in the form of CSV formatted output files,
and is used to populate several DB2 tables in the Repository. This information can
then be queried by Tivoli Common Reporting to provide trending of SCRT data, as
well as comparing this with the corresponding Usage Data.

Running SCRT Import Utility


The HSISCUST post-installation customization process creates a Job in the JCLLIB
dataset to run the Tivoli Asset Discovery for z/OS SCRT Utility. Member
HSISSCRT contains the JCL to run the job.

INPUT
DDNAME CSVIN, which will contain the CSV output from the IBM SCRT tool.
This may be from a data set with DSORG of PS or PO. Binary uploaded CSV files
are supported.

OUTPUT
Several DB2 tables will be populated from the data contained in CSVIN, including
NODE, NODE_CAPACITY, and PRODUCT_NODE_CAPACITY. Ensure that the
CSVIN DD points to the .CSV output file created by the IBM SCRT tool. This may
be a DSORG=PO or PS data set.

TPARAM parameters
SSID=
DB2 subsystem name. Value assigned, as defined in job HSISCUST
REPSCHEMA=
Default is SI7. Repository schema name
GKB=
Default is GKB7. Schema name for the Global Knowledge Base

XML Export Utility


This utility extracts information in XML format for customers to import into the
Tivoli Asset Management for IT product.

Running XML Export Utility


The HSISCUST post-installation customization job creates JCL jobs in the JCLLIB to
run the XML Export utility. Member HSISKBT contains JCL to run the job.

The output XML file generated from this utility needs to be ftp to a distributed
environment and then loaded into TAMIT. Also the XML file needs to be translated
from EBCDIC to ASCII. Here is an example on how to perform the ftp process.

124 Administration Guide and Reference


IBM Confidential

1. C:\temp ftp host name (Using command line FTP connect to the host system)
2. When prompted enter your user name and password.
3. ftp > quote type a (set to ASCII)
4. ftp > get XML.EXPORT.FILE C:\XML.FILE
(ftp file from host to local workstation)
5. ftp > exit
If you need to ftp non ASCII characters, then issue ENCODING statement as
this extra command before the GET command :
quote site ENCODING=MBCS MBDATACONN=(IBM-939,UTF-8)
(this example is for a Japanese codepage)

TPARAM parameters
SSID=
DB2 subsystem name. Value assigned, as defined in job HSISCUST.
SCHEMA=
Default is SI7. Repository schema.
a) Using the Repository schema value means that a catalog of products
installed on your site is selected
b) You can also use the GKB schema value. This would mean that a catalog of
all products defined in the GKB is selected.

HSISZCAT
The Usage Monitor produces at least one raw Usage data set each day. The ZCAT
Utility (PGM=HSICZCAT) can be used to concatenate multiple Usage Monitor data
sets into one single data set on the mainframe.

HSISZCAT will scan for data sets with a predetermined naming convention using
the following dsn construct:
umon-dsn-prefix.dyyyyddd.thhmmsst

The umon-dsn-prefix is determined by the UMDSN parm value. For example,


PGM=HSICZCAT,PARM=UMDSN(umon-dsn-prefix) . This will be the same as
the value defined on the Usage Monitor DSN(...) parameter. It has a maximum of
26 characters, which do not include the .dyyyyddd.thhmmsst suffix.

The data sets are logically concatenated to a single output dataset and the input
files are renamed to:
umon-dsn-prefix.dyyyyddd.shhmmsst

Note the letter s instead of t in the low level qualifier.

The output file may be pre-allocated. For example:


//ZCATOUT DD DSN=your-dsname,RECFM=VB,LRECL=27994,UNIT=SYSALLDA,
// SPACE=(CYL,(20,10),RLSE),DISP=(,CATLG)

or

the output data set will be dynamically allocated with the following name:
umon-dsn-prefix.dyyyyddd.uhhmmsst .

Note the letter u

Chapter 15. Utilities 125


IBM Confidential

Running HSISZCAT
The HSISCUST post-installation customization job creates JCL jobs in the JCLLIB to
run the concatenation of Usage Monitor data sets. Member HSISZCAT contains
JCL to run the job.

Check the SYSPRINT DD for messages, output similar to the following will be
displayed on execution:
DELETE option specified in the Parm string
input dataset identified: 'MACNIVE.MONITOR.FAE3.D2009105.T0000000'
input dataset identified: 'MACNIVE.MONITOR.FAE3.D2009106.T0000001'
input dataset identified: 'MACNIVE.MONITOR.FAE3.D2009107.T0000004'
Info: Catalog CATALOG.USER.SYSPLEXE had 3 dsnames.
Info: 3 'MACNIVE.MONITOR.FAE3.D%%%%%%%.T%%%%%%%' entries found
Info: 3 datasets ready for input processing

OPEN OUTPUT aok. Dataset name= 'DD:ZCATOUT '


Open input dataset 'MACNIVE.MONITOR.FAE3.D2009105.T0000000' aok
Open input dataset 'MACNIVE.MONITOR.FAE3.D2009106.T0000001' aok
Open input dataset 'MACNIVE.MONITOR.FAE3.D2009107.T0000004' aok
ZCAT: shall now delete input datasets
DELETE 'MACNIVE.MONITOR.FAE3.D2009105.T0000000'
DELETE 'MACNIVE.MONITOR.FAE3.D2009106.T0000001'
DELETE 'MACNIVE.MONITOR.FAE3.D2009107.T0000004'
ZCAT: 3 datasets successfully logically concatenated to
newly created 'DD:ZCATOUT ' dataset

Return Codes:
RC=00 ok
RC=01 No eligible input
RC=04 Some output okay with warnings
RC> 4 Serious error

Deleting HSISZCAT Input data sets


You can delete renamed input data sets by running HSISZCAT using the DELETE
parameter. For example:
//ZCAT EXEC PGM=HSICZCAT,PARM='UMDSN(umon.dsn.prefix),DELETE'

126 Administration Guide and Reference


IBM Confidential

Appendix A. Messages
This section lists the various messages output by Tivoli Asset Discovery for z/OS

HSIA - Automation Server messages


Return codes

0 No errors encountered. All requests processed successfully.


16 Unrecoverable error. No requests processed. SYSIN or HSIPZIP or INQSOUT
File cannot be used, or unsupported Operating System.

Message suffix codes

Suffix Meaning Raises


Minimum
Cond Code to
I Information Message 0
W Warning Message 4
E Error Message 8
S Severe Error Message 12
U Unrecoverable Error Message 16

Message texts and explanations


All numeric completion codes of system services reported in these
messages are in hexadecimal unless otherwise stated.

Programmer response: None.


HSIA001E EXPECTED CLOSE PARENTHESIS
WAS NOT FOUND IN INPUT Module: HSIACUST
RECORD
Explanation: Parsing did not detect the expected right HSIA003E AN UNRECOGNISED OPERAND WAS
parenthesis. ENCOUNTERED
System action: Terminates the processing of the Explanation: An operand other than TIME was
HSIAPARM member contents. specified.
User response: Correct the HSIAPARM member System action: Terminates the processing of the
contents. HSIAPARM member contents.
Programmer response: None. User response: Correct the HSIAPARM member
contents.
Module: HSIACUST
Programmer response: None.
HSIA002E EXPECTED OPERAND VALUE NOT Module: HSIACUST
FOUND BEFORE THE CLOSE
PARENTHESIS
HSIA004E THE TIME OPERAND VALUE IS
Explanation: No subparameter value was specified INVALID
within the parenthesis.
Explanation: The TIME operand value did not
System action: Terminates the processing of the conform to syntax requirements.
HSIAPARM member contents.
System action: Terminates the processing of the
User response: Correct the HSIAPARM member HSIAPARM member contents.
contents.

Copyright IBM Corp. 2009 127


HSIA005E HSIA012E IBM Confidential

User response: Correct the HSIAPARM member Module: HSIACUST


contents.
Programmer response: None. HSIA009E REFRESH IGNORED - COULD NOT
PROCESS BAD PARAMETERS
Module: HSIACUST
Explanation: The HSIAPARM contents contained an
error so the Automation Server could not update its
HSIA005E NO FTP OR JOB STATEMENT
operational parameters.
BEFORE DSN STATEMENT
System action: Terminates the processing of
Explanation: There is no preceding action to relate the
HSIAPARM contents.
dsname mask to.
User response: Correct the HSIAPARM member
System action: Terminates the processing of the
contents.
HSIAPARM member contents.
Programmer response: None.
User response: Correct the HSIAPARM member
contents. Module: HSIACUST
Programmer response: None.
HSIA010E NO FUNCTIONS WERE REQUESTED
Module: HSIACUST
Explanation: No actions were specified. The
Automation Server has no work to do.
HSIA006E AN UNRECOGNISED STATEMENT
TYPE WAS ENCOUNTERED System action: Terminates the processing of
HSIAPARM contents.
Explanation: A statement type other than FTP, JOB or
DSN was specified. User response: Correct the HSIAPARM member
contents.
System action: Terminates the processing of the
HSIAPARM member contents. Programmer response: None.
User response: Correct the HSIAPARM member Module: HSIACUST
contents.
Programmer response: None. HSIA011E NO DATA SET NAME MASKS WERE
SPECIFIED
Module: HSIACUST
Explanation: No work was requested. The Automation
Server has no work to do.
HSIA007E TERMINATING - HSIz AUTOMATION
SERVER IS ALREADY ACTIVE System action: Terminates the processing of
HSIAPARM contents.
Explanation: The Automation Server is already
running. Only one concurrent copy can run in an User response: Correct the HSIAPARM member
operating system image. contents.
System action: Program terminates with condition Programmer response: None.
code 16. The established Automation Server continues.
Module: HSIACUST
User response: None.
Programmer response: None. HSIA012E NUMBER OF ACTIONS EXCEEDS
MAXIMUM OF 32
Module: HSIACUST
Explanation: Too many actions were requested.
HSIA008E TERMINATING - COULD NOT System action: Terminates the processing of
INITIALISE WITH BAD PARAMETERS HSIAPARM contents.
Explanation: The HSIAPARM contents contained an User response: Reduce the number of actions
error so the Automation Server could not initialize. specified.
System action: The program terminates with condition Programmer response: None.
code 16.
Module: HSIACUST
User response: Correct the HSIAPARM member
contents.
Programmer response: None.

128 Administration Guide and Reference


IBM Confidential HSIA013E HSII001I

System action: Terminates the processing of the


HSIA013E NUMBER OF DATA SET NAME
member. If the member is HSIAPARM the Automation
MASKS EXCEEDS THE MAXIMUM OF
Server terminates. For template members the
250
Automation Server continues processing.
Explanation: Too many dataset name masks were
User response: Create the required member in the
specified.
HSIACNTL library.
System action: Terminates the processing of
Programmer response: None.
HSIAPARM contents.
Module: HSIACUST
User response: Reduce the number of dataset name
masks.
HSIA015E INPUT LOGICAL RECORD LENGTH
Programmer response: None.
WAS NOT 80
Module: HSIACUST
Explanation: A record was read from the HSIACNTL
library which was not 80 bytes long.
HSIA014E MEMBER 1 WAS NOT FOUND IN THE
System action: The program terminates and takes no
HSIACNTL FILE
actions.
Explanation:
User response: Ensure the HSIACNTL library only
Member HSIAPARM was found to be missing from the contains fixed length 80 byte records.
HSIACNTL file.
Programmer response: None.
In the message text:
Module: HSIACUST
1 name of missing member.

HSII - Utility messages


Return codes

0 No errors encountered. All requests processed successfully.


4 I/O error in one or more program libraries.
8 Error - Incomplete data. Processing continues. OPEN or other system service
error.
12 Syntax error.
16 Unrecoverable error.
20 Disastrous error. No requests processed. SYSPRINT file cannot be used.

Message suffix codes

Suffix Meaning Raises Minimum


Condition Code to
I Information Message 0
W Warning Message 4
E Error Message 8
S Severe Error Message 12
U Unrecoverable Error Message 16

Message texts and explanations


All numeric completion codes of system services reported in these
messages are in hexadecimal unless otherwise stated.
The HSIICUST program could not read commands
HSII001I Read failed for SYSIN, RC=1
from the SYSIN DDname.
Explanation:
In the message text:

Appendix A. Messages 129


HSII002I HSII010I IBM Confidential

1 The return code from EXECIO System action: The program terminates and takes no
actions.
System action: The program terminates and takes no
actions. User response: Check the return code from the
allocate command in the TSO commands manual.
User response: Correct the JCL and provide a SYSIN
Correct the options and try running the program again.
DD with valid control statements.
The probable option in error is HSIINST.
Programmer response: None.
Programmer response: None.
Module: HSIICUST
Module: HSIICUST

HSII002I Required Option 1 is missing from


HSII005I 1 failed for 2, RC=3
SYSIN
Explanation:
Explanation:
The HSIICUST program could not perform a required
The HSIICUST program did not find the required
ISPF function because an error occurred during the
option in the SYSIN supplied by the user.
ISPF function execution.
In the message text:
In the message text:
1 The name of the option that is missing.
1 The name of ISPF function that failed.
System action: The program terminates and takes no
2 The resource that caused the failure.
actions.
3 The return code from the ISPF function.
User response: Correct the SYSIN and supply the
option. System action: The program terminates and takes no
actions. The program may have written out JCL and
Programmer response: None.
parameter members. These members should be treated
Module: HSIICUST as suspect as they might contain errors in them due to
the nature of this error.
HSII003I Optional Option 1 is missing from User response: Check that the options specified do
SYSIN, default 2 is provided. not exceed the field length requirements of the various
options. If the problem persists, report the problem to
Explanation: IBM.
The HSIICUST program did not find an optional option Programmer response: None.
in the SYSIN supplied by the user.
Module: HSIICUST
In the message text:
1 The name of the option that is missing. HSII006I Model Dataset SHSISAMP has not been
2 The supplied default. found.

System action: The program continues and uses the Explanation: The HSIICUST program could not find
default as documented in the message. the SHSISAMP dataset created during installation.

User response: Supply the option and re-run the System action: The program terminates and takes no
customization program if the default is unacceptable. actions.

Programmer response: None. User response: Check that the HSI option is correctly
specified and that the installation target libraries are
Module: HSIICUST available to the customization program.
Programmer response: None.
HSII004I Allocation of dataset 1 to 2 failed, RC=3
Module: HSIICUST
Explanation:
The HSIICUST program could not allocate the dataset HSII010I 1 statement verb not one of 1
to the ddname for some reason.
Explanation:
In the message text:
During syntax parsing for a statement the verb found
1 The name of the dataset that failed allocation. does not match any of the valid verbs for the program.
2 The DD name to be allocated. In the message text:
3 The return code from the allocate command.

130 Administration Guide and Reference


IBM Confidential HSII011I HSII104I

1 The word that is not a valid verb. User response: Change the DEFINE REGION
statement to refer to a region name that does not
System action: The program terminates and takes no
already exist.
actions.
Programmer response: None.
User response: Update the statements to the program
to correct the verb in error and supply a correct verb. Module: HSIIREGN
Programmer response: None.
HSII102I Region 1 has not been defined.
Module: HSIIREGN
Explanation:
HSII011I 1 not valid for verb 1 The ASSIGN REGION statement contains a region
name that does not exist.
Explanation:
In the message text:
During syntax parsing for a statement, a word was
found that does not match the syntax of the statement 1 Region to be assigned.
for the verb that is being processed.
System action: The program does not process this
In the message text: statement. Statements following the statement in error
are not processed.
1 A word that is not valid for the statement syntax
for a verb. User response: Change the ASSIGN REGION
statement to refer to a region name that exists.
System action: The program terminates and takes no
actions. Programmer response: None.
User response: Update the statements to the program Module: HSIIREGN
to correct the statement in error.
Programmer response: None. HSII103I Inventory 1 has not been defined.
Module: HSIIREGN Explanation:
The ASSIGN INVENTORY statement contains an
HSII100I 1 Missing from configuration. inventory that does not exist.
Explanation: In the message text:
The Region Assignment utility requires the parameter 1 Inventory to be assigned.
in the TPARAM dataset.
System action: The program does not process this
In the message text: statement. Statements following the statement in error
are not processed.
1 Parameter that is missing.
User response: Change the ASSIGN INVENTORY
System action: The program terminates and takes no
statement to refer to an inventory name that exists.
actions.
Programmer response: None.
User response: Update the parameters in the
TPARAM DD to add the missing parameter. Module: HSIIREGN
Programmer response: None.
HSII104I Region 1 is already assigned to 2
Module: HSIIREGN
Explanation:
HSII101I Attempt to define region 1 failed, region The ASSIGN REGION statement contains a region
already exists. name that is to be assigned to another region, but the
region being assigned is already assigned to a region.
Explanation:
In the message text:
The DEFINE REGION statement contains a region
name that already exists. 1 Region to be assigned.
In the message text: 2 Parent region name.
1 Region to be defined. System action: The program does not process this
statement. Statements following the statement in error
System action: The program does not process this
are not processed.
statement. Statements following the statement in error
are not processed.

Appendix A. Messages 131


HSII105I HSII110I IBM Confidential

User response: Do not attempt to assign regions that this probably means that the resource specified
are already assigned. (ddname) is missing or empty. For all other error,
report the problem to IBM Service.
Programmer response: None.
Module: HSIIREGN
Module: HSIIREGN

HSII108I SQL 1 failed, SQLCODE=2


HSII105I Region 1 defined.
Explanation:
Explanation:
An error has occurred executing the SQL verb for the
The DEFINE REGION statement has executed correctly.
table specified.
In the message text:
In the message text:
1 Region to be defined.
1 SQL verb and table name.
System action: The program continues with
2 SQLCODE from failing statement.
processing.
System action: The program stop processing
User response: None.
statements. The current statement changes to DB2
Programmer response: None. tables are backed out.

Module: HSIIREGN User response: Report this error to the System


Programmer.
HSII106I Inventory 1 assigned to 2 Programmer response: Report the problem to IBM
Service.
Explanation:
Module: HSIIREGN
The ASSIGN INVENTORY statement has executed
correctly.
HSII109I Inventory 1 is already assigned to 2
In the message text:
Explanation:
1 Inventory to be assigned.
An error has occurred executing the SQL verb for the
2 Region name. table specified.
System action: The program continues with In the message text:
processing.
1 Inventory name.
User response: None.
2 Region name.
Programmer response: None.
System action: The program stop processing
Module: HSIIREGN statements. The current statement changes to DB2
tables are backed out.
HSII107I 1 from 2 failed, RC=3 User response: Report this error to the System
Explanation: Programmer.

An error has occurred executing the service for the Programmer response: Report the problem to IBM
resource specified. The service issued the return code Service.
mentioned. Module: HSIIREGN
In the message text:
1 Service that failed. HSII110I Inventory 1 removed from 2

2 Resource that failed. Explanation:

3 Return code from service. The inventory specified has been successfully removed
from the region specified.
System action: The program stop processing
statements. The current statement changes to DB2 In the message text:
tables are backed out. 1 Inventory name.
User response: Report this error to the System 2 Region name.
Programmer.
System action: The program continues processing.
Programmer response: For EXECIO READ service,

132 Administration Guide and Reference


IBM Confidential HSII111I HSII116I

User response: None. statements. The current statement changes to DB2


tables are backed out.
Programmer response: None.
User response: Remove the region assignments from
Module: HSIIREGN
the region, before trying to delete the region.
Programmer response: None.
HSII111I Inventory 1 failed removal from
2,SQLCODE=3 Module: HSIIREGN
Explanation:
HSII114I Cannot delete region 1, region has
The inventory specified has not been removed from the
inventories assigned.
region specified.
Explanation:
In the message text:
The region specified cannot be deleted because it has
1 Inventory name.
inventories assigned to it.
2 Region name.
In the message text:
3 SQL Return Code.
1 Region name.
System action: The program stop processing
System action: The program stop processing
statements. The current statement changes to DB2
statements. The current statement changes to DB2
tables are backed out.
tables are backed out.
User response: Report this error to the System
User response: Remove the inventory assignments
Programmer.
from the region, before trying to delete the region.
Programmer response: Report the problem to IBM
Programmer response: None.
Service.
Module: HSIIREGN
Module: HSIIREGN

HSII115I Region 1 deleted.


HSII112I Cannot delete region 1 - 2
Explanation:
Explanation:
The region specified has been deleted.
The region specified must not be deleted from the
database. In the message text:
In the message text: 1 Region name.
1 Region ID. System action: The program continues processing.
2 Region name. User response: None.
System action: The program stop processing Programmer response: None.
statements. The current statement changes to DB2
Module: HSIIREGN
tables are backed out.
User response: Do not delete the region specified.
HSII116I Region 1 not deleted, SQLCODE=2
Programmer response: None.
Explanation:
Module: HSIIREGN
The region specified was not deleted due to an SQL
error. SQLCODE details the error that occurred.
HSII113I Cannot delete region 1, region has
In the message text:
children.
1 Region name.
Explanation:
2 SQL Return Code.
The region specified cannot be deleted because it has
other regions assigned to it. System action: The program stop processing
statements. The current statement changes to DB2
In the message text:
tables are backed out.
1 Region name.
User response: Report this error to the System
System action: The program stop processing Programmer.

Appendix A. Messages 133


HSII117I HSII204I IBM Confidential

Programmer response: Report the problem to IBM


HSII201I 1 CSVIN dataset is not PO or PS.
Service.
Explanation:
Module: HSIIREGN
SCRT Import Utility requires the CSVIN dsn to have a
DSORG of PO or PS
HSII117I Region 1 assigned to 2
In the message text:
Explanation:
1 CSVIN dataset not PO or PS.
The region specified was assigned to a parent region.
System action: The program terminates and takes no
In the message text:
actions.
1 Region name.
User response: Ensure that the CSVIN dsn has a
2 Region name. DSORG of PO or PS before submitting the Job.

System action: The program continues processing. Programmer response: None.

User response: None. Module: HSIISCRT

Programmer response: None.


HSII202I 1 contact IBM for a GKB refresh.
Module: HSIIREGN
Explanation:
HSII118I Region 1 contains DBCS characters. The SCRT Import utility has detected a missing PID
Explanation: In the message text:
The region name specified must not contain DBCS 1 PID is missing.
characters.
System action: The program continues.
In the message text:
User response: Contact IBM for a Global Knowledge
1 Region name. Base (GKB) refresh. Include the missing PID number.
System action: The program stop processing Programmer response: None.
statements. The current statement changes to DB2
Module: HSIISCRT
tables are backed out.
User response: Do not put DBCS characters in the
HSII203I 1 Update failed.
region name.
Explanation:
Programmer response: None.
The SCRT Import Utility has failed to update a table.
Module: HSIIREGN
In the message text:
HSII200I 1 DDname CSVIN is missing. 1 Table update failed.
Explanation: System action: The program terminates and takes no
actions.
The SCRT Import utility requires the DDname CSVIN
User response: Examine the SQL return code to
In the message text:
determine the cause of the error. Contact IBM support
1 DDname that is missing. with this information.

System action: The program terminates and takes no Programmer response: None.
actions.
Module: HSIISCRT
User response: Add the CSVIN DDname to the JCL
and include the required input dataset containing data
HSII204I 1.
from the IBM SCRT tool.
Explanation:
Programmer response: None.
SCRT Import Utility Summary Report heading.
Module: HSIISCRT
In the message text:
1 Summary Report heading.

134 Administration Guide and Reference


IBM Confidential HSII205I HSII304I

System action: The program continues and takes no User response: Informational message, no action
actions. required.
User response: Display summary heading of SCRT Programmer response: None.
Import Utility. This will be followed by information
Module: HSIIKBT
lines detailing counts of CPC, LPAR and PIDs added to
DB2 tables.
HSII302I SQL warning for 1.
Programmer response: None.
Explanation:
Module: HSIISCRT
SQL warning from a command
HSII205I 1. In the message text:
Explanation: 1 SQL warning.
Summarize all table additions at the conclusion of the System action: The program continues.
SCRT Import Utility.
User response: Issue a warning message if the
In the message text: SQLCODE is not equal to 0 or 100.
1 Table additions from SCRT Import Utility Programmer response: None.
System action: The program continues and takes no Module: HSIIKBT
actions.
User response: Display a summary detailing counts of HSII303I SQL error for 1.
CPC, LPARs and PIDs, LPAR and PIDs added to DB2
tables. Explanation:

Programmer response: None. The XML Export Utility has encountered an error.

Module: HSIISCRT In the message text:


1 SQL Error.
HSII300I Error writing to 1. System action: The program terminates and takes no
Explanation: actions.

The XML Export utility has a problem writing the XML User response: Examine the SQL return code to
file determine the cause of the error. Contact IBM support
with this information.
In the message text:
Programmer response: None.
1 Error writing to DDNAME
Module: HSIIKBT
System action: The program terminates and takes no
further actions.
HSII304I 1.
User response: Check the Return Code and any
preceding messages. Explanation:

Programmer response: None. The XML Export Utility has encountered a DSNREXX
error.
Module: HSIIKBT
In the message text:

HSII301I Number of lines written to SWKBTXML 1 DSNREXX error.


DD is1. System action: The program terminates and takes no
Explanation: actions.

No. of Lines written to SWKBTXML DD by the XML User response: Examine the preceding error messages
Export utility. to determine the error. Contact IBM if you cannot
resolve the problem
In the message text:
Programmer response: None.
1 Lines written to SWKBTXML DD.
Module: HSIIKBT
System action: The program continues and takes no
actions.

Appendix A. Messages 135


HSII305I HSIP004S IBM Confidential

System action: The program terminates and takes no


HSII305I Invalid schema 1.
actions.
Explanation:
User response: Ensure that the correct Schema is
The XML Export Utility has encountered a problem being used.
with an invalid Schema.
Programmer response: None.
In the message text:
Module: HSIIKBT
1 Invalid Schema

HSIP - Inquisitor for z/OS messages and codes


Return codes

0 No errors encountered. All requests processed successfully.


4 I/O error in one or more program libraries.
8 Error - Incomplete data. Processing continues. OPEN or other system service
error.
12 Syntax error.
16 Unrecoverable error. No requests processed. SYSIN or HSIPZIP or HSIPOUT File
cannot be used, or unsupported Operating System.
20 Disastrous error. No requests processed. SYSPRINT file cannot be used.

Message suffix codes

Suffix Meaning Raises Minimum


Condition Code to
I Information Message 0
W Warning Message 4
E Error Message 8
S Severe Error Message 12
U Unrecoverable Error Message 16

Message texts and explanations


All numeric completion codes of system services reported in these
messages are in hexadecimal unless otherwise stated.
CANNOT OPEN SYSIN FILE
HSIP000U PROCESSING TERMINATED - NO
USABLE SYSPRINT FILE Explanation: The OPEN of the SYSIN file failed.
Explanation: The OPEN of the SYSPRINT file failed. System action: Terminates with a condition code of
Note: This message is issue by WTO with 16.
ROUTCDE=(2,11). All other messages are written to the
SYSPRINT file. User response: Ensure a usable SYSIN file is allocated.

System action: Terminates with a condition code of Programmer response: None.


20. Module: HSIPINQ
User response: Ensure a usable SYSPRINT file is
allocated. The program overrides any unacceptable HSIP004S PROCESSING TERMINATED -
DCB values. UNKNOWN VERB 1
Programmer response: None. Explanation:
Module: HSIPINQ Parsing detected unrecognised data when looking for a
verb.
HSIP001U PROCESSING TERMINATED - In the message text:

136 Administration Guide and Reference


IBM Confidential HSIP005S HSIP011I

1 name of the encountered verb.


HSIP008S PROCESSING TERMINATED -
System action: Terminates with a condition code of EXPECTED LEFT PARENTHESIS
12. MISSING

User response: Correct the SYSIN file contents and Explanation: Parsing did not detect the expected left
rerun the program. parenthesis.

Programmer response: None. System action: Terminates with a condition code of


12.
Module: HSIPINQ
User response: Correct the SYSIN file contents and
rerun the program.
HSIP005S PROCESSING TERMINATED -
UNKNOWN OPERAND 1 Programmer response: None.
Explanation: Module: HSIPINQ
Parsing detected unrecognised data when looking for
an operand. HSIP009S PROCESSING TERMINATED -
EXPECTED RIGHT PARENTHESIS
In the message text: MISSING
1 name of the encountered operand. Explanation: Parsing did not detect the expected right
System action: Terminates with a condition code of parenthesis.
12. System action: Terminates with a condition code of
User response: Correct the SYSIN file contents and 12.
rerun the program. User response: Correct the SYSIN file contents and
Programmer response: None. rerun the program.

Module: HSIPINQ Programmer response: None.


Module: HSIPINQ
HSIP006S PROCESSING TERMINATED -
UNEXPECTED LEFT PARENTHESIS HSIP010U PROCESSING TERMINATED,
ENCOUNTERED OPERATING SYSTEM NOT
Explanation: Parsing detected a left parenthesis at an SUPPORTED - CODE 1
unexpected location. Explanation:
System action: Terminates with a condition code of The value of the byte at CVTDCB was not X9B.
12.
In the message text:
User response: Correct the SYSIN file contents and
rerun the program. 1 hexadecimal value of first byte of CVTDCB.
Programmer response: None. System action: Terminates with a condition code of
16.
Module: HSIPINQ
User response: This version of the Inquisitor cannot
be run on this Operating System. If necessary, contact
HSIP007S PROCESSING TERMINATED - IBM support.
UNEXPECTED RIGHT PARENTHESIS
ENCOUNTERED Programmer response: None.
Explanation: Parsing detected a right parenthesis at an Module: HSIPINQ
unexpected location.
System action: Terminates with a condition code of HSIP011I MISSING RIGHT PARENTHESIS
12. ASSUMED

User response: Correct the SYSIN file contents and Explanation: End-of-file was detected for SYSIN
rerun the program. before an expected right parenthesis was detected.

Programmer response: None. System action: The request is accepted and processing
continues.
Module: HSIPINQ
User response: Correct the SYSIN file contents to
avoid this message.

Appendix A. Messages 137


HSIP012S HSIP017E IBM Confidential

Programmer response: None.


HSIP015I VOLUMES=1 DATASETS=2 BAD-D/S=3
Module: HSIPINQ PROGRAMS=4
Explanation:
HSIP012S PROCESSING TERMINATED -
Processing of a request has been completed. Statistics
MISSING OPERAND
related to the request are shown.
SUBPARAMETER FOR 1
In the message text:
Explanation:
1 count of volumes scanned for this request.
A required subparameter of an operand was not
specified. 2 count of data sets successfully processed.
In the message text: 3 count of data sets which could not be processed.
1 name of the operand being processed. 4 count of programs processed for this request.
System action: Terminates with a condition code of System action: Processing continues.
12.
User response: None.
User response: Correct the SYSIN file contents and
Programmer response: None.
rerun the program.
Module: HSIPINQ
Programmer response: None.
Module: HSIPINQ
HSIP016I ACCEPTED REQUEST NUMBER 1
Explanation:
HSIP013S PROCESSING TERMINATED - E-O-F
INSTEAD OF EXPECTED Parsing of a request has been completed successfully.
CONTINUATION The request is stored for subsequent processing.
Explanation: End-of-file was detected for SYSIN In the message text:
instead of an expected record required to continue the
current statement being parsed. 1 sequence number of the request.

System action: Terminates with a condition code of System action: Processing continues.
12. User response: None required.
User response: Correct the SYSIN file contents and Programmer response: None.
rerun the program.
Module: HSIPINQ
Programmer response: None.
Module: HSIPINQ HSIP017E DYNALLOC FAILURE: RC=1 ERROR=2
INFO=3 VOLUME=4
HSIP014I COMPLETED REQUEST NUMBER 1 - Explanation:
PROCESSING STATISTICS ARE:
A data set could not be dynamically. allocated. See
Explanation: message HSIP080I for the name of the. dataset that
Processing of a request has been completed. A incurred the problem.
HSIP015I message follows containing the statistics for In the message text:
the request.
1 return code of the DYNALLOC macro.
In the message text:
2 dynamic allocation return code (DARC).
1 sequence number of the request.
3 dynamic allocation information code.
System action: Processing continues.
4 volume serial number of the data set.
User response: None.
System action: Processing of this data set is
Programmer response: None. terminated.
Module: HSIPINQ User response: If necessary, rerun when the file is
available for use. Note: The meanings of many DARC
values are usually available in Appendix A of the ISPF
Tutorial.
Programmer response: None.

138 Administration Guide and Reference


IBM Confidential HSIP018E HSIP024S

Module: HSIPINQ Module: HSIPINQ

HSIP018E VTOC DYNALLOC FAILURE: RC=1 HSIP022W I/O ERR MEMBER 1 IN 2


ERROR=2 INFO=3 VOLUME=4
Explanation:
Explanation:
An I/O error was encountered while reading the
A VTOC could not be dynamically allocated. macro. contents of a load module.
In the message text: In the message text:
1 return code of the DYNALLOC 1 name of the program being processed.
2 dynamic allocation return code (DARC). 2 name of the data set being processed.
3 dynamic allocation information code. System action: Processing of this member continues.
4 volume serial number of the data set. User response: None required.
System action: Processing of this volume is Programmer response: None.
terminated.
Module: HSIPINQ
User response: If necessary, rerun when the VTOC is
available for use to process this volume. Note: The
HSIP023E ABEND 1 IN OPEN FOR 2
meanings of many DARC values are usually available
in Appendix A of the ISPF Tutorial. Explanation:
Programmer response: None. An abnormal end occurred while opening a data set.
Module: HSIPINQ In the message text:
1 hexadecimal system abend and reason
HSIP020I 1 INQUISITOR OUTPUT RECORDS
WRITTEN 2 name of the data set being processed.

Explanation: System action: Processing of this data set is


terminated.
Processing has concluded and all data files have been
closed. User response: None required, but you may wish to
exclude the data set from processing, or correct the
In the message text: cause of the abend.
1 number of records written. Programmer response: None.
System action: Termination continues. Module: HSIPINQ
User response: None required.
HSIP024S PROCESSING TERMINATED - BAD
Programmer response: None.
UCBSCAN RETURN CODE OF HEX 1
Module: HSIPINQ
Explanation:
An unexpected return code was received from
HSIP021S PROCESSING TERMINATED -
UCBSCAN.
INVALID OPERAND SUBPARAMETER
FOR 1 In the message text:
Explanation: 1 hexadecimal return code of the
The specified subparameter of an operand was not System action: Processing of volume scanning for this
valid. request is terminated.
In the message text: User response: Rerun the program when no dynamic
reconfiguration changes are being implemented.
1 name of the operand being processed.
Programmer response: None.
System action: Terminates with a condition code of
12. Module: HSIPINQ
User response: Correct the SYSIN file contents and
rerun the program.
Programmer response: None.

Appendix A. Messages 139


HSIP025U HSIP032I IBM Confidential

2 count of load module text blocks written.


HSIP025U PROCESSING TERMINATED -
CANNOT OPEN HSIPOUT FILE System action: Processing continues.
Explanation: The OPEN of the HSIPOUT file failed. User response: None required. The DUMPTEXT
operand should only be specified at the request of IBM
System action: Terminates with a condition code of
support.
16.
Programmer response: None.
User response: Ensure that the allocated HSIPOUT file
is usable, or omit the HSIPOUT file in favour of using Module: HSIPINQ
the HSIPZIP file.
Programmer response: None. HSIP030I DUMPTEXT OPERAND IGNORED
FOR SCANDIR VERB
Module: HSIPINQ
Explanation: A DUMPTEXT operand was encountered
for a SCANDIR request. That is, the possible dumping
HSIP026E I/O ERROR ENCOUNTERED
of load module text blocks was specified in a request
READING VTOC OF VOLUME 1 ON
which does not have access to text blocks.
DEVICE 2
System action: The DUMPTEXT operand is ignored
Explanation:
and processing continues.
An I/O error was encountered while reading a VTOC.
User response: Remove the DUMPTEXT operand to
In the message text: avoid this message. The DUMPTEXT operand should
only be specified at the request of IBM support.
1 volume serial number being processed.
Programmer response: None.
2 device number of the volume.
Module: HSIPINQ
System action: Processing of this track of the VTOC is
terminated.
HSIP031I BAD SELECTION CRITERIA FOR 2
User response: None required, but you may wish to
exclude the volume from processing, or correct the Explanation:
cause of the I/O error.
Processing of a data set was specified but attributes did
Programmer response: None. not match other selection criteria also specified in the
request. This message is followed by HSIP038I which
Module: HSIPINQ
details the cause.
In the message text:
HSIP028U PROCESSING TERMINATED -
CANNOT OPEN HSIPDMP FILE 2 name of the data set being processed.
Explanation: The OPEN of the HSIPDMP file failed System action: Processing of this data set is
after DUMPTEXT was specified. terminated.
System action: Terminates with a condition code of User response: If this data set is a program library
16. which should be processed by the Inquisitor then
modify or remove the conflicting selection criteria.
User response: Ensure a usable HSIPDMP file is
allocated, or remove all DUMPTEXT operands from Programmer response: None.
the contents of the SYSIN file. The DUMPTEXT
Module: HSIPINQ
operand should only be specified at the request of IBM
support.
HSIP032I OBTAIN FAILED RC=1 VOLUME 2
Programmer response: None.
Explanation:
Module: HSIPINQ
The system could not read the VTOC entry for the data
set named in the HSIP033I message which follows this
HSIP029I TEXT-DUMPS=2
message. This message is only issued when a program
Explanation: parameter of DSNMSG or ALLMSG is specified.
Processing of a request with DUMPTEXT specified has In the message text:
completed. This message follows HSIP015I.
1 hexadecimal return code of the OBTAIN macro.
In the message text:
2 volume serial number being processed.

140 Administration Guide and Reference


IBM Confidential HSIP033I HSIP039S

System action: Processing of this data set is In the message text:


terminated.
1 volume serial number being processed.
User response: Ensure the relevant catalog entry is
2 device number of the volume.
correct. Ensure the relevant volume is online and
available to the system. Ensure there is no I/O error in System action: Processing of this track of the VTOC is
the relevant volumes VTOC. Contact System Support terminated.
for further assistance in diagnosis.
User response: None required, but you may wish to
Programmer response: None. exclude the volume from processing, or correct the
cause of the I/O error.
Module: HSIPINQ
Programmer response: None.
HSIP033I OBTAIN FAILED FOR DATASET 1 Module: HSIPINQ
Explanation:
HSIP037E SECURITY ACCESS DENIED FOR 1
The system could not read the VTOC entry for the data
set on the volume named in the previous HSIP032I Explanation:
message. This message is only issued when a program
parameter of DSNMSG or ALLMSG is specified. A RACROUTE macro determined the program had
insufficient security access to read the data set.
In the message text:
In the message text:
1 name of the data set being processed.
1 name of the data set being processed.
System action: Processing of this data set is
terminated. System action: Processing of this data set is
terminated.
User response: Ensure the relevant catalog entry is
correct. Ensure the relevant volume is online and User response: Contact Security Administration to
available to the system. Ensure there is no I/O error in obtain sufficient security access to read the data set or
the relevant volumes VTOC. Contact System Support exclude the data set from processing.
for further assistance in diagnosis. Programmer response: None.
Programmer response: None. Module: HSIPINQ
Module: HSIPINQ
HSIP038I BAD SELECTION CRITERIA WAS 1
HSIP034I REFER DATE WAS 1 FOR 2 Explanation:
Explanation: Processing of a data set was specified but attributes did
A load library was opened. The reference date of the not match other selection criteria also specified in the
data set before the OPEN is reported in this message. request. This message follows HSIP031I which shows
This message is only issued when a program parameter the data set name.
of DSNMSG or ALLMSG is specified. In the message text:
In the message text: 1 cause of the data set processing failure.
1 the Julian reference date from the VTOC entry. System action: Processing of this data set is
2 name of the data set being processed. terminated.

System action: Processing of this data set continues. User response: If this data set is a program library
which should be processed by the Inquisitor then
User response: None required. modify or remove the conflicting selection criteria.
Programmer response: None. Programmer response: None.
Module: HSIPINQ Module: HSIPINQ

HSIP036E OPEN ERROR ENCOUNTERED HSIP039S PROCESSING TERMINATED - ALL


READING VTOC OF VOLUME 1 ON POSSIBLE DATA SETS ARE
DEVICE 2 EXCLUDED
Explanation: Explanation: An exclusion mask has been specified
which excludes all possible data sets included by a
The VTOC of the volume shown could not be opened.

Appendix A. Messages 141


HSIP040S HSIP046I IBM Confidential

selection mask. Both masks are shown after this


HSIP043I MODULE/CSECT OPERAND
message.
IGNORED FOR SCANDIR VERB
System action: Terminates with a condition code of
Explanation: A MODULE operand was encountered
12.
for a SCANDIR request. That is, the output of program
User response: Modify or remove the conflicting structure data was requested in a request which does
selection criteria. not have access to this data.

Programmer response: None. System action: The MODULE operand is ignored and
processing continues.
Module: HSIPINQ
User response: Remove the MODULE operand to
avoid this message.
HSIP040S PROCESSING TERMINATED - ALL
POSSIBLE DASD VOLUMES ARE Programmer response: None.
EXCLUDED
Module: HSIPINQ
Explanation: An exclusion mask has been specified
which excludes all possible DASD volumes included by
HSIP044I XMODULE/XCSECT OPERAND
a selection mask. Both masks are shown after this
IGNORED FOR SCANDIR VERB
message.
Explanation: An XMODULE operand was
System action: Terminates with a condition code of
encountered for a SCABDIR request. That is, the output
12.
of program structure data was implied in a request
User response: Modify or remove the conflicting which does not have access to this data.
selection criteria.
System action: The XMODULE operand is ignored
Programmer response: None. and processing continues.

Module: HSIPINQ User response: Remove the XMODULE operand to


avoid this message.

HSIP041S PROCESSING TERMINATED - ALL Programmer response: None.


POSSIBLE PROGS ARE EXCLUDED
Module: HSIPINQ
Explanation: An exclusion mask has been specified
which excludes all possible programs included by a
HSIP045I THE XDSNAME MASK IS NOT A
selection mask. Both masks are shown after this
SUBSET OF ANY DSNAME MASK
message.
Explanation: The mask specified in the XDSNAME
System action: Terminates with a condition code of
operand excludes possible values not included in the
12.
DSNAME operand. This message is issued to highlight
User response: Modify or remove the conflicting possible inconsistencies in a request.
selection criteria.
System action: Processing continues.
Programmer response: None.
User response: Recode the XDSNAME operand as a
Module: HSIPINQ further qualification of the DSNAME operand to avoid
this message.

HSIP042S PROCESSING TERMINATED, ALL Programmer response: None.


POSSIBLE MODULES ARE EXCLUDED
Module: HSIPINQ
Explanation: An exclusion mask has been specified
which excludes all possible modules included by a
HSIP046I THE XVOLUME MASK IS NOT A
selection mask.
SUBSET OF ANY VOLUME MASK
System action: Terminates with a condition code of
Explanation: The mask specified in the XVOLUME
12.
operand excludes possible values not included in the
User response: Modify or remove the conflicting VOLUME operand. This message is issued to highlight
selection criteria. If no CSECT-level records are required possible inconsistencies in a request.
then omit both MODULE and XMODULE operands.
System action: Processing continues.
Programmer response: None.
User response: Recode the XVOLUME operand as a
Module: HSIPINQ further qualification of the VOLUME operand to avoid
this message.

142 Administration Guide and Reference


IBM Confidential HSIP047I HSIP054I

Programmer response: None. System action: Processing continues.


Module: HSIPINQ User response: None required.
Programmer response: None.
HSIP047I THE XPROGRAM MASK IS NOT A
Module: HSIPINQ
SUBSET OF ANY PROGRAM MASK
Explanation: The mask specified in the XPROGRAM
HSIP051I ******** PARSE ONLY REQUEST
operand excludes possible values not included in the
PROCESSED - NO ACTION TAKEN
PROGRAM operand. This message is issued to
********
highlight possible inconsistencies in a request.
Explanation: Processing of a SCANCMD request has
System action: Processing continues.
completed.
User response: Recode the XPROGRAM operand as a
System action: Processing continues.
further qualification of the PROGRAM operand to
avoid this message. User response: None required.
Programmer response: None. Programmer response: None.
Module: HSIPINQ Module: HSIPINQ

HSIP048I THE XMODULE MASK IS NOT A HSIP052U PROCESSING TERMINATED -


SUBSET OF ANY MODULE MASK MISSING HSIPOUT AND HSIPZIP
FILES
Explanation: The mask specified in the XMODULE
operand excludes possible values not included in the Explanation: Neither an HSIPOUT nor an HSIPZIP
MODULE operand. This message is issued to highlight file is allocated. At least one output file is required.
possible inconsistencies in a request.
System action: Terminates with a condition code of
System action: Processing continues. 16.
User response: Recode the XMODULE operand as a User response: Specify an output file and rerun the
further qualification of the MODULE operand to avoid job.
this message.
Programmer response: None.
Programmer response: None.
Module: HSIPINQ
Module: HSIPINQ
HSIP053U PROCESSING TERMINATED -
HSIP049I THE XSTOGROUP MASK IS NOT A COMPRESSION SUBROUTINE ERROR
SUBSET OF ANY STOGROUP MASK
Explanation: While processing the HSIPZIP file the
Explanation: The mask specified in the XSTOGROUP compression subroutine encountered an error. The error
operand excludes possible values not included in the message from the compression subroutine immediately
STOGROUP operand. This message is issued to follows this message.
highlight possible inconsistencies in a request.
System action: Terminates with a condition code of
System action: Processing continues. 16.
User response: Recode the XSTOGROUP operand as a User response: Correct the error described in the
further qualification of the STOGROUP operand to message from the compression subroutine. If necessary,
avoid this message. contact IBM support.
Programmer response: None. Programmer response: None.
Module: HSIPINQ Module: HSIPINQ

HSIP050I MODULES=1 HSIP054I FULLDIR OPERAND IGNORED FOR


SCANDIR VERB
Explanation:
Explanation: A FULLDIR operand was encountered
Processing of a request with MODULE specified has
for a SCANDIR request. That is, the processing of load
completed. This message follows HSIP015I.
module member data was specified in a request which
In the message text: does not have access to this data.
1 count of CSECTs processed in this request.

Appendix A. Messages 143


HSIP056I HSIP060S IBM Confidential

System action: The FULLDIR operand is ignored and


HSIP058S PROCESSING TERMINATED -
processing continues.
DUPLICATE OPERAND
User response: Remove the FULLDIR operand to ENCOUNTERED: 1
avoid this message.
Explanation:
Programmer response: None.
An input request was found to have the indicated
Module: HSIPINQ operand specified more than once.
In the message text:
HSIP056I 1 2 COMMENCING SCAN OF
1 name of the duplicate operand
VOLUME 3 ON UNIT 4
System action: Terminates with a condition code of
Explanation:
12.
A request without the CATALOG keyword began
User response: Correct the SYSIN file contents and
processing a DASD volume. This message provides
rerun the program.
feedback on the progress of long-running Inquisitor
requests. Programmer response: None.
In the message text: Module: HSIPINQ
1 Date of message.
HSIP059E BINDER FAILURE FOR MEMBER 1
2 Time of message.
RC=2 REASON=3
3 Serial number of volume being
Explanation:
4 Device number of volume being
The Binder could not successfully process a member of
System action: Processing continues. a PDSE. The Binder Fast Data Access API return and
reason codes provide more detailed indicators of the
User response: None required. cause. If the reason code is 1080003A then ensure that
Programmer response: None. your system has fixes for IBM APARs OA08880 and
OA09299 applied.
Module: HSIPINQ
In the message text:

HSIP057E ABEND 1 IN OPEN FOR VTOC OF 1 name of the member being processed.
VOLUME 2 ON UNIT 3 2 hexadecimal Binder FDA API return code.
Explanation: 3 hexadecimal Binder FDA API reason code.
A request without the CATALOG keyword attempted System action: Terminates data collection for this
to open a DASD volume VTOC and the OPEN member, writes out data already collected and
abended. The volume is not usable. continues processing the next member.
In the message text: User response: None required.
1 Hexadecimal system abend and reason codes. Programmer response: None.
2 Serial number of volume being processed. Module: HSIPINQ
3 Device number of volume being processed.
System action: Processing of this volume is HSIP060S PROCESSING TERMINATED -
terminated. SYMBOL SUBSTITUTION FAILURE -
ASASYMBP RC=1
User response: Vary the volume offline, and/or
reformat the volume. Institute any appropriate volume Explanation:
recovery procedures. The system symbol substitution routine could not
Programmer response: None. successfully perform symbol substitution. Data before
and after substitution is shown in the SYSPRINT file.
Module: HSIPINQ
In the message text:
1 hexadecimal return code.
System action: Terminates with a condition code of
12.

144 Administration Guide and Reference


IBM Confidential HSIP061I HSIP066E

User response: Correct or remove the symbols in Module: HSIPINQ


control statement input.
Programmer response: None. HSIP064E ABEND 1 FOR 2 IN 3
Module: HSIPINQ Explanation:
A subtask processing a program object from a PDSE
HSIP061I 1 NON-REEDITABLE IN 2 has abended. The abend probably occurred in the
Program Binder API.
Explanation:
In the message text:
A program object in a PDSE was encountered which
has been marked non-reprocessable by the program 1 Hexadecimal system abend code.
binder. This message is only issued when a program
2 Name of the member being processed.
parameter of PGMMSG or ALLMSG is specified.
3 Name of the data set being processed.
In the message text:
System action: Data collected for this member so far
1 Name of program which is not reprocessable.
is retained. Other Data Management abends may
2 Name of the data set being processed. follow, especially in CLOSE processing, which are
unrecoverable and may abend the main Inquisitor task.
System action: Further data collection for this member
is terminated. User response: Exclude the programs causing the
failure and rerun the Job. Ensure the fix for IBM APAR
User response: None required.
OW47547 is applied to your system.
Programmer response: None.
Programmer response: None.
Module: HSIPINQ
Module: HSIPINQ

HSIP062S PROCESSING TERMINATED, THE


HSIP065S PROCESSING TERMINATED - MCDS
CATALOG REQUEST NEEDS EXACTLY
FILE FAILED VERIFICAION
ONE DSNAME MASK
Explanation: The MCDS data definition (DD) was
Explanation: A request with the CATALOG operand
found to be unusable by by the Inquisitor. One or more
either omitted the DSNAME operand or specified more
of the following is true: o The MCDS file could not be
than one DSNAME mask.
opened. Message HSIP066E follows. o The MCDS file is
System action: Terminates with a condition code of not a VSAM key-sequenced data set (KSDS) o The
12. KSDS relative key position (RKP) is not zero (0). o The
KSDS key length is not forty-four (44).
User response: Correct the SYSIN file contents and
rerun the program. To process multiple data set name System action: Terminates with a condition code of
masks via the CATALOG specify a separate Inquisitor 12.
request for each mask. There is no programmed limit to
User response: Either ensure that the Inquisitor has
the number of requests which can be processed in a
read access to DFHSMs MCDS, or recode the
single Inquisitor run.
Inquisitor request(s) so that the MCDS is not required.
Programmer response: None. MCDS access is required if either or both of the
REMIGRATE and NOML2 keywords are specified.
Module: HSIPINQ
Programmer response: None.

HSIP063S PROCESSING TERMINATED, ALL Module: HSIPINQ


POSSIBLE STORAGE GROUPS ARE
EXCLUDED
HSIP066E MCDS OPEN ERROR - RC=1
Explanation: An exclusion mask has been specified REASON=2
which excludes all possible storage groups included by
Explanation:
the selection mask. Both masks are shown after this
message. The OPEN of the MCDS data definition (DD) was not
successful.
System action: Terminates with a condition code of
12. In the message text:
User response: Modify or remove the conflicting 1 VSAM OPEN hexadecimal return code.
selection criteria.
2 VSAM OPEN hexadecimal reason code.
Programmer response: None.

Appendix A. Messages 145


HSIP067E HSIP071W IBM Confidential

System action: Issues message HSIP065S and


HSIP069U PROCESSING TERMINATED -
terminates with a condition code of 12.
PROGRAM IS NOT APF
User response: Either ensure that the Inquisitor has AUTHORIZED
read access to DFHSMs MCDS, or recode the
Explanation: The Inquisitor has determined that it is
Inquisitor request(s) so that the MCDS is not required.
not running in an APF authorized environment, and
MCDS access is required if either or both of the
PARM=NOAPF was not specified.
REMIGRATE and NOML2 keywords are specified.
System action: Terminates with a condition code of
Programmer response: None.
20.
Module: HSIPINQ
User response: Ensure that the HSIPINQ program is
run in an APF authorized environment, or specify
HSIP067E MCDS READ RC=1 REASON=2 FOR 3 PARM=NOAPF in the JCL.

Explanation: Programmer response: None.

The MCDS record of a data set cataloged on volume Module: HSIPINQ


MIGRAT could not be read. Either the record is missing
or there was an I/O error.
HSIP070E BAD BLKSIZE AFTER OPEN FOR 1
In the message text:
Explanation:
1 VSAM GET hexadecimal return code.
A BPAM DCB was opened for the named PDS, but
2 VSAM GET hexadecimal reason code. despite the VTOC entry indicating a suitable blocksize,
the blocksize in the DCB after the OPEN was not
3 name of data set cataloged on volume MIGRAT. positive.
System action: Processing of this data set is In the message text:
terminated.
1 name of the data set being processed.
User response: If the data set is not really migrated
then correct the catalog entry. If the MCDS is corrupt System action: Processing of member contents for this
then begin recovery procedures. data set is terminated to avoid an S002-30 abend.

Programmer response: None. User response: The PDS is probably corrupt and
should be deleted. Recreate it from a backup if
Module: HSIPINQ appropriate.
Programmer response: None.
HSIP068E CATALOG RC=1 RSN=2,3 4
Module: HSIPINQ
Explanation:
The Catalog Search Interface returned an entry which is HSIP071W IGNORING INVALID DSNAME IN 1
flagged as being in error by Catalog Management.
Explanation:
In the message text:
The Catalog Search Interface (CSI) returned a data set
1 Catalog Management decimal return code. name with invalid characters. Although VTOC entries
2 Catalog Management decimal reason code. can contain keys that are not valid data set names, such
entries cannot be cataloged. Therefore the entry
3 Catalog Management module identifier. returned from the CSI does not represent an actual data
4 name of catalog entry in error. set.

System action: Processing of this data set is In the message text:


terminated. 1 name of the catalog being processed.
User response: Correct the catalog entry. Refer to the System action: The returned catalog entry is
System Messages manual for message IDC3009I to find discarded.
out the meaning of the Catalog Management error
codes. User response: Ensure that the named catalog is not
corrupt and contains no invalid entries.
Programmer response: None.
Programmer response: None.
Module: HSIPINQ
Module: HSIPINQ

146 Administration Guide and Reference


IBM Confidential HSIP072I HSIP077E

HSIP072I BYPASS PROCESSING DATA SET 1 HSIP075W FDRABR ABEND 1 CHECKING 2


Explanation: Explanation:
The name of the data set indicated that it does not An abend occurred during ABR processing while
contain programs which would normally be executed, checking a data set which may have been archived.
and therefore the Inquisitor skipped processing it. This
In the message text:
message is only issued when a program parameter of
DSNMSG or ALLMSG is specified. 1 hexadecimal system abend code.
In the message text: 2 name of the data set being processed.
1 name of the data set being bypassed. System action: Processing of this data set is
terminated.
System action: The data set is not opened, and no
data from it is collected. User response: Ensure the catalog entry for the data
set is correct.
User response: None required, but if the data set must
be processed then specify its name in an inclusion Programmer response: None.
mask without any generic masking characters, either by
adding this mask to the existing request, or by adding Module: HSIPINQ
an additional request to the same Inquisitor run.
Programmer response: None. HSIP076E BAD LOAD 1-2: 3 4

Module: HSIPINQ Explanation:


The Inquisitor attempted to load a product tag data
HSIP073I NO DATA WAS EXTRACTED FROM 1 module from the named data set, but LOAD issued the
displayed abend code.
Explanation:
In the message text:
The data set contained no members eligible for
selection. This message is only issued when a program 1 abend code returned by LOAD.
parameter of DSNMSG or ALLMSG is specified. 2 abend reason code returned by LOAD.
In the message text: 3 name of the member containing the tag data.
1 name of the processed data set. 4 name of the data set containing the tag data
System action: The data set was opened, but no data module.
from it is collected. System action: Processing continues with the next
User response: None required. member in the data set.

Programmer response: None. User response: Verify that the named data set contains
no unusable modules. If necessary, delete any modules
Module: HSIPINQ that are of no further use.
Programmer response: None.
HSIP074S PROCESSING TERMINATED, ABRIN
OR ABRPRINT FILES NOT Module: HSIPINQ
ALLOCATED
Explanation: A request had ABRMIG and/or HSIP077E ISITMGD RC=1 RSN=2 FOR 3
ABRARC specified but at least one of the required Explanation:
ABRIN and ABRPRINT files was not defined in the
JCL. The Inquisitor executed an ISITMGD macro for the
named data set, but ISITMGD issued a non-zero return
System action: Terminates with a condition code of code.
12.
In the message text:
User response: Ensure the required files are
pre-allocated for the Inquisitor. 1 decimal return code issued by ISITMGD.

Programmer response: None. 2 hexadecimal reason code issued by ISITMGD.

Module: HSIPINQ 3 name of the data set being processed.


System action: Processing continues with the next
data set.

Appendix A. Messages 147


HSIP078E HSIP999U IBM Confidential

User response: Consult the applicable DFSMS Macro 1 return code from the Catalog Search Interface.
Instructions for Data Sets manual to determine the
System action: Processing catalog entries for the
meaning of the ISITMGD return and reason codes.
request is terminated.
Ensure that the named data set is a valid and accessible
partitioned data set. If necessary, gather appropriate User response: Correct any related catalog errors.
diagnostic materials and contact IBM support.
Programmer response: None.
Programmer response: None.
Module: HSIPINQ
Module: HSIPINQ

HSIP098E CATALOG SEARCH INTERFACE


HSIP078E DESERV RC=1 RSN=2 FOR 3 ERROR RC=1 CATALOG RC=2 REAS=3
Explanation: Explanation:
The Inquisitor executed a DESERV FUNC=GET_ALL A request with the CATALOG keyword was specified,
macro for the named data set, but DESERV issued a and the Catalog Search Interface encountered an error.
non-zero return code.
In the message text:
In the message text:
1 return code from the Catalog Search Interface.
1 decimal return code issued by DESERV.
2 return code from Catalog Management.
2 hexadecimal reason code issued by DESERV.
3 reason code from Catalog Management.
3 name of the data set being processed.
System action: Processing catalog entries for the
System action: Processing continues with the next request is terminated.
data set.
User response: Correct any related catalog errors.
User response: Consult the applicable DFSMS Macro
Instructions for Data Sets manual to determine the Programmer response: None.
meaning of the DESERV return and reason codes. Module: HSIPINQ
Ensure that the named data set is a valid and accessible
partitioned data set. If necessary, gather appropriate
diagnostic materials and contact IBM support. HSIP099E CATALOG SEARCH INTERFACE
ERROR RC=1 CATALOG RC=2 REAS=3
Programmer response: None. MODULE=4
Module: HSIPINQ Explanation:
A request with the CATALOG keyword was specified,
HSIP080I DYNALLOC FAILURE: DSN=1 and the Catalog Search Interface encountered an error.
Explanation: In the message text:
A data set could not be dynamically allocated. 1 return code from the Catalog Search Interface.
In the message text: 2 return code from Catalog Management.
1 name of the data set being processed. 3 reason code from Catalog Management.
System action: Depends upon other messages 4 module identifier.
associated with this message.
System action: Processing catalog entries for the
User response: None. request is terminated.
Programmer response: None. User response: Correct any related catalog errors.
Module: HSIPINQ Programmer response: None.
Module: HSIPINQ
HSIP097E CATALOG SEARCH INTERFACE
ERROR RC=1
HSIP999U MODULE HSIPMSG FAILED -
Explanation: MSGID=1, RC=2, REASON=3
A request with the CATALOG keyword was specified, Explanation:
and the Catalog Search Interface encountered an error.
HSIMSG was called to produce a message text, but the
In the message text: call failed.

148 Administration Guide and Reference


IBM Confidential HSIT001U HSIT003S

In the message text: User response: Inform the system programmer.


1 identifier of the failing message. Programmer response: Contact IBM Support.
2 HSIMSG return code. Module: HSIPINQ
3 HSIMSG reason code.
System action: Terminates with a condition code of
20.

HSIT - Product Tagging messages


Return codes

0 No errors encountered. All requests processed successfully.


4 Warning issued. Processing continues. I/O error in one or more program
libraries.
8 Error - Incomplete data. Processing continues. OPEN or system service error.
12 Severe error. Processing terminates. Utility failure or syntax error.
16 Unrecoverable error. No requests processed. SYSIN file cannot be used.
20 Disastrous error. No requests processed. SYSPRINT file cannot be used.

Message suffix codes

Suffix Meaning Raises Minimum


Condition Code to
I Information Message 0
W Warning Message 4
E Error Message 8
S Severe Error Message 12
U Unrecoverable Error Message 16

Message texts and explanations


All numeric completion codes of system services reported in these
messages are in hexadecimal unless otherwise stated.

HSIT001U HSITAGP could not open the input file HSIT002S Unrecognized statement type: 1
1
Explanation:
Explanation:
Input text was encountered which does not match any
A required file could not be opened successfully. known statement type.
In the message text: In the message text:
1 name of file. 1 encountered input data.
System action: Processing terminates with condition System action: Processing terminates with condition
code 16. code 12.
Operator response: None. Operator response: None.
User response: Correct the file definition and rerun User response: Correct the input and rerun the job.
the job.
Programmer response: None.
Programmer response: None.
Module: HSITAGP
Module: HSITAGP
HSIT003S Duplicate value supplied for 1

Appendix A. Messages 149


HSIT004S HSIT008S IBM Confidential

Explanation: was not specified. One cause for this condition is the
ommission of a parenthesis.
More than one occurrence of the named statement type
was encountered but only one value can be accepted. In the message text:
In the message text: 1 name of the parameter or operand being processed
when the error is detected.
1 name of the statement verb.
System action: Processing terminates with condition
System action: Processing terminates with condition
code 12.
code 12.
Operator response: None.
Operator response: None.
User response: Correct the input and rerun the job.
User response: Remove the redundant statement and
rerun the job. Programmer response: None.
Programmer response: None. Module: HSITAGP
Module: HSITAGP
HSIT007I A closing parenthesis assumed for 1
HSIT004S Value missing in 1 statement Explanation:
Explanation: End-of-file was raised when processing input
statements before an expected close parenthesis was
An input statement of the type indicated was
encountered.
encountered but no non-blanks followed the statement
type name. In the message text:
In the message text: 1 name of the parameter or operand being processed
when the error is detected.
1 name of the statement verb.
System action: Processing continues as if the expected
System action: Processing terminates with condition
close parenthesis had been specified.
code 12.
Operator response: None.
Operator response: None.
User response: Check that the resulting processing is
User response: Supply an appropriate value after the
as expected. Correct the input file for future use, and
statement type name.
rerun the job if the desired processing was not
Programmer response: None. performed.

Module: HSITAGP Programmer response: None.


Module: HSITAGP
HSIT005S Value specified for LICENSED was
neither YES nor NO
HSIT008S Unexpected open parenthesis
Explanation: A LICENSED statement was processed encountered after 1
which had a value specified other than one of the valid
Explanation:
values.
An open parenthesis was encountered when one was
System action: Processing terminates with condition
not expected. If this occurred while a parameter or
code 12.
operand was being processed then it is named in the
Operator response: None. message.

User response: Correct the value and rerun the job. In the message text:

Programmer response: None. 1 name of the parameter or operand being processed


when the error is detected.
Module: HSITAGP
System action: Processing terminates with condition
code 12.
HSIT006S The 1 parameter had no subparameter
value specified Operator response: None.
Explanation: User response: Correct the input file and rerun the
job.
A statement parameter or operand was specified but
the required subparameter or value of the parameter Programmer response: None.

150 Administration Guide and Reference


IBM Confidential HSIT009S HSIT014S

Module: HSITAGP Programmer response: None.


Module: HSITAGP
HSIT009S Unexpected close parenthesis
encountered after 1
HSIT012S Missing open parenthesis after 1
Explanation:
Explanation:
A close parenthesis was encountered when one was not
Whilst parsing the TAGLIBS statement looking for a
expected. If this occurred while a parameter or operand
subparameter or value in parentheses specified for the
was being processed, then it is named in the message.
parameter or operand named in the message, text was
In the message text: encountered which was not enclosed in parentheses.
1 name of the parameter or operand being processed In the message text:
when the error is detected.
1 name of the parameter or operand being processed
System action: Processing terminates with condition when the error is detected.
code 12.
System action: Processing terminates with condition
Operator response: None. code 12.
User response: Correct the input file and rerun the Operator response: None.
job.
User response: Correct the input and rerun the job.
Programmer response: None.
Programmer response: None.
Module: HSITAGP
Module: HSITAGP

HSIT010S 1 is an unknown TAGLIBS parameter


HSIT013S Value 1 too long for parameter 2
Explanation:
Explanation:
Input data was encountered which is not a recognized
The length of a subparameter or value was found to
parameter or operand of the TAGLIBS statement.
exceed the maximum length allowed. The maximum
In the message text: length allow depends on the specific parameter or
operand being processed. For example, a data set name
1 the encountered input data.
mask exceeding 44 characters in length causes this
System action: Processing terminates with condition condition, as will a volume mask exceeding 6
code 12. characters in length.

Operator response: None. In the message text:

User response: Correct the input file and rerun the 1 encountered input data.
job.
2 name of the parameter or operand being processed
Programmer response: None. when the error is detected.

Module: HSITAGP System action: Processing terminates with condition


code 12.
HSIT011S Member name 1 has embedded blank(s) Operator response: None.
Explanation: User response: Correct the input and rerun the job.
The value specified on the TAGMEM statement was Programmer response: None.
not a valid partitioned data set member blank within
Module: HSITAGP
the 8-character member name.
In the message text:
HSIT014S End of input reached, expected
1 the input value specified on the TAGMEM continuation is missing
statement.
Explanation: End-of-file was raised on the input
System action: Processing terminates with condition (SYSIN) file, but the TAGLIBS statement currently
code 12. being processed was expected to continue on the next
record.
Operator response: None.
System action: Processing terminates with condition
User response: Correct the input file and rerun the code 12.
job.

Appendix A. Messages 151


HSIT015S HSIT019E IBM Confidential

Operator response: None. System action: Processing terminates with condition


code 12.
User response: Either supply the missing input data
or remove the continuation character from the last Operator response: None.
input record, and rerun the job.
User response: Supply a statement of the named type
Programmer response: None. which specifies a value.
Module: HSITAGP Programmer response: None.
Module: HSITAGP
HSIT015S Required data set name specification is
missing
HSIT018W Catalog search terminated by RC=1
Explanation: The processing of a TAGLIBS statement while searching for 2
completed without encountering a data set name
Explanation:
selection mask specification.
The Catalog Search Interface (CSI) was called to search
System action: Processing terminates with condition
for catalog entries matching the displayed data set
code 12.
name mask, but the CSI call ended with a non-zero
Operator response: None. return code. This may indicate a corrupt catalog or
trouble accessing a potentially relevant catalog. It may
User response: Ensure that all TAGLIBS statements
mean that one or more data sets which you intended to
specify at least one value in a DATASET or DSNAME
process were not processed.
parameter or operand.
In the message text:
Programmer response: None.
1 the return code issued by the Catalog Search
Module: HSITAGP
Interface.
2 the data set name mask passed to the Catalog
HSIT016S Symbol substitution failure -
Search Interface.
ASASYMBM RC=1
System action: Processing continues with any data set
Explanation:
catalog entries that can be accessed.
Symbol substitution was attempted for a TAGLIBS
Operator response: None.
statement record which had at least one ampersand in
it, and the system symbol substitution routine User response: Check the data set name mask for
ASASYMBM terminated with a non-zero return code. suitability to your system environment. Use IDCAMS
to examine any relevant catalog entries. Ensure that all
In the message text:
catalogs which would be referenced by such a search
1 the completion code returned by ASASYMBM. are on accessible volumes. Use the same data set name
mask with other software which also calls the CSI such
System action: Processing terminates with condition as the Inquisitor or ISPF option 3.4 to see if further
code 12. diagnostic information can be acquired. The error will
Operator response: None. usually be associated with the local catalog
configuration and catalog contents.
User response: Check all uses of symbols in the input
(SYSIN) file. If necessary, gather appropriate diagnostic Programmer response: None.
materials and contact IBM support. Module: HSITAGP
Programmer response: None.
Module: HSITAGP HSIT019E DESERV failed - RC=1 Reason=2 for
data set 3

HSIT017S No value for 1 was specified Explanation:

Explanation: A DESERV FUNC=GET_ALL macro was issued to


acquire the member list for a data set but DESERV
A value for a statement of the type named in the issued a non-zero return code.
message is required, but was not found in the input
file. In the message text:

In the message text: 1 the decimal return code issued by DESERV.

1 the type of input statement required to specify the 2 the hexadecimal reason code issued by DESERV.
missing value.

152 Administration Guide and Reference


IBM Confidential HSIT020S HSIT023I

3 the name of the data set being processed by Operator response: None.
DESERV.
User response: Consult the applicable MVS
System action: The named data set is not processed, Authorized Assembler Services Guide to determine the
and processing continues with the next relevant data meaning of the dynamic allocation return, error, and
set, if any. information codes. Check that the named data set is
accessible and available for allocation.
Operator response: None.
Programmer response: None.
User response: Consult the applicable DFSMS Macro
Instructions for Data Sets manual to determine the Module: HSITAGP
meaning of the DESERV return and reason codes.
Ensure that the named data set is a valid and accessible
HSIT022S Return code 1 was returned by program
program library. If necessary, gather appropriate
2
diagnostic materials and contact IBM support.
Explanation:
Programmer response: None.
Either the High Level Assembler (program ASMA90) or
Module: HSITAGP
the Program Binder (program IEWL) was dynamically
invoked to assist with creating the output data, but the
HSIT020S Dynamic allocation failure - BPXWDYN named program issued a non-zero return code.
RC=1
In the message text:
Explanation:
1 the decimal return code issued by the named
BPXWDYN was called to dynamically allocate a program.
required work file but BPXWDYN issued a non-zero
2 the name of the program that was invoked.
return code. As a result, processing cannot proceed.
System action: Processing terminates with condition
In the message text:
code 12.
1 the hexadecimal return code issued by BPXWDYN.
Operator response: None.
System action: Processing terminates with condition
User response: Examine all associated job output to
code 12.
determine if the problem is caused by a correctable
Operator response: None. environmental error. If so, make the correction and
rerun the job. If not, gather all relevant diagnostic
User response: Consult the applicable Using REXX
materials and contact IBM support.
and z/OS UNIX System Services manual to determine
the meaning of the return code. Examine the job log Programmer response: None.
and messages to see any associated dynamic allocation
Module: HSITAGP
error message.
Programmer response: None.
HSIT023I Processing terminated due to
Module: HSITAGP encountered error condition
Explanation: Because of a previously reported error,
HSIT021E DYNALLOC failed - RC=1 Error=2 the Product Tagging Utility is terminating unilaterally,
Infor=3 for data set 4 quite possibly without processing all of the specified
program library data sets, and without generating all of
Explanation:
the requested program product tagging data.
A DYNALLOC macro was issued to dynamically
System action: Processing terminates.
allocate a program library for processing but
DYNALLOC issued a non-zero return code. Operator response: None.
In the message text: User response: Investigate any previously reported
error conditions as appropriate.
1 the decimal return code issued by DYNALLOC.
Programmer response: None.
2 the contents of S99ERROR in hexadecimal.
Module: HSITAGP
3 the contents of S99INFO in hexadecimal.
4 name of the data set which could not be allocated.
System action: Processing continues with the next
data set, if any.

Appendix A. Messages 153


HSIT024E HSIT028W IBM Confidential

programs from which data has been collected during


HSIT024E ISITMGD failed - RC=3 Reason=4 for
this run.
file 5 and data set 6
In the message text:
Explanation:
1 the condition code issued by the HSITAGP upon
An ISITMGD macro was issued against a program
termination.
library but ISITMGD issued a non-zero return code.
2 the number of programs processed in this run of
In the message text:
HSITAGP.
3 the decimal return code issued by ISITMGD.
System action: Processing completes with the
4 the decimal reason code issued by ISITMGD. displayed condition code.
5 the name of the file being processed by ISITMGD. Operator response: None.
6 the name of the data set being processed by User response: None required.
ISITMGD.
Programmer response: None.
System action: The named data set is not processed,
Module: HSITAGP
and processing continues with the next relevant data
set, if any.
HSIT027E DYNALLOC failed - RC=1 Error=2
Operator response: None.
Info=3 for volume 4
User response: Consult the applicable DFSMS Macro
Explanation:
Instructions for Data Sets manual to determine the
meaning of the ISITMGD return and reason codes. A DYNALLOC macro was issued to dynamically
Ensure that the named data is a valid and accessible allocate a volume for processing but DYNALLOC
partitioned data set. If necessary, gather the appropriate issued a non-zero return code.
diagnostic materials and contact IBM support.
In the message text:
Programmer response: None.
1 the decimal return code issued by DYNALLOC.
Module: HSITAGP
2 the contents of S99ERROR in hexadecimal.

HSIT025I 1 programs found to tag from data set 2 3 the contents of S99INFO in hexadecimal.

Explanation: 4 the volume serial number of the volume which


could not be allocated.
Input processing of the named data set has completed,
resulting in data from the reported number of System action: Processing continues with the next
programs being accumulated for subsequent output. volume, if any.

In the message text: Operator response: None.

1 the number of programs processed. User response: Consult the relevant MVS Authorized
Assembler Services Guide to determine the meaning of
2 the data set name containing the processed the dynamic allocation return, error, and information
programs. codes. Check that the named volume is accessible and
available for allocation.
System action: Processing continues.
Programmer response: None.
Operator response: None.
Module: HSITAGP
User response: None required.
Programmer response: None.
HSIT028W Unable to acquire any product
Module: HSITAGP maintenance level date
Explanation: After having processed all of the relevant
HSIT026I Processing complete - CC=1 - 2 programs HSITAGP was unable to acquire any date
programs tagged in total stamp for use as a maintenance level indicator.
Explanation: System action: Blanks are placed in the maintenance
level field and processing continues.
The Product Tagging Utility program HSITAGP has
completed processing. This message reports the Operator response: None.
condition code issued by HSITAGP and the number of
User response: None required.

154 Administration Guide and Reference


IBM Confidential HSIT029S HSIT030S

Programmer response: None. Explanation:


Module: HSITAGP The displayed data byte was encountered when
processing the value specified for the statement type
indicated. The value specified on the statement is
HSIT029S 1 statement value length exceeds the
expected to be a string. Valid byte values for text data
allowed maximum of 2 bytes
are in the range from X40 to XFE inclusive. The
Explanation: control code encountered is either not valid input or
not valid input in this location. The only control codes
The value specified for the named statement type was that may be used in the input value are SO (X0E) and
found to be longer than the maximum allowed. The SI(X0F) when they are used to encapsulate DBCS data.
maximum byte count allowed for a value of this
statement type is shown in the message. In the message text:

In the message text: 1 the hexadecimal value of the invalid text


code-point.
1 the type of input statement being processed.
2 the type of input statement being processed.
2 number of bytes.
System action: Processing terminates.
System action: Processing terminates.
Operator response: None.
Operator response: None.
User response: Remove the undisplayable characters
User response: Correct the input and rerun the job. from the input value. If using DBCS, ensure that SO
Programmer response: None. precedes DBCS text and SI terminates DBCS text, and
that the DBCS text is an even number of valid text
Module: HSITAGP bytes.
Programmer response: None.
HSIT030S Invalid text character X1 found in 2
statement Module: HSITAGP

HSIX - Inquisitor for z/OS UNIX messages and codes


Put your short description here; used for first paragraph and abstract.
Return codes

0 No errors encountered. All requests processed successfully.


4 I/O error in one or more program libraries.
8 Error - Incomplete data. Processing continues. OPEN or other system service
error.
12 Syntax error.
16 Unrecoverable error. No requests processed. SYSIN or HSIPZIP or HSIPOUT File
cannot be used, or unsupported Operating System.
20 Disastrous error. No requests processed. SYSPRINT file cannot be used.

Message suffix codes

Suffix Meaning Raises Minimum


Condition Code to
I Information Message 0
W Warning Message 4
E Error Message 8
S Severe Error Message 12
U Unrecoverable Error Message 16

Appendix A. Messages 155


HSIX001I HSIX005E IBM Confidential

Message texts and explanations


All numeric completion codes of system services reported in these
messages are in hexadecimal unless otherwise stated.
Module: HSIXINQ
HSIX001I SPECIFIED DIRECTORY NAME
IGNORED DUE TO LEADING BLANK
HSIX004I FUNCTION 1 FAILED, HEX RC=2, HEX
Explanation: A record from file HSIXROOT was read
REASON=3
and was found to start with a blank.
Explanation:
System action: The program ignores the record.
The named z/OS UNIX system service issued a
User response: Correct the input. Directory names in
negative return code.
HSIXROOT should start in column 1.
In the message text:
Programmer response: None.
1 Function name.
Module: HSIXINQ
2 Return Code.
HSIX002I THE SPECIFIED DIRECTORY NAME 3 Reason Code.
DOES NOT START WITH A SLASH
System action: Processing continues.
Explanation: A record from file HSIXROOT was read
and was found to start with a non-blank that is not a User response: Determine the meaning of the return
slash. It is flagged in case processing errors result from and reason code values, and correct the problem if
the non-standard directory name. appropriate.

System action: Processing continues. Programmer response: None.

User response: Correct the input if it is incorrect. Module: HSIXCUST

Programmer response: None.


HSIX005E 1
Module: HSIXINQ
Explanation:

HSIX003I PROGRAM PARAMETER 1 The named path was not successfully processed by the
DISCARDED z/OS UNIX system service named in the preceding
HSIX004I message. Data will not be collected from
Explanation: directories and files which could not be opened.
The program parameter contained some unrecognized In the message text:
data.
1 Path in error
In the message text:
System action: Processing continues.
1 Parameter in error
User response: Ensure that all necessary parts of the
System action: The displayed part of the program z/OS UNIX file system are accessible.
parameter is ignored.
Programmer response: None.
User response: Correct the program parameter.
Module: HSIXCUST
Programmer response: None.

HSIZ - Usage Monitor messages


Return codes

0 Normal termination.
16 Initialization failed.

Message suffix codes

Suffix Meaning Raises


Minimum
Cond Code to

156 Administration Guide and Reference


IBM Confidential HSIZ001I HSIZ007I

I Information Message 0
W Warning Message 4
E Error Message 8
S Severe Error Message 12
U Unrecoverable Error Message 16

Message texts and explanations


All numeric completion codes of system services reported in these
messages are in hexadecimal unless otherwise stated.
Explanation:
HSIZ001I USAGE MONITOR INITIALIZING
The Usage Monitor is already running. Only one
Explanation: The Usage Monitor has been started.
concurrent copy can run in an operating system image.
System action: Processing continues.
In the message text:
User response: None required.
1 current system identifier.
Programmer response: None.
System action: Processing terminates. The established
Module: HSIZMON Usage Monitor task continues.
User response: None required.
HSIZ002I 1 DETECTED UNSUPPORTED
Programmer response: None.
OPERATING SYSTEM
Module: HSIZMON
Explanation:
The Usage Monitor may not run on an unsupported
HSIZ006I 1 USAGE MONITOR QEDIT BUFFER
operating system.
SET FAILED
In the message text:
Explanation:
1 current system identifier.
A QEDIT issued to set up MODIFY command
System action: Processing terminates. processing has failed.
User response: None required. In the message text:
Programmer response: None. 1 current system identifier.
Module: HSIZMON System action: Processing terminates.
User response: Notify the system programmer.
HSIZ003I 1 USAGE MONITOR NOT APF
Programmer response: If necessary, contact IBM
AUTHORIZED
support.
Explanation:
Module: HSIZMON
The Usage Monitor needs to be executed in an APF
authorized environment.
HSIZ007I 1 USAGE MONITOR MODULE 2
In the message text: FAILED - RETURN CODE=3
1 current system identifier. Explanation:
System action: Processing terminates. A Usage Monitor subroutine has failed.
User response: See System Programmer to correct the In the message text:
error.
1 current system identifier.
Programmer response: APF authorize the load
2 failing module name.
libraries that the Usage monitor runs from.
3 decimal return code.
Module: HSIZMON
System action: Processing terminates.
HSIZ005I 1 USAGE MONITOR ALREADY User response: Notify the system programmer.
ACTIVE

Appendix A. Messages 157


HSIZ008I HSIZ013I IBM Confidential

Programmer response: If the return code is 312, then Programmer response: If necessary, contact IBM
you must increase your MAXCAD parameter. This support.
requires an IPL. For any other return codes, retain any
Module: HSIZMON
diagnostic materials and contact IBM support.
Module: HSIZMON
HSIZ011E 1 USAGE MONITOR - WRITER TASK
ABENDED - S2
HSIZ008I 1 USAGE MONITOR ASID 2 SET IN
Explanation:
AVT 3
A writer task has ended abnormally.
Explanation:
In the message text:
An Anchor Vector Table (AVT) has been acquired or
reacquired, and has been updated for the current server 1 current system identifier.
address space.
2 Abend code from writer task.
In the message text:
System action: Processing continues.
1 current system identifier.
User response: Notify the system programmer.
2 ASID number.
Programmer response: Local reasons for system
3 AVT Address. abends should be investigated. If necessary, retain all
diagnostic materials and contact IBM support.
System action: Processing continues.
Module: HSIZMON
User response: None.
Programmer response: None.
HSIZ012I **DATA LOSS** UNUSABLE DSN=1
Module: HSIZMON
Explanation:
It is likely that Usage Monitor data has been lost
HSIZ009I DATA WRITTEN TO DSN=1
because of unexpected behaviour by a writer task. Any
Explanation: compressed output data that has been written will
probably be unusable.
Usage Monitor data has been written to the named
data set. In the message text:
In the message text: 1 data set name of the created output file.
1 data set name of the created output System action: Processing continues.
System action: Processing continues. User response: Examine any preceding messages to
determine the likely cause of the writer task error. If
User response: Transfer the named data set to the
the output data set is complete it can be used,
system where the HSIz data base resides so it can be
otherwise if the data is compressed it is unusable. If the
processed.
data set is empty then this fact can be noted and the
Programmer response: None. data set can be deleted. Unless retaining an unusable
data set for diagnosis reasons it can be deleted.
Module: HSIZMON
Programmer response: Investigate any writer task
abends.
HSIZ010E 1 USAGE MONITOR - WRITER TASK
ENDED - COND CODE 2 Module: HSIZMON
Explanation:
HSIZ013I 1 USAGE MONITOR -
A writer task has ended with a non-zero completion UNRECOGNISED PROGRAM
code. PARAMETER IGNORED
In the message text: Explanation:
1 current system identifier. An unrecognised program parameter was specified.
2 Return code of writer task. In the message text:
System action: Processing continues. 1 current system identifier.
User response: Notify the system programmer. System action: Processing continues.

158 Administration Guide and Reference


IBM Confidential HSIZ014I HSIZ020I

User response: Remove or correct the program


HSIZ017I 1 USAGE MONITOR TERMINATING -
parameter.
NOW WRITING CAPTURED DATA
Programmer response: None.
Explanation:
Module: HSIZMON
A STOP command has been encountered. The current
repository contents are written before the Usage
HSIZ014I 1 USAGE MONITOR - COULD NOT Monitor terminates.
OPEN FILE HSIZIN
In the message text:
Explanation:
1 current system identifier.
The HSIZIN file could not be opened by the Usage
System action: The Usage Monitor starts a writer task
Monitor.
and waits for its completion before terminating.
In the message text:
User response: None required.
1 current system identifier.
Programmer response: None.
System action: Processing terminates.
Module: HSIZMON
User response: Supply or correct the HSIZIN DD
statement in the JCL.
HSIZ018I 1 USAGE MONITOR HAS NOW
Programmer response: None. TERMINATED

Module: HSIZMON Explanation:


The Usage Monitor has now freed resources and is
HSIZ015I 1 USAGE MONITOR - COULD NOT about to terminate.
OPEN FILE HSIZMSG
In the message text:
Explanation:
1 current system identifier.
The HSIZMSG file could not be opened by the Usage
System action: Processing terminates.
Monitor.
User response: None required.
In the message text:
Programmer response: None.
1 current system identifier.
Module: HSIZMON
System action: Processing terminates.
User response: Supply or correct the HSIZMSG DD
HSIZ019I 1 USAGE MONITOR REPOSITORY
statement in the JCL.
FULL - NOW SWITCHING
Programmer response: None.
Explanation:
Module: HSIZMON
The current Usage Monitor data collection repository is
full.
HSIZ016I 1 USAGE MONITOR TERMINATING -
In the message text:
INVALID OR MISSING HSIZIN DATA
1 current system identifier.
Explanation:
System action: A new repository is created and used
At least one HSIZIN input statement was invalid, or
for subsequent data collection. A writer task is initiated
input required to be present in the HSIZIN file was
for the full repository.
missing.
User response: None required.
In the message text:
Programmer response: None.
1 current system identifier.
Module: HSIZMON
System action: Processing terminates.
User response: Examine the HSIZMSG output report.
HSIZ020I 1 THE SPECIFIED NUMBER WAS TOO
Correct any invalid statements. Ensure a valid data set
SMALL
name prefix was specified.
Explanation:
Programmer response: None.
The numeric value of a command subparameter was
Module: HSIZMON
too small to be valid in the command context.

Appendix A. Messages 159


HSIZ021I HSIZ026I IBM Confidential

In the message text: User response: None required.


1 current system identifier. Programmer response: None.
System action: The command is discarded. Module: HSIZMON
User response: Correct the numeric value and reissue
the command. HSIZ024I 1 PROGRAM NAME MASK 2 ADDED
TO TABLE
Programmer response: None.
Explanation:
Module: HSIZMON
A command to add a program name mask to a
program mask table was issued, and the mask was
HSIZ021I 1 THE SPECIFIED NUMBER WAS TOO
added successfully.
LARGE
In the message text:
Explanation:
1 current system identifier.
The numeric value of a command subparameter was
too large to be valid in the command context. 2 program mask specified in command.
In the message text: System action: Processing continues.
1 current system identifier. User response: None required.
System action: The command is discarded. Programmer response: None.
User response: Correct the numeric value and reissue Module: HSIZMON
the command.
Programmer response: None. HSIZ025I 1 PROGRAM NAME MASK 2 NOT
DELETED - NOT FOUND IN TABLE
Module: HSIZMON
Explanation:
HSIZ022I 1 PASSIVE MODE SET FROM A command to delete a program name mask from a
PROGRAM PARAMETER program mask table was issued, but the mask was not
present in the table.
Explanation:
In the message text:
PASSIVE was specified in the program parameter.
1 current system identifier.
In the message text:
2 program mask specified in command.
1 current system identifier.
System action: Processing continues.
System action: The Usage Monitor starts in passive
mode unless overridden by input from the HSIZIN file. User response: None required.
User response: Set the Usage Monitor into collection Programmer response: None.
mode to start data collection.
Module: HSIZMON
Programmer response: None.
Module: HSIZMON HSIZ026I 1 PROGRAM NAME MASK 2
DELETED FROM TABLE
HSIZ023I 1 PROGRAM NAME MASK 2 NOT Explanation:
ADDED - ALREADY IN TABLE
A command to delete a program name mask to a
Explanation: program mask table was issued, and the mask was
deleted successfully.
A command to add a program name mask to a
program mask table was issued, but the mask was In the message text:
already present in the table.
1 current system identifier.
In the message text:
2 program mask specified in command.
1 current system identifier.
System action: Processing continues.
2 program mask specified in command.
User response: None required.
System action: Processing continues.
Programmer response: None.

160 Administration Guide and Reference


IBM Confidential HSIZ027I HSIZ033I

Module: HSIZMON
HSIZ030I 1 USAGE MONITOR - NO DATA
COLLECTED SO SKIPPING WRITE
HSIZ027I WARNING - ECSA APPEARS TO BE
Explanation:
EXHAUSTED - INCREASE SIZE FOR
NEXT IPL Before a writer task was initiated to output the contents
of a Usage Monitor repository, it was found that the
Explanation: The Usage Monitor has attempted to
repository contained no data, and that therefore data
acquire storage from ECSA, but was given CSA storage
output processing could be omitted.
by the system. This indicates that there is insufficient
ECSA for the current workloads, and that it should be In the message text:
increased for the next IPL.
1 current system identifier.
System action: Processing continues.
System action: Processing continues.
User response: Notify the system programmer.
User response: None required.
Programmer response: Add around 50 to 100
Programmer response: None.
megabytes to the ECSA size in the system IPL
parameters. Check the capacity of the COMMON page Module: HSIZMON
data set.
Module: HSIZMON HSIZ031I 1 INITIATING REPOSITORY SWITCH
Explanation:
HSIZ028I *DANGER* - ECSA AND CSA APPEAR
TO BE EXHAUSTED - INCREASE A switch (SWI) command was issued and the requested
ECSA NEXT IPL action is being initiated.

Explanation: The Usage Monitor has attempted to In the message text:


acquire some common storage, but the requested 1 current system identifier.
amount was unavailable. This indicates that there is
insufficient ECSA for the current workloads, and that it System action: Processing continues.
should be increased for the next IPL. User response: None required.
System action: Processing continues. Programmer response: None.
User response: Notify the system programmer. Module: HSIZMON
Programmer response: Add around 50 to 100
megabytes to the ECSA size in the system IPL HSIZ032I 1 2 COMMAND UNKNOWN
parameters. Close some applications using CSA. If
necessary, commence orderly shutdown and reIPL Explanation:
before the system crashes. Check the capacity of the A command was issued but was not recognised.
COMMON page data set.
In the message text:
Module: HSIZMON
1 current system identifier.
HSIZ029I 1 THERE IS CURRENTLY NO 2 name of the issued command.
EXCLUDE TABLE
System action: The command is ignored. Processing
Explanation: continues.
A request was made to change or display the program User response: If necessary, correct and reissue the
name mask exclude table, but there is currently no command.
exclude table.
Programmer response: None.
In the message text:
Module: HSIZMON
1 current system identifier.
System action: Processing continues. HSIZ033I 1 2 COMMAND PROCESSED

User response: None required. The EXC command Explanation:


may be used to create a table.
A command was issued and has been processed
Programmer response: None. successfully.

Module: HSIZMON In the message text:

Appendix A. Messages 161


HSIZ034I HSIZ039I IBM Confidential

1 current system identifier. System action: Processing continues.


2 name of the issued command. User response: None required.
System action: Processing continues. Programmer response: None.
User response: None required. Module: HSIZMON
Programmer response: None.
HSIZ037I 1 2 COMMAND REJECTED
Module: HSIZMON
Explanation:
HSIZ034I 1 2 COMMAND HAS INVALID A recognised command was issued at a time when the
OPERAND Usage Monitor is unable to process the command.
Explanation: In the message text:
A command was issued but an invalid operand was 1 current system identifier.
encountered.
2 name of the issued command.
In the message text:
System action: The command is ignored. Processing
1 current system identifier. continues.
2 name of the issued command. User response: Try again after the Usage Monitor has
freed the resources.
System action: The command is ignored. Processing
continues. Programmer response: None.
User response: If necessary, correct and reissue the Module: HSIZMON
command.
Programmer response: None. HSIZ038I 1 CURRENT USAGE MONITOR
PROGRAM EXCLUDE LIST:
Module: HSIZMON
Explanation:
HSIZ035I 1 2 COMMAND FAILED A D-X command was issued to display the program
name exclude table contents. The active entries are
Explanation:
shown after this message.
A command was issued but insufficient resources were
In the message text:
available to execute it successfully.
1 current system identifier.
In the message text:
System action: The data is displayed and processing
1 current system identifier.
continues.
2 name of the issued command.
User response: None required.
System action: The command is ignored. Processing
Programmer response: None.
continues.
Module: HSIZMON
User response: Try again after more resources become
available.
HSIZ039I 1 REPOSITORY SWITCH HAS BEEN
Programmer response: None.
QUEUED
Module: HSIZMON
Explanation:
A repository switch was triggered by a SWI or STOP
HSIZ036I 1 2 COMMAND CAUSED NO
command, or by the current repository becoming full,
CHANGE
but a writer task is already active. This message is
Explanation: followed by message HSIZ040I which shows the
creation timestamp of the active writer task.
A command was issued but the state to be set by the
command was found to already exist. In the message text:

In the message text: 1 current system identifier.

1 current system identifier. System action: Data collection is suspended. Wait for
the current writer task to complete whereupon a new
2 name of the issued command. writer task is created, and a new repository is created,

162 Administration Guide and Reference


IBM Confidential HSIZ040I HSIZ044I

and data collection is resumed.


HSIZ042I CURRENT USAGE MONITOR
User response: Check that there are sufficient OUTPUT SYSTEM ID IS 1
resources to dispatch the Usage Monitor address space.
Explanation:
Check that there are no serialization problems with
system components such as device allocation which A D-I command was issued to display the current
could be inhibiting writer task processing. system identifier which is to be contained in output
header records.
Programmer response: None.
In the message text:
Module: HSIZMON
1 System ID of current system.
HSIZ040I 1 WAITING FOR WRITER TASK System action: Processing continues.
ATTACHED 2
User response: None required.
Explanation:
Programmer response: None.
A repository switch was triggered by a SWI or STOP
Module: HSIZMON
command, or by the current repository becoming full,
but a writer task is already active. This message follows
message HSIZ039I and shows the creation timestamp of HSIZ043I 1 WARNING - DATA DISCARDED
the active writer task. DUE TO (E)CSA STORAGE LIMIT
In the message text: Explanation:
1 current system identifier. The Usage Monitor has detected for the first time in the
life of the repository or since a CSA limit change that
2 Time stamp of write task.
program usage event data has been discarded due to
System action: Data collection is suspended. Wait for the CSA/ECSA storage usage limit being reached. This
the current writer task to complete whereupon a new limit was set with the CSA command.
writer task is created, and a new repository is created,
In the message text:
and data collection is resumed.
1 current system identifier.
User response: Check that there are sufficient
resources to dispatch the Usage Monitor address space. System action: Processing continues.
Check that there are no serialization problems with
system components such as device allocation which User response: Adjust the Usage Monitor CSA limit as
could be inhibiting writer task processing. appropriate for the particular system. Ensure that the
ECSA size has been generously defined for the system,
Programmer response: None. and that the common page data set size is adequate.
Ensure that the Usage Monitor address space is
Module: HSIZMON
running at a higher priority than all CPU-bound
workloads. Generally, monitors need to run at a higher
HSIZ041I 1 CURRENT USAGE MONITOR priority than the workloads being monitored.
OUTPUT DYNALLOC PARMS:
Programmer response: None.
Explanation:
Module: HSIZMON
A D-A command was issued to display the current
output dynamic allocation parameters, which are
HSIZ044I 1 SWITCH-AND-WRITE TIME-OF-DAY
shown after this message.
IS SET TO 2:3
In the message text:
Explanation:
1 current system identifier.
A D-T command was issued to display the
System action: The data is displayed and processing switch-and-write time-of-day setting for this system.
continues. hh:mm switch time-of-day.
User response: None required. In the message text:
Programmer response: None. 1 current system identifier.
Module: HSIZMON 2 HH - Hour of the day.
3 MM - minute of the hour.
System action: Processing continues.

Appendix A. Messages 163


HSIZ045I HSIZ050I IBM Confidential

User response: None required. Programmer response: None.


Programmer response: None. Module: HSIZMON
Module: HSIZMON
HSIZ048I 1 USAGE MONITOR - IDENTIFY
FAILED HEX RC=2
HSIZ045I 1 CREATED REPOSITORY 2-3
Explanation:
Explanation:
The Usage Monitor executed an IDENTIFY macro
A repository was created to hold collected program
which failed.
usage data.
In the message text:
In the message text:
1 current system identifier.
1 current system identifier.
2 hexadecimal return code of the IDENTIFY macro.
2 space token of the repository data space.
System action: Processing terminates.
3 ALET of the repository data space.
User response: Notify the system programmer.
System action: Processing continues.
Programmer response: Investigate why an IDENTIFY
User response: None required.
macro would fail with that return code.
Programmer response: None.
Module: HSIZMON
Module: HSIZMON
HSIZ049I 1 DATA SET NAME MASK NOT
HSIZ046I 1 DELETED REPOSITORY 2-3 4 DEACTIVATED, NOT FOUND IN LIST
ENTRIES CACHED
Explanation:
Explanation:
A command to delete a data set name mask from a
A repository which was no longer needed was deleted. data set name mask list was issued, but the mask was
not present in the list.
In the message text:
In the message text:
1 current system identifier.
1 current system identifier.
2 space token of the repository data space.
System action: Processing continues.
3 ALET of the repository data space.
User response: None required.
4 number of entries cached to reduce overhead.
Programmer response: None.
System action: Processing continues.
Module: HSIZMON
User response: None required.
Programmer response: None. HSIZ050I 1 DATA SET NAME MASK 2 LIST 3
Module: HSIZMON Explanation:
A D-D command was issued to display the data set
HSIZ047I 1 USAGE MONITOR - ATTACHING name mask include and exclude lists. These header and
WRITER SEQ-NO-2 trailer lines mark the start and end of the lists.
Explanation: In the message text:
A writer task is being attached to write out repository 1 current system identifier.
contents. The writer task sequence number is also
reported. The first writer task to run after the Usage 2 INCLUDE or EXCLUDE.
Monitor starts has a sequence number of 1.
3 START or END.
In the message text:
System action: Processing continues.
1 current system identifier.
User response: None required.
2 sequence number of writer task this run.
Programmer response: None.
System action: Processing continues.
Module: HSIZMON
User response: None required.

164 Administration Guide and Reference


IBM Confidential HSIZ051I HSIZ055I

In the message text:


HSIZ051I 1 (E)CSA QUEUING STORAGE LIMIT:
2 1 current system identifier.
Explanation: 2 YES or NO.
Either a CSA command was issued to change the limit System action: Processing continues.
setting, or a D-S command was issued. The CSA
queuing storage limit can be used to limit the quantity User response: None required.
of CSA to be used to hold program usage data Programmer response: None.
elements queued for storing into the data space
repository. When this limit is reached further data is Module: HSIZMON
discarded. A count of discarded elements is maintained
an reported at termination. A limit of zero means the HSIZ054I 1 MONITORING LINK PACK AREA
usage monitor never tries to limit CSA storage usage. PROGRAMS? 2
In the message text: Explanation:
1 current system identifier. Either an LPA command was issued to change the LPA
2 NO LIMIT or kilobyte limit. program monitoring status or a D-S command was
issued. When the answer is YES the usage of programs
System action: Processing continues. residing in the Link Pack Area is monitored. When
User response: None required. answer is NO only the usage of programs loaded into
address space regions (and sometimes into CSA) is
Programmer response: None. monitored.
Module: HSIZMON In the message text:
1 current system identifier.
HSIZ052I 1 THE CACHE TRIGGER EVENT
COUNT IS 2 2 YES or NO.

Explanation: System action: Processing continues.

Either a TRG command was issued to change the cache User response: None required.
trigger event count or a D-S command was issued. Programmer response: None.
When a job uses the same program a number of times,
the repository entry may be cached if the number has Module: HSIZMON
reached the cache trigger event count. The updating of
cached entries is a synchronous process which does not HSIZ055I 1 FLAG SYSPLEX-WIDE COMMON
use common storage. A limited number of cache entries SOFTWARE? 2
are available. The cache is cleared when the repository
is switched. Explanation:

In the message text: Either a PLX command was issued to change the
sysplex status flag or a D-S command was issued. This
1 current system identifier. flag setting is copied to the header record every time a
2 event count required to cause data set is written by the Usage Monitor. This flag can
be used to determine how usage data relates to
System action: Processing continues. Inquisitor data. In particular, if more than one
User response: None required. Operating System image entirely shares a common
DASD subsystem, a YES value can enable the usage
Programmer response: None. data of more than one system to relate to a single
Inquisitor data collection.
Module: HSIZMON
In the message text:
HSIZ053I 1 MONITORING UNIX PROGRAMS? 2 1 current system identifier.
Explanation: 2 YES or NO.
Either a USS command was issued to change the UNIX System action: Processing continues.
program monitoring status or a D-S command was
issued. When the answer is YES the usage of programs User response: None required.
fetched from UNIX files is monitored. When the answer Programmer response: None.
is NO only the usage of programs from PDS and PDSE
libraries is monitored. Module: HSIZMON

Appendix A. Messages 165


HSIZ056I HSIZ060I IBM Confidential

HSIZ056I 1 PREFER VOLUME SYMBOL OVER HSIZ058I 1 FILE HSIZIN IS NOT ALLOCATED -
SERIAL? 2 CANNOT PERFORM REFRESH
Explanation: Explanation:
Either a SYM command was issued to change the A REF command was issued to refresh settings from
volume symbol status or a D-S command was issued. commands in the HSIZIN file, but the HSIZIN file had
When the answer is YES the volume serial number been freed, and was no longer allocated to the Usage
field of data records contains six asterisks instead of the Monitor.
IPL volume serial (system residence volume) and
In the message text:
symbol names for other volumes if a system static
symbol can be found with a value matching the 1 current system identifier.
captured volume serial number. Otherwise the volume
serial number is written as normal. When the answer is System action: The refresh operation is suppressed
NO the captured volume serial number is always and processing continues.
output. A YES setting may be useful to improve data User response: Ensure FREE=CLOSE is not specified
matching when system software platform volume in the HSIZIN JCL DD statement. Recycle the Usage
switches take place. Monitor to refresh the settings if necessary.
In the message text: Programmer response: None.
1 current system identifier. Module: HSIZMON
2 YES or NO.
System action: Processing continues. HSIZ059I 1 REFRESH PERFORMED WITH NO
ERRORS
User response: None required.
Explanation:
Programmer response: None.
A REF command was issued to refresh settings from
Module: HSIZMON commands in the HSIZIN file. All commands in the
HSIZIN file were completed successfully.
HSIZ057I 1 WILL WRITER TASK SORT THE In the message text:
DATA? 2
1 current system identifier.
Explanation:
System action: Processing continues.
Either a SRT command was issued to change the SORT
status or a D-S command was issued. When the answer User response: None required.
is YES the writer task attaches the sites SORT utility to Programmer response: None.
sort the data before it is written to the output data set.
When the answer is NO data is written in the (hashed) Module: HSIZMON
order it is stored in within the repository. Usage import
processing time may be significantly reduced when the HSIZ060I 1 REFRESH PERFORMED BUT
data is sorted. The Usage Monitor address space ERROR(S) FOUND
consumes more resources if the writer task is to sort
the data. Local customization of SORT settings and/or Explanation:
Usage Monitor JCL may be required to ensure that A REF command was issued to refresh settings from
sufficient SORTWORK space is available when sorting commands in the HSIZIN file. At least one command in
is to be performed. the HSIZIN file resulted in an error.
In the message text: In the message text:
1 current system identifier. 1 current system identifier.
2 YES or NO. System action: Processing terminates.
System action: Processing continues. User response: Examine the output in the HSIZMSG
User response: None required. file to determine the problem(s).

Programmer response: None. Programmer response: None.

Module: HSIZMON Module: HSIZMON

166 Administration Guide and Reference


IBM Confidential HSIZ062I HSIZ066I

System action: Processing continues.


HSIZ062I 1 MAXCAD=2 IS PROBABLY TOO
SMALL User response: None required.
Explanation: Programmer response: None.
A DSPSERV CREATE macro issued a return code of 12. Module: HSIZMON
This is usually caused by the maximum number of
SCOPE=COMMON data spaces already existing, so
that no more can be created. To increase this maximum HSIZ065I 1 WILL WRITER TASK CORRECT
specify a larger value for MAXCAD in the system LINKLIST DSN? 2
parameter library for the next IPL. Explanation:
In the message text: Either an LLC command was issued or a D-S command
1 current system identifier. was issued. When the answer is YES the writer task
will perform a BLDL for programs known to have been
2 current value of MAXCAD. fetched from the link list, and each output record for
such programs will be altered to reflect the link list
System action: Processing terminates.
data set name that the writer task found the program
User response: Restart the Usage Monitor after a in.
SCOPE= COMMON data space has been deleted.
In the message text:
Programmer response: Allow a greater number of
1 current system identifier.
concurrent SCOPE=COMMON data spaces by
increasing MAXCAD in PARMLIB. 2 YES or NO.
Module: HSIZMON System action: Processing continues.
User response: None required.
HSIZ063I 1 COLLECTING UNKNOWN
EVENTS? 2 Programmer response: None.

Explanation: Module: HSIZMON

Either a UNK command was issued or a D-S command


was issued. When the answer is YES this message HSIZ066I 1 2 IDLE ELEMENT(S) LOST DUE TO
indicates that the Usage Monitor logs events with ZERO POINTER
incomplete data which would not normally be Explanation:
collected. Data base content is not affected.
The Usage Monitor was terminating normally when a
In the message text: storage accounting discrepancy was discovered. The
1 current system identifier. storage for the idle element chain was being freed
when it was found to be terminated by a zero pointer
2 YES or NO. before the expected number of elements had been
processed. The most probable cause is a storage
System action: Processing continues.
overlay. This may or may not represent a Usage
User response: None required. Monitor logic error. The size of common storage which
may be unusable until the next IPL can be calculated
Programmer response: None.
by multiplying the element count by the size of an
Module: HSIZMON element.
In the message text:
HSIZ064I 1 WILL WRITER TASK COMPRESS
1 current system identifier.
THE DATA? 2
2 the number of elements being reported.
Explanation:
System action: Termination continues.
Either a ZIP command was issued to change the output
compression setting or a D-S command was issued. User response: Determine if the size of the potential
When the answer is YES the writer task writes loss of common storage is likely to impact upon system
compressed data to reduce I/O volumes. stability, and take the appropriate action. Ensure that
all appropriate maintenance has been applied.
In the message text:
Programmer response: None.
1 current system identifier.
Module: HSIZMON
2 YES or NO.

Appendix A. Messages 167


HSIZ067I HSIZ072I IBM Confidential

Programmer response: None.


HSIZ067I 1 SAVE ELEMENTS ON THE IDLE
CHAIN? 2 Module: HSIZMON
Explanation:
HSIZ070I 1 GET REGISTERED PRODUCT DATA
Either an IDL command was issued or a D-S command
NOW? 2
was issued. When the answer is YES the Usage Monitor
will place processed work elements on a chain for idle Explanation:
elements instead of freeing the storage. When an
address space needs an element to record a program A D-S command was issued. When the answer is YES
usage event, one from the idle chain will be used in registered software product data from SMF is currently
preference to acquiring more storage. Use of the idle being collected by the Usage Monitor. When the answer
chain can reduce GETMAIN/FREEMAIN processing is NO then this SMF data is not being currently
and therefore improve overall efficiency. collected.

In the message text: In the message text:

1 current system identifier. 1 current system identifier.

2 YES or NO. 2 YES or NO.

System action: Processing continues. System action: Processing continues.

User response: None required. User response: None.

Programmer response: None. Programmer response: None.

Module: HSIZMON Module: HSIZMON

HSIZ068I 1 GET JOB ACCOUNT NOW? 2 HSIZ071I 1 GET REGISTERED PRODUCT DATA
LATER? 2
Explanation:
Explanation:
A D-S command was issued. When the answer is YES
job account data is currently being collected as program Either a PRS command was issued or a D-S command
usage events are recorded. When the answer is NO job was issued. When the answer is YES registered
account data is not being collected currently. software product data from SMF will be collected after
the next Usage Monitor collection repository switch.
In the message text: When the answer is NO this SMF data will not be
collected after the next switch.
1 current system identifier.
In the message text:
2 YES or NO.
1 current system identifier.
System action: Processing continues.
2 YES or NO.
User response: None.
System action: Processing continues.
Programmer response: None.
User response: None.
Module: HSIZMON
Programmer response: None.
HSIZ069I 1 GET JOB ACCOUNT LATER? 2 Module: HSIZMON
Explanation:
HSIZ072I 1 GET DYNAMIC CAPACITY DATA
Either a JAC command was issued or a D-S command
NOW? 2
was issued. When the answer is YES job account data
will be collected after the next Usage Monitor collection Explanation:
repository switch. If the answer is NO job account data
will not be collected from that time onwards. A D-S command was issued. When the answer is YES,
hardware capacity information is currently being
In the message text: collected by the Usage Monitor. When the answer is
NO, hardware capacity information is not being
1 current system identifier.
currently collected.
2 YES or NO.
In the message text:
System action: Processing continues.
1 current system identifier.
User response: None.

168 Administration Guide and Reference


IBM Confidential HSIZ073I HSIZ203I

2 YES or NO. System action: Processing continues.


System action: Processing continues. User response: None.
User response: None. Programmer response: None.
Programmer response: None. Module: HSIZMON
Module: HSIZMON
HSIZ201I DYNALLOC FAILURE RC=1 ERROR=2
INFO=3 DSN=4
HSIZ073I 1 GET DYNAMIC CAPACITY DATA
LATER? 2 Explanation:
Explanation: The writer task could not dynamically allocate a new
output data set.
Either a CAP command was issued or a D-S command
was issued. When the answer is YES the Usage Monitor In the message text:
will collect hardware capacity information after the
1
next Usage Monitor collection repository switch. When
the answer is NO the hardware capacity information 2 dynamic allocation return code (DARC).
will not be collected after the next switch.
3 dynamic allocation information code.
In the message text:
4 name of the data set being allocated.
1 current system identifier.
System action: Processing of the repository is
2 YES or NO. terminated, and the data lost.
System action: Processing continues. User response: Correct the cause of the allocation
failure. If necessary, use the DSN, PRI, SEC and UNT
User response: None.
commands to customize the allocation request for your
Programmer response: None. installation. Note: The meanings of most DARC values
are usually available in Appendix A of the ISPF
Module: HSIZMON
Tutorial.
Programmer response: None.
HSIZ074I 1 OUTPUT NAMES OF USERS? 2
Module: HSIZ0203
Explanation:
Either a UNM command was issued or a D-S command
HSIZ202I USAGE MONITOR - COMPRESSION
was issued. When the answer is YES collected user
SUBROUTINE ERROR
names will be included in the data output by the Usage
Monitor writer task. When the answer is NO user Explanation: While processing repository data the
names will not be written to the output data set. compression subroutine encountered an error. The error
message from the compression subroutine immediately
In the message text:
follows this message.
1 current system identifier.
System action: Processing of the repository is
2 YES or NO. terminated, and the data lost.

System action: Processing continues. User response: Correct the error described in the
message from the compression subroutine. If necessary,
User response: None.
Programmer response: None.
Programmer response: None.
Module: HSIZ0203
Module: HSIZMON

HSIZ203I USAGE MONITOR - SORT FAILED -


HSIZ080I 12 RC=3
Explanation: Explanation:
Displays the dataset name mask for a D-D command. While sorting repository data the SORT task ended
In the message text: with a non-zero condition code which is taken to mean
that the sort was not successful. This message is
1 current system identifier. followed by message HSIZ205I.
2 Data set name. In the message text:

Appendix A. Messages 169


HSIZ204I HSIZ303I IBM Confidential

3 decimal return code of the sort subtask. System action: The message is preceded by message
HSIZ202I.
System action: The output data set is closed, and the
writing of unsorted data to the same data set is User response: Examine the message for further
attempted. information.
User response: Consult the documentation of the Programmer response: None.
SORT utility. The contents of the SORT report file
Module: HSIZ0203
(DDNAME=SYSOUT) may be helpful.
Programmer response: None.
HSIZ301I DESERV FUNC=EXIT RC=1 REASON=2
Module: HSIZ0203
Explanation:
DESERV FUNC=EXIT issued a non-zero return code.
HSIZ204I USAGE MONITOR - SORT ABENDED
-1 In the message text:
Explanation: 1 Return code from DESERV.
While sorting repository data the SORT task ended 2 Reason code from DESERV.
abnormally. This message is followed by message
HSIZ205I. System action: The DESERV exit is not installed.

In the message text: User response: Notify the system programmer.

1 the abend code of the sort subtask. Programmer response: Research the DESERV feedback
to determine why the exit could not be installed.
System action: The output data set is closed, and the
writing of unsorted data to the same data set is Module: HSIZ0303
attempted.
User response: Investigate why such an abend could HSIZ302I CSVDYNEX ADD (1) RC=2 REASON=3
occur. The contents of the SORT report file Explanation:
(DDNAME=SYSOUT) may be helpful.
CSVDYNEX ADD issued a non-zero return code.
Programmer response: None.
In the message text:
Module: HSIZ0203
1 xxxxx

HSIZ205I USAGE MONITOR - UNSORTED 2 Return code from CSVDYNEX.


DATA WILL BE WRITTEN 3 Reason code from CSVDYNEX.
Explanation: The sorting of output data has failed so System action: The SMF exit is not installed.
the data is now written unsorted.
User response: Notify the system programmer.
System action: The message is preceded by either
HSIZ203I or HSIZ204I. After the SORT task ended the Programmer response: Research the CSVDYNEX
output data set has been closed and reopened. feedback to determine why the exit could not be
Repository data is about to be written to the output installed.
data set. Module: HSIZ0303
User response: None required, other than
investigating why the sort failed. HSIZ303I ATTRIBUTE MISMATCH - 1 NOT
Programmer response: None. INSTALLED

Module: HSIZ0203 Explanation:


The examined SVC table entry did not have the
HSIZ206I 1 expected attributes.

Explanation: In the message text:

The HSISHRNK compression routine issued an error 1 Module name.


message which is displayed. System action: The SVC intercept is not installed.
In the message text: User response: Notify the system programmer.
1 Error message from HSISHRNK Programmer response: Contact IBM support.

170 Administration Guide and Reference


IBM Confidential HSIZ306I HSIC020E

Module: HSIZ0303 4 User name.


5 ID name.
HSIZ306I BAD 1 ENTRY PGM=2 JOB=3 USER=4
6 Date.
ID=5 DATE=6 REJECTED
System action: Attempted to dump some data to
Explanation:
HSIZSNAP if the file is allocated, and will then try to
An invalid work element has been detected and some free the work element without processing its contents.
of its contents are displayed.
User response: Notify the system programmer.
In the message text:
Programmer response: The problem is indicative of a
1 Status name. storage overlay. Contact IBM support.
2 Program name. Module: HSIZ3060
3 Job name.

HSIC - Globalization messages


Return codes

0 No errors encountered. All requests processed successfully.


16 Unrecoverable error. No requests processed. SYSIN or HSIPZIP or INQSOUT
File cannot be used, or unsupported operating system.

Message suffix codes

Suffix Meaning Raises


Minimum
Cond Code to
I Information Message 0
W Warning Message 4
E Error Message 8
S Severe Error Message 12
U Unrecoverable Error Message 16

Message texts and explanations


All numeric completion codes of system services reported in these
messages are in hexadecimal unless otherwise stated.
Explanation: When attempting to issue a message, the
HSIC002E A message is missing from the internal
internal message repository layout did not follow the
repository
expected format.
Explanation: A message is missing from the internal
System action: The application terminates.
message repository. When the default language is not
English, it could simply mean that no translation of the User response: Contact your IBM representative.
given message exists. If the default language is English,
that would indicate an error in the given application.
HSIC020E application-name encountered errors. Error
System action: The application would normally code = errorcode
continue ignoring the given message number , but the
specific action depends on the code attempting to issue Explanation: The Application has encountered errors
the message which could also terminate the application. during processing. This is a general message on
completion indicating that an error has occurred.
User response: Contact your IBM representative.
System action: Completes with given error code .

HSIC003U The internal message repository is User response: Refer to additional message, or to the
corrupted. Return codes on page 174 section, and to the log for

Appendix A. Messages 171


HSIC021S HSIC034S IBM Confidential

more details on the specific error. If necessary, contact the database and the version of the product. If
your IBM representative. necessary, contact your IBM representative.

HSIC021S application-name encountered fatal errors. HSIC027S Inquisitor Import table tablename is
Error code = error-code missing a column.
Explanation: The Application has encountered fatal Explanation: The given table is missing an expected
errors during processing. column. This suggests a mismatch between the
database and this version of the product.
System action: Terminates with given error code
System action: The application terminates without
User response: Refer to additional message, or to the
processing any records.
Return codes on page 174 section, and to the log for
more details on the specific error. If necessary, contact User response: Check for a version mismatch between
your IBM representative. the database and the version of the product. If
necessary, contact your IBM representative.
HSIC023E Inquisitor Import error occurred in
opening: filename HSIC028S Inquisitor Import table tablename
appears to be an old version.
Explanation: The Inquisitor import could not open the
given file. Explanation: The given table in the database does not
have the expected format.
System action: Terminates without processing any
records. System action: The application terminates without
processing any records.
User response: Check that the file exists, and if it
does, check for any additional log message identifying User response: Check for a version mismatch between
the error. If necessary, contact your IBM representative. the database and the version of the product. If
necessary, contact your IBM representative.
HSIC024E Inquisitor Import input file is in error.
It looks like a usage data file HSIC029S Inquisitor Import error when writing to
table tablename
Explanation: The inquisitor import has encountered
an invalid input file. Explanation: An SQL error when attempting to write
to the given table.
System action: Terminates without processing any
records. System action: The application terminates.
User response: Check that the input file is a valid file. User response: Check the log for additional details
If necessary, contact your IBM representative. about the given error. If necessary, contact your IBM
representative.
HSIC025E Inquisitor Import input file is in error.
It looks like a hardware data file HSIC030S The Inquisitor Import did not find a
valid system header record in the input
Explanation: The Inquisitor Import has encountered
file
an invalid input file.
Explanation: The input file does not follow the
System action: Terminates without processing any
expected format.
records.
System action: The application terminates.
User response: Check that the input file is a valid file.
If necessary, contact your IBM representative. User response: Check that the correct input file is
supplied, and that there is no version mismatch. If
necessary, contact your IBM representative.
HSIC026E Inquisitor Import detected that table
tablename is missing or invalid.
HSIC034S Error reading Repository TPARAM table
Explanation: The expected table is missing from the
database or has invalid format. This suggests a Explanation: An error occurred while reading the
mismatch between the database and this version of the TPARAM Repository table.
product.
System action: The application terminates.
System action: Terminates without processing any
User response: Check the log for any additional
records.
messages indicating the cause of the error. If necessary,
User response: Check for a version mismatch between contact your IBM representative.

172 Administration Guide and Reference


IBM Confidential HSIC035E HSIC050E

HSIC035E The Repository is in use by the HSIC040E Reserved word: reservedword in param:
application-name param
Explanation: The application cannot run because the Explanation: A reserved word or system value schema
Repository is already in use by another application. ID was chosen as a parameter value.
Wait untilapplication-name completes before running the
System action: The application terminates.
current application. If the Repository is not in use by
application-name, then the cause could be that it was User response: Specify a different parameter value
previously run, but did not run to completion. To
correct the problem, either rerun the application-name
identified in this message, or alternatively, run the HSIC041W value:value in param:param is not a
HSISTPRM supplied job to reset FVALUE to 0 where recommended schema ID
FKEY = PROCRUN in the TPARAM table. Explanation: The value is not recommended because
System action: The application terminates. of possible conflicts with existing values.

User response: Check the application is not already in System action: The application continues.
use, before running this application. User response: Please choose a different value to
avoid any conflicts
HSIC036E Syntax error scanning TPARAMS file on
line linenumber HSIC042E TPARAM file: param:param has an
Explanation: The TPARAM file does not conform to invalid proposed value: value
the required syntax on the given line. Explanation: The parameter cannot be set to the given
System action: The specified option or value is value, because the value is not valid..
ignored, and its default value is used where applicable. System action: The value is ignored, and the
User response: Check that valid options/values are application continues.
supplied as specified in the documentation of the User response: Please choose a valid value as per the
application that you are running. documentation of the given application

HSIC037E Schema schemavalue is too long in param HSIC043E The application has failed to open the
param TPARAM file. Error: errordescription
Explanation: A schema id that is too long has been Explanation: The application could not open the
specified. TPARAM file. The error description contains more
System action: The application terminates. details regarding the reason for the error.

User response: Check that the schema id does not System action: The application terminates.
exceed 8 characters in length. User response: Check that the TPARAM file exists and
is valid.
HSIC038E Unbalanced quote for value: value in
param: param HSIC045E String string cannot exceed numberchars
Explanation: A starting quote was found for the given in length
parameter that has no matching end quote. Explanation: A parameter length limit has been
System action: The application terminates. exceeded.

User response: Check that the given parameter has System action: The application terminates.
matching quotes User response: Ensure that the specified parameter
length is not exceeded.
HSIC039E Illegal character in value:value of
param:param HSIC050E The program-name program has detected
Explanation: An invalid character was found in the an invalid date parameter
given value. Explanation: A date parameter was found to be
System action: The application terminates. invalid.

User response: Check that the given parameter value System action: The application terminates.
is valid for its type. User response: Ensure that the date format is valid,
and start dates do not overlap end dates.

Appendix A. Messages 173


HSIC051S 6211 IBM Confidential

HSIC051S Error adding record HSIC055S Table initialization failure during


Repository Merge
Explanation: An SQL error occurred when adding a
record to a table. Explanation: At least one table initialization failed
when merging repositories.
System action: The application terminates.
System action: The application terminates.
User response: Check the log for additional
information about the error. If necessary contact your User response: Check the log for any additional
IBM representative. details about this error. If necessary, contact your IBM
representative.
HSIC052S Error updating record
HSIC056S Some table destination fields are
Explanation: An SQL error occurred when updating a
smaller than source
record in a table.
Explanation: At fields in the target repository are not
System action: The application terminates.
large enough to fit the contents of fields in the source
User response: Check the log for additional repository.
information about the error. If necessary contact your
System action: The application terminates, and the
IBM representative.
repositories are not merged.
User response: Check that the destination repository
HSIC053S Error deleting record
is not an older version than the source repository. If
Explanation: An SQL error occurred when deleting a necessary, you can recreate the destination repository
record from a table. using the latest version of the product. If the problem
persists, contact your IBM representative.
System action: The application terminates.
User response: Check the log for additional HSIC057E A value for parameter: parameter-name
information about the error. If necessary contact your must be specified
IBM representative.
Explanation: A mandatory parameter for this
application has not been specified.
HSIC054E Usage Summary detected an invalid
SUMBY value System action: The application terminates during the
syntax checking of input parameters.
Explanation: The Usage Summary detected an invalid
SUMBY value. User response: Ensure that a value for the given
parameter is specified. Refer to the documentation of
System action: The specified value is ignored. The the failing application for an explanation of the given
application continues using the default SUMBY value. parameter and/or valid parameter values.
User response: Refer to the documentation of the
Usage Summary parameter for valid SUMBY values.

Return codes
6016 Input text file open error 6204 MVS system header record not found in
input file
6060 Input Parameter error
6205 Unix System Services header record not
found in input file
6061 Database open error

6206 No system header record found in input


6062 Database commit error
file.

6063 Error reading repository TPARAM table


6208 Error writing to TPARAM table

6065 Repository is in use


6209 Error opening input file

6203 Inquisitor Import table open fail


6211 Fatal error writing system record

174 Administration Guide and Reference


IBM Confidential 6212 6600

6212 Fatal error writing library record 6405 IQ database is empty

6213 Fatal error writing module record 6409 TDECISION table open error

6218 Input file looks like a usage data file 6413 Error creating scorecard tables for Match
Engine
6219 Input file looks like a hardware data
file 6428 Local KB TRULES table open error

6220 Index missing error 6434 Failure to open archive file

6221 Vendor product version table processing 6435 Error creating index
error
6436 Error setting current index
6222 Tagged module key table processing
error
6437 Search KB phase error

6226 Repository must be enabled for Unix


6438 Volume serial library phase error
System Services, when the REPLACE
option is in effect.
6439 Inter Library phase error
6237 Inquisitor Import table does not exist or
is a missing a column 6440 Rules processing phase error

6238 Inquisitor Import table does not exist 6444 LPA phase error

6239 Inquisitor Import table appears to be an 6448 Error while clearing LMOD count
old version.
6449 TDECISION Table is missing
6240 Error updating fGPassLibID record FDECRPTION and/or FCATEGORY
fields
6241 Error deleting empty libraries
6450 GKB TPRODUCT record seek error
6244 Error assigning package information to
TMODULE records 6451 LKB TPRODUCT record seek error

6260 Nothing to import, as no module 6452 TDECISION record edit error


records were found in IQ file.
6453 KB TVERSION record access error
6400 Knowledge Base type is incorrect
6454 KB TPRODUCT record access error
6402 Failure in initializing IQ tables
6455 KB TVENDOR record access error
6403 IQ TMODULE open error
6600 Match Engine tables TDECISION
6404 IQ TMODULE index error and/or TMIGREPORT are missing

Appendix A. Messages 175


6619 6812 IBM Confidential

6619 Error opening TPACKAGE table 6640 Error updating FINVID field in
TINVREG table
6620 Repository table initialization failed
6641 Error updating FINVID field in
TINVREG table
6621 Failure opening IQ table

6642 Error updating summary tables


6622 Unable to access GKB TVERSION table

6643 Error querying table in FMODID order


6623 IQ TMODULE table is empty

6645 Error marking TLIBRARY,


6624 Predecessor inventory ID key does not
TMODULETPOVLIB and TPOVINV
exist
records as deleted.

6625 Repository is not enabled for Unix


6647 Repository type does not match IQ type
System Services

6648 When using a Continuous Inventory, an


6626 Repository must be enabled for Unix
Inventory Name must be specified
System Services, when the REPLACE
option is in effect.
6800 At least one repository failed during
initialization
6627 SYSPLEX ID mismatch in inventory
record
6802 No matching LPAR found in table
6628 SMFID mismatch in inventory record
6803 Primary Inventory ID set to 0 for LPAR
6629 Inventory ID key of zero is not valid
6804 Error trying to find FMODID or FLIBID
6630 Error in deleting library record
6805 Inventory ID does not exist
6632 Error transferring TLIBRARY
information from IQ to Repository 6806 Unable to find or create TLPAR record
for LPAR
6633 Error accessing TINVCTL table
6807 Error trying to find or create Job or User
entry
6634 Mismatch found between the TINVCTL
record flag and the REPLACE option.
6808 Error writing MTD record
6635 Error updating FMODCNT field in
TLIBRARY and TPOVLIB tables 6809 Error updating summary tables

6636 Product version key error 6810 Error adding TUSELIBRARY record

6637 Module key error 6811 TLIBRARY update error

6639 Error updating FINVID18 fields in 6812 Summary table error


TUIMPORTCTRL table

176 Administration Guide and Reference


IBM Confidential 6813 7060

6813 Error reading import control record 7027 TUSEPOVLIB record edit error

6814 User initiated stop 7028 TUSEPOV record seek error

7000 At least one table failed initialization 7029 TUSEPOV record add error

7002 Invalid usage summary parameters 7030 TUSEPOV record edit error

7003 Invalid month in usage summary 7034 TUSEMTD critical failure


parameter
7035 TUSEMTD error updating record with
7004 Date order error zero FMTDID

7005 TMODULE record seek error 7036 TVERSION record seek error

7011 Error inserting record into TMODULE 7037 TUSEPO record seek error
table
7038 TUSEPO record seek error
7013 TJOBDATA record seek error
7039 TUSEPO record edit error
7014 TJOBDATA record add error
7040 TUSEPO record delete error
7015 TUSERDATA record seek error
7043 TMODULE record edit error
7016 TUSERDATA record add error
7044 TUSEPOVLIB record delete error
7017 TUSEMTD record seek error
7045 TUSEPOV record delete error
7018 TUSEMTD record add error
7046 TPERIODS record delete error
7019 TUSEMTD record edit error
7051 TUSELIB record delete error
7020 TUSEMTD record delete error
7052 IDS_USUM_TUSELIB_AUTONUM_ERROR
7021 TPOVINV record seek error
7055 TLPAR record edit error
7022 TPERIODS record seek error
7056 TUSELIB record seek error
7023 TPERIODS record add error
7057 TUSELIB record add error
7024 TPERIODS record edit error
7058 TPOVLIB record seek error
7025 TUSEPOVLIB record seek error
7060 TLPAR record seek error
7026 TUSEPOVLIB record add error

Appendix A. Messages 177


7061 7627 IBM Confidential

7061 Join record seek error 7606 TLIBRARY record seek error

7062 TLIBRARY record edit error 7607 TLIBRARY record edit error

7063 TLIBRARY record seek error 7608 TLIBRARY record add error

7065 Invalid SUMBY value 7609 TLIBRARY record delete error

7201 Inventory to be deleted does not exist in 7610 Transfer product version join seek error
repository
7611 TPOVLIB record seek error
7203 TLIBRARY record delete failure
7612 TPOVLIB record edit error
7204 TPOVINV record delete failure
7613 TPOVLIB record add error
7205 TPERIODS record delete failure
7614 TPOVLIB record delete error
7206 TLPAR record delete failure
7615 TPOVINV record seek error
7207 TUIMPCTRL record delete failure
7616 TPOVINV record edit error
7208 Failure updating Delete Inventory ID
record.
7617 TPOVINV record add error

7209 Failure deleting TINVCTL records of


7618 TPOVINV record delete error
deleted inventory

7619 Table TINVPOV failed in initialization


7210 Error scanning product version

7620 TVERSION record seek error


7211 Error reassigning predecessor links in
successor InvCTL records
7621 TVERSION record edit error
7600 Table initialization failure
7622 TVERSION record add error
7601 Destination repository column size
failure 7623 TVERSION record delete error

7602 TINVCTL record seek error 7624 Table TVERSION open failed

7603 TINVCTL record edit error 7625 TPRODUCT record seek error

7604 TINVCTL record add error 7626 TPRODUCT record edit error

7605 TINVCTL record delete error 7627 TPRODUCT record add error

178 Administration Guide and Reference


IBM Confidential 7628 7671

7628 TPRODUCT record delete error 7650 TREGLEAF record delete error

7629 TPRODUCT open error 7651 TINVREG record seek error

7630 TVENDOR record seek error 7652 TINVREG record edit error

7631 TVENDOR record edit error 7653 TINVREG record add error

7632 TVENDOR record add error 7654 TINVREG record delete error

7633 TVENDOR record delete error 7655 TJOBDATA record seek error

7634 TVENDOR open error 7656 TJOBDATA record edit error

7635 TMODULE record seek error 7657 TJOBDATA record add error

7636 TMODULE record edit error 7658 TJOBDATA record delete error

7637 TMODULE record add error 7659 TUSERDATA record seek error

7638 TMODULE record delete error 7660 TUSERDATA record edit error

7639 TREGCLASS record seek error 7661 TUSERDATA record add error

7640 TREGCLASS record edit error 7662 TUSERDATA record delete error

7641 TREGCLASS record add error 7663 TLPAR record seek error

7642 TREGCLASS record delete error 7664 TLPAR record edit error

7643 TREGION record seek error 7665 TLPAR record add error

7644 TREGION record edit error 7666 TLPAR record delete error

7645 TREGION record add error 7667 TUSEMTD record seek error

7646 TREGION record delete error 7668 TUSEMTD record edit error

7647 TREGLEAF record seek error 7669 TUSEMTD record add error

7648 TREGLEAF record edit error 7670 TUSEMTD record delete error

7649 TREGLEAF record add error 7671 TUSELIB record seek error

Appendix A. Messages 179


7672 7699 IBM Confidential

7672 TUSELIB record edit error 7694 TUIMPORTCTRL record seek error

7673 TUSELIB record add error 7695 TUIMPORTCTRL record edit error

7674 TUSELIB record delete error 7696 TUIMPORTCTRL record add error 7697

7675 TPERIODS record seek error 7697 TUIMPORTCTRL record delete error

7676 TPERIODS record edit error 7698 Source and destination repositories are
not the same type
7677 TPERIODS record add error
7699 Source and/or Destination Repositories
are not the correct category database
7678 TPERIODS record delete error

7679 TUSEPOVLIB record seek error

7680 TUSEPOVLIB record edit error

7681 TUSEPOVLIB record add error

7682 TUSEPOVLIB record delete error

7683 TUSEPOVLIB open error

7684 TUSEPOV record seek error

7685 TUSEPOV record edit error

7686 TUSEPOV record add error

7687 TUSEPOV record delete error

7688 TUSEPOV open error

7689 TUSEPO record seek error

7690 IDS_MRGE_TUSEPO_EDIT_ERROR

7691 TUSEPO record add error

7692 TUSEPO record delete error

7693 TUSEPO open error

180 Administration Guide and Reference


IBM Confidential

Appendix B. Repository table layouts


Table 16. TINVCTL
Column Name Column Type Column Description
Length
FINVID Integer Inventory ID
FINVNAME Char 24 Inventory ID name
FVERSIONGKBID Char 15 Version of the Global KB used to
match
FIQDATE Timestamp Current date that Inquisitor was run
on Mainframe
FIQDATEFIRST Timestamp Date the Inquisitor was first run on
Mainframe
FMIGDATEFIRST Timestamp Initial migrate date
FMIGDATE Timestamp Date Inquisitor data was loaded to
Repository
FSYSCPUID Char 12 CPU Serial number
FSYSPLEXID Char 8 Sysplex Name
FSYSFMID Char 8 System FMID
FSMFID Char 20 SMF ID
FPREVINVID Integer Predecessor Inventory ID
FIQSYSPLEXUSE Smallint Was the SYSPLEX option turned on
FVENDORCNT Integer Number of Vendors in Inventory
FPRODUCTCNT Integer Total Product count in Inventory ID
FLIBCNT Integer Total number of libraries in the
inventory
FINVCONT Char 1 Continuous Inventory
FINVTYPE Smallint Type of Inventory
FIQNAME Varchar 254 IQ Filename and path for DB2
Schema name

Table 17. TINVREG


Column Name Column Type Column Description
Length
FREGIONID Integer Parent Region ID
FINVID Integer Inventory ID

Table 18. TIQHISTORY


Column Name Column Type Column Description
Length
FHISTORYID Integer Unique ID
FINVID Integer Inventory ID
FIQDATE Timestamp Inquisitor date
FMIGTYPE Smallint Migrate type

Copyright IBM Corp. 2009 181


IBM Confidential

Table 18. TIQHISTORY (continued)


FIPADDR Varchar 254 List of IP Addresses
FSUBNETMASK Varchar 254 List of Subnet Masks
FMACADDR Varchar 254 List of MAC Addresses
FOSNAME Varchar 254 Operating System Name
FOSTYPE Varchar 254 OS type e.g. WINNT
FOSVERSION Varchar 254 Operating System Version
FOSBUILDNUMBER Varchar 254 Build Number of OS
FOSCSDVERSION Varchar 254 Latest Service Pack Installed
FOSSERNUM Varchar 254 OS product serial identification
number.
FOSINSTDATE Timestamp Date of OS installation. Null if
unknown.
FOSLASTBOOTDATE Timestamp Date of OS last boot. Null if
unknown.
FOSLASTBOOTDATE Timestamp Date of OS last boot. Null if
unknown.
FTOTALMEMORY Integer Total Physical Memory in MB

Table 19. TJOBDATA


Column Name Column Type Column Description
Length
FJOBNAME Char 8 Job Name
FJOBID Integer Job ID
FJOBTYPE Char 6 Job Type

Table 20. TLIBRARY


Column Name Column Type Column Description
Length
FLIBID Integer Library ID
FLIBNAME Char 128 Library name
FINVID Integer Inventory ID
FCREATIONDATE Timestamp Library creation date on Mainframe
FLIBDEVNUM Char 4 DASD device number
FREFERENCEDATE Timestamp Date library last referenced
FLIBVOLSER Char 6 Volser library resides on
FTRACKSALLOC Char 10 Number of allocated tracks
FTRACKSUSED Char 10 Number of used tracks
FORIGIN Char 1 Blank - PDS, E - PDSE, V - VTOC
FCATALOG Char 1 S - SMS managed, C - Cataloged, U
uncataloged W - cataloged on wrong
volume
FLINKLIST Char 1 Is this a link listed library
FLINKPACK Char 1 Is this library in the Linkpack
FAPFAUTH Char 1 Is this library APF authorized

182 Administration Guide and Reference


IBM Confidential

Table 20. TLIBRARY (continued)


FLASTUSAGE Date 1st month of the most recent usage
applied to any module in this library
FUSEFLAG Smallint Flag for library usage
FMODCNT Integer Number of modules in library
FOBSERVEFIRST Timestamp Date and time that library was first
observed
FOBSERVELAST Timestamp Date and time that library was last
observed
FOBSERVEDELETED Timestamp Date and time that library was
deleted from Inquisitor data.

Table 21. TLPAR


Column Name Column Type Column Description
Length
FLPARID Integer LPAR ID
FLPARNAME Char 20 Name of the LPAR
FUSEFLAG Smallint Indicates if usage has been attributed
to this LPAR
FEDITFLAG Smallint Has this LPAR record been updated
manually
FMANF Char 10 Machine manufacturer
FMACHINE Char 12 CPU Model
FSERIALNO Char 12 CPU Serial number
FMIPS Integer Number of MIPS for LPAR
FSYSPLEXID Char 8 Sysplex name if in a Sysplex

Table 22. TMODULE


Column Name Column Type Column Description
Length
FMODID Integer Module ID
FMODNAME Char 40 Module name
FLIBID Integer Library ID
FPOVLIBID Integer Product Library ID
FMODFLAG Smallint Module indication flag as to which
product version it belongs to and
whether it has been superseded.
FFMID Char 12 FMID
FMODSIZE Char 8 Module size
FUSEFLAG Smallint Flag for module usage
FMODTYPE Smallint Type of module
FOBSERVEFIRST Timestamp Date and time that module was first
observed
FOBSERVELAST Timestamp Date and time that module was last
observed

Appendix B. Repository table layouts 183


IBM Confidential

Table 22. TMODULE (continued)


FOBSERVEDELETED Timestamp Date and time that module was
deleted from Inquisitor data

Table 23. TPARAM


Column Name Column Type Column Description
Length
FKEY Char 64 Parameter Key
FVALUE Char 254 Parameter Value

Table 24. TPERIODS


Column Name Column Type Column Description
Length
FPERIOD Date Calendar month for usage
FINVID Integer Inventory ID
FSUMMARISED Smallint Summary status

Table 25. TPOVINV


Column Name Column Type Column Description
Length
FPOVINVID Integer Unique ID
FPOVID Integer Product ID
FINVID Integer Inventory ID
FPOVGID Integer Global Knowledge Base Version ID
FOBSERVEFIRST Timestamp First time observation was made
FOBSERVELAST Timestamp Last time observation was made
FOBSERVEDELETED Timestamp First time observation was not found
in this library
FPRODUCTID Integer Product ID
FVENDORID Integer Vendor ID
FPRODINVID Integer Product and Inventory ID
FPATCHLIST Varchar 254 List of current patches applied to
z/OS UNIX product.

Table 26. TPOVLIB


Column Name Column Type Column Description
Length
FPOVLIBID Integer Unique ID
FPOVINVID Integer Product inventory ID
FLIBID Integer Library ID
FPOVLIBPID Integer Previous Product Version ID
FMATCHCODE Char 3 Matching code
FMATCHID Integer Link to Inquisitor Decision table
FPRODUCTPCT Integer Product percentage used during
match

184 Administration Guide and Reference


IBM Confidential

Table 26. TPOVLIB (continued)


FVERSIONPCT Integer Version percentage used during
match
FOBSERVEFIRST Timestamp First time observation was made
FOBSERVELAST Timestamp Last time observation was made
FOBSERVEDELETED Timestamp First time observation was not found
in this library
FMODCNT Integer Number of load modules in library
for product

Table 27. TPRODUCT


Column Name Column Type Column Description
Length
FPRODUCTID Integer Product ID
FPRODUCTNAME Char 50 Product Name (could be alias name)
FGLOBALNAME Char 50 Product Name (always Global Name
if Alias is used)
FOPTIONNAME Char 30 Option Name
FVENDORID Integer Vendor ID
FPRODSTATUS Smallint Billable Status
FCATEGORY Char 30 Product Category
FDESCRIPTION Varchar 254 Product Description

Table 28. TREGCLASS


Column Name Column Type Column Description
Length
FREGCLASSID Smallint Region Class ID
FCLASSNAME Char 24 Region classification title
FICONID Smallint Icon Lookup

Table 29. TREGION


Column Name Column Type Column Description
Length
FREGIONID Integer Region ID
FREGIONNAME Char 64 Region Name
FPARENTID Integer Owning Region ID
FREGCLASSID Smallint Region category
FSEQ Smallint Sequence number for regions

Table 30. TREGLEAF


Column Name Column Type Column Description
Length
FPARENTID Integer Parent Region ID
FREGIONID Integer Region ID

Appendix B. Repository table layouts 185


IBM Confidential

Table 31. TUIMPORTCTRL


Column Name Column Type Column Description
Length
FINVID1 Integer Primary Inventory ID
FINVID2 Integer Second ID
FINVID3 Integer Third ID
FINVID4 Integer Fourth ID
FINVID5 Integer Fifth ID
FINVID6 Integer Sixth ID
FINVID7 Integer Seventh ID
FINVID8 Integer Eighth ID
FMODVPOV Char 1 If non 0 allows relaxed VPOV
assignment
FLPARNAME Char 20 LPAR name

Table 32. TUSELIB


Column Name Column Type Column Description
Length
FUSELIBID Integer Unique ID
FLPARID Integer LPAR ID
FLIBID Integer Library ID

Table 33. TUSEMTD


Column Name Column Type Column Description
Length
FMTDID Integer Unique ID
FLPARID Integer LPAR ID
FMODID Integer Module ID
FJOBID Integer Job ID
FUSERID Integer User ID
FPOVLIBID Integer Product Library ID
FEVENTCNT Float Total calls to module for this month
FPERIOD Date Calendar month that usage occurred
FFIRSTDATE Date First day of usage in the month
FLASTDATE Date Last day of usage in the month
FPROVIDER Char 4 Provider Service
FPOVINVID Integer Unique ID
FPRODINVID Integer Product and Inventory ID
FACCOUNTID Integer

Table 34. TUSEPO


Column Name Column Type Column Description
Length
FUSEPOVINVID Integer Unique ID

186 Administration Guide and Reference


IBM Confidential

Table 34. TUSEPO (continued)


FLARPID Integer LPAR ID
FPRODINVID Integer Product & inventory ID
FJOBCNT Integer Number of distinct Jobs for a
product
FUSERCNT Integer Number of distinct Users for a
product
FEVENTCNT1 Float Sum of calls to this product current
month
FEVENTCNT3 Float Sum of calls to this product previous
3 month
FEVENTCNT6 Float Sum of calls to this product previous
4-6 month
FEVENTCNT9 Float Sum of calls to this product previous
7-9 month
FEVENTCNT12 Float Sum of calls to this product previous
10-12 month
FPERIOD Date Calendar month in which usage
occurred
FFIRSTUSED Date The earliest usage date in month
FLASTUSED Date The most recent usage date in month

Table 35. TUSEPOV


Column Name Column Type Column Description
Length
FUSEPOVINVID Integer Unique ID
FLARPID Integer LPAR ID
FPOVINVID Integer POVINV ID
FJOBCNT Integer Number of distinct Jobs for a
product
FUSERCNT Integer Number of distinct Users for a
product
FEVENTCNT1 Float Sum of calls to this product current
month
FEVENTCNT3 Float Sum of calls to this product previous
3 month
FEVENTCNT6 Float Sum of calls to this product previous
4-6 month
FEVENTCNT9 Float Sum of calls to this product previous
7-9 month
FEVENTCNT12 Float Sum of calls to this product previous
10-12 month
FPERIOD Date Calendar month in which usage
occurred
FFIRSTUSED Date The earliest usage date in month
FLASTUSED Date The most recent usage date in month
FPRODINVID Integer Product Inventory ID

Appendix B. Repository table layouts 187


IBM Confidential

Table 35. TUSEPOV (continued)


FSEQNO Smallint Internal use only
FACCCNT Integer Internal use only

Table 36. TUSEPOVLIB


Column Name Column Type Column Description
Length
FUSEPOVLIBID Integer Unique ID
FLARPID Integer LPAR ID
FPOVLIBID Integer POVLIB ID
FJOBCNT Integer Number of distinct Jobs for a
product
FUSERCNT Integer Number of distinct Users for a
product
FEVENTCNT1 Float Sum of calls to this product current
month
FEVENTCNT3 Float Sum of calls to this product previous
3 month
FEVENTCNT6 Float Sum of calls to this product previous
4-6 month
FEVENTCNT9 Float Sum of calls to this product previous
7-9 month
FEVENTCNT12 Float Sum of calls to this product previous
10-12 month
FPERIOD Date Calendar month in which usage
occurred
FFIRSTUSED Date The earliest usage date in month
FLASTUSED Date The most recent usage date in month
FSEQNO Smallint Internal use only
FACCCNT Integer

Table 37. TUSERDATA


Column Name Column Type Column Description
Length
FUSERID Integer User ID
FUSERNAME Char 10 User Name
FORGNAME Char 8 Owning Organization
FREALNAME Char 20 Real persons name

Table 38. TVENDOR


Column Name Column Type Column Description
Length
FVENDORID Integer Vendor ID
FVENDORNAME Char 50 Vendor Name (could be alias name)
FGLOBALNAME Char 30 Vendor Name (always Global Name
if Alias is used)

188 Administration Guide and Reference


IBM Confidential

Table 38. TVENDOR (continued)


FVENDORGUID Char 32

Table 39. TVERSION


Column Name Column Type Column Description
Length
FPOVID Integer Version ID
FVERSIONNAME Char 16 Version name
FPPNUMNAME Char 16 PPNUM
FPRODUCTID Integer Product Option ID
FMINUSAGE Float Minimum usage threshold
FVERSIONGUID Char 32
FFEATUREGUID Char 32

Table 40. TACCOUNT


Column Name Column Type Column Description
Length
FACCOUNTID Integer
FACCOUNTCODE Char 20

Table 41. TUSEPRS


Column
Column Name Column Type Length Description
FUSEPRSID Integer
FREGVEND Char 16
FREGPROD Char 16
FREGFEAT Char 16
FREGVRN Char 6
FREGPID Char 8
FREGFLAGS Char 8
FLPARID Integer
FPERIOD Date
FFIRSTDATE Date
FLASTDATE Date

Table 42. NODE


Column
Column Name Column Type Length Description
NODE_KEY Char 32
NODE_TYPE Char 4
HW_TYPE Char 4
HW_MODEL Char 3
HW_PLANT Char 2
HW_SERIAL Char 12

Appendix B. Repository table layouts 189


IBM Confidential

Table 42. NODE (continued)


Column
Column Name Column Type Length Description
HW_NAME Char 10
HW_VENDOR Char 10
LPAR_NUMBER Integer
LPAR_NAME Char 10
VMGUEST_NAME Char 10
HW_NODE_KEY Char 32
LAST_UPDATE_TIME Timestamp

Table 43. NODE_CAPACITY


Column
Column Name Column Type Length Description
NODE_KEY Char 32
PERIOD Date
START_TIME Timestamp
END_TIME Timestamp
METRIC_TYPE Char 10
LAST_UPDATE_TIME Timestamp
QUANTITY Integer

Table 44. PRODUCT


Column
Column Name Column Type Length Description
SW_KEY Char 32
SW_TYPE Char 8
VENDOR_NAME Char 50
PRODUCT_NAME Char 50
VERSION Integer
VERSION_NAME Char 50
FEATURE_NAME Char 50
PID Char 8
EID Char 8
SSPID Char 8
SSEID Char 8
PRICETYPE Char 10
SUBCAPACITY Char 20
ICA Char 1
IPLA Char 1
VUE Char 8
VENDOR_GUID Char 32
PRODUCT_GUID Char 32

190 Administration Guide and Reference


IBM Confidential

Table 44. PRODUCT (continued)


Column
Column Name Column Type Length Description
VERSION_GUID Char 32
FEATURE_GUID Char 32
LAST_UPDATE_TIME Timestamp

Table 45. PRODUCT_INSTALL


Column
Column Name Column Type Length Description
SW_KEY Char 32
SYSTEM_KEY Char 32
INSTALL_DATE Date
UNINSTALL_DATE Date
LAST_USED_DATE Date
LAST_UPDATE_TIME Timestamp

Table 46. PRODUCT_NODE_CAPACITY


Column
Column Name Column Type Length Description
SW_KEY Char 32
NODE_KEY Char 32
PERIOD Date
START_TIME Timestamp
END_TIME Timestamp
METRIC_TYPE Char 10
LAST_UPDATE_TIME Timestamp
QUANTITY Float

Table 47. SYSTEM


Column
Column Name Column Type Length Description
SYSTEM_KEY Char 32
LAST_UPDATE_TIME Timestamp
SID Char 4
SMFID Char 4
SYSPLEX Char 8

Table 48. SYSTEM_NODE


Column
Column Name Column Type Length Description
SYSTEM_KEY Char 32
NODE_KEY Char 32
PERIOD Date

Appendix B. Repository table layouts 191


IBM Confidential

Table 48. SYSTEM_NODE (continued)


Column
Column Name Column Type Length Description
START_TIME Timestamp
END_TIME Timestamp
LAST_UPDATE_TIME Timestamp

Table 49. TABLE PRODUCT_USE


Column
Column Name Column Type Length Description
PERIOD Date
SYSTEM_KEY Char 32
SW_KEY Char 32
FLPARID Integer
HW_NODE_KEY Char 32
USER_CNT Integer
JOBNAME_CNT Integer
ACCOUNT_CNT Integer
SCRT_MSU Integer
EVENT_CNT Float
START_DATE Date
END_DATE Date
LAST_UPDATE_TIME Timestamp

Table 50. TABLE PRODUCT_USE_DETAIL


Column
Column Name Column Type Length Description
PERIOD Date
FLPARID Integer
VERSION_GUID Char 32
FEATURE_GUID Char 32
USERNAME Char 8
JOBNAME Char 8
ACCOUNTCODE Char 20
EVENT_CNT Float
START_DATE Date
END_DATE Date

192 Administration Guide and Reference


IBM Confidential

Notices
This information was developed for products and services offered in the U.S.A.

IBM may not offer the products, services, or features discussed in this document in
other countries. Consult your local IBM representative for information on the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may
be used instead. However, it is the users responsibility to evaluate and verify the
operation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matter
described in this document. The furnishing of this document does not grant you
any license to these patents. You can send license inquiries, in writing, to:

IBM Director of Licensing


IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBM
Intellectual Property Department in your country or send inquiries, in writing, to:

IBM World Trade Asia Corporation


Licensing
2-31 Roppongi 3-chome, Minato-ku
Tokyo 106-0032, Japan

The following paragraph does not apply to the United Kingdom or any other
country where such provisions are inconsistent with local law: INTERNATIONAL
BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION AS IS
WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
PURPOSE. Some states do not allow disclaimer of express or implied warranties in
certain transactions, therefore, this statement may not apply to you.

This information could include technical inaccuracies or typographical errors.


Changes are periodically made to the information herein; these changes will be
incorporated in new editions of the publication. IBM may make improvements
and/or changes in the product(s) and/or the program(s) described in this
publication at any time without notice.

Any references in this information to non-IBM Web sites are provided for
convenience only and do not in any manner serve as an endorsement of those Web
sites. The materials at those Web sites are not part of the materials for this IBM
product and use of those Web sites is at your own risk.

IBM may use or distribute any of the information you supply in any way it
believes appropriate without incurring any obligation to you.

Copyright IBM Corp. 2009 193


IBM Confidential

Licensees of this program who wish to have information about it for the purpose
of enabling: (i) the exchange of information between independently created
programs and other programs (including this one) and (ii) the mutual use of the
information which has been exchanged, should contact:

IBM Corporation
_Department number/Building number_
_Site mailing address_
_City, State; Zip Code_
_U.S.A. (or appropriate country)

Such information may be available, subject to appropriate terms and conditions,


including in some cases, payment of a fee.

The licensed program described in this document and all licensed material
available for it are provided by IBM under terms of the IBM Customer Agreement,
IBM International Program License Agreement or any equivalent agreement
between us.

Any performance data contained herein was determined in a controlled


environment. Therefore, the results obtained in other operating environments may
vary significantly. Some measurements may have been made on development-level
systems and there is no guarantee that these measurements will be the same on
generally available systems. Furthermore, some measurements may have been
estimated through extrapolation. Actual results may vary. Users of this document
should verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers of


those products, their published announcements or other publicly available sources.
IBM has not tested those products and cannot confirm the accuracy of
performance, compatibility or any other claims related to non-IBM products.
Questions on the capabilities of non-IBM products should be addressed to the
suppliers of those products.

All statements regarding IBMs future direction or intent are subject to change or
withdrawal without notice, and represent goals and objectives only.

This information is for planning purposes only. The information herein is subject to
change before the products described become available.

This information contains examples of data and reports used in daily business
operations. To illustrate them as completely as possible, the examples include the
names of individuals, companies, brands, and products. All of these names are
fictitious and any similarity to the names and addresses used by an actual business
enterprise is entirely coincidental.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, which


illustrate programming techniques on various operating platforms. You may copy,
modify, and distribute these sample programs in any form without payment to
IBM, for the purposes of developing, using, marketing or distributing application
programs conforming to the application programming interface for the operating
platform for which the sample programs are written. These examples have not
been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or
imply reliability, serviceability, or function of these programs.

194 Administration Guide and Reference


IBM Confidential

If you are viewing this information softcopy, the photographs and color
illustrations may not appear.

Trademarks
IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of
International Business Machines Corporation in the United States, other countries,
or both. If these and other IBM trademarked terms are marked on their first
occurrence in this information with a trademark symbol ( or ), these symbols
indicate U.S. registered or common law trademarks owned by IBM at the time this
information was published. Such trademarks may also be registered or common
law trademarks in other countries. A current list of IBM trademarks is available on
the Web at Copyright and trademark information (www.ibm.com/legal/
copytrade.shtml).

Intel, Intel logo, Intel Inside, Intel Inside logo, Intel Centrino, Intel Centrino logo,
Celeron, Intel Xeon, Intel SpeedStep, Itanium, and Pentium are trademarks or
registered trademarks of Intel Corporation or its subsidiaries in the United States
and other countries.

Linux is a registered trademark of Linus Torvalds in the United States, other


countries, or both.

Microsoft, Windows, Windows NT, and the Windows logo are trademarks of
Microsoft Corporation in the United States, other countries, or both.

UNIX is a registered trademark of The Open Group in the United States and other
countries.

Other company, product, or service names may be trademarks or service marks of


others.

Notices 195
IBM Confidential

196 Administration Guide and Reference


IBM Confidential

Index
A C DB2 Connect
installing 18
ABRARC cache Trigger event count DB2 JDBC driver 29
Inquisitor request verb 52 setting 79 DB2 objects 39
ABRMIG CAP DCB usage monitor command 69
Inquisitor request verb 51 usage monitor command 65 DEL usage monitor command 69
action processing 106 captured data delete Inventory 121
action statement 108 matching, to Knowledge Base 4 Delete Inventory
function 108 captured data, Inquisitor running 121
syntax 109 importing 4 deployment scenarios 7
active exclude list CATALOG Designing requests 54
displaying 68 Inquisitor request verb 50 Destination Repository 123
affected by migration 39 compressed output data switch Dorana Version 5 Release 4 35
Alias: CSECT setting 84 DSN usage monitor command 70
Inquisitor request verb 49 Computation phase
Alias: DSNAME tasks 4
Inquisitor request verb 48 continuous inventory 89
Alias: PGM Control statement specification 47 E
Inquisitor request verb 49 counters and statistics EXC usage monitor command 71
Alias: SG display 66 exclusion masking
Inquisitor request verb 50 CSA dataset name 62
Alias: XCSECT usage monitor command 66 program name 62
Inquisitor request verb 50 exclusion masks
Alias: XDSNAME use of to reduce data 62
Inquisitor request verb 49
Alias: XPGM
D
D-A
Inquisitor request verb 49
usage monitor command 66 F
Alias: XSG FULLIDR
D-C
Inquisitor request verb 50 Inquisitor request verb 51
usage monitor command 66
association
D-D usage monitor command 67
creating 119
D-I usage monitor command 67
AUTHLIBS
Inquisitor request verb 50
D-S usage monitor command 68 G
D-T usage monitor command 68 globalization
authorization 14
D-X usage monitor command 68 message suffix codes 171
automatic switch-and-write time of day
Data Capture phase message texts and explanations 171
setting 82
tasks 3 return codes 171
automatic switch-and-write time setting
data eet name inclusion entries globalization messages
displaying 68
adding 72 HSIC 171
automation server
data set allocation unit
data set cleanup 108
setting 81
Automation Server
data set allocation volume
creating the control data set 105
setting 82 H
files used by 104 hardware requirements 13
data set name
JCL 104 high level qualifier
syntax 110
message suffix codes 127 running
data set name exclusion entries
message texts and explanations 127 for Usage Monitor 122
adding 83
messages HSISZCAT 125
deleting 83
HSIA 127 deleting input data sets 126
data set name inclusion entries
preinstalling the control data set 106 running 126
deleting 71
request control statements 108 HSIZ - Usage Monitor
data set name inclusion/exclusion lists
return codes 127 messages 156
displaying 67
starting 106
data set name prefix
stopping 106
setting 70
Automation Server for z/OS 104
data set space primary allocation I
setting 75, 77 IDD usage monitor command 71
data space repository size
B setting 77
IDL usage monitor command
idle work element usage
72

batch reporting 99 DATASET control 72


Batch Reporting Inquisitor request verb 48 IDS usage monitor command 72
definition 3 DB2 Inquisitor 2
customization 17 captured data, importing 4

Copyright IBM Corp. 2009 197


IBM Confidential

Inquisitor (continued) Load to Repository (continued) parameter (continued)


collection of output 56 running 90 ASSTORC 22
functions, performed by 45 TPARAM parameters 90 ASVOLS 22
JCL 43 LPA usage monitor command 74 CBCDLL 19
message suffix codes 155 CEERUN 19
messages and codes DB 21
HSIX 155
running 3
M DB2 19
DB2EXIT 19
Match Engine 87
Inquisitor data DB2RUN 19
definition 3
adding data to existing Inventory 89 DBADMIN 21
running 87
definition 7 DBSSID 19
matched information
Inquisitor for z/OS 43 FLSCHMA 23
loading, into repository 5
Examples 52 GKBSCHMA 22
messages
files used by 44 GKBUSCHM 22
Automation Server
message suffix codes 136 HSIINST 19
HSIA 127
message texts and explanations 136 IQSCHEMAS 23
HSIC - globalization 171
messages and codes IQWLPRI 23
Product Tagging
HSIP 136 IQWLSEC 23
HSIT 149
return codes 136 IQWLUPRI 24
Utility 129
Inquisitor for z/OS UNIX 57 IQWLUSEC 24
Messages 127
files used by 58 IQWMPRI 23
messages and codes
JCL 57 IQWMSEC 23
Inquisitor
message texts and explanations 156 IQWMUPRI 24
HSIP 136
return codes 155 IQWMUSEC 24
migrated libraries
Inquisitor Import 85 KBCPYPND 21
processing 55
definition 3 KBMGMTC 21
migration 33, 35
running 85 KBSTORC 21
Hardware and Software Identification
Inquisitor requests KBVOLS 21
for z/OS Version 7 Release 1 37
syntax 46 LKBSCHMA 22
TLCMz 33
installation LKBUSCHM 22
MOD usage monitor command 74
verifying 31 LOCI 19
MODULE
Installation MESCHMA 23
Inquisitor request verb 49
requirements 13 MODE 19
Monitor
inventory association 118 REPSCHMA 23
running 4
running 119 SET HSI 18
SYSIN parameter 119 SET ISP 18
SGBIGCAT 20
N SGBIGVOL 20
J new data space repository
switching to 78
SGIDXCAT 20
SGIDXVOL 21
JAC usage monitor command 73
NOALIAS SGTABCAT 20
Japanese messages
Inquisitor request verb 50 SGTABVOL 20
customizing tasks 26
NOML2 TIADPLAN 20
job account collection status
Inquisitor request verb 51 PLX usage monitor command 75
setting 73
NONSMS post-installation
Inquisitor request verb 50 customization 17
NORECALL post-installation jobs
K Inquisitor request verb 51 creating 18
Knowledge Base NOTAGDATA running 26
captured data, matching 4 Inquisitor request verb 52 PRI usage monitor 75
knowledge base updates 103 processors 13
running 103 Product Tagger
O definition 3
Product Tagging
operational mode
L altering 74
message suffix codes 149
message texts and explanations 149
license JARs output allocation parameters
messages
installing 29 display 66
HSIT 149
link list output data sort status
return codes 149
correction 73 setting 78
product tagging utility 111
link pack area program monitoring status output DCB attributes
PROGRAM
setting 74 setting 69
Inquisitor request verb 49
LINKLIST
program mask entries
Inquisitor request verb 50
deleting 69
LLC usage monitor command 73
load to Repository 89
P program mask exclusion entries
parameter adding 71
Load to Repository
ASMGMTC 22 PRS usage monitor command 76
definition 3

198 Administration Guide and Reference


IBM Confidential

Q symbolic volume serial on output switch


setting 79
Usage Import
definition 3
queuing storage limit SYMVOL TPARAM parameters 91
set 66 Inquisitor request verb 51 Usage Monitor 61
SYSIN commands 65
parameter 124 definition 3
R SYSIN commands 116 files used by 61
REF usage monitor command 76 sysplex-wide software flag JCL 61
Region altering 75 refreshing the settings 64
definition 7 system identifier starting 63
region association utility 116 displaying 67 stopping 63
Region Association utility usage monitor settings
running 116 refreshing 76
registered software activity data T usage monitor system identifier
setting 77
collection status Tagger
setting 76 usage summary 119
control statements 113
REMIGRATE running 120
running 113
Inquisitor request verb 51 user name collection status
TCR reporting 93
reporting 93 setting 80
Tivoli Asset Discovery for z/OS
reporting phase USS Usage Monitor command 81
installing 15
tasks 5 Utilities 103
overview 1
reporting software running 5
Tivoli Common Reporting
database communications 14 Utility
data sources for JDBC
operating system 14 message suffix codes 129
configuring 30
reporting tool 14 Message texts and explanations 129
definition 3
Repository messages 129
determining JDBC data sources 30
matched information, loading 5 return codes 129
importing report package 30
Repository Merge 122 installing 15
running 123 post-installation tasks 29
Repository table layouts 181 starting 29 V
return codes 174 transferring report package 30 VOL usage monitor command 82
globalization 171 User Roles 31 VOLUME
Tivoli Common Reporting software 14 Inquisitor request verb 49
TLCMz Exporter 35
S TPARAM parameters 122
SCANCMD Delete Inventory 121
Inquisitor Import 85
W
function request verb 46 WRT usage monitor command 82
SCANDIR Load to Repository 90
function request verb 46 Match Engine 87
SCANMOD program parameters 116
function request verb 46 Repository Merge 123 X
SCANOBJ Usage Deletion 121 XDATASET
function request verb 46 Usage Import 91 Inquisitor request verb 49
SCANPGM Usage Summary 120 XDD usage monitor command 83
function request verb 46 TPARAM table XDS usage monitor command 83
SCRT running the update 124 XML
parameters 124 TRG usage monitor command 79 TPARAM parameters 125
running XML Export Utility 124
input 124 running 124
output 124 U XMODULE
Inquisitor request verb 50
TPARAM 124 UNIX program monitoring status
SCRT Import Utility 124 XPROGRAM
setting 81
running 124 Inquisitor request verb 49
UNK usage monitor command 80
SEC usage monitor command 77 XSTOGROUP
unknown event collection switch
security 14 Inquisitor request verb 50
setting 80
running Inquisitor against z/OS UNIX XVOLUME
UNM - Set user name collection
files 59 Inquisitor request verb 49
status 80
SID usage monitor command 77 UNT usage monitor command 81
SIZ usage monitor command 77 usage captured data
software requirements 13 importing 5 Z
SRT usage monitor command 78 usage deletion 121 z/architecture software 13
status settings running 121 z/Architecture software
displaying 68 Usage Event computation phase 13
STOGROUP definition 7 data capture phase 13
Inquisitor request verb 50 usage import 91 reporting phase 13
SWI usage monitor command 78 running 91
SYM usage monitor command 79

Index 199
IBM Confidential

z/OS
customization 17
ZIP usage monitor command 84

200 Administration Guide and Reference




Part Number: SC23-9991-00

IBM Confidential
Printed in USA

SC23-9991-00

You might also like