IMS CHKP

IBM IMS Online Reorganization Facility for z/OS
Version 1 Release 2
User's Guide
SC27-1577-06
IBM IMS Online Reorganization Facility for z/OS

Version 1 Release 2
User's Guide
SC27-1577-06
Note: Before using this information and the product it supports, read the information in Notices on page 117.
This edition applies to Version 1 Release 2 of IBM IMS Online Reorganization Facility for z/OS (product number 5655-H97) and to all subsequent releases and modifications until otherwise indicated in new editions. This edition replaces SC27-1577-05. Copyright IBM Corporation 1996, 2011. US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
Contents
About this information . . . . . . . . v
Service updates and support information . Highlighting conventions . . . . . . How to look up message explanations. . Searching an information center. . . Using a Web search . . . . . . . Using LookAt. . . . . . . . . How to send your comments . . . . . v . v . v . . . . vi . . . . vi . . . . vi . . . . vii . . . . . . . . .
Chapter 3. Applying maintenance . . . 31

HRFYUTIL syntax . . . . . . . . . . . HRFYUTIL control statements for maintenance . 31 32
Chapter 1. IMS Online Reorganization Facility overview . . . . . . . . . . . 1

What does IMS Online Reorganization Facility do? . 1 Database administration and change management . . 2 IMS Online Reorganization Facility features and benefits . . . . . . . . . . . . . . . . 3 Overview of the online reorganization process . . . 5 IMS Online Reorganization Facility documentation and updates . . . . . . . . . . . . . . 9 Accessibility features . . . . . . . . . . . 10 Summary of changes . . . . . . . . . . . 10
Chapter 2. Configuring IMS Online Reorganization Facility . . . . . . . . 13

Restrictions . . . . . . . . . . . . . . Hardware and software prerequisites . . . . . . Configuration considerations . . . . . . . . IMS Online Reorganization configuration road map Configuring the base environment . . . . . . . Managing BMP pauses . . . . . . . . . . How BMPs are affected during a reorganization How large checkpoint intervals are affected by BMP pauses . . . . . . . . . . . . . Adding checkpoints . . . . . . . . . . Installing the BMP pause feature . . . . . . Managing pauses for CICS and ODBA applications Enabling XCF connections . . . . . . . . . Setting up online IMS subsystems and XCF group names . . . . . . . . . . . . . Setting up IMS Online Reorganization Facility jobs XCF group names. . . . . . . . . . Verifying online IMS subsystems XCF connections . . . . . . . . . . . . . Verifying IMS Online Reorganization Facility jobs XCF connections. . . . . . . . . . . . Configuring your IMS Online Reorganization Facility runtime environment . . . . . . . . The runtime options modules HRFSETOP and HRF#ssid . . . . . . . . . . . . . . HRFSETOP and HRF#ssid module parameters . . Defining IMS Online Reorganization Facility runtime options . . . . . . . . . . . . Defining IMS Online Reorganization Facility Runtime Options per IMSID . . . . . . . . 13 14 15 15 16 17 17 18 19 20 21 22 22 23 23 24 25 25 26 28 29
| | | | | | | | | | | | | | | | | |
Chapter 4. Using IMS Online Reorganization Facility . . . . . . . . 35

Data and system flow . . . . . . . . . . . Running the IMS Online Reorganization Facility . . DD statements . . . . . . . . . . . . . The HRFSYSIN DD statement . . . . . . . HRFSYSIN DD statement keywords . . . . . Keywords that affect DBD and DMB replacements Takeover restart processing . . . . . . . . . Examples for IMS Online Reorganization Facility . . Example: Reorganizing a HIDAM without DBD changes. . . . . . . . . . . . . . . Example: Reorganizing an HDAM database with DBD changes . . . . . . . . . . . . . Example: IMS Online Reorganization Facility batch procedure . . . . . . . . . . . . Example: Reorganizing a partition of a PSINDEX Example: Unloading a HIDAM database . . . 35 35 36 42 42 63 64 65 65 66 66 67 67
Chapter 5. Troubleshooting . . . . . . 69
Gathering diagnostic information . . . . . . . DEBUG diagnostic record formatting exit routine Generating diagnostic information . . . . . . . HRFYUTIL syntax . . . . . . . . . . . An IMS Online Reorganization Facility job cannot connect to an online IMS subsystem . . . . . . 69 69 71 71 72
| | | |
Chapter 6. IMS Tools Online System Interface . . . . . . . . . . . . . . 75

IMS Tools Online System Interface overview . . IMS Tools Online System Interface implementation Setting up the PROCLIB member . . . . . . PROCLIB member keyword parameters . . . PROCLIB member keyword parameter syntax . IMS Tools Online System Interface messages . . Return and reason codes for client exception processing . . . . . . . . . . . . . IMS Tools Online System Interface abend codes . . 75 75 . 76 . 76 . 78 . 78 . 79 . 88
| |
Chapter 7. IMS Online Reorganization Facility messages and codes . . . . . 89

Return codes and abend codes . Messages . . . . . . . . . . . . . . . . . . . . . 89 . 89
Chapter 8. Reference . . . . . . . . 115

Sample library members . . . . . . . . . . 115
| |
Notices . . . . . . . . . . . . . . 117
Trademarks . . . . . . . . . . . . . . 118
Copyright IBM Corp. 1996, 2011
iii
Index . . . . . . . . . . . . . . . 121
iv
User's Guide
About this information

IBM IMS Online Reorganization Facility for z/OS (also referred to as IMS Online Reorganization Facility) is a database reorganization tool that you can use to maintain your databases so that they run as efficiently as possible. These topics provide instructions for configuring, and using IMS Online Reorganization Facility. These topics are designed to help database administrators, system programmers, application programmers, and system operators perform these tasks: v Customize your IMS Online Reorganization Facility environment v Diagnose and recover from IMS Online Reorganization Facility problems v Use IMS Online Reorganization Facility with other DB2 or IMS products To use these topics, you should have a working knowledge of: v The z/OS operating system v ISPF v SMP/E Specific changes since the previous edition of this book are indicated by a vertical bar (|) to the left of a change. Editorial changes that have no technical significance are not noted. Always check the DB2 and IMS Tools Product publications page for the most current version of this publication: http://www.ibm.com/software/data/db2imstools/imstools-library.html
Service updates and support information

To find service updates and support information, including software fix packs, PTFs, Frequently Asked Question (FAQs), technical notes, troubleshooting information, and downloads, refer to the following Web page: http://www.ibm.com/support/entry/portal/Overview/Software/ Information_Management/IMS_Tools
Highlighting conventions
This information uses the following highlighting conventions: v Boldface type indicates commands or user interface controls such as names of fields, folders, icons, or menu choices. v Monospace type indicates examples of text that you enter exactly as shown. v Italic type indicates variables that you should replace with a value, to indicate the titles of other publication, and to emphasize significant terms.
How to look up message explanations

You can use any of the following methods to search for messages and codes:
Searching an information center

In the search box that is located in the top left toolbar of any Eclipse help system, such as the IBM Information Management Software for z/OS Solutions Information Center, enter the number of the message that you want to locate. For example, you can enter DFS1065A in the search field. Use the following tips to help you improve your message searches: v You can search for information on codes by entering the code; for example, enter -327. v Enter the complete or partial message number. You can use wild cards (* or ?) in the message number to broaden your search; for example, DFS20??I. The information center contains the latest message information for all of the information management products that are included in the information center.
Using a Web search

You can use any of the popular search engines that are available on the Web to search for message explanations. When you type the specific message number or code into the search engine, you will be presented with links to the message information in IBM information centers.
Using LookAt
LookAt is an online facility that you can use to look up explanations for most of the IBM messages you encounter, as well as for some system abends and codes. Using LookAt to find information is faster than a conventional search because in most cases LookAt goes directly to the message explanation. You can use LookAt from the following locations to find IBM message explanations for z/OS elements and features, z/VM, VSE/ESA, and Clusters for AIX and Linux: v The Internet. You can access IBM message explanations directly from the LookAt Web site at http://www.ibm.com/eserver/zseries/zos/bkserv/lookat/. v Your z/OS TSO/E host system. You can install code on your z/OS or z/OSe systems to access IBM message explanations, using LookAt from a TSO/E command line (for example, TSO/E prompt, ISPF, or z/OS UNIX System Services running OMVS). v Your Microsoft Windows workstation. You can install code to access IBM message explanations on the z/OS Collection (SK3T-4269) using LookAt from a Microsoft Windows command prompt (also known as the DOS command line). v Your wireless handheld device. You can use the LookAt Mobile Edition with a handheld device that has wireless access and an Internet browser (for example, Internet Explorer for Pocket PCs, Blazer, or Eudora for Palm OS, or Opera for Linux handheld devices). Link to the LookAt Mobile Edition from the LookAt Web site. You can obtain code to install LookAt on your host system or Microsoft Windows workstation from a disk on your z/OS Collection (SK3T-4269) or from the LookAt Web site (click Download, and select the platform, release, collection, and location that suit your needs). More information is available in the LOOKAT.ME files available during the download process.
vi
User's Guide
How to send your comments

Your feedback is important in helping to provide the most accurate and high-quality information. If you have any comments about this book or any other IMS Online Reorganization Facility documentation, use either of the following options: v Use the online reader comment form, which is located at: www.ibm.com/software/data/rcf/ v Send your comments by e-mail to comments@us.ibm.com. Be sure to include the name of the book, the part number of the book, the version of IMS Online Reorganization Facility, and, if applicable, the specific location of the text you are commenting on (for example, a page number or table number).
About this information
vii
viii
User's Guide
Chapter 1. IMS Online Reorganization Facility overview

IMS Online Reorganization Facility performs a one-step reorganization of IMS databases with minimal database availability impact. IMS Online Reorganization Facility supports internal logical relationships, secondary indexes, and HALDBs. Taking systems offline for maintenance can affect your business. In today's market, systems must be highly available because the cost of outage can be too high. Online data reorganization provides users with full access to the database during a data reorganization, improves the overall database availability, and reduces planned downtime. IMS Online Reorganization Facility provides the following capabilities and benefits: v Lets you schedule when you want to reorganize online databases by predefining an online reorganization window, which saves DBA resources and CPU time, and increases database availability v Provides all the necessary reorganization procedures (unload, reload, prefix resolution, prefix update, secondary index building, and image copy) in one simple step v Supports secondary indexing and internal logical relationships (excluding external logical relationships) v Reduces database downtime from hours to seconds v Improves DBA productivity by providing a single-step reorganization process v Eliminates the need for operator intervention after reorganization a database has been reorganized v Provides optional pointer checking and ACB or DMB replacements Keeping IMS databases reorganized helps ensure that your IMS applications perform at their optimal levels. Topics: v What does IMS Online Reorganization Facility do? v Database administration and change management on page 2 v IMS Online Reorganization Facility features and benefits on page 3 v Overview of the online reorganization process on page 5 v IMS Online Reorganization Facility documentation and updates on page 9 v Accessibility features on page 10 v Summary of changes on page 10
What does IMS Online Reorganization Facility do?

IMS Online Reorganization Facility provides a way to reorganize and unload your IMS databases with minimal impact to their availability. IMS Online Reorganization Facility allows a database to be updated while the reorganization or unload process is occurring. After all changes are captured and applied, the database is taken offline for a brief period at the end of the reorganization. During this period, the shadow data sets that have been
reorganized are renamed to match the original database data set names. A shadow data set is a temporary copy of an original data set. After the online reorganization is complete, no manual intervention is required, unless the database state is undetermined or if you have specified that the shadow database data sets not be renamed. IMS Online Reorganization Facility supports the following database organization types: v HDAM (Hierarchical Direct Access Method) v HIDAM (Hierarchical Indexed Direct Access Method) v HISAM (Hierarchical Indexed Sequential Access Method) v SHISAM (Simple Hierarchical Indexed Sequential Access Method) v PHDAM (Partitioned Hierarchical Direct Access Method) v PHIDAM (Partitioned Hierarchical Indexed Direct Access Method) v PSINDEX v Secondary index When IMS Online Reorganization Facility reorganizes HISAM, HIDAM, HDAM, and SHISAM databases it recreates all associated index data sets. PHIDAM and PHDAM databases are reorganized as single partitions. HALDB partitions are reorganized in single job step and their internal logical relationships are supported. Index databases (including PSINDEX) can be reorganized while the database remains online. IMS Online Reorganization Facility supports secondary indexing and internal logical relationships (excluding external logical relationships). IMS Online Reorganization Facility can optionally create a standard HD unload data set for a database, and it also creates a standard image copy data set for all the reorganized databases that are registered as recoverable with DBRC. IMS Online Reorganization Facility depends on other utilities, some of which are required and some of which are optional. For more information about these operational requisites see the IBM Program Directory for IMS Online Reorganization Facility for z/OS.
Database administration and change management

IBM solutions help IT organizations maximize their investment in IMS databases while staying on top of some of today's toughest IT challenges. Database administration and change management are the core responsibilities of the DBA. If not managed correctly, they can monopolize data center resources, waste valuable time, and can result in errors. Managing the database administration and change management process requires database administrators to address the following questions: v How can I ensure that I complete all the necessary steps when making changes? v v v v What is the best way to propagate changes to other database environments? How can I keep IMS software versions current? How do I manage a corrupted database? What is the most efficient way to convert IMS full-function databases to the new High Availability Large Database (HALDB) format?
User's Guide
Many IMS Tools products provide database management features that are not available in IMS itself or that provide enhancements to capabilities that are built into IMS. IMS Online Reorganization Facility is only one of several IMS Tools products that provide enhancements to the process of managing database operations.
IMS Online Reorganization Facility and other IMS Tools

Many IMS tools provide database management features that are not available in IMS itself or provide enhancements to capabilities built into IMS. IMS Online Reorganization Facility for z/OS is fully integrated with the IBM high performance utilities. IMS Online Reorganization Facility is designed for those customers that require certain databases be available on a 24x7 basis. IBM has two solutions that can help reduce the time that is required to keep databases in top condition, while enhancing your ability to manage IMS databases. These solutions are: v IMS Parallel Reorganization for z/OS v IMS Online Reorganization Facility for z/OS The IBM advanced solutions require only one job step and operate in a parallel mode to reduce elapsed times. These IMS Tools solutions are truly integrated, end-to-end processes that are designed to work with the basic IMS high performance utilities from IBM, which include: v IMS HP Unload for z/OS v IMS HP Load for z/OS v IMS Index Builder for z/OS v IMS HP Prefix Resolution for z/OS v IMS HP Image Copy for z/OS v IMS HP Pointer Checker for z/OS Other IMS Tools products that can assist with database administration and change management include: v IMS HD Compression Extended v IMS Library Integrity Utilities v IMS Parameter Manager v IMS Sequential Randomizer Generator v IMS Sysplex Manager v IMS Tools Knowledge Base
IMS Online Reorganization Facility features and benefits

Using IMS Online Reorganization Facility to reorganize IMS databases offers some significant benefits over other methods of reorganizing IMS databases. IMS Online Reorganization Facility provides the following features and benefits: Increase database availability All database changes are captured and applied while the databases are being reorganized. You do not need to take the databases offline to
reorganize them. IMS Online Reorganization Facility is designed to reorganize databases while they are being updated or accessed within IMS online systems. Improve performance IMS Online Reorganization Facility provides high-performance by streamlining parameter setting and running tasks in parallel. Simplify your JCL IMS Online Reorganization Facility saves time and eliminates the difficulty that is involved with writing DD statements by dynamically allocating the database data sets with DBRC, and dynamically allocating image copy data sets and other output data sets by using control statements. Achieve a one-step reorganization process By automatically invoking other required reorganization utilities in a single reorganization step, IMS Online Reorganization Facility saves DBA resources and CPU time. Create compatible data Data that is created by IMS Online Reorganization Facility is compatible with IMS standard utilities. The optional HD unload data set and the DFSURWF1 data set (that is created only for internal logical relationships and not for secondary indexes) are examples of data sets that are compatible with the IMS standard utilities. | | | | | | | | | | | | | | Automate replacement of DBDs and ACBs or DMBs DBD changes are supported during the reorganization process and do not require any manual intervention after the reorganization. You can make the DBD change available immediately without using IMS online change because IMS Online Reorganization Facility performs the following actions: v It copies the changed DMB to ACBLIBA and ACBLIBB. v It starts the database during the Takeover phase. v It activates the new DMB. IMS Online Reorganization Facility automatically generates an ACB and performs a DMB replacement in the master and active ACBLIBs and of the current online IMS subsystems. This approach eliminates manual intervention, increases database availability, and clears the database PROHIBIT AUTH DBRC status that results from any DBD or ACB change. Generate statistic and progress reports Statistic reports Provide statistics about data sets, segments, and segment pointers. The reports serve as valuable aids in tuning your databases. Progress reports Provide detailed descriptions of the progress of the reorganization. The messages describe all the reorganization functions and their statuses in order of occurrence. All the other utilities that are used by IMS Online Reorganization Facility provide reports in their respective output data sets. Pause support during /DBRECOVERY Batch message processing programs (BMPs) can be paused during /DBRECOVERY (/DBR) commands. Also, CICS and OTMA applications can quiesce database access during ODBA commands.
User's Guide
Scheduled Takeover phase Managing database outages so that they occur with the least amount of service disruption is important. You can use the TAKEOVER.WINDOW keyword to predefine the takeover period. Automatic Takeover phase restart processing If the previous reorganization job failed or was delayed during the Takeover phase, the Takeover phase can restart automatically from where it stopped.
Overview of the online reorganization process

IMS Online Reorganization Facility performs the reorganization process in several phases. Reorganization phases occur in the following sequence: 1. Verification phase 2. Copy phase 3. Reorganization phase 4. Apply phase 5. Takeover phase 6. Completion phase Descriptive messages are written to the MSGPRINT log that indicate the start and end of each phase and the progress of the tasks that are being performed. IMS Online Reorganization Facility makes a copy of the target databases and reorganizes the copy. While that phase is being processed, IMS Online Reorganization Facility captures any updates that were made since the first copy was taken and processes those recent updates against the reorganized copy. This process continues until all the updates have been applied. A single /DBR command outage is necessary at the end of the reorganization to alter the database data sets from the shadow names to the original names, and to make any ACB or DMB replacements in the online systems. After the updates have been applied, a user-scheduled outage of several seconds occurs during which the database's data sets are swapped and the new reorganized database becomes available. You can schedule this outage by using the TAKEOVER.WINDOW keyword. The following figure shows the data flow through the phases of IMS Online Reorganization Facility processing.
Original DBs / DSs
CAPTURE
VERIFICATION Phase
Log
COPY Phase
UNLOAD Process
Temp DBs / DSs

Shadow DBs / DSs Image Copy DBs / DSs Batch Log
RELOAD Process
Image Copy Process

DBs / DSs Changes
APPLY Phase
TAKEOVER Phase
COMPLETION Phase
Figure 1. Data flow of the online reorganization process
The Verification phase

The Verification phase is the initial phase during which the IMS environment components and databases are verified to ensure that they meet the necessary requirements. The following verifications are performed during this phase: v IMS Release and component requirements are met. v DBRC registration and database state requirements are met. v Database DBD requirements are met. v Database data set requirements are met. They cannot exceed 42 characters in length and they must be cataloged. v The level of IMS Online Reorganization Facility for the STEPLIB in the batch job and the IMS control regions is verified. v JCL requirements are met. v Control statement syntax is verified. v Shadow data set (.S data sets) are constructed and deleted, and reallocation is performed and verified. v Temporary (.T data sets) ALTER data sets are deleted, and the deletions are verified. v Other miscellaneous checking is performed.
User's Guide
The Verification phase attempts to perform all necessary verifications at the beginning of the reorganization. If minimum requirements are not met, this phase fails with a U999 abend, and all messages are written to the MSGPRINT log. The original databases are not impacted.
The Copy phase

Before the Copy phase begins, the databases are briefly paused to flush the buffers across all IMS subsystems. Flushing the buffers eliminates the need to issue /DBR commands and eliminates the need to unauthorize the databases in DBRC. During the first database sync point pause, the online component of IMS Online Reorganization Facility is notified to perform the following actions: v It captures all changes made to the primary database data sets. v It sends the changes to the Online Reorganization batch utility. v It prepares the changes for application during the Copy phase. The Copy phase copies only the original primary database to a shadow copy. The shadow data sets are allocated during the Verification phase. The shadow data sets are dynamically constructed based on the original data set names and an appended .S suffix. Important: You must have enough DASD to allocate the data sets within the same SMS pool (most common) or designated DASD volumes on which your original database data sets are allocated. Because most databases are allocated by using SMS, the number of DASD volumes is not an issue. You do not need to provide IDCAMS definitions for the shadow data sets. The shadow data sets are constructed by using the cataloged information from the original data set names. Near the end of the Copy phase, another database sync point pause is issued. This sync point pause ensures that all the changes that were made to the primary database data sets have been applied to the shadow database data sets. During this second brief pause, the following actions occur: v v v v Any application update calls to the primary database are captured. Changes are sent to the IMS Online Reorganization Facility batch utility. Changes are made to the shadow primary database. The shadow primary index (for HIDAM or PHIDAM) is created from the shadow primary database.
The primary index is rebuilt without any effect on the availability of the original databases. Secondary indexes are not copied to shadow databases in this phase; they are rebuilt later.
The Reorganization phase

The following tasks, which are necessary to complete a reorganization of a primary database and all of its associated databases, are performed during the reorganization phase. 1. 2. 3. 4. The shadow database is unloaded. The shadow database is reloaded. Any existing secondary indexes are rebuilt except for HALDB databases. Any existing internal logical relationships are rebuilt.
5. The reorganized shadow databases of all the original databases that are registered as RECOV in DBRC are image copied and can be pointer checked. During the Reorganization phase, any application update calls that are captured by the online component of IMS Online Reorganization Facility are written to a temporary data set for use in the subsequent Apply phase.
The Apply phase

During the Apply phase, all the application calls that have occurred since the start of the reorganization process are applied to the shadow data sets. Throughout the Apply phase, any application update calls that are issued in the IMS online regions are still captured and stored in a temporary data set. When the Apply phase determines that it has applied nearly all the captured update calls, it issues a /DBR FEOV command. The /DBR FEOV command stops any additional access to the original database in the IMS online regions, and turns on the PROHIBIT AUTH flag in DBRC. The database and its indexes are unavailable until after the Takeover phase. The Apply phase ends when all the captured update calls have been applied.
The Takeover phase

The Takeover phase begins when the Apply phase completes. During the Takeover phase, the original databases are swapped with the reorganized shadow databases. The following tasks are performed during the Takeover phase in this order: 1. Verifies that the database and its indexes are unavailable. 2. Notifies DBRC of the REORG with a timestamp after the /DBR command. 3. Notifies DBRC of the image copy with a timestamp that is greater than the REORG timestamp. 4. Notifies DBRC of a DB ALLOC that is needed for log data sets. 5. Notifies DBRC of logs that were created during the Apply phase. These logs are marked in error until the Takeover phase completes. 6. Swaps the reorganized shadow data sets with the original database data sets. 7. Performs the ACBGEN and ACBLIB or DMB replacements if DBD changes have occurred. 8. Copies the NEWDBD to the current DBDLIB if DBDCOPY(Y) is specified. 9. Authorizes the databases in DBRC. 10. Starts the databases by using a /START command. 11. Continues to recover the log marked in error. Corrects the previous log that was marked in error with a valid timestamp that is greater than the DBRC REORG and image copy notifications. The Takeover phase does not wait for the previous log correction to occur. 12. Notifies DBRC of the log with the new timestamp. If the Takeover phase completes abnormally, the job abends, the databases are left in a PROHIBIT AUTH status, and IMS Online Reorganization Facility invokes the Takeover Restart utility. You can restart the IMS Online Reorganization Facility batch job only if the job terminated abnormally within the Takeover phase. No other phase of IMS Online Reorganization Facility is restartable.
User's Guide
Related concept: v Takeover restart processing on page 64
The Completion phase

The Completion phase is the final phase of IMS Online Reorganization Facility processing. During this phase, the following cleanup tasks are performed: v All the final reports and messages are written. v Shadow data sets are deleted if you have specified DELETE(Y). v Data sets are deallocated. v Miscellaneous cleanup tasks are performed. v The IMS Online Reorganization Facility batch job ends.
IMS Online Reorganization Facility documentation and updates

This topic explains where to find DB2 and IMS Tools information on the Web, and explains how to receive information updates automatically.
IMS Online Reorganization Facility information on the Web

The DB2 and IMS Tools Library Web page provides current product documentation that you can view, print, and download. To locate publications with the most up-to-date information, refer to the following Web page: http://www.ibm.com/software/data/db2imstools/library.html You can also access documentation for many DB2 for z/OS and IMS Tools from the Information Management Software for z/OS Solutions Information Center: http://publib.boulder.ibm.com/infocenter/imzic Documentation for many DB2 Tools that run on Linux, UNIX, and Windows systems can be found in the IBM DB2 Tools for Linux, UNIX, and Windows Information Center: http://publib.boulder.ibm.com/infocenter/mptoolic/v1r0/index.jsp IBM Redbooks publications that cover DB2 and IMS Tools are available from the following Web page: http://www.ibm.com/software/data/db2imstools/support.html The Data Management Tools Solutions Web site shows how IBM solutions can help IT organizations maximize their investment in DB2 and IMS databases while staying ahead of today's top data management challenges: http://www.ibm.com/software/data/db2imstools/solutions/index.html
Receiving documentation updates automatically

To automatically receive a weekly e-mail that notifies you when new technote documents are released, when existing product documentation is updated, and
when new product documentation is available, you can register with the IBM My Support service. You can customize the service so that you receive information about only those IBM products that you specify. register with the My Support service: Go to http://www.ibm.com/support/mysupport Enter your IBM ID and password, or create one by clicking register now. When the My Support page is displayed, click add products to select those products that you want to receive information updates about. The DB2 and IMS Tools category is located under Software > Data and Information Management > Database Tools & Utilities. 4. Click Subscribe to e-mail to specify the types of updates that you would like to receive. 5. Click Update to save your profile. To 1. 2. 3.
Accessibility features
Accessibility features help a user who has a physical disability, such as restricted mobility or limited vision, to use a software product successfully. The major accessibility features inIMS Online Reorganization Facility enable users to: v Use assistive technologies such as screen readers and screen magnifier software. Consult the assistive technology documentation for specific information when using it to access z/OS interfaces. v Customize display attributes such as color, contrast, and font size. v Operate specific or equivalent features by using only the keyboard. Refer to the following publications for information about accessing ISPF interfaces: z/OS ISPF User's Guide, Volume 1 z/OS TSO/E Primer z/OS TSO/E User's Guide These guides describe how to use ISPF, including the use of keyboard shortcuts or function keys (PF keys), include the default settings for the PF keys, and explain how to modify their functions.
Summary of changes
This topic summarizes the technical changes for this edition. New and changed information is indicated by a vertical bar (|) to the left of a change. Editorial changes that have no technical significance are not noted. | | | | | | | | | | SC27-1577-06 v Clarified and updated the information on cross-system coupling facility (XCF) connections. For details, see Enabling XCF connections on page 22. SC27-1577-05 v Updates are made to reflect the changes to the IMS Online Reorganization Facility and TOSI interfaces. The new TOSI version is now part of the IMS Tools Base. TOSI and IMS Online Reorganization Facility are now implemented by using the IMS Tools Generic exits. For more information, see Enabling XCF connections on page 22
10
User's Guide
| | | | | | | |
v Added a new topic Installing the BMP pause feature on page 20. v Add information to the ONLINECHANGE keyword, applicable when IMS uses dynamic allocation. For more information, see Keywords that affect DBD and DMB replacements on page 63. v Added the BMPRETRY, DBSTART, and HOLDDATA parameters to the HRFSETOP and HRF#ssid module parameters on page 26 topic. v Added the DBSTART and ITKBSERVER keywords to the HRFSYSIN DD statement keywords on page 42 topic. SC27-1577-04 v Replace the "Linking the DFSRRC00 SMP/E USERMOD into IMS RESLIB" topic with a new topic. To review the new topic, see Installing the BMP pause feature on page 20. v Removed the "Editing the JCL of BMP jobs" topic. v Removed the "Managing BMP pauses with IMS Program Restart Facility" topic. SC27-1577-03 v This manual has undergone extensive editorial and organizational changes. v Updates were made to reflect the support for CICS and BMP pause functionality. v Additional DD statements and keywords, including: DFSURGU1 IEFRDER2 DBDLIST IC1DSN IC2DSN ICEIN IC.VIC IC.VICDSN IMSID
LOG1DSN LOG2DSN SC27-1577-02 v You can use the IMS Online Reorganization Facility to reorganize just an index data set. v You can use the IMS Online Reorganization Facility to reorganize all the partitions for a particular HALDB. This function also provides you the support to reorganize a HALDB that has an internal logical relationship. v You can use the IMS Online Reorganization Facility to run a near-online unload of a database.
11
12
User's Guide
Chapter 2. Configuring IMS Online Reorganization Facility

Before you can use IMS Online Reorganization Facility, you must configure your environment. This process involves configuring the base environment, managing the required database pauses, setting up XCF connections, and defining runtime options that are specific to your environment. Topics: v Restrictions v Hardware and software prerequisites on page 14 v Configuration considerations on page 15 v IMS Online Reorganization configuration road map on page 15 v Configuring the base environment on page 16 v Managing BMP pauses on page 17 v Managing pauses for CICS and ODBA applications on page 21 v Enabling XCF connections on page 22 v Configuring your IMS Online Reorganization Facility runtime environment on page 25
Restrictions
IMS Online Reorganization Facility has the same restrictions as all the other utilities that are used by the reorganization process and some additional restrictions. IMS Online Reorganization Facility does not support the following items: v Batch jobs running as DLI, DBB, or ULU region types accessing the database during the reorganization process HSAM databases HIDAM databases with compressed root keys Databases and database data sets that are not registered to DBRC External logical relationships Fast Path databases Reorganization of multiple HALDB partitions in one step (you can do this type of reorganization in parallel with separate IMS Online Reorganization jobs) v HALDB DBD changes v Reorganization of HALDB M-V data sets v v v v v v v Uncataloged or corrupted databases v Databases using PDF The following DBD changes are not allowed by IMS Online Reorganization Facility: v DBD Name v DBD Type v DBD access method
13
v v v v v v v v v v v v v v v v
Randomizer name Conversion from full function to HALDB Conversion from, or to a single secondary index or shared secondary index Deletion of a secondary index Primary index VSAM blocksize DSG structures Deletion of segments Hierarchical structure changes Segment type sequence Decrease of fixed segment lengths Fixed to, or from variable length segments Segment sequence key names, offsets, and length Addition of logical relationships Modification or deletion of internal logical relationships HIDAM database root key compression
Hardware and software prerequisites

Before you configure IMS Online Reorganization Facility, make sure that your environment meets the following minimum hardware and software requirements.
Hardware prerequisites
Your hardware must support IMS V9R1 or subsequent versions, releases, and modification levels.
Software prerequisites
You must have the following required software: v z/OS Version 1 Release 9 configurations or subsequent versions, releases, and modification levels v IMS V9R1 or subsequent versions, releases, and modification levels v DBRC The following software is optional. The following IMS Tools can improve the performance of IMS Online Reorganization Facility. v IMS High Performance Unload for OS/390 V1.2 (5655-E06) v IMS High Performance Load for z/OS V2.1 (5655-M26) v IMS High Performance Image Copy for z/OS V4.1 (5655-N45) or later v IMS High Performance Pointer Checker for z/OS V3.1 (5655-U09) or later v IMS High Performance Prefix Resolution for z/OS, V3.1 (5655-M27) (if internal logical relationships require it) | v IMS Program Restart Facility for OS/390, V2.1 (5655-E14) v IMS Tools Base for z/OS
| | |
14
User's Guide
Configuration considerations
Before you begin to configure IMS Online Reorganization Facility, you need to consider some configuration choices that you have when you use IMS Online Reorganization Facility. | | | | | | | | If you have IMS Program Restart Facility, do not install the BMP pause USERMOD for either IMS Recovery Solution Pack: Database Recovery Facility: Extended Functions or IMS Online Reorganization Facility. The USERMOD provided with IMS Program Restart is the best version to use. If IMS Program Restart Facility is not installed, IMS Recovery Solution Pack: Database Recovery Facility: Extended Functions continues to function normally. If you have DBDs that contain virtual segments, you must provide a DFSURGU1 DD statement because standard IMS utilities are used during the reorganization.
IMS Online Reorganization configuration road map

You need to progress through five main tasks when configuring IMS Online Reorganization Facility. The information in this topic provides a quick reference to those tasks, the processes you need to run, and links to the topics that explain how to complete the task.
Table 1. IMS Online Reorganization Facility configuration road map Task Configure the base environment Instructions The summarized configuration steps are: 1. Validate that your systems meet all the requirements for IMS Online Reorganization Facility. 2. Apply any necessary maintenance. 3. Specify load libraries. 4. Recycle all affected control regions. Manage BMP pauses 1. Install the BMP pause feature. 2. Optional: Define extra checkpoint intervals. v Installing the BMP pause feature on page 20 v Adding checkpoints on page 19 Edit and run the HRFCICS member. Managing pauses for CICS and ODBA applications Enable XCF connections Perform the following steps: 1. Set up online IMS subsystems and XCF group names for the IMS Tools Online Interface. 2. Set up IMS Online Reorganization Facility jobs XCF group names. 3. Verify online IMS subsystems XCF connections. 4. Verify IMS Online Reorganization Facility jobs XCF connections for the IMS Tools Online Interface. Managing pauses for CICS and ODBA applications on page 21 Enabling XCF connections on page 22 Link to topic Configuring the base environment on page 16
15
Table 1. IMS Online Reorganization Facility configuration road map (continued) Task Configure your IMS Online Reorganization Facility runtime environment Instructions Perform the following steps: 1. Edit and run the HRFINST member. 2. Edit and run the HRFSETOP member. Link to topic Configuring your IMS Online Reorganization Facility runtime environment on page 25
Configuring the base environment

Before you can perform the more advanced configuration steps, you must configure a basic IMS Online Reorganization Facility environment.
Procedure
To initially set up IMS Online Reorganization Facility in one or more IMS subsystems, complete the following steps: 1. Verify that you have installed and applied up-to-date maintenance for, and that you are licensed for all the required IMS Utilities for IMS Online Reorganization Facility. 2. Determine which IMS Control Regions share the same RECON across the sysplex. 3. Ensure that all databases to be processed by IMS Online Reorganization Facility are registered with DBRC. 4. Ensure that the primary databases to be processed by IMS Online Reorganization Facility are registered as RECOV in DBRC. 5. Modify and run the HRFINST member in the IMS Online Reorganization Facility Sample Library. 6. APF-authorize the following items: v The IMS Online Reorganization Facility Load Library v The IMS Utilities that are required for IMS Online Reorganization Facility v Any libraries in the STEPLIB of the batch online reorganization job v All libraries in the STEPLIB of the IMS Control Region Verify that the same maintenance level of IMS Online Reorganization Facility exists in the STEPLIB for the following items: v All IMS control regions that use the same RECONs as the IMS Online Reorganization Facility batch job v The IMS Online Reorganization Facility batch job Provide a DFSURGU1 DD statement if you have DBDs that contain virtual segments. Verify that the IMS Tools Base Generic exits are used for both the IMS Online Reorganization Facility version of DFSPPUE0 and DFSFLGX0 exits. Ensure that the IMS Online Reorganization Facility version of DFSPPUE0 exit is defined in the GPR* exit definition members. Ensure that the IMS Online Reorganization Facility version of DFSFLGX0 is defined in the GLX* exit definition members. Verify that Generic Exits are installed in your IMS control region. Your STEPLIB must contain the SGLXLOAD, SFOILOAD, and SHRFLOAD libraries.
| 7.
| | | | | | | | | | |
8. 9. 10. 11. 12.
16
User's Guide
13. Verify that IMS Tools Online Interface FOI* members are created for all affected control regions. 14. Recycle all affected control regions. No special restart is necessary. 15. Ensure that you received the following initialization messages from IMS Online Reorganization Facility and from the IMS Tools Online System Interface component in each IMS control region that shares the same RECON data sets. |
HRF010503I Joined XCF group TOIssid7 as member ssid7 GLX2926I IMS TOOLS GENERIC LOGGER EXIT INITIALIZATION IN PROGRESS GPR2926I IMS TOOLS GENERIC PARTNER EXIT INITIALIZATION IN PROGRESS GPR2926I IMS TOOLS GENERIC PARTNER EXIT INITIALIZATION COMPLETE DFS0578I - READ SUCCESSFUL FOR DDNAME PROCLIB MEMBER = FOIssidP HRF01536I ONLINE REORG FACILITY V1.2 mm/dd/yy nn.nn HRF01500I ONLINE REORG FACILITY INITIALIZATION FOR ssid COMPLETED
If IMS Online Reorganization Facility is in the STEPLIB and an error is encountered, the following message is issued:
HRF01500E Online Reorg Facility V1.0 initialization for <ssid> failed, RC=XXXX
Managing BMP pauses

If you plan to use IMS Online Reorganization Facility for databases that are used by long running BMPs, you must enable BMP job pause handling for any BMPs that access the databases during the reorganization process. Several methods are available for managing BMP job pauses for the IMS Online Reorganization Facility reorganization job and any BMPs that access the databases during the reorganization process.
How BMPs are affected during a reorganization

How BMPs are affected during a reorganization depends on whether a BMP is running at the time of the reorganization or is started during the reorganization, and on the type of database that is involved in the reorganization.
Concurrent BMPs and the same database

When the IMS Online Reorganization Facility reorganizes a database, it must temporarily stop the database using the /DBR command. IMS does not allow a database to be stopped with a /DBR command while an active BMP is accessing that database. The IMS Online Reorganization Facility can communicate with any BMP that is accessing the database when the reorganization job must stop the database with a /DBR command. When a BMP detects that IMS Online Reorganization Facility must momentarily stop a database, the BMP temporarily stops until IMS Online Reorganization Facility restarts the database. The method by which a BMP is stopped is determined by the type of database that requires the stop. v If the database is not a HALDB, the BMP issues a 3303 pseudoabend after the successful completion of the next CHKP call. The job step TCB detects that it was a pseudoabend issued to allow IMS Online Reorganization Facility to stop the database with a /DBR command. The job step TCB then waits for IMS Online Reorganization Facility to restart the database. When the database is restarted, the job step TCB restarts the BMP from the last completed checkpoint.
17
v If the database is a partition of a HALDB, after the successful completion of the next CHKP call, the BMP waits for the partition to be restarted before returning control to that application.
BMPs started during reorganization

When new BMPs are started during a reorganization, a check is made to determine if IMS Online Reorganization Facility needs to perform, or if it has already performed, a /STOP or /DBR command on a database that the BMP needs to access. If so, the job step TCB waits until IMS Online Reorganization Facility has restarted the database before it invokes the application. This process is the same for a HALDB database.
Example
The following example explains how BMPs are stopped and restarted during a reorganization: 1. A U3303 pseudoabend is issued when IMS Online Reorganization Facility needs to stop the non-HALDB database with a /DBR command after the BMP reaches the next checkpoint:
DFS0540I DFS0542I DFS682I DFS554A DFS552I *EXTENDED CHECKPOINT* PROGRAM=Y$$$APPL,CKPTID=CHKPT002, REGID=0001,DAY=341,TIME=1728184 IM7A *EXTENDED CHECKPOINT* DAY=341,TIME=172818452297-0700 IM7A BATCH-MSG PROGRAM AHDOPR2 JOB BMP002 MAY BE RESTARTED FROM CHKPT ID CHKPT002 IM7A BMP002 00001 UPDSTEP AHDOPR2 (2) 000,3303 2004/341 10:28:18 IM7A BATCH REGION BMP002 STOPPED ID=00001 TIME=1028 IM7A
2. IMS Online Reorganization Facility recovers the database by issuing a /DBR command:
DFS2500I DFS0488I FOI110I DFS551I DFS552I DATABASE HDOPR2 SUCCESSFULLY DEALLOCATED IM7A DBR COMMAND COMPLETED. DBN= HDOPR2 RC= 0 IM7A ACTION INITIATED: /DBR DB HDOPR2 LOCAL NOFEOV IM7A BATCH BATCH REGION BMP002 STARTED ID=00001 TIME=1030 REGION BMP002 STOPPED ID=00001 TIME=1030 IM7A IM7A
3. The BMP is automatically restarted and runs to completion:
| | | | | | | | | | | | | | |
How large checkpoint intervals are affected by BMP pauses

When IMS Online Reorganization Facility needs to pause a BMP, it does it at the next checkpoint call. When the checkpoint frequency is low, reaching the next checkpoint call can take more time than you expect. The IMS Online Reorganization Facility BMP handler allows you to add additional checkpoints. The BMP handler does not manage the application restart. The application needs to specify which database PCB to use to trigger a pause. This trigger can be a GU call or when the root segment is reached on GN calls. IMS Online Reorganization Facility then determines if the pause interval has expired and if a pause request is pending. If a pause interval has expired or a request is pending, IMS Online Reorganization Facility creates a CHKP call and issues a 3303 abend because a /DBR command was issued. The application returns to the IMS Online Reorganization Facility main task and resumes after the pause request has processed. The BMP application must have checkpoints defined.
18
User's Guide
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
If the application does not issue CHKP calls, CHKP=N must be specified to indicate that there is no waiting for a checkpoint call. After a pause request is pending, a checkpoint is issued, the BMP is paused, and a 3303 abend is issued. IMS Online Reorganization Facility captures the first CHKP call and repeats that call. Currently defined checkpoints stay where they were defined and additional checkpoints can be added. The application can be independent on the content of the checkpoint ID because IMS Online Reorganization Facility might create its own ID.
Adding checkpoints
If the intervals between the checkpoints for your applications is long, you can enable additional checkpoints using the IMS Online Reorganization Facility BMP handler.
About this task

The BMP handler adds additional checkpoint calls. You must manage application restarts using other methods.
Procedure
To enable the extra checkpoints, in the JCL job for the BMP: Specify the CHKPNTS DD statement. Adhere to the following syntax rules when you specify the CHKPNTS DD statement: v Only one parameter per line v Parameter must start within the first 20 positions v Comments can be included after the parameter, but must be separated by at least three blanks v No comma at the end of a parameter v Multiple occurrences of the same parameter makes the last effective v CALLTYPE or POS must be specified The CHKPNTS DD statement contains the following parameters: PCB=nnn|name nnn|name specifies the PCB to be used for triggering the checkpoint. You can specify either a name or the PCB number, where 1 would be the IOPCB. If you do not specify a value, PCB=2 is the default. If AIB calls are made, you must specify the PCB=name. INTVL=nnn nnn specifies the pause interval in seconds. If you do not specify a value, INTVL=30 is the default. CALLTYPE=GU This parameter specifies that a GU|GHU call triggers the pause test. POS=ROOT This value specifies that whenever a root segment is reached, a pause test is triggered. APPLWAIT=Y This value specifies that the application does TIMER waits. The pausing for these applications is enabled.
19
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
CHKP=(U | X | N) This parameter specifies how you want the BMP controller to behave. v Specify U to interrupt at any IMS call for a specified PCB. A checkpoint is created if the application did not provide any CHKP calls. v Specify X to interrupt at any IMS call for any of the PCBs. v Specify N if the application does not issue CHKP calls. IMS Online Reorganization Facility creates a checkpoint when pausing the BMP. If you specify CHKP=N, you must also specify the PCB, CALLTYPE, and POS parameters.
Example
The following example checks on PCB 4 for GN calls. When a root segment is returned, it determines if the 20-second interval has expired. If it has, IMS Online Reorganization Facility performs a pause test. If the BMP needs to be paused, a CHKP call is issued, the BMP is paused, and a 3303 abend is issued. The application restarts after the pause request has passed.
//CHKPNTS DD * PCB=4 INTVL=20 POS=ROOT
The following example checks every 10 seconds for a pause request. If the application is in a TIMER wait, it pauses the application with a 3303 abend. The application restarts after the pause request has passed.
//CHKPNTS DD INTVL=10 APPLWAIT=Y *
Installing the BMP pause feature

Use the following methods to enable the ability to pause and restart BMP jobs.
About this task

Important: If you have any other applications that relink the IMS region controller or that use a different IMS region controller module for BMPs, consider using this method to link those modules and IMS Online Reorganization Facility modules.
Procedure
Based on your environment, use one of the following methods to install BMP pause: 1. If you want to allow changes to the JCL of the BMP and you want to have IMS Online Reorganization Facility manage the BMP pause functionality: a. Refer to the instructions within the SAMPLIB member HRFSMP9. b. Run the SAMPLIB member HRFSMP9. This SAMPLIB member creates an alias of DFSRRC99 for DFSRRC00. c. Add the IMS Online Reorganization Facility library to the STEPLIB. d. Change the EXEC statements to invoke HRFRRCXX region controller module. 2. If you do not want to allow changes to the JCL of the BMP and you want to have IMS Online Reorganization Facility manage the BMP pause functionality: a. Refer to the instructions within the SAMPLIB member HRFSMP1.
20
User's Guide
| | | | | | | | | | | | | | | | | | | | | | | | |
b. Run the SAMPLIB member HRFSMP1. HRFSMP1 creates an alias of DFSRRC99 for DFSRRC00. 3. To have a different product manage BMP pause functionality for you, use the following instructions: a. Follow the instructions that are provided by the product. b. If you want to allow the JCL of the BMP to change, add the IMS Online Reorganization Facility library to the STEPLIB. c. If you do not want to allow changes to the JCL of the BMP: v Refer to the instructions within the SAMPLIB member HRFBMP9. v Run the SAMPLIB member HRFBMP9. 4. If you do not want to use SMP/E, use the SAMPLIB member HRFBMP.
Example
BMP example (does not require JCL changes):
//BMP EXEC PGM=DFSRRC00, // REGION=80M,PARM=BMP,.... //STEPLIB DD DISP=SHR,DSN=imsrel.sdfsresl
BMP example (with JCL changes):

//BMP EXEC PGM=HRFRRCXX, // REGION=80M,PARM=BMP,... //STEPLIB DD DISP=SHR,DSN=orf.load // DD disp=shr,DSN=imsrel.sdfsresl
Managing pauses for CICS and ODBA applications

IMS Online Reorganization Facility must pause a CICS or an ODBA application that is attempting to access that database when the reorganization job runs.
About this task

During a database reorganization, IMS Online Reorganization Facility must temporarily stop or issue /DBR on the database. The /DBR command requires a pause of all processing on the IMS database. Long running jobs that are often associated with CICS and ODBA must be paused. Any attempt to schedule a PSB in CICS or an ODBA application that contains a PCB for a database that has been processed with /DBR, results in an abend. When a CICS or ODBA APSB request detects that IMS Online Reorganization Facility needs to momentarily stop, the thread in which the APSB request is made is put into a temporary wait state until IMS Online Reorganization Facility restarts the database. | | | | | | If IMS Recovery Expert or IMS Recovery Solution Pack: Database Recovery Facility: Extended Functions is installed, review the considerations listed in Configuration considerations on page 15. The SAMPLIB contains the HRFCICS member, which you can use to manage the required IMS Online Reorganization Facility pauses for any CICS or ODBA applications.
Procedure
| | | 1. Locate the HRFCICS member in your SAMPLIB. 2. Edit HRFCICS as necessary to manage the pauses required by IMS Online Reorganization Facility.
21
Enabling XCF connections

Before you can use IMS Online Reorganization Facility and IMS Tools Online System Interface component, you must set up cross-system coupling facility (XCF) connections so that IMS Online Reorganization Facility can dynamically establish the XCF connections that it uses. | | | The IMS Online Reorganization Facility SAMPLIB member HRFFOI contains detail on how to configure IMS Online Reorganization Facility and IMS Tools Online System Interface.
Setting up online IMS subsystems and XCF group names

For each online IMS subsystem, IMS Online Reorganization Facility and IMS Tools Online System Interface must be activated in the control region for that subsystem.
Procedure
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | To set up online IMS subsystems and XCF group names: 1. Add the load libraries for IMS Online Reorganization Facility, IMS Tools Generic exits, and IMS Tools Base to the STEPLIB concatenation of the control region JCL. 2. Verify that Generic Exits have been defined properly. For more information, see Configuring the base environment on page 16. 3. Define the XCF group names. Recommendation: Specify different names for the change capture interface and IMS Tools Online System Interface connections. a. Define the XCF group name to establish the change capture interface connection by editing either the HRFSETOP module, the HRF#ssid modules, or both, and adding the XCFGROUP=keyword parameter. Use the same XCF group name for all sharing IMS subsystems, that is, those within the same RECON. The default group name is ORFXCF. b. Define the XCF group name to establish the IMS Tools Online System Interface connection in the PROCLIB member by editing either the HRFSETOP module, the HRF#ssid modules, or both, and setting the TOIGROUP=keyword to be the same name (but with the "TOI" prefix) that is specified in the FOIssidP members that share the same RECON data sets. The group name must start with TOI. The XCF group name in the TOSI PROCLIB FOIssidP member must not specify the TOI portion of the group name. Use the same XCF group name for all sharing IMS subsystems, that is, those within the same RECON. Important: v If you do not specify the TOIGROUP parameter, it will default to TOIXCF. It must match the name that is specified in the applicable FOIssidP member (prefixed by TOI). v The member name of the PROCLIB member is FOIimsidP, where imsid is the IMS subsystem ID. c. You must create a separate PROCLIB FOIimsidP member for each IMS subsystem. IMS Tools Online System Interface appends TOI to the beginning of the XCFGROUP= value to create the XCF group name that it uses. The default value that is defined in the HRFFOI sample member is XCF, which results in an XCF group name of TOIXCF. Refer to the
22
User's Guide
| | | |
SAMPLIB member HRFFOI for what TOSI requires. HRFFOI also includes information about how to set up and use the parameters for generic exits. For more information about IMS Tools Online System Interface, see the IMS Tools Common Service Reference.
Results
The IMS Online Reorganization Facility and the IMS Tools Online System Interface component join an XCF group when the IMS control region is started and they maintain this connection for the time that the IMS control regions which share the same RECON are active. | | | | | | | | | | | | | | | | | | | | |
Setting up IMS Online Reorganization Facility jobs XCF group names

When an IMS Online Reorganization Facility job attempts to establish an XCF connection to an online IMS subsystem, the same XCF group name used in the online subsystem must be used by the IMS Online Reorganization Facility job.
About this task

Define XCF group names for online IMS subsystems to establish the change capture interface connection.
Procedure
To set up the IMS Online Reorganization Facility jobs XCF group names: 1. Edit the HRFSETOP sample member, the HRFINST sample member, or both, and override the XCFGROUP=keyword and TOIGROUP=keyword parameters. The default group name for XCFGROUP is ORFXCF. The default group name for TOIGROUP is TOIXCF. Recommendation: Specify different XCF names for IMS Tools Online System Interface and IMS Online Reorganization Facility. 2. Run the IMS Online Reorganization Facility job in the HRFSETOP sample member and the HRFINST sample member, or both. Running the job defines the XCF group names used to establish the IMS Tools Online System Interface and IMS Online Reorganization Facility connections.
Verifying online IMS subsystems XCF connections

Verify that you have correctly set up your XCF connections.
Procedure
To verify online IMS subsystems XCF connections: 1. Start your online IMS subsystem with IMS Online Reorganization Facility and IMS Tools Online System Interface activated. 2. Verify that the following messages are displayed: | | | | | | | |
HRF010503I Joined XCF group ORFssid as member ssid GLX2926I IMS TOOLS GENERIC LOGGER EXIT INITIALIZATION IN PROGRESS GPR2926I IMS TOOLS GENERIC PARTNER EXIT INITIALIZATION IN PROGRESS DFS0578I - READ SUCCESSFUL FOR DDNAME PROCLIB MEMBER = FOIssidP HRF01536I ONLINE REORG FACILITY V1.2 mm/dd/yy nn.nn HRF01500I ONLINE REORG FACILITY INITIALIZATION FOR ssid COMPLETED GPR2926I IMS TOOLS GENERIC PARTNER EXIT INITIALIZATION COMPLETE FOI100I TOOLS ONLINE INTERFACE ENABLED; XCF GROUP=TOIssid ssid
23
Verifying IMS Online Reorganization Facility jobs XCF connections

Verify that you have correctly set up the XCF connections for your IMS Online Reorganization Facility jobs.
Procedure
| | | | | To verify job XCF connections: 1. Verify that you have recycled the IMS control region to initialize IMS Online Reorganization Facility, IMS Tools Online System Interface, and the IMS Tools Generic exits. For more information, seeVerifying online IMS subsystems XCF connections on page 23. 2. Verify that similar messages are displayed. The messages are display during the initialization of the IMS Online Reorganization Facility job while it is attempting to establish the two XCF connections to each online IMS subsystem. HRF01000I Indicates the startup of the receiver that attempts to establish the connections for the change capture interface. | | | | | HRF01503I Shows that IMS Online Reorganization Facility has joined the XCF group ORFXCF (or whatever name was specified in the HRFSETOP or HRFINST sample members). This group name was obtained from the XCFGROUP= value in the HRFSETOP module, the /HRF#ssid modules, or both. HRF01108I Indicates the successful connection to the IMS Online Reorganization Facility component in the online subsystem. If there are multiple online subsystems, a similar message is displayed for each subsystem. HRF01000I Indicates the startup of the IMS Tools Online System Interface that attempts to establish the connections. | | | | | | | | HRF01503I Indicates that the XCF group TOIXCF (or whatever name was specified in the HRFSETOP or HRFINST sample members) was joined. This group name was obtained from the TOIGROUP. HRF01108I Indicates the successful connection to the IMS Tools Online System Interface component in the online subsystem. If there are multiple online subsystems, a similar message is displayed for each subsystem. Ensure that the same XCF group name is used for all sharing IMS subsystems, in other words those within the same RECON.
Example
| | Here is an example of the message that is displayed when you have correctly set up the XCF connections for your IMS Online Reorganization Facility jobs:
HRF01000I HRF01503I HRF01108I HRF01000I HRF01503I HRF01108I Change receiver started Joined XCF group ORFXCF as member jobname.dbdname Change receiver interface connected to online subsystem ssid TOSI interface started Joined XCF group TOIXCF as member jobname TOSI interface connected to online subsystem ssid
24
User's Guide
Configuring your IMS Online Reorganization Facility runtime environment

| | | | Before you can use IMS Online Reorganization Facility, you must configure your runtime environment. Configure your runtime environment by setting parameters in the HRFINST or HRFSETOP SAMPLIB member that creates the runtime options in the HRFSETOP module, the HRF#ssid modules, or both.
The runtime options modules HRFSETOP and HRF#ssid

| | | | | | | | | IMS Online Reorganization Facility uses customizable modules HRFSETOP, HRF#ssid, or both, to define runtime options that you can change or define for your installation. These members can be created for unique IMS subsystems. The HRFSETOP module, the HRF#ssid modules, or both, are created by running the SAMPLIB JCL members HRFINST or HRFSETOP. The HRFSETOP module and the HRF#ssid modules are loaded from the STEPLIB concatenation during IMS Online Reorganization Facility initialization in both the IMS control region and in the IMS Online Reorganization Facility address spaces. Multiple setup option member modules are created by running the SAMPLIB JCL member HRFSETOP. You can change the options in the module by assembling and link editing or binding the module. If required, you can define multiple setup option members in the same library. For example, you might need multiple runtime option members in the same library because you need different sets of options for each IMS subsystem or for each IMSPLEX. If you define multiple runtime option members, the names of the additional members must: v Begin with HRF# v Be suffixed with either an IMS ID or an IMSGROUP When you create and define multiple runtime option members in an IMS control region, the members are automatically searched for in the following order: 1. HRF#imsid 2. HRF#imsgroup 3. HRFSETOP The first SETOP member that is found is the set of options that is used within that control region. In an IMS Online Reorganization Facility job, there is an OPTID keyword for the REORG command that you can use to specify an IMS ID or an IMSGROUP. The default for the OPTID keyword is IMSID, specifying that the IMSID from DFSVC000 in RESLIB is used as the suffix for the SETOP member name. The IMS Online Reorganization Facility jobs, runtime options modules are searched for in the following order: 1. HRF#optid 2. HRFSETOP
25
Important: For both the IMS control region and IMS Online Reorganization Facility batch jobs, the contents of runtime options modules are not merged from one level to another. That is, you must specify all the required values in the runtime options module that is found.
HRFSETOP and HRF#ssid module parameters

The IMS Online Reorganization Facility runtime options modules HRFSETOP and HRF#ssid contain the parameters that you have defined for your environment in the SYSIN DD statement of the sample JCL in HRFINST or HRFSETOP modules. | | | | | | | | | | | | | Set the HRFSETOP parameters to suit your environment. BMPRETRY nnn Specify a numerical value that indicates how many retry attempts to make when a WTOR is issued to stop BMP jobs. When the number is exceeded, the IMS Online Reorganization Facility job stops. The original database remains available and is returned to active status. DBSTART N | NO | Y | YES If UPDATE DB STOP() was used to stop the database before running the IMS Online Reorganization Facility job, the database is not started after the reorganization process concludes. Use this parameter to indicate whether to start the database. Specify Y to start the database during the Takeover phase even if it was stopped at the start of the IMS Online Reorganization Facility job. DBSTART (Y|N) can also be specified in the job control card. DEBUG N | NO | Y | YES Additional debugging within the IMS control region. DEBUG=Y indicates that IMS Online Reorganization Facility can write additional messages and traces to aid in debugging or diagnosing IMS Online Reorganization Facility activity in the IMS control region. ENQNAMEnnn Any valid 1- to 8-character ENQ major name. This parameter specifies the QNAME to be used for IMS Online Reorganization Facility enqueues. Change this parameter only if the default value conflicts with other components or products in your environment. Default: $ORFENQ$ LOGDATAC sss A 1- to 8-character SMS data class that is used to define temporary log data sets that are needed for applying captured changes. This value is required only if you have not also specified LOGUNIT. Default: none | | | | | | | | | | LOGMGMTC sss A 1- to 8-character SMS management class name that is used to define temporary log data sets necessary for applying captured changes. This value is required only if you have not also specified LOGUNIT. Default: none LOGSTORC sss A 1- to 8-character SMS storage class name that is used to define temporary log data sets necessary for applying captured changes. This value is required only if you have not also specified LOGUNIT. Default: none
26
User's Guide
LOGHLQ ppppppppppppp A 1- to 26-character data set prefix that is used to define temporary log data sets that are needed for applying captured changes. IMS Online Reorganization Facility appends either a DBD or HALDB partition name plus a Z1 or Z2 followed by an HHMMSS timestamp to the prefix to create the data set name. The data set is deleted upon successful completion of the reorganization job. Default: ORF.APPLYLOG.HLQ LOGUNIT uuuuuuuu A 1- to 8-character unit name that is used to define temporary log data sets that are needed for applying captured changes. This value is required only if you have not also specified LOGDATAC, LOGSTORC, or LOGMGMTC. Default: SYSALLDA RCDATAC sss A 1- to 8-character SMS data class name to use for temporary RECON data sets that are needed when a HALDB database is reorganized. This value is required only if RCVOL is not specified. Default: none | | | | | | | | | | RCMGMTC sss A 1- to 8-character SMS management class name to use for temporary RECON data sets necessary when a HALDB database is reorganized. This value is required only if RCVOL is not specified. Default: none RCSTORC sss A 1- to 8-character SMS storage class name to use for temporary RECON data sets necessary when a HALDB database is reorganized. This value is required only if RCVOL is not specified. Default: none RCVOL vvvvvv A 1- to 6-character volume serial to use for temporary RECON data sets that are needed when a HALDB database is reorganized. This value is required only if you have not also specified RCDATAC, RCSTORC, or RCMGMTC. Default: none RECON ppppppppppppp A 1- to 26-character data set prefix that is used to create temporary RECON data sets that are needed when a HALDB database is reorganized. IMS Online Reorganization Facility appends a RECON identifier (R1, R2, or R3) and timestamp when it defines these data sets. The data sets are deleted upon completion of the reorganization job. Default: TEMP.RECON.HLQ RSTRTDSN vvvv Any valid VSAM KSDS data set name for the IMS Online Reorganization Facility restart data set. Specify the data set to be used by IMS Online Reorganization Facility Restart processing to store information that is needed during the takeover process. Preallocate this data set. Default: ORF.RESTART.DSN
27
TOIGROUP TOIxxx XCF group name for the IMS Tools Online System Interface. Any valid XCF group name that begins with TOI and ends with the characters that match the XCFGROUP= in the FOIimsidP member. Specify an up to 8-character group name suffix to use for XCF communication between the IMS Tools Online System Interface component in IMS control regions and IMS Online Reorganization Facility batch utilities. This name must match the constructed name that is defined in the FOIimsidP IMS PROCLIB member. The TOIGROUP must begin with the characters TOI. The IMS Tools Online System Interface always adds TOI to the beginning of the XCFGROUP name that is specified in the FOIimsidP member. | | Default: TOIGROUP=TOIXCF in the HRFSETOP module and XCFGROUP=XCF in the FOIimsidP would result in TOIXCF. ULOGIDln User log record ID. The ID is a 2-character value, A0 - FF, that specifies the hexadecimal ID for the user log records that are generated by IMS Online Reorganization Facility. Default: F0 UNLSPAC nnn A 3-digit numeric space allocation value to be used for temporary data set allocations, for example, the unload file. Specify a numeric value for the number of cylinders to allocate per temporary data set. The number of data sets that are allocated is determined by IMS Online Reorganization Facility. Default: 200 UNLUNIT nnn Any valid direct-access 8-character unit name to be used for LGDS allocations, for example, the unload file. These files are temporary files and they default to SYSALLDA unless otherwise specified. Default: SYSALLDA | | | | | | XCFGROUP nnn Any valid XCF group name that is not used as a TOI XCFGROUP name. Specify an up to 8-character name for the group name to use for XCF communication between IMS control regions and IMS Online Reorganization Facility batch utilities. Make this name unique within the sysplex. Default: ORFXCF XCFMAX nnnn A 0-2000 numeric value for maximum storage for XCF buffer usage. This parameter specifies a megabyte limit, that is used to store unprocessed messages that are received through XCF. This limit is provided to protect against cases where the IMS Online Reorganization Facility cannot keep up with the changes that are being captured from the online IMS subsystems. When the XCFMAX limit is reached, the IMS Online Reorganization Facility batch job abends. Default: 300
Defining IMS Online Reorganization Facility runtime options

You must set the required parameters in the IMS Online Reorganization Facility runtime options module (HRFSETOP). The settings are the default runtime options.
28
User's Guide
Procedure
| To 1. 2. 3. define default runtime options: Edit SAMPLIB member HRFINST, HRFSETOP, or both. Modify the job card to meet your environmental requirements. Substitute values that are appropriate to your environment for the values in italicized lowercase text. 4. Save the HRFINST and HRFSETOP JCL members. 5. Submit the HRFINST job to load, link edit, and bind the HRFSETOP module from the STEPLIB concatenation in both the IMS control region and in the IMS Online Reorganization Facility address spaces.
| | | | | | | | | | | | | | | | | | | | | |
Defining IMS Online Reorganization Facility Runtime Options per IMSID

If you require multiple runtime options modules for individual IMS or IMSPLEX systems, edit SAMPLIB member HRFSETOP. You must set the required parameters in the IMS Online Reorganization Facility runtime options module (HRFSETOP).
Procedure
To define runtime options for IMSID: 1. Edit SAMPLIB member HRFSETOP. 2. Modify the job card to meet your environmental requirements. 3. Change all the your.hrf.load specifications to your HRF LOAD library name. 4. Change all the your.hrf.samplib specifications to your HRF SAMPLE library name. 5. Provide the applicable values to all parameters to suit your environment. 6. In the link-edit step (EXEC PGM=HEWL) SYSIN DD statement, change the name of the load module to be created to the name that you want to create. For example, change the load module name to HRF#imsid or HRF#imsgrp. 7. Save the modified HRFSETOP JCL member to the HRF#imsid or HRF#imsgrp JCL members. 8. Submit the job to load, link edit, and bind your new setup options module from the STEPLIB concatenation in both the IMS control region and in the IMS Online Reorganization Facility address spaces.
29
30
User's Guide
Chapter 3. Applying maintenance

You can install IMS Online Reorganization Facility maintenance without having to shut down and restart the IMS subsystem by using the HRFYUTIL utility.
Before you begin

v Both IMS Online Reorganization Facility and the IMS Tools Online System Interface component must already be installed. v The IMS online system must have previously been started with IMS Online Reorganization Facility libraries in the STEPLIB or JOBLIB to ensure that it has initialized in the control region for the first time. v You must run the HRFYUTIL job on the same z/OS system on which the IMS control region is running for the targeted IMS subsystem. This job fails if changes are currently being captured by IMS Online Reorganization Facility for any DBDs in the targeted IMS subsystem.
Procedure
To install IMS Online Reorganization Facility maintenance: 1. Edit the HRFYUTIL job. 2. Supply the appropriate DD statements and control statements. The following example JCL shows the job to run the HRFYUTIL utility. Substitute the appropriate values for the italicized text in the JCL. Additional DASD space is required for the shadow data sets.
//UTIL EXEC PGM=HRFYUTIL,REGION=0M //STEPLIB DD DISP=SHR,DSN=hrfload //*HRFLIB DD DISP=SHR,DSN=special.hrfload //MSGPRINT DD SYSOUT=* //HRFSYSIN DD * INSTALL IMSID(IM81) //
3. Submit the job.
Results
You can also use the utility to verify the current maintenance level of IMS Online Reorganization Facility in an online system and to optionally check the level of a library with the level in an online system. Optionally, and only with the recommendation of IBM Software Support, you can use the IMS Online Reorganization Facility utility to back out maintenance. Topics: v HRFYUTIL syntax v HRFYUTIL control statements for maintenance on page 32
HRFYUTIL syntax
This topic describes the syntax for HRFYUTIL, including its program name, DD statements, and control statements. Use HRFYUTIL to verify the maintenance level of IMS Online Reorganization Facility in an online system, to check the level of a library with the level in an online system you use these DD statements, or to perform diagnostic tests.
31
Attention: Use HRFYUTIL for diagnostic tests only at the direction of IBM Software Support and only during a time when additional system processing can be accommodated. This utility causes additional system processing for all the calls and logging in the IMS control region. A large amount of SYSOUT data can potentially be written in the IMS control region while this utility is active. Program name: HRFYUTIL DD statements: HRFSYSIN Required. Indicates the input control statement data set. Format: RECFM=F or FB, LRECL=80 MSGPRINT Optional. Indicates the SYSOUT data set to which runtime messages are logged. If this DD statement is not specified, it is dynamically allocated. Format: RECFM=FA, LRECL=133 HRFLIB Optional. If this DD statement is provided, new IMS Online Reorganization Facility maintenance is loaded from this DD instead of from the STEPLIB or JOBLIB concatenation.
HRFYUTIL control statements for maintenance

You can specify several control statements in the HRFSYSIN input control data set to identify which type of action or maintenance is to be performed. These control statements include: Command INSTALL Required. Indicates that you are installing maintenance. Keywords ACTION Optional. IMS Online Reorganization Facility creates an ITASK in the IMS control region to handle the communications to and from other address spaces. In the rare event that the IMS Online Reorganization Facility ITASK abnormally terminates communications, subsequent IMS Online Reorganization Facility jobs are unable to run. By running the maintenance utility and specifying ACTION(RESTART), the IMS Online Reorganization Facility ITASK is restarted. When you specify ACTION(RESTART), only the ITASK is restarted. Any requests to install or check that the maintenance level are ignored. Format 'RESTART' Default None FORCE Optional. Indicates whether to install maintenance even if the maintenance level that is referenced by the maintenance utility is at a lower level than what is currently active in the IMS control region.
32
User's Guide
FORCE(NO) Specifies that maintenance is installed only if the library that is referenced by the maintenance utility is at a more current maintenance level. FORCE(YES) Specifies that the maintenance level that is referenced by the maintenance utility is installed regardless of whether it is more current than what is active in the IMS control region. Format YES | Y | NO | N Default NO IMSID Required. Indicates the target IMS subsystem ID in which to install new maintenance. Format Any valid 1- to 4-character subsystem ID. Default None MODULE Optional. Indicates that only the specific module is installed into the IMS control region. This control statement is normally used only to test a specific fix and by special request. Format Any valid 1- to 8-character HRF module name. Default ALL TEST Optional. Indicates whether to install new maintenance or only to check that the library that is specified by the utility is at a more current level than what is active in the IMS control region. TEST(NO) Specifies that any new maintenance from the libraries in the utility is installed. TEST(YES) Specifies that the maintenance utility is to report on whether the library that is specified in the utility is at a different maintenance level than what is currently active in the IMS control region. Return codes when TEST(YES): RC=0 The IMS control region is at the same or a newer maintenance level. RC=8 The IMS control region is at an older maintenance level. RC=16 Some modules in the IMS control region are at an older maintenance level and some are at a newer maintenance level. Format YES | Y | NO | N Default NO
Chapter 3. Applying maintenance
33
34
User's Guide
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
Chapter 4. Using IMS Online Reorganization Facility

To use the IMS Online Reorganization Facility to reorganize or unload a database, create a JCL job that contains the appropriate DD statements and run the job. In this topic: v Data and system flow v Running the IMS Online Reorganization Facility v v v v DD statements on page 36 Keywords that affect DBD and DMB replacements on page 63 Takeover restart processing on page 64 Examples for IMS Online Reorganization Facility on page 65
Data and system flow

The reorganization and unload of a database is invoked by the REORG and UNLOAD commands in the HRFSYSIN DD statement.
Running the IMS Online Reorganization Facility

IMS Online Reorganization Facility runs the reorganization and unload as a standard z/OS batch job. You need to specify an EXEC statement and DD statements that define the input and output data sets in your JCL.
About this task

The DD statements that you need depend on whether you are using IMS Online Reorganization Facility to reorganize or to unload a database. Many of the DD statements are mutually exclusive based on the type of job that you need to run.
Procedure
To reorganize or unload a database: 1. Create a JCL job that contains the appropriate elements. 2. Specify the EXEC statement in the following format:
//name EXEC PGM= HRFREORG,REGION=rrrrM // PARM=DBD=dbdname
DBD Description This keyword is optional. Use the DBD keyword to identify which primary database is to be reorganized by IMS Online Reorganization Facility. If you do not specify the DBD keyword, the online reorganization batch job terminates during the Verification phase, resulting in a U999 abend and message. Format Either a DBD name or the variable &PARM. If you specify the variable, the DBD name must be specified in the z/OS parameter string as PARM='DBD=(dbdname)'.
35
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
Default value None 3. Specify the DD statements to define input data sets and output data sets. 4. Run the JCL.
DD statements
DD statements of the IMS Online Reorganization Facility functions determine the input and output data sets and how the functions are run. When you create JCL to run IMS Online Reorganization Facility, you need to include the appropriate DD statements. The DD statements you need depend on the type of job that you want to run (UNLOAD or REORG) and other characteristics of your environment. Your database data set names must be a total of 42 characters in length or less. The following list summarizes the DD statements that are used by IMS Online Reorganization Facility. DFSPRINT Description This statement is optional for the REORG and UNLOAD commands. It defines a print file for the High Performance image copy. The data set can reside on DASD or it can be routed through the output job. IMS Online Reorganization Facility dynamically allocates this DD statement if you do not provide it. Role Format LRECL=122 DFSRESLB Description This statements is optional for the REORG command, but is not applicable for the UNLOAD command. It points to an authorized library that contains IMS SVC modules. IMS Online Reorganization Facility dynamically allocates this DD if you do not provide it. Role Format RECFM=U DFSUINPT Description This statement is required by the UNLOAD command and optional for the REORG command if you want a copy of the HD Unload file. It is used as a repository for the unloaded data that consists of HD unload records. You can use this statement when you are running HP unload. This DD statement overrides the dynamic allocation of the unload data set. Input Output
36
User's Guide
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Role Role Format Role Format
IMS Online Reorganization Facility dynamically creates these temporary data sets to avert out-of-space conditions. If you choose to override the dynamic allocation of this data set, which is not recommended, you can specify this DD statement in your JCL. If you override dynamic allocation, you must also supply sufficient space parameters to avoid out-of-space conditions. The DFSUINPT DD uses the HD Unload format. See the information about the SYSUT2 DDname in the IMS High Performance Unload User's Guide for z/OS. Output RECFM=VB DFSURGU1 Description This statement is required by the UNLOAD command, but is not applicable for the REORG command. It is used as a repository for HD unload records when the standard IMS unload utility (DFSURGU0) is used. If you use the IMS unload utility, you must specify this DD statement. Role Format RECFM=VB DFSURWF1 Description This statement is optional for the REORG command and not applicable for the UNLOAD command. It overrides the dynamic allocation of the data set that contains logical relationship records only, but does not contain secondary index records. Used if logical relationships exist and you want a copy of the WF1 file for processing after the IMS Online Reorganization Facility job step. This data set is for logical relationship records needed by Prefix Resolution or Update. Important: This DD statement is not recommended because IMS Online Reorganization Facility creates the data set dynamically. Output / Input RECFM=VB, LRECL=900 HRFSYSIN Description This statement is required by the REORG and UNLOAD commands. It defines a control statement or data set that contains control statements that specify the functions of IMS Online Reorganization Facility. Related Reference: v The HRFSYSIN DD statement on page 42 Input Output
37
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
Format LRECL=80 Free form. You do not need to code each keyword on a separate line, and each line can begin in any column from 1 to 72. ICEPRINT Description This statement is optional for the REORG and UNLOAD commands. It defines the SYSOUT output data set and output from the High Performance Image Copy Utility reports generated by IMS Online Reorganization Facility. This data set can reside on DASD or it can be routed through the output job. IMS Online Reorganization Facility dynamically allocates this data set if you do not provide the DD statement. Role Format LRECL=133 IEFRDER Description This statement is optional for the REORG command, but is not applicable to the UNLOAD command. It describes the log data set that is used by IMS Online Reorganization Facility during the Apply phase. This data set must reside on DASD. If changes are captured during the reorganization process, these log data sets are registered to DBRC as batch logs. The batch logs are needed in a recovery situation. If you choose not to use this DD statement, you can use dynamic allocation for the log data sets instead. To use the dynamic allocation for the IMS logs, see the LOG1DSN, LOG2DSN, LOGPRI, and LOGSEC parameters. Role Format RECFM=VB IEFRDER2 Description This statement is optional for the REORG command, but is not applicable for the UNLOAD command. You can use dynamic allocation for the log data sets instead. It describes the secondary copy of the IEFRDER log data set. This data set must reside on DASD. If changes are captured during the Online Reorganization process, these log data sets are registered to DBRC as batch logs that are needed in a recovery situation. Role Format RECFM=VB IMAGECOPYN Description This statement is required for the REORG and UNLOAD commands if you specified ICDYN(N) or ICDDN keywords indicating that the Output Output Output
38
User's Guide
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Role Format Role Format IMS Role Format
image copy data sets are not dynamically allocated. It specifies the output image copy data set for each database data set being reorganized. This DD statement must correlate to the ICDDN keyword that you specified. Specify one DD statement for each image copy DDN that is specified on the ICDDN() keyword. This DDNAME overrides any dynamic allocation for this data set. Output RECORD=FB or VBS
Description This statement is required for the REORG and UNLOAD commands. It describes the library that contains the DBDs of the database that you are reorganizing and its indexes. This data set must reside on DASD. If you have specified ONLINECHANGE(Y), this file must also describe the library that contains the PSBs that reference the database that you are reorganizing. This data set must be first in the concatenation and must reside on DASD. Role Format RECFM=U IMSACB, IMSACBA, and IMSACBB Description These statements are required for the REORG command if you specified ONLINECHANGE(Y). These DD statements are not applicable to the UNLOAD command. They describe the libraries that contain the new ACBs for the DBDs that have been changed. These data sets must reside on a direct-access device. If you use dynamic allocation for IMSACBA and IMSACBB for the online system, these DD statements must be provided in the JCL. IMS Online Reorganization Facility is able to extract the dsnames of A and B from the online system. Output RECFM=U MSGPRINT Description This statement is optional for the REORG and UNLOAD commands. It defines the IMS Online Reorganization Facility output data set. The data set can reside on DASD or it can be routed through the output job. It contains all the progress messages that are associated with the reorganization, in the order of execution. IMS Online Reorganization Facility dynamically allocates this data set if you do not provide this DD statement. Output LRECL=133 Input
39
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
NEWDBD Description If you requested a DBD change for the REORG command, this statement is required. This statement is not applicable to the UNLOAD command. It describes the library that is to be used when you have requested a DBD change. If you specify this DD statement, this library data set must: v Reside on DASD v Contain all DBDs for the associated databases that are being reorganized To invoke the physical sequential sort before reloading any data in the reload step, you must specify RELOAD.SORT(Y). If the DBD is an HDAM and the new DBD changes could change the randomized sequence of the database records. When the IMS Library Integrity Utility is installed, the new DBD is updated in IMS Library Integrity Utility. See the IMSID keyword. The IMS Library Integrity Utility library must be made available to activate this function. Role Format RECFM=U RECON1-3 Description This statement is optional for the REORG command, but is not applicable to the UNLOAD command. Defines the database recovery control (DBRC) RECON data sets. RECON data sets dictate which databases and IMS online systems are used during the reorganization. Attention: If you specified IMSDALIB DD dynamic allocation, do not use these RECON DD statements. If you have used JCL to allocate RECON1 as a spare data set, you must restart the database. Role Format KSDS STEPLIB Description This statement is required in all IMS Online Reorganization Facility jobs and must always be APF-authorized, even if a DFSRESLB DD statement is provided. It points to two or more authorized library data sets. Authorized library data sets include: v IMS Online Reorganization Facility load library v IMS Utilities that are available for IMS Online Reorganization Facility v IMS RESLIB library v Any other libraries The libraries can appear in any order. Input | Output Input
40
User's Guide
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Role Format Role Format
//STEPLIB DD DISP=SHR,DSN=hrfload // DD DISP=SHR,DSN=imstools // DD DISP=SHR,DSN=reslib
where: v hrfload is the name of the library that contains the IMS Online Reorganization Facility load modules. v imstools is the optional name of the library that contains the IMS reorganization utilities load modules. v reslib is the name of the library that contains the IMS load modules. If you do not specify an IMSDALIB DD statement in the JCL, you must specify the MDALIB in the STEPLIB for dynamic allocation purposes. Input RECFM=U SYSPRINT Description This statement is optional for the REORG and UNLOAD commands. It defines the statistics output data set and output from other utilities executed under the control of IMS Online Reorganization Facility. The data set can reside on DASD or it can be routed through the output job. IMS Online Reorganization Facility dynamically allocates this data set if you do not provide it. Output LRECL=133 SYSUDUMP Description This statement is required only if a dump is requested by IBM Software Support. It defines a dump data set. If the IMS Online Reorganization Facility detects an error and ends with a U999 abend, this dump is not necessary. However, if any other system or user abend is encountered, this data set might be required for problem diagnosis. This data set can reside on DASD or it can be routed through the output job. Role Format LRECL=133 TRACE Description This statement is optional for the REORG and UNLOAD commands. It defines the output data set that is used by IMS Online Reorganization Facility to write diagnostic trace records. This data set might be required for problem diagnosis. This data set can reside on DASD or it can be routed through the output job. Output
41
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Role Format
If you do not provide this DD statement, it is dynamically allocated to SYSOUT by IMS Online Reorganization Facility. Output LRECL=133
The HRFSYSIN DD statement

The HRFSYSIN DD statement is a required DD statement that defines a control statement or data set that contains the control statements that specify the functions of IMS Online Reorganization Facility. Consider the following rules and guidelines when you code the HRFSYSIN DD statement: v You must begin the HRFSYSIN DD statement with either the REORG command or the UNLOAD command. Use the REORG command to perform the entire reorganization process. For example:
//HRFSYSIN DD * REORG DBD(HIOPR1)
Use the UNLOAD command to create only an unload file of a database. For example:
//HRFSYSIN DD * UNLOAD DBD(HIOPR1)
v The input control HRFSYSIN DD statement contains one command and one or more keywords, many of which have sufficient default values. The HRFSYSIN DD statement is free form. That is, you do not need to code each keyword on a separate line, and each line can begin in any column from 1 to 72. v Any line can be continued to the next line by including a comma after a keyword, followed by a blank and a hyphen. For example:
REORG DBD(HALDB0) PARTITION(HALPART0) ICDDN(HALDD0A,ICPRT0)
v To continue a line in the middle of a keyword subparameter list, do not separate the first subparameter value that is contained within a set of parentheses. For example, an incorrectly formatted continuation would look like:
ICDDN(, HALDD1A,ICPRT1)
In the following example the line continuation in the middle of a keyword subparameter list is coded correctly:
ICDDN(HALDD1A, ICPRT1)
HRFSYSIN DD statement keywords

DD statements of the IMS Online Reorganization Facility Reorganization and Unload functions determine the input and output data sets and how the Reorganization and Unload functions are run. DATACLAS Description This keyword is optional. If you use SMS to dynamically allocate your work data sets and image copies, use this keyword to specify
42
User's Guide
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Format DBD Format
a specific SMS storage class. If you do not use SMS to dynamically allocate work data sets and image copies, you do not need to specify this keyword. (dataclass) Default value None
Description This keyword is optional. Use the DBD keyword to identify which primary database is to be reorganized by IMS Online Reorganization Facility. If you do not specify the DBD keyword, the online reorganization batch job terminates during the Verification phase, resulting in a U999 abend and message. Format Either a DBD name or the variable &PARM. If you specify the variable, the DBD name must be specified in the z/OS parameter string as PARM='DBD=(dbdname)'. Default value None DBDCOPY Description This keyword is required for REORG HRFSYSIN DD statements if you specified ONLINECHANGE(Y). It is not applicable for UNLOAD HRFSYSIN DD statements. Use the DBDCOPY keyword to specify whether the NEWDBD is copied to the IMS DDNAME if a database has DBD changes. If you have DBD changes, it is highly recommended that you specify both DBDCOPY(Y) and ONLINECHANGE(Y), so that the databases do not require manual intervention at the end of the reorganization. If you specify DBDCOPY(Y), then you must also specify ONLINECHANGE(Y), NEWDBD(xxxx), and TAKEOVER(Y). (Y | N) Default value N DBDLIST Description This keyword is optional for the REORG HRFSYSIN DD statements, but is not applicable to the UNLOAD HRFSYSIN DD statements. The specified ddname is included in the JCL. It must be a SYSOUT file. If the ddname is not found, it is allocated dynamically. The DBD source statements are printed to the specified file. Format (ddname) DBSTART
43
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | FEOV
Description This keyword is optional for the REORG HRFSYSIN DD statements, but is not applicable to the UNLOAD HRFSYSIN DD statements. It specifies whether or not the database should be started, even if it was not started at the beginning of the IMS Online Reorganization Facility job. Format (Y | N) Default value N DELETE Description This keyword is optional. This optional keyword is applicable only if you also specified TAKEOVER(Y). Use the DELETE keyword to indicate whether the database copies (before reorganization) are deleted. After the ALTER of the shadow databases to the original names has taken place, the .S copies of the databases are copies of the data as it was before it was reorganized. Format (Y | N) Default value Y
Description This keyword is optional for the REORG HRFSYSIN DD statements, but not applicable for UNLOAD HRFSYSIN DD statements. It indicates whether the /DBR command specifies FEOV (force end-of-volume) or NOFEOV during the Takeover phase. Format (Y | N) Default value None GDGLIMIT Description This keyword is optional for the REORG HRFSYSIN DD statements, but not applicable for UNLOAD HRFSYSIN DD statements. It specifies the maximum number of GDG (generation data group) data sets that can be associated with a model GDG. This value is used by IMS Online Reorganization Facility when all the following conditions are true: v A GDG is requested for an image copy data set v IMS Online Reorganization Facility is being used to dynamically allocate the image copy data set v The GDGMODEL that is specified does not yet exist If you have specified any image copies with the ICDDN keyword and you have specified any image copies in the JCL, this keyword
44
User's Guide
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Format Format
is ignored for those image copies only. The existence of a GDG base is verified for the image copy data set before allocating it, if you have: v Dynamic allocation of your image copy data sets (by specifying ICDYN(Y)) v Requested that image copy data sets are GDGs (by specifying ICTRLR(1)) If a GDG base does not exist, IMS Online Reorganization Facility automatically defines one. When a GDG base is automatically defined, you can control the number of generations that are kept by specifying the value with the GDGLIMIT keyword. 0-255 Default value 20 GDGMODEL Description This keyword is required for the REORG HRFSYSIN DD statements if the following conditions are true: v You do not specify one or more image copies in the JCL v You specify ICDYN(Y) v You specify ICTRLR(1), which indicates that the dynamically allocated image copy is a GDG It is not applicable for UNLOAD HRFSYSIN DD statements. Use the GDGMODEL keyword to identify a model for the GDG image copy data sets. Use the GDGMODEL keyword with the ICDYN(Y), ICHLQ, ICMID, and ICID keywords. If you specified a GDG for image copy data sets, specify the GDG model to be used. The GDGMODEL that you specified must be a cataloged image copy data set name. (gdgmodel) Default value None IC.COMP Description This keyword is optional for the REORG HRFSYSIN DD statement, but not applicable for the UNLOAD HRFSYSIN DD statements. It indicates whether the image copies are to be compressed by the image copy utility. The IC.COMP keyword must be used with the IC.COMPRTN keyword. Format (Y | N) Default value N IC.COMPRTN Description This keyword is optional for the REORG HRFSYSIN DD statement,
45
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | ICDYN Format
but not applicable for the UNLOAD HRFSYSIN DD statements. It indicates which compression routine is to be used if IC.COMP(Y) is also specified. The IC.COMPRTN keyword must be used with the IC.COMP keyword. (comprtn) Default value FABJCMP3 ICDDN Description This keyword is required for REORG HRFSYSIN DD statements if an image copy has been specified in the JCL and so, are not dynamically allocated by using ICDYN(Y). It is not applicable for the UNLOAD HRFSYSIN DD statements. Use the ICDDN keyword to identify the image copy DDNAME that is associated with a DBD DDNAME if the image copy data set is specified in the JCL. If ICNUM(2) is specified, you must identify a second DDNAME to be used if one is specified in the JCL. Otherwise, if ICDYN(Y) is specified, the second copy is dynamically allocated by using the ICHLQ, ICMID, ICID, and ICTRLR keywords. Format (dbd-dname,icddn[,icddn2]) Default value None
Description This keyword is required for REORG HRFSYSIN DD statements if one or more image copies are not specified in the JCL. Use the ICDYN keyword to identify whether one or more image copies are to be dynamically allocated by using the ICHLQ, ICMID, ICID, and ICTRLR keywords. If any image copy has been specified with the ICDDN keyword and has been specified in the JCL, this keyword is ignored for those image copies only. Format (Y | N) Default value N IC1DSN Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is an alternative to specifying the image copy data set name by using the ICHLQ, ICID, ICMID, and ICTRLR keywords. The data set name can contain variables, which are indicated by an ampersand (&). Enclose each variable in periods (.). The following variables are supported: &JOBNAME Name of this job.
46
User's Guide
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | ICEIN Format
&DBD The DBD name. This value changes to the first partition name when not all partitions are processed. &DATE1 This variable is substituted as Dyyyyddd. &DATE2 This variable is substituted as Ddddyyyy. &DATE3 This variable is substituted as Dddmmyy. &DATE4 This variable is substituted as Dmmddyy. &DATE5 This variable is substituted as Dyymmdd. &TIME1 This variable is substituted as Thhmmss. &TIME2 This variable is substituted as Thhmm. where: v yyyy is the 4-digit year v yy is the last 2 digits of the year v v v v mm is the month ddd is the day of the year dd is the day of the month hh is the hour (24 hour clock) local time
v mm is the minute v ss is the second (dsname) Default value None IC2DSN Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to specify a secondary image copy data set name. You can create the data set name by using the same method that is described for IC1DSN. Ensure that you create a unique data set name. Format (dsname) Default value None
Description This keyword is optional for REORG HRFSYSIN DD statements,

47
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | ICMID ICID ICHLQ Format
but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to describe a file by its DD statement. The file must contain the required High Performance Image Copy statements, including the allocation function. If you use this keyword, you do not need to use the other image copy (IC) keywords. This parameter is ignored if HPIC is not used. Restrictions exist for which HPIC functions can be used. See the HRF1 member in your SAMPLIB for an example. (ddname) Default value None
Description This keyword is required for REORG HRFSYSIN DD statements if one or more image copies are not specified in the JCL and the ICDYN(Y) keyword is specified. It is not applicable for UNLOAD HRFSYSIN DD statements. Use ICHLQ to specify the high-level qualifier when dynamically allocating any image copy data set. Use the ICHLQ keyword with the ICDYN(Y), ICMID, ICID, and ICTRLR keywords. If you have specified any image copy with the ICDDN keyword and you have specified any image copies in the JCL, this keyword is ignored for those image copies only. Format (ichlq1[,ichlq2]) Default value None
Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to distinguish between single or dual image copy data sets when you dynamically allocate dual image copies. Use the ICID keyword with the ICDYN(Y), ICHLQ, ICMID, and ICTRLR keywords. If you have specified any image copy with the ICDDN keyword and if you have specified any image copies in the JCL, this keyword is ignored for those image copies only. Specifying ICID(1) renders IC1 or IC2. Specifying ICID(2) renders none. Format (1 | 2) Default value 1
Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to specify the mid-level data set qualifier when you dynamically allocate any image copy data set. Use the ICMID keyword with the ICDYN(Y), ICHLQ, ICID, and ICTRLR keywords. If you have specified any image copy with the ICDDN
48
User's Guide
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Format
keyword and you have specified any image copy in the JCL, this keyword is ignored for those image copies only. Specify 1 to render:
dbdname.ddname.
Specify 2 to render:
dbdname.
Specify 3 to render:
ddname.
Specify 4 to render no mid-level data set qualifier. (1 | 2 | 3 | 4) Default value 2 ICNUM Description This keyword is required for REORG HRFSYSIN DD statements if a second copy of an image copy is to be dynamically allocated. It is not applicable for UNLOAD HRFSYSIN DD statements. Use the ICNUM keyword to indicate single or dual image copies. Specify ICNUM(1) to indicate that a single image copy is to be dynamically allocated. Specify ICNUM(2) to indicate that dual image copies are to be dynamically allocated. Format (1 | 2) Default value None ICTRLR Description This keyword is required for REORG HRFSYSIN DD statements if all the following conditions are true: v You do not specify one or more image copies in the JCL v You specified ICDYN(Y) v The dynamically allocated image copy is a GDG It is not applicable for UNLOAD HRFSYSIN DD statements. It is used to indicate whether a dynamically allocated image copy is a GDG data set and to use another final suffix qualifier. If a dynamically allocated image copy is not a GDG, ICTRLR identifies the last-qualifier of the image copy data set. Use the ICTRLR keyword with the ICDYN(Y), ICHLQ, ICMID, and ICID keywords. If you specified any image copy with the ICDDN keyword and you have specified any image copy in the JCL, the ICTRLR keyword is ignored for those image copies only. The ICTRLR keyword specifications render the following final suffix qualifiers: ICTRLR(1) GDG ICTRLR(2) Dyymmdd.Thhmmss
49
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Format IC.VIC Format
ICTRLR(3) Dmmddyy.Thhmmss ICTRLR(4) Dddmmyy.Thhmmss ICTRLR(5) None (1 | 2 | 3 | 4 | 5) Default value 2
Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to indicate whether all index image copies are registered as virtual. Specifying Y for this keyword, results in a USER IC that uses the IC.VICDSN as user data. Specifying N for this keyword, results in an index database registered as unrecoverable and not image copied. Y|N Default value N IC.VICDSN Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to specify the virtual image copy data set name. Format (dsname) Default value VIRT.IC ICVOLCT Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to specify the number of volumes to allocate for image copy data sets. If you have specified dynamic allocation for your image copy data sets (by specifying ICDYN(Y)), you can control the number of volumes by using the ICVOLCT keyword. Specify a value larger than 1 if you estimate the space that is required for an image copy data set requires more than what is available on a single volume. The ICVOLCT value is applied to all image copy data sets that are dynamically defined in the IMS Online Reorganization Facility job. Format 0-20
50
User's Guide
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | IMSID IMSID
Default value 1
Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to specify the IMSID parameter the IMS Library Integrity Utilities is using for this DBD. This keyword is used only when the NEWDBD statement is specified. To recalculate the unique ID for the DBD, you must include the IMS Library Integrity Utilities in your STEPLIB, DBDCOPY must be (Y), and ONLINECHANGE must be (Y). Format (xxxx) where xxxx is the IMSID to be used. Default The default value is taken from the IMS RESLIB (DFSVC000) value.
Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to specify the IMSID parameter the IMS Library Integrity Utilities is using for this DBD. This keyword is used only when the NEWDBD statement is specified. To recalculate the unique ID for the DBD, you must include the IMS Library Integrity Utilities in your STEPLIB, DBDCOPY must be (Y), and ONLINECHANGE must be (Y). Format (xxxx) where xxxx is the IMSID to be used. Default The default value is taken from the IMS RESLIB (DFSVC000) value. ITKBSERVER Description This keyword is optional. It is used to specify the name of the IMS Tools KB server that is used to store output. See the IMS Tools KB installation for detail. Format (xxxxxxxx) Where xxxxxxxx is the 8-character name of the IMS Tools KB server. Default value None LOG1DSN Description Specify the data set name for the primary log data set. The data set
51
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Format
name can contain variables, which are indicated by an ampersand (&). Enclose each variable in periods. The following variables are supported: &JOBNAME Name of this job. &DBD The DBD name. This value changes to the first partition name when not all partitions are processed. &DATE1 This variable is substituted as Dyyyyddd. &DATE2 This variable is substituted as Ddddyyyy. &DATE3 This variable is substituted as Dddmmyy. &DATE4 This variable is substituted as Dmmddyy. &DATE5 This variable is substituted as Dyymmdd. &TIME1 This variable is substituted as Thhmmss. &TIME2 This variable is substituted as Thhmm. where: v yyyy is the 4-digit year v yy is the last 2 digits of the year v v v v mm is the month ddd is the day of the year dd is the day of the month hh is the hour (24 hour clock) local time
v mm is the minute v ss is the second The following example shows a LOG1DSN keyword and variables:
LOG1DSN(HLQ1.HLQ2.&DBD.&DATE5.&TIME2.LOG1)
If the DBD name is MYDBD, the following data set name is created:
HLQ1.HLQ2.MYDBD.D070924.T1055.LOG1
(dsname) Default value None LOG2DSN Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to specify the data set name for the secondary log data set.
52
User's Guide
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Format
This keyword is ignored when dual logging is not specified in HRFSETOP. You can create the data set name by using the same method that is described for LOG1DSN. Ensure that you create a unique data set name. (dsname) Default value None LOGPRI Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to specify the primary space allocation in the cylinder. The maximum value is 9999. Format 0-9999 Default value 200 LOGSEC Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to specify the secondary space allocation in the cylinder. The maximum value is 9999. Format 0-9999 Default value 100 MGMTCLAS Description This keyword is required if you use SMS to dynamically allocate your work data sets and image copies. Use the MGMTCLAS keyword to identify the SMS Management Class. Format (mgmtclass) Default value None MONITOR Description This keyword is optional. It is used to generate a message in MSGPRINT every xxx minutes to indicate the progress of the reorganization process. The message indicates what phase the reorganization process is in and how many updates have been captured and applied up to that point. If you do not specify the MONITOR keyword, or if you specify MONITOR(0), IMS Online Reorganization Facility does not automatically generate these messages. In either case, though, the operator can issue an MVS MODIFY command (F jobname,MONITOR), and IMS Online
53
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | OPTID Format Format Format
Reorganization Facility sends the progress information to both the MSGPRINT data set and to the MVS console. 0-999 Default value 0 NEWDBD Description This keyword is required for REORG HRFSYSIN DD statements if you are requesting DBD changes. It is not applicable for UNLOAD HRFSYSIN DD statements. It is used to indicate the DDNAME of the DBDLIB that contains the new DBD to be used when reloading the database. You must include this DDNAME and data set in the JCL and it must contain the primary DBD. If you have DBD changes, it is highly recommended that you specify both the NEWDBD and ONLINECHANGE(Y) keywords so that the databases do not require manual intervention at the end of the reorganization. Include only the primary DBD and any other associated DBDs that have changed in this library, because the DMB is replaced for those DBDs. The NEWDBD keyword is ignored for HALDB. See the ONLINECHANGE, DBDCOPY, and TAKEOVER keywords for mutual exclusivity considerations. (newdbd) Default value None ONLINECHANGE Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is recommended if you request DBD changes. It is used to indicate whether a DMB replacement is performed by IMS Online Reorganization Facility, if the databases had DBD changes. If the databases had DBD changes, it is highly recommended that you specify both the NEWDBD and ONLINECHANGE(Y) keywords so that the databases do not require manual intervention at the end of the reorganization. This keyword is ignored for HALDB. When IMS uses dynamic allocation for the ACBLIB, the A and B data sets must be included in the JCL. If you specify ONLINECHANGE(Y), you must also specify NEWDBD(xxxx), TAKEOVER(Y), and DBDCOPY(Y). (Y | N) Default value Y
54
User's Guide
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
Description This keyword is optional. It is used to identify which SETOP member to use. IMS Online Reorganization Facility appends the specified suffix to HRF# to determine the name of the SETOP member to locate. IMSID indicates that the default IMS ID that is defined in SDFSRESL can be used as the suffix. If the SETOP member name that is created by appending the OPTID value that was specified is not found in STEPLIB, the default SETOP member name of HRFSETOP is used. You can use this parameter when a SETOP member is defined for an IMSPLEX set of IMS subsystems. Format 1- to 4-character suffix or IMSID Default value IMSID PARTITION Description This keyword is required if you are reorganizing a HALDB or PSINDEX. It is used to identify a specific partition to be reorganized by IMS Online Reorganization Facility. The DBD keyword must contain the master-DBD. If you do not specify the PARTITION keyword, all partitions for the HALDB or PSINDEX are reorganized. Generally the keyword is optional because the default value is PARTITION(*), which specifies all partitions. For example, this HRFSYSIN DD statement is for a full-function database that is not doing selected partition reorganization:
//HRFSYSIN DD * REORG DBD(HDOPR1) ICDYN(N) ICDDN(HDOPR11,ICPR1) //*
This example HRFSYSIN DD statement is for a HALDB database in which the partition named HALPART1 is requested:
//HRFSYSIN DD * REORG DBD(HALDB1) PARTITION(HALPART1) ICDDN(HALDD1A,ICPRT1) //*
This example HRFSYSIN DD statement includes the UNLOAD command. The PARTITION keyword is absent because the default is PARTITION(*), which specifies all partitions.
//HRFSYSIN DD * UNLOAD DBD(HDOPR1) //*
Format (partition) Default value * PRERES.ALLOWLC Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is
55
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Format
used to control prefix resolution handling when logical children that do not have logical parents are present. For additional information see the IMS High Performance Prefix Resolution for z/OS User's Guide. (Y | N) Default value Determined by IMS High Performance Prefix Resolution. PRERES.ALLOWLP Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to control prefix resolution handling when logical parents that do not have logical children are present. For additional information see the IMS High Performance Prefix Resolution for z/OS User's Guide. Format (Y | N) Default value Determined by IMS High Performance Prefix Resolution. PRERES.AVGRLEN Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to help prefix resolution optimize the use of the LPLCWKxx and TWINWKxx data sets. For additional information, see the IMS High Performance Prefix Resolution for z/OS User's Guide. Format (nnn) Default value Determined by IMS High Performance Prefix Resolution. PRERES.FILSZ Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to help prefix resolution optimize the use of the LPLCWKxx and TWINWKxx data sets. For additional information, see the IMS High Performance Prefix Resolution for z/OS User's Guide. Format (nnnnnnnnn) Default value Default is determined by IMS High Performance Prefix Resolution. PRERES.OPRTLC Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to control the printing of orphan logical children during prefix resolution. For additional information, see the IMS High Performance Prefix Resolution for z/OS User's Guide.
56
User's Guide
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
Format (Y | N) Default value Default is determined by IMS High Performance Prefix Resolution. PRERES.OPRTLP Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to control the printing of orphan logical parents during prefix resolution. For additional information, see the IMS High Performance Prefix Resolution for z/OS User's Guide. Format (Y | N) Default value Default is determined by IMS High Performance Prefix Resolution. PRERES.UPDLPC Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to control the updating of the counter in logical parents during prefix resolution. For additional information, see the IMS High Performance Prefix Resolution for z/OS User's Guide. Format (Y | N) Default value Default is determined by IMS High Performance Prefix Resolution. PRERES.XAVGRLEN Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to help prefix resolution optimize the use of the INDXWKxx data set. For additional information, see the IMS High Performance Prefix Resolution for z/OS User's Guide. Format (nnn) Default value Default is determined by IMS High Performance Prefix Resolution. PRERES.XFILSZ Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to help prefix resolution optimize the use of the INDXWKxx data set. For additional information, see the IMS High Performance Prefix Resolution for z/OS User's Guide. Format (nnnnnnnnn)
57
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
Default value Default is determined by IMS High Performance Prefix Resolution. PTRCHECK Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to indicate whether the pointers of the image copies are checked concurrently. If PTRCHECK is set to (Y), you must be licensed for the IBM Pointer Checker and it must be in the STEPLIB. Format (Y | N | HISTORY | BITMAP | FSEMAP | MAXFSD) Default value N RELOAD.DBIOBUF Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to specify the DBIOBUF (VSAM or BSAM I/O buffers) option that is managed by the IMS High Performance Load Utility during the reorganization. See the IBM IMS High Performance Load for OS/390 User's Guide for details and default values. Format (nnn) Default value Determined by IMS High Performance Load. RELOAD.DBRLBUF Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to specify the DBRLBUF (load buffers) option that is used by the IMS High Performance Load Utility during the reorganization. See the IBM IMS High Performance Load for OS/390 User's Guide for details and default values. Format (nnn) Default value Determined by IMS High Performance Load. RELOAD.FRSPC Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to specify the FRSPC (free space) option used by the IMS High Performance Reload Utility during the reorganization. See the IBM IMS High Performance Load for OS/390 User's Guide for details and default values. Format Y|N
58
User's Guide
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
Default value Determined by IMS High Performance Load. RELOAD.HPIO Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to specify the HPIO performance option that is used by the IMS High Performance Reload Utility during the reorganization. If the RELOAD.HPIO keyword is not specified in HRFSYSIN, the IMS HP Load default value is used. See the IBM IMS High Performance Load for OS/390 User's Guide for details. Format Y|N Default value N RELOAD.OADSPR Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to affect the use of data space storage by High Performance Load during the reload step. See the IBM IMS High Performance Load for OS/390 User's Guide for details and default values. Format Y|N Default value Determined by IMS High Performance Load. RELOAD.RAAFORMAT Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to specify the RAAFORMAT (format the root addressable area) option that is used by the IMS High Performance Load Utility during the reorganization. See the IBM IMS High Performance Load for OS/390 User's Guide for details and default values. Format Y|N Default value Determined by IMS High Performance Load. RELOAD.SEARCH Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to specify a SEARCH algorithm to be used by the IBM IMS High Performance Load Utility during the reorganization. See the IBM IMS High Performance Load for OS/390 User's Guide for details and default values.
59
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
Format (nnn) Default value Determined by IMS High Performance Load. RELOAD.SORT Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to cause HP Load to invoke the physical sequential sort before reloading any data in the reload step. See the IBM IMS High Performance Load for OS/390 User's Guide for details. If DBD changes are being implemented during the IMS Online Reorganization Facility job that can cause the sequence of database records to change, the physical sequential sort must be called during the reload step by specifying RELOAD.SORT(Y). If you do not specify the RELOAD.SORT keyword in HRFSYSIN, the IMS HP Load default is used. Format YES | Y | NO | N | COND | C Default value N RELOAD.USEREXIT Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to identify the name of a user exit to be used for data conversion or manipulation of the database during reload. User exits are only supported during the reload of the database. Format (exitname) Default value No exit name RESTART Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to indicate whether IMS Online Reorganization Facility is to continue with a TAKEOVER-restart if it detects that the previous job failed. It is recommended that you do not specify RESTART(OVERRIDE) to override the restart process because it would cause data integrity problems if the database had not been manually recovered. Specify the RESTART(OVERRIDE) option only if you have recovered the database after a previous IMS Online Reorganization Facility job failed during Takeover and you are aware of the consequences. If you specify RESTART(AUTOMATIC) or RESTART(AUTO), and IMS Online Reorganization Facility detects that the previous job
60
User's Guide
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Format
had a restart record in the restart data set, it automatically continues and restarts the Takeover phase from where it ended last. If you specify RESTART(NO) or RESTART(N), and IMS Online Reorganization Facility detects that the previous job had a restart record in the restart data set, it does not automatically continue. IMS Online Reorganization Facility issues a message that informs you that a restart is required, that a prior job has failed, and that you might need to investigate. (AUTOMATIC | AUTO | NO | N | OVERRIDE) Default value N SHADOW Description This keyword is optional. It is used to indicate whether all shadow data sets exist as your predefined shadows or if the shadows are to be deleted or defined by Online Reorganization Facility. The options are: v SHADOW(E) to indicate that the shadows exist and have been predefined. v SHADOW(A) to indicate that IMS Online Reorganization Facility deletes or defines them using the attributes of the original data sets. This option can be useful when the cluster definition needs to be changed and is different than the original data set attributes, such as amount of space, and other attributes. Format (Allocate | Exist) Default value A (Allocate) STORCLAS Description This keyword is required if you use SMS to dynamically allocate your work data sets and image copies. It is used to identify the SMS Storage Class. Format (storclass) Default value None TAKEOVER Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to indicate whether IMS Online Reorganization Facility performs the TAKEOVER phase (the original database is affected). If TAKEOVER(DELAY) is specified the original data sets are not affected. This feature allows you to manually perform steps after the reorganization process and before the databases are brought
61
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Format Format
online, if needed. The database is left in a DB recovery needed state with PROHIBIT AUTH status set in DBRC. Restart information is saved in a restart data set. Takeover can be completed by resubmitting your job with TAKEOVER(Y) and RESTART(AUTO) keywords specified. If TAKEOVER(Y) is specified the original databases are swapped with the shadow data sets. The reorganized databases will be available online after the TAKEOVER phase completes, and the reorganization will be considered complete. If ONLINECHANGE(Y), DELETE(Y), and DBDCOPY(Y) are specified, TAKEOVER(Y) must be specified. (Y | N | DELAY) Default value Y TAKEOVER.WINDOW Description This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements. It is used to define a takeover window and to define the action to take if the takeover is not started by the end of the window. This keyword is applicable only if TAKEOVER(Y) is specified. This keyword is not applicable during a RESTART. Optionally specify begHH:MM if you do not want takeover to start until a certain time. If IMS Online Reorganization Facility is ready for Takeover phase before begHH:MM, a message is issued and the program goes into idle mode. Any changes that are occurring are captured and applied to the database. After the time that is specified by begHH:MM, IMS Online Reorganization Facility begins the Takeover processing. At any time that the IMS Online Reorganization Facility job is idling, you can specify an MVS modify (/F jobname,TAKEOVER) to begin takeover processing. Optionally specify endHH:MM to ensure that takeover does not start after the specified time. Specify an endaction to specify what to do if the time that is specified by endHH:MM is exceeded. endaction is applicable only if endHH:MM is specified. Valid values for endaction are: ABEND Abend the job if takeover is not yet started. NEXTDAY Reset the takeover window for the next day. NEXTDAY is valid only if begHH:MM is also specified. WTOR Issue a WTOR to query the operator about what action to take. (begHH:MM[,endHH:MM[,endaction]]) begHH:MM,endHH:MM format '00:00' to '23:59'. Times are in 24hour time.
62
User's Guide
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
Default value Begin takeover when ready.
Keywords that affect DBD and DMB replacements

If a DBD is changed during an online reorganization (as a result of specifying the NEWDBD keyword), IMS Online Reorganization Facility automatically performs an ACBGEN. The ACBGEN is performed in the staging ACBLIB that you specified on the IMSACB DD statement. This final process occurs during the takeover phase. If IMS Library Integrity Utilities is installed and specified in the STEPLIB, the unique ID of the DBD can be updated. To have IMS Online Reorganization Facility use IMS Library Integrity Utilities to recalculate the unique ID for the DBD, you must perform or verify the following steps: v Include the IMS Library Integrity Utilities in your STEPLIB. v Ensure the value DBDCOPY is (Y). v Ensure the value of ONLINECHANGE is (Y). You can specify three keywords that affect the final stages of DBD or DMB replacement: ONLINECHANGE, DBDCOPY, and NEWDBD. ONLINECHANGE You can use the keyword to indicate whether an ACB or DMB replacement (like an online change) is done to complete the takeover process and make the database available. If you specify ONLINECHANGE(Y), the following actions occur: v A DMB is loaded before the database is started in online systems. v The ACBs are copied from the IMSACB DD statement into the IMSACBA and IMSACBB libraries. If the online systems are not available during this phase, the IMSACBA and IMSACBB DD statements must be present in the JCL for the online change to be successful. If the online systems are available during this phase, IMS Online Reorganization Facility obtains both the active and inactive ACB libraries that are allocated to the online systems. If dynamic ACBLIB is active, the A and B data sets must be specified in the JCL; otherwise you do not have to specify the IMSACBA and IMSACBB DD statements in the JCL. v If the IMSACBA and IMSACBB DD statements that you specified in the JCL are different from the available online systems, the ACBs are copied to the following locations: Libraries specified in the JCL ACB libraries that are allocated in the control region If you specify ONLINECHANGE(N), the following actions occur: v The ACBGEN is performed and placed into the staging IMSACB library. v The copy to the IMSACBA and IMSACBB libraries is not performed. v The DMB is not replaced. DBDCOPY You can use the DBDCOPY keyword to indicate whether the new DBD is copied to the current DBDLIB (IMS DD statement).
63
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
If you specified ONLINECHANGE(Y), copying the DBD used in the reorganization to the DBDLIB is highly recommended. Copying the new DBD helps avoid out-of-sync situations between the DBDLIB and the ACBLIB. If you specified DBDCOPY(N), the database is not left offline and in prohibit authorization status. NEWDBD The following restrictions apply when you use the NEWDBD parameter to specify a secondary index: v You can specify only five new indexes. v You must place your new index DBDs in the NEWDBD data set. v You must register your new index DBDs with DBRC before running IMS Online Reorganization Facility. v You must have allocated and cataloged your data sets before running IMS Online Reorganization Facility. IMS Online Reorganization Facility forces ONLINECHANGE to a setting of NO. The NO setting is required because all the PSBs that reference the primary DBD must be rebuilt. IMS Online Reorganization Facility cannot replace PSBs, so you must perform a standard IMS online change. The results from the DBDCOPY and ONLINECHANGE copies can be found in the IEBPRINT output of the IMS Online Reorganization Facility job. If the ACBGEN, the DBDCOPY, or the online change fails, a message is written to the following locations: v MSGPRINT v The applicable output data sets (such as IEBPRINT and SYSPRINT) If any of these operations fail or are delayed, the database is left in prohibit authorization status and it remains unavailable to the online systems until one of the following situations occur: v The system is restarted to complete the process. v You manually fix and restart the database. v A restart is done to complete the process and manual fixes are made.
Takeover restart processing

IMS Online Reorganization Facility allows a Takeover phase restart to occur if the previous reorganization job failed or was delayed during the Takeover phase. A takeover restart allows the Takeover phase to automatically restart from where it stopped to continue IMS Online Reorganization Facility processing. The restart key-sequenced data set has the following characteristics: v It is defined within the setup options during installation. v It is used by IMS Online Reorganization Facility to save information that is required to restart within the Takeover phase. v It is read at the beginning of each job to determine if a restart record exists for a specific DBD name or partition name. v It is required to ensure data integrity and availability if a reorganization fails or is delayed.
64
User's Guide
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
To perform a restart, the previous online reorganization job for a specific database (DBD name or partition name) must have met one of the following criteria: v It failed during the Takeover phase. v It was delayed (TAKEOVER(DELAY)) by the previous control statements. If the control statements or restart data set are not modified, the next time the same reorganization job runs, at the beginning of the job, IMS Online Reorganization Facility detects that there is a restart pending. The restart pending is detected by reading the data that was saved in the restart data set. Upon detection of a restart pending, a restart automatically begins if you have specified RESTART(AUTOMATIC). When a successful restart has been performed by using RESTART(AUTOMATIC), the following actions occur: v The database is made available online. v The restart data is removed from the restart data set to allow subsequent jobs to start from the beginning. The default RESTART option is RESTART(N). The restart option allows you to respond to the restart-detected message and specify whether a restart is to be performed. You must change the RESTART option to RESTART(AUTOMATIC) to allow a restart to begin. If you have recovered the database or partition, or you do not need to restart the database (), you can override the restart status by specifying RESTART(OVERRIDE). Generally, when the test database or the database state has been recovered manually, you can consider using the RESTART(OVERRIDE) option. The reorganization job is not restarted in the Takeover phase and is instead started as though there was never a restart pending. The job is restarted at the first phase of the reorganization job. The restart data for this database or partition is removed from the restart data set. No action is taken by IMS Online Reorganization Facility other than removing the restart data from the restart data set. Attention: Use the RESTART(OVERRIDE) option with caution.
Examples for IMS Online Reorganization Facility

The examples provided in the following topics show some of the typical ways that you can use the IMS Online Reorganization Facility.
Example: Reorganizing a HIDAM without DBD changes

As a result of running the following job the HIDAM OSAM database remains online as the reorganization process is executed as a single step. The following example JCL job reloads a HIDAM database that matches its corresponding (HIOPR1) DD names with no secondary indexes and no DBD changes.
//*-------------------------------------------------------------------------------//* Online Reorganization of a HIDAM OSAM database with no secondary indexes //* (no DBD changes) //*-------------------------------------------------------------------------------//ORF EXEC PGM=HRFREORG,REGION=80M //STEPLIB DD DSN=yourhlq.HRFLOAD,DISP=SHR // DD DSN=IMSVS.R11.USERLIB,DISP=SHR <=== ROUTINES // DD DSN=IMSUTIL.V2.SHPSLMD0,DISP=SHR <=== IMS TOOLS // DD DSN=IMSVS.R11.SDFSRESL,DISP=SHR //IMS DD DSN=IMSVS.R11.DBDLIB,DISP=SHR //IMSDALIB DD DSN=IMSVS.R11.MDALIB,DISP=SHR //IEFRDER DD DSN=yourhlq.HIOPR1.IEFRDER, // DISP=(,CATLG,DELETE),
65
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
// SPACE=(CYL,(300,50),RLSE),UNIT=SYSALLDA //* //ICPR11 DD DISP=(,CATLG,DELETE),DSN=yourhlq.HIOPR1.HIOPR11.IC(+1), // SPACE=(CYL,(300,50),RLSE),UNIT=SYSALLDA,DCB=(yourhlq.MODEL.DCB) //ICPX1 DD DISP=(,CATLG,DELETE),DSN=yourhlq.HIOPX1.HIOPX1.IC(+1), // SPACE=(CYL,(100,50),RLSE),UNIT=SYSALLDA,DCB=(yourhlq.MODEL.DCB) //* //HRFSYSIN DD * REORG DBD(HIOPR1) ICDDN((HIOPR11,ICPR11), (HIOPX1,ICPX1)) //*
Example: Reorganizing an HDAM database with DBD changes

As a result of running the following job the HDAM VSAM database remains online as the reorganization process is executed as two steps, the DBDGEN step and IMS Online Reorganization Facility step. The following example JCL reloads an HDAM database with two secondary indexes with DBD changes.
//*-----------------------------------------------------------------------//* DBDGEN (changing the randomizer parameters) //*-----------------------------------------------------------------------//DBDGEN EXEC DBDGEN,MBR=HDVPR1 //L.SYSLMOD DD DSN=IMSVS.R11.DBDLIB.NEW(HDVPR1),DISP=SHR //*-----------------------------------------------------------------------//* Online Reorganization of an HDAM database with 2 secondary indexes //* (DBD changes and IC dynamic allocation) //*-----------------------------------------------------------------------//ORF EXEC PGM=HRFREORG,PARM=DBD=dbdname,REGION=0M //STEPLIB DD DSN=yourhlq.HRFLOAD,DISP=SHR // DD DSN=IMSVS.R11.MDALIB,DISP=SHR // DD DSN=IMSVS.R11.USERLIB,DISP=SHR <=== ROUTINES // DD DSN=IMSUTIL.V2.SHPSLMD0,DISP=SHR <=== IMS TOOLS // DD DSN=IMSVS.R11.SDFSRESL,DISP=SHR //IMS DD DSN=IMSVS.R11.DBDLIB,DISP=SHR //IMSACB DD DSN=IMSVS.R11.ACBLIB,DISP=SHR //IMSNEW DD DSN=IMSVS.R11.DBDLIB.NEW,DISP=SHR <--- changed DBDs //IEFRDER DD DSN=yourhlq.HDVPR1.IEFRDER, // DISP=(,CATLG,DELETE), // SPACE=(CYL,(300,50),RLSE),UNIT=SYSALLDA //* //HRFSYSIN DD * REORG DBD(HDVPR1) NEWDBD(IMSNEW) ONLINECHANGE(Y) DBDCOPY(Y) RELOAD.SORT(Y) ICDYN(Y) ICHLQ(yourhlq.IC) ICMID(2) ICTRLR(5) //*
Example: IMS Online Reorganization Facility batch procedure

You can use the following procedure to execute an IMS Online Reorganization Facility batch job. You do not need to use this procedure if you prefer to use JCL without procedures (PROCs).
//HRF PROC DBD=DUMMY,RGN=0M,IMSHLQ=,HRFLOAD=,USERLIB=, // IMSUTIL=,SYS2=,SOUT=*,WRKHLQ=,UNIT=SYSALLDA //* //IEFDEL EXEC PGM=IEFBR14,REGION=4096K //DELLOG DD DISP=(MOD,DELETE,DELETE), // DSN=&WRKHLQ..&DBD..IEFRDER, // SPACE=(TRK,(1,1)),UNIT=SYSALLDA //*-------------------------------------------------------------//* INVOKE IMS ONLINE REORGANIZATION FACILITY (HRF) //*-------------------------------------------------------------//HRF EXEC PGM=HRFREORG,REGION=0M //STEPLIB DD DISP=SHR,DSN=&HRFLOAD // DD DISP=SHR,DSN=&IMSREL..MDALIB
66
User's Guide
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
// DD DISP=SHR,DSN=&USERLIB // DD DISP=SHR,DSN=&IMSUTIL..SHPSLMD0 // DD DISP=SHR,DSN=&IMSREL..SDFSRESL //IMSDALIB DD DISP=SHR,DSN=&IMSREL..MDALIB //IMS DD DISP=SHR,DSN=&IMSREL..DBDLIB //IMSNEW DD DISP=SHR,DSN=&IMSREL..DBDLIB.NEW //IMSACB DD DISP=SHR,DSN=&IMSREL..ACBLIB //* //IEFRDER DD DSN=&WRKHLQ..&DBD..IEFRDER, // DISP=(,CATLG,DELETE), // DCB=(RECFM=VB,LRECL=900,BLKSIZE=11860), // SPACE=(CYL,(300,50),RLSE),UNIT=SYSALLDA //* //*HRFSYSIN THAT YOU MUST SUPPLY // PEND
Example: Reorganizing a partition of a PSINDEX

This example shows the JCL that you can use to reorganize a PSINDEX partition.
//* Reorganizing a partition of a PSINDEX //*-------------------------------------------------------------------//ORF EXEC PGM=HRFREORG,REGION=80M //STEPLIB DD DSN=yourhlq.HRFLOAD,DISP=SHR // DD DSN=IMSVS.R11.USERLIB,DISP=SHR <=== ROUTINES // DD DSN=IMSUTIL.V2.SHPSLMD0,DISP=SHR <=== IMS TOOLS // DD DSN=IMSVS.R11.SDFSRESL,DISP=SHR //IMS DD DSN=IMSVS.R11.DBDLIB,DISP=SHR //IMSDALIB DD DSN=IMSVS.R11.MDALIB,DISP=SHR //HRFSYSIN DD * REORG DBD(PSXO4) PARTITION(PSXO4A) //
Example: Unloading a HIDAM database

This example shows the JCL that you can use to unload a HIDAM OSAM database.
//* Unload of a HIDAM OSAM database //*-------------------------------------------------------------------//ORF EXEC PGM=HRFREORG,REGION=80M //STEPLIB DD DSN=yourhlq.HRFLOAD,DISP=SHR // DD DSN=IMSVS.R11.USERLIB,DISP=SHR <=== ROUTINES // DD DSN=IMSUTIL.V2.SHPSLMD0,DISP=SHR <=== IMS TOOLS // DD DSN=IMSVS.R11.SDFSRESL,DISP=SHR //IMS DD DSN=IMSVS.R11.DBDLIB,DISP=SHR //IMSDALIB DD DSN=IMSVS.R11.MDALIB,DISP=SHR //DFSUINPT DD DSN=yourhlq.HDOPR1.UNLOAD, // DISP=(,CATLG,DELETE), // SPACE=(CYL,(300,50),RLSE),UNIT=SYSALLDA //HRFSYSIN DD * UNLOAD DBD(HIOPR1) //
67
68
User's Guide
Chapter 5. Troubleshooting
The following topics describe some common processes and situations that can help you to troubleshoot problems with IMS Online Reorganization Facility. Topics: v Gathering diagnostic information v Generating diagnostic information on page 71 v An IMS Online Reorganization Facility job cannot connect to an online IMS subsystem on page 72
Gathering diagnostic information

Before you report a problem with IMS Online Reorganization Facility to IBM Software Support, you need to gather the appropriate diagnostic information.
Procedure
Provide the following information for all IMS Online Reorganization Facility problems: v A clear description of the problem and the steps that are required to recreate the problem v All messages that were issued as a result of the problem v Product release number and the number of the last program temporary fix (PTF) that was installed v The version of IMS that you are using and the type and version of the operating system that you are using Provide additional information based on the type of problem that you experienced: For online abends, provide the following information v A screen capture of the panel that you were using when the abend occurred v The job log from the TSO session that encountered the abend v The job log from the server v A description of the task that you were doing before the abend occurred For errors in batch processing, provide the following information v The complete job log v Print output v Contents of any data sets that were used during the processing
DEBUG diagnostic record formatting exit routine

The DEBUG diagnostic records must be formatted for your interpretation. The HRFOLGOF exit routine invokes the DFSERA10 IMS file select and print utility to format the diagnostic records that you created by running DEBUG. The following example shows how to use the HRFOLGOF exit routine to invoke the IMS file select and print utility.
69
//********************************************************************* //* FUNCTION: FILE SELECT AND PRINT UTILITY - DFSERA10 //*-------------------------------------------------------------------//PRNTUSER EXEC PGM=DFSERA10 //STEPLIB DD DISP=SHR,DSN=your.ims.SDFSRESL // DD DISP=SHR,DSN=your.hrf.LOAD //SYSPRINT DD SYSOUT=* //SYSUT1 DD DISP=SHR,DSN=your.ims.log.dataset //SYSIN DD * CONTROL CNTL SKIP=0,STOPAFT=EOF,DDNAME=SYSUT1 OPTION PRINT OFFSET=5,VALUE=F0,EXITR=HRFOLOGF, + PARM=(IOAREA=Y,DUMP=N,DEBUG=Y) END
The important values in the SYSIN control statements include the following: EXITR=HRFOLOGF Specifies that the IMS Online Reorganization Facility formatting exit routine is called for the selected log records. OFFSET=5 Identifies the offset of the log record ID. VALUE=F0 Specifies the log records to select. This value must be the same value as was specified in the HRFSETOP options ULOGID=. The default for HRFSETOP is F0'. PARM= Specifies the processing options for the IMS Online Reorganization Facility formatting exit routine (HRFOLOGF). IOAREA= Controls whether the user I/O area is formatted for any captured log records. Formatting the I/O area can substantially increase the amount of print output that is generated. Specify IOAREA=Y to indicate that the user IOAREA is formatted. Specify IOAREA=N to indicate that the user I/O area is not formatted. DUMP= Indicates whether a hex dump of each log record is included with the formatted output. Specify DUMP=Y to indicate that a hex dump of each log record is included with the formatted output. Specify DUMP=N to indicate that a hex dump of each log record is not included with the formatted output. DEBUG= Controls whether the additional log records that are generated by having DEBUG activated is formatted. Formatting the additional log records generated by DEBUG can substantially increase the amount of print output that is generated. Specify DEBUG=Y to indicate that the additional log records that are generated by having DEBUG activated is formatted. Specify DEBUG=N to indicate that the additional log records that are generated by having DEBUG activated is not formatted.
70
User's Guide
Generating diagnostic information

Use the IMS Online Reorganization Facility utility (HRFYUTIL) to generate additional diagnostic information for use in troubleshooting and solving problems. Specifically, you use the HRFYUTIL job to cause IMS Online Reorganization Facility's change capture process to gather additional information about the updates that are occurring within the control region. When you run the HRFYUTIL job, MSGPRINT and TRACE SYSOUT files are dynamically allocated in the IMS control region. The additional information is provided to these two data sets. This utility also causes additional IMS Online Reorganization Facility log records to be written to the IMS log for the databases that have change capture active. To run the HRFYUTIL job, create a JCL job that includes the appropriate statements and run the job.
HRFYUTIL syntax
This topic describes the syntax for HRFYUTIL, including its program name, DD statements, and control statements. Use HRFYUTIL to verify the maintenance level of IMS Online Reorganization Facility in an online system, to check the level of a library with the level in an online system you use these DD statements, or to perform diagnostic tests. Attention: Use HRFYUTIL for diagnostic tests only at the direction of IBM Software Support and only during a time when additional system processing can be accommodated. This utility causes additional system processing for all the calls and logging in the IMS control region. A large amount of SYSOUT data can potentially be written in the IMS control region while this utility is active. Program name: HRFYUTIL DD statements: HRFSYSIN Required. Indicates the input control statement data set. Format: RECFM=F or FB, LRECL=80 MSGPRINT Optional. Indicates the SYSOUT data set to which runtime messages are logged. If this DD statement is not specified, it is dynamically allocated. Format: RECFM=FA, LRECL=133 HRFLIB Optional. If this DD statement is provided, new IMS Online Reorganization Facility maintenance is loaded from this DD instead of from the STEPLIB or JOBLIB concatenation.
HRFYUTIL control statements for diagnostic testing

You can specify several control statements in the HRFSYSIN input control data set to identify which type of action or maintenance is to be performed. These control statements include:
71
Command Control Statements (HRFSYSIN): You can specify any number of control statements in the SYSIN data set to identify which databases and data sets to process for diagnostic analysis. Command: DEBUG Keywords: IMSID Required. Indicates the target IMS subsystem ID on which to activate or stop diagnostic tests. Format: Any valid 1-4 character subsystem ID. Default: None. ACTION Required. Indicates whether to start or stop diagnostic tests. Specify START start providing additional diagnostic tests. Specify STOP stop providing additional diagnostic tests. The following example shows how to start the HRFYUTIL utility. The example includes the EXEC statement, the DD statements, and the control statements.
//UTIL EXEC PGM=HRFYUTIL,REGION=0M //STEPLIB DD DISP=SHR,DSN=HRFLOAD //MSGPRINT DD SYSOUT=* //HRFSYSIN DD * DEBUG IMSID(IM71) ACTION(START) //
The following example shows how to stop the utility, HRFYUTIL. The example includes the EXEC statement, the DD statements, and the control statements.
//UTIL EXEC PGM=HRFYUTIL,REGION=0M //STEPLIB DD DISP=SHR,DSN=HRFLOAD //MSGPRINT DD SYSOUT=* //HRFSYSIN DD * DEBUG IMSID(IM71) ACTION(STOP) //
An IMS Online Reorganization Facility job cannot connect to an online IMS subsystem
A problem that users sometimes encounter is the failure of an IMS Online Reorganization Facility job to connect to an online IMS subsystem. The following subsections describe the symptoms, cause, and description of what happens when an IMS Online Reorganization Facility job cannot connect to an online IMS subsystem.
Symptoms
The following messages are displayed when you are trying to run an IMS Online Reorganization Facility job:
HRF01511E Target member imsid not active HRF01107E Online subsystem imsid not available
72
User's Guide
The messages are incorrect because the IMS subsystem that is identified in these messages is active and available.
Cause
The IMS Tools Online System Interface component was not activated in the control region, or a different XCF group name was specified in the control region and in the IMS Online Reorganization Facility job. When an IMS Online Reorganization Facility job is submitted, it attempts to connect to all online IMS subsystems that might have access to the database that is being reorganized. The connection is an attempt to capture any concurrent updates and to control access to the database during certain points of the reorganization process. If the IMS Online Reorganization Facility job cannot establish access to every online IMS subsystem, that job abnormally terminates.
Description
To determine which online IMS subsystems might have access to the database that is being reorganized IMS Online Reorganization Facility reads the subsystem records from the RECON. If there are any abnormally terminated online subsystems, IMS Online Reorganization Facility is unable to continue because it cannot establish a connection to the subsystem to determine the database status. For each active online subsystem in the RECON, IMS Online Reorganization Facility attempts to establish two XCF connections to that subsystem. The first XCF connection is used to capture and receive any concurrent updates that might occur while IMS Online Reorganization Facility is performing the reorganization. This connection is called the change capture interface. The second connection is called the IMS Tools Online System Interface and it is used to issue any operator commands to display or control access to the database if and when it is needed. The main reason for you to have two separate XCF connections, is that the change capture interface is specific only to IMS Online Reorganization Facility, whereas the IMS Tools Online System Interface can be shared by several different IMS High Performance tools.
Solution
For a complete description of the tasks to fix this problem see Enabling XCF connections on page 22.
73
74
User's Guide
Chapter 6. IMS Tools Online System Interface

IMS Tools Online System Interface is a general-purpose command interface that allows IMS tools to interface with all supported IMS versions. Topics: v IMS Tools Online System Interface overview v IMS Tools Online System Interface implementation v Setting up the PROCLIB member on page 76
IMS Tools Online System Interface overview

IMS Tools Online System Interface is a general-purpose command interface that allows IMS tools to interface with all supported IMS versions. The IMS Tools Online System Interface is started during IMS initialization. IMS Tools Online System Interface reorganization and recovery solutions allow other clients to start and stop full function database resources and issue IMS commands that need to interact with online DB/DC IMS or CICS DBCTL systems that own the target databases. IBM IMS Tools products use the IMS Tools Online System Interface to issue its action commands and IMS commands.
IMS Tools Online System Interface implementation

This section provides important information about the implementation of the IMS Tools Online System Interface.
General implementation
The IMS Tools Online System Interface library must be included in the appropriate authorization table, so that the libraries in the JOBLIB or STEPLIB concatenation do not lose their APF authorization. Related Reading: For information about APF authorization, see the MVS Initialization and Tuning Reference.
Integration implementation
If you are using an older version of the IMS Tools Online System Interface, the IMS Tools Online System Interface library or other APF-authorized PDS MUST be located before any other library that might contain a customer or vendor version of module DFSPPUE0 (Partner Product User Exit Routine). IMS Tools Online Interface System Interface must be installed using IMS Generic | | | | IMS Tools Online Interface System Interface can be installed using IMS Generic Exits, which no longer distributes a DFSPPUE0 module. The FOIPPUE1 module must be defined in the Generic Partner Exit PROCLIB member (GPR*).
75
| | | | | | | |
If other vendor products have these exits and are not defined to use Generic Exits, ensure that the following actions are taken: 1. The vendor's DFSPPUE0 and DFSFLGX0 exits must be concatenated in the STEPLIB. 2. The vendor's DFSPPUE0 and DFSFLGX0 exits must pass control to the SGLXLOAD (Generic Exit) load libraries. The Generic Exit load libraries must be able to pass control to the IMS Online Reorganization Facility DFSPPUE0 and DFSFLGX0 exits. .
Operation implementation
Each input request or output response must fit within the 61 K length data buffer. If input data exceeds the 61 K buffer maximum, a parsing error is encountered. If response data exceeds the 61 K buffer maximum, the returned data is truncated. IMS Tools Online System Interface supports DL/I databases and DEDB areas. IMS Tools Online System Interface does not support MSDB database types.
Setting up the PROCLIB member

The IMS Tools Online System Interface PROCLIB member defines the required and optional parameter values to initialize and run the IMS Tools Online System Interface environment. The IMS Tools Online System Interface PROCLIB member must be a member of a PDS which you define with the IMS PROCLIB data definition statement concatenation. The IMS Tools Online System Interface member name must have three parts: ppp, iiii, and c. Define it according to the following specifications: ppp iiii c The three-byte IMS Tools Online System Interface product prefix, FOI. The 1-to-4 byte IMSID associated with the target IMS control region. A one-byte character identifier, P.
An example of an IMS Tools Online System Interface PROCLIB member name for the IMSA subsystem is FOIIMSAP. The following sections describe the PROCLIB member keyword parameters, keyword parameter syntax, and an example IMS Tools Online System Interface PROCLIB member.
PROCLIB member keyword parameters

The IMS Tools Online System Interface PROCLIB member contains keyword parameters that you need to set. The following list shows the IMS Tools Online System Interface PROCLIB member keyword parameters and their meanings: XCFGROUP= Specifies the XCF group that IMS Tools Online System Interface joins to interface with client programs.
76
User's Guide
Specify the XCF group name as a 1- to 5-character alphanumeric string that IMS Tools Online System Interface prefixes with the characters TOI to produce the XCF group name. XCFGROUP is a required parameter that has no default value. Customizing the IMS control region: To customize the IMS control region for using IMS Tools Online System Interface, you must define a unique group name for each data sharing group or set of RECONs within a sysplex on which IMS Tools Online System Interface is used. All the IMS subsystems that are in the same data sharing group must also be in the same group as IMS Tools Online System Interface. During initialization in the control region, IMS Tools Online System Interface attempts to locate member FOIimsiidP (for example: FOIIMS1P for IMS1, FOISYS3P for SYS3). This member specifies the XCF group as: XCFGROUP=xxxxx. Note: The XCFGROUP name does not begin with TOI and does not exceed five characters. For example: XCFGROUP=IMS31 would represent TOIIMS31. If both IMS systems share the same RECONs, the XCFGROUP name would be identical in both FOIxxxxP members. If IMS Tools Online System Interface locates the member, IMS Tools Online System Interface initializes and joins the group, TOIxxxxx. After IMS Tools Online System Interface joins the group, other tools can communicate with this IMS if they join the same group. If IMS Tools Online System Interface does not locate the member, IMS Tools Online System Interface does not initialize in the control region. IMS Tools Online System Interface issues a warning message, and other tools cannot communicate with IMS even if they join the group because no program is available in IMS to service their requests. INTTIME= Specifies the Wait Time value to be used for synchronous requests. Specify the wait time in seconds to a maximum value of 3600 seconds. Code the INTTIME parameter as a 1- to 4-character numeric string. If you do not specify INTTIME, a default value of one second is used. INTNUM= Specifies the number of Wait Time intervals. Specify the wait time interval as a 1- to 2-character numeric string with maximum value of 60 intervals. If you do not specify INTNUM, a default value of one interval is used. RESTART= Specifies whether the IMS Tools Online System Interface environment re-initializes following an abnormal termination. You can code RESTART=YES to permit restart processing or RESTART=NO to prohibit permit restart processing. If you do not specify RESTART a default action of YES is used. DUMP= Specifies whether an IMS Tools Online System Interface environment failure produces a dump during ESTAE processing. You can code DUMP=YES to produce a dump or DUMP=NO to specify not to produce a dump. If you do not specify DUMP, a default action of YES is used.
77
If you specify DUMP=NO, IMS Tools Online System Interface ESTAE processing does not produce a dump, but sends the FOI102I messages to the system console. These messages provide diagnostic information and include the following information: v PSW and System or User abend code. v MODID and entry point address (if applicable and available). v DATA of abending code. v Registers of abending program.
PROCLIB member keyword parameter syntax

You can specify PROCLIB member keyword parameters in free format. They can be preceded by one or more blanks and terminated by blanks or a comma. You can code single keywords or multiple keywords on individual statements. However, keywords cannot be split on multiple statements, they must be contained on a single statement. You must specify keywords within positions 1 through 71 of a statement. Statements with an asterisk (*) in position one are treated as comment statements and are not processed. Statements with a slash followed by an asterisk (/*) in any positions are treated as trailing comments and the remainder of the statement is not processed.
IMS Tools Online System Interface messages

This reference section provides detailed information about IMS Tools Online System Interface messages. Use this information to help you with troubleshooting. Errors that are encountered while processing data on the ISPF user interface panels are indicated through a short message that is displayed on the top right corner of the panel. To obtain more information about any processing error, enter HELP (PF1). For messages that are issued by IMS or DFS, see the following IMS manuals: v Message and Codes, Volume 1, GC26-9433 v Messages and Codes, Volume 2, GC27-1120 An alphabetic severity code is contained in the last character of the message. The severity code characters include: A, E, I, and W. v A messages indicate action is required by the user before processing can continue. v E messages indicate an error condition in which a requested function did not complete successfully. The condition might or might not require action. v I messages are informational only. v W messages warn the user of a possible error condition. For each message, the following accompanying information is provided where applicable: Explanation: This information explains what the message text means, why it occurred, and what its variable entry fields are (if any)
78
User's Guide
FOI001E FOI005W
System Action: This information explains what the system does next User Response: This information describes whether a response is necessary, what the appropriate response is, and how the response affects the system or program
Return and reason codes for client exception processing

These are the IMS Tools Online System Interface exception processing return and reason codes. RC 12 Reason Codes 01 02 The specified client function is not an IMS supported command verb. The specified client function is not supported by IMS Tools Online System Interface. Reason code 02 also provides the actual parsing error in the Variable Response Data Return Code. See the FOI210I message for a description of this code.
FOI001E TOOLS ONLINE INTERFACE INIT FAILURE - REASON=rsn 215 220 240 241 242 250 PROCLIB read error XCF group name invalid Load failed for XCF message exit initialization module FOIMSGIX Initialize XCF message exit failed Load failed for action message module FOIACTMX IXCJOIN failure
Explanation: A failure occurred initializing the IMS Tools Online System Interface environment. The rsn value states the failure reason. Two modules issue the FOI001E message. Failures detected by DFSPPUE0 display reasons codes 1xx and failures detected by FOIITK0X display reason codes 2xx. Reason codes 100 101 105 106 107 110 112 200 201 202 203 204 205 210 IMS SSCT not found IMS Release unknown Error loading FOIITK0X Unable to locate DISP WA Unable to allocate QSAV Unable to create ITASK Error posting ITASK GETMAIN failed for FOIMCB IMS Release not supported GETMAIN failed for volatile work area Load failed for IMS Tools Online System Interface abend intercept routine FOIAIR0X IMS Tools Online System Interface ESTAE request failed GETMAIN failed for 24 BIT dynamic storage LOAD failed for dependent functional action module FOIDAM0X
System action: The IMS Tools Online System Interface environment is not initialized and control is returned to IMS. If the failure was detected by module DFSPPUE0, IMS issues abend U740. If the failure was detected by FOIITK0X, IMS completes its initialization processing without IMS Tools Online System Interface. User response: Using the provided reason code, correct the stated failure and restart IMS, which initiates IMS Tools Online System Interface processing. FOI005W DUPLICATE KEYWORD ENCOUNTERED, MEMBER=m, KW=k
Explanation: The IMS Tools Online System Interface PROCLIB member m contained a duplicate keyword k. The first occurrence of the keyword is accepted and subsequent occurrences are ignored. System action: Processing continues with the accepted keyword parameter. User response: If the accepted keyword parameter is valid, no action is required. Otherwise, correct the PROCLIB member and restart IMS.
79
FOI006E FOI110I
FOI006E KEYWORD DATA INVALID, MEMBER=m, KW=k condition, TERM=ABEND and has left the XCF group g. System action: If IMS Tools Online System Interface has shutdown, the IMS Tools Online System Interface environment is no longer active. If IMS Tools Online System Interface has abnormally terminated, the IMS Tools Online System Interface environment terminates. The IMS Tools Online System Interface environment automatically re-initializes if the PROCLIB member keyword RESTART=YES is specified. User response: None, the IMS Tools Online System Interface environment leaves the XCF group and terminates processing. FOI102I PSW=psw CODE=code MODID=id EPA=epa DATA AT a=data Rxx-yy
Explanation: The IMS Tools Online System Interface PROCLIB member m contained a keyword k which specified invalid data. System action: Processing continues, the invalid keyword data is ignored. User response: Correct the invalid keyword data in the PROCLIB member and restart IMS. FOI007W PARAMETER NOT RECOGNIZED, MEMBER=m, STRING=s
Explanation: The IMS Tools Online System Interface PROCLIB member m contained a parameter string s, which is not recognized. System action: Processing continues, the unrecognized parameter string is ignored. User response: Correct the unrecognized parameter string in the PROCLIB member and restart IMS. FOI090W XCF LEAVE FAILED, XCF GROUP=g, RC=rc, RSN=rsn
Explanation: During IMS Tools Online System Interface shutdown processing, the IXCLEAVE call to XCF to leave the XCF Group g failed. The IXCLEAVE return code rc and reason code rsn identify the failure. System action: Processing continues, the IMS Tools Online System Interface environment did not leave the XCF group. User response: Client programs might hang if they are waiting for IMS Tools Online System Interface response notification. Client programs should provide for timeout processing. FOI100I TOOLS ONLINE INTERFACE ENABLED, XCF GROUP=g
Explanation: The IMS Tools Online System Interface environment has encountered an abnormal termination condition. The IMS Tools Online System Interface PROCLIB member keyword DUMP=NO was specified to suppress dump processing. IMS Tools Online System Interface ESTAE processing sends diagnostic information to the system console. The diagnostic information includes the following: v The abending PSW and the system or user completion code. v The abending module ID (and entry point if possible). v The failing instruction string. v The abending general registers. System action: IMS Tools Online System Interface continues with abnormal termination processing. User response: None, the IMS Tools Online System Interface environment leaves the XCF group and terminates processing. FOI105E XCF SEND FAILURE, RC=rc, RSN=rsn
Explanation: The IMS Tools Online System Interface environment has successfully initialized and has joined the XCF group g. System action: Processing continues, the IMS Tools Online System Interface environment is ready to receive client requests. User response: None. FOI101I FOI101I TOOLS ONLINE INTERFACE DISABLED, XCF GROUP=g, TERM=SHUTDOWN | ABEND
Explanation: An IMS Tools Online System Interface action module attempted to send a response message to a target client via XCF services. The send request was failed by XCF with return and reason codes defined by RC and RSN respectively. System action: None. User response: None. FOI110I ACTION INITIATED
Explanation: The IMS Tools Online System Interface environment has shutdown because of the specification, TERM=SHUTDOWN or IMS Tools Online System Interface encountered an abnormal termination
Explanation: All IMS Tools Online System Interface commands cause this message to be displayed with the command text attached at the end for up to 90 bytes. This message indicates that the command action has been initiated.
80
User's Guide
FOI200I FOI210I
System action: None. User response: None. FOI200I INITIALIZATION COMPLETE FOI204E SRB SERVICES INITIALIZATION FAILED, RC=retcode
Explanation: An attempt to IMODULE LOAD the XCF SRB Message Exit or XCF FRR routine has failed. System action: The IMS Tools Online System Interface ITASK abends. User response: Make sure all required modules are in IMS or IMS Tools Online System Interface program libraries and sufficient region size is specified with the IMS Control region startup procedure. FOI210I PARSING FAILED FOR COMMAND ccccccc, RC=rc, RSN=rsn
Explanation: Initialization for IMS Tools Online System Interface has successfully completed. All IMS release dependent and independent modules have been loaded and Cell Pools (CPOOLs) have been created and initialized. XCF SRB Message Exit services have also been set up to be scheduled. System action: IMS Tools Online System Interface initialization continues. User response: None. FOI201E INITIALIZATION FAILED
Explanation: One or more errors were encountered when parsing the action command ccccccc that was issued by the client. Message FOI210I is issued in conjunction with message FOI110I. System action: The failing command is rejected and a message is sent back to the client. User response: Take the appropriate action based on the return (rc) and reason code (rsn) you received. Correct the erroneous command and resubmit the transaction from the client. RC=00 Parsing has completed successfully. RC=04 Warnings RSN=514 The AREA keyword is not supported. RC=08 ERRORS RSN=501 The command verb was not found in CVB. RSN=502 Invalid command verb. RSN=503 The GET CPOOL attempt failed. RSN=510 The required 'DB' keyword was not found. RSN=511 The 'DB' keyword has no parameters. RSN=512 More than one 'DB' or 'AREA' keyword was specified. RSN=513 Too many parameters were specified for 'DB' or 'AREA' keyword. RSN=515 LOCAL and GLOBAL parameters are mutually exclusive. RSN=516 Duplicate keywords were found. RSN=517 An invalid keyword was found. RSN=518 Generic DBnames are not supported.
Explanation: One of the following failures occurred: v Loading or initialization of IMS release dependent routines failed. v Loading or initialization of IMS release independent routines failed. v Cell Pool creation and initialization failed. v XCF Message Exit services failed. System action: The IMS Tools Online System Interface ITASK abends. User response: Review the IMS Control Region job log for other messages associated with the abend. Ensure that all required modules are in the //STEPLIB concatenation. Contact IBM Software Support if necessary and provide them with the dump and messages. FOI203E IMODULE LOAD FAILED FOR module, RC=retcode
Explanation: An error has occurred processing an IMS IMODULE LOAD service call. The module could not be loaded. The return code retcode is the return code from the IMS IMODULE LOAD service call. System action: The IMS Tools Online System Interface ITASK terminates with a user abend. User response: Check the IMS IMODULE LOAD return codes as described in appendix about MIS system service codes in IMS Messages and Codes Vol. 1. Make sure all required modules are in the IMS or IMS Tools Online System Interface program libraries and sufficient region size is specified with the IMS Control region startup procedure.
81
FOI212I FOI512E
RSN=519 The 'ALL' keyword is not allowed or it is mixed with other database names. RSN=520 An invalid access parameter was detected. RSN=521 GLOBAL and ACCESS parameters are mutually exclusive. RSN=522 Either the INTTIME or INTNUM parameter is not numeric. RSN=523 The INTTIME parameter is not 1 =< t =< 3600. RSN=524 The INTNUM parameter is not 1 =< n =< 60. RC=12 INVALID FUNCTION CODE FOI212I ERROR IN cccccccc COMMAND PROCESSOR, RC=rc, RSN=rs. The specified ALL keyword is invalid. 13 More than 6240 database or area names were found in the input. 14 The buffer is full before the end of your input. CATASTROPHIC ERROR 12 Reason Codes 01 CPOOL was not obtained. XCF SEND ERROR Reason Codes See the IXCMSGO documentation for error return and reason codes contained in the request AWE. System action: The failing command is rejected and a message is sent back to the client. User response: Take the appropriate action based on the return and reason code you received. Correct the error and resubmit the transaction from the client. FOI510I CLIENT API VERSION v.r.m INITIALIZATION COMPLETE
12
48
Explanation: An error was encountered when processing action command ccccccc (DBRTEST or BMPLIST). Message FOI210I is issued in conjunction with message FOI110I. Message FOI212I is not displayed for RC=04. Return Codes 00 Successful completion 04 Warning completion (no message is issued) 01 One or more DB names or area names are in error. 30 DBRTEST failed - the DB or area is used by BMP. 31 DBRTEST failed - the DB or area is used by DBCTL or CICS. 32 DBRTEST failed - the DB or area is used by WFI. 33 OLR is active for this database or area. 34 ORS recovery is active. 08 Critical error Reason Codes 01 An invalid DB resource was encountered. 02 An invalid function code was encountered. 05 The database or area is invalid. 06 The database or area was not initialized. 08 Area not found. 09 Found full-function DB for AREA keyword.
Explanation: The IMS Tools Online System Interface client environment has successfully initialized. System action: Processing continues, the client is ready to process API function requests. User response: None. FOI511E CLIENT API INITIALIZATION FAILED
Explanation: A failure occurred initializing the IMS Tools Online System Interface client environment. Message FOI512E or FOI513E will follow indicating the reason for failure. System action: The IMS Tools Online System Interface client environment is not initialized and control is returned to the caller. User response: Based on the accompanying error message, take appropriate action. FOI512E INVALID FUNCTION CODE FOR MODULE FOICINI0, FUNC=xxxx
Explanation: The IMS Tools Online System Interface client initialization module has received an invalid function code. System action: The function code is rejected and initialization processing ends. User response: Ensure that all of the required modules are in the //STEPLIB concatenation. Correct the error and resubmit the initialization process.
82
User's Guide
FOI513E FOI530I
If the problem persists, contact IBM Software Support and provide them with documentation. FOI513E LOAD FAILED FOR MMMMMMMM, COMP=SCCC-RS FOI523E UNABLE TO OBTAIN WORKAREA FROM CELL POOL, RC=XX
Explanation: The IMS Tools Online System Interface client connect function was unsuccessful in obtaining a work area for IXCJOIN processing. System action: Processing ends. The client is unable to send and receive messages to the Tools Online System Interface. User response: Ensure that all of the required modules are in the //STEPLIB concatenation. Correct the error, and resubmit the function request. If the problem persists, contact IBM Software Support and provide them with documentation. FOI524W CONNECT FAILED. RC=rc, RSN=rsn
Explanation: The IMS Tools Online System Interface client initialization module has received an invalid function code. System action: The initialization process ends. User response: See the Load macro information in the z/OS V1R4.0 MVS Authorized Assembler Services Reference Vol 3 (LLACOPY-SDUMPX) for SCC-RS. Correct the error, and resubmit the initialization process. FOI520I TOOLS ONLINE INTERFACE CLIENT API ENABLED, XCF GROUP=gggggggg
Explanation: The IMS Tools Online System Interface client has successfully connected to the XCF group gggggggg. System action: Processing continues. The client is ready to send and receive messages to the Tools Online System Interface. User response: None. FOI521I TOOLS ONLINE INTERFACE CLIENT API DISABLED, XCF GROUP=gggggggg
Explanation: The IMS Tools Online System Interface client connect function was unsuccessful. v Return Codes: 12 = Critical Error 16 = Catastrophic Error v Reason Codes: 201 The TOSI client application could not query the specified group name. User response: Ensure that the group name is correct and/or the XCF group is active. 202 The TOSI client application could not join the specified group name. User response: The RC/RSN for IXCJOIN is returned to the TOSI client applications response buffer. Contact IBM software support if necessary and provide them with documentation. 203 - Cell Pool Error. User response: Ensure that all of the required modules are in the //STEPLIB concatenation. Contact IBM software support if necessary and provide them with documentation. The IXGJOIN return and reason codes in this message are described in the z/OS V1R9.0 MVS Authorized Assembler Services Reference (EDT-IXG). Review the RC/RSN for proper action, correct the problem if possible, and try the operation again. Contact IBM software support if necessary and provide them with documentation. System action: Processing ends. Control is returned to the caller. User response: Correct the error, and resubmit the function request. FOI530I REQUEST COMPLETED SUCCESSFULLY
Explanation: The IMS Tools Online System Interface client failed to connect to the XCF group gggggggg. System action: Processing ends. The client is unable to send and receive messages to the Tools Online System Interface. User response: Refer to message FOI522I for proper action. FOI522I TOOLS ONLINE INTERFACE CLIENT API JOIN FAILED FOR GROUP=gggggggg with RC=rc, RSNC=rsnc
Explanation: The IMS Tools Online System Interface client failed to connect to the XCF group gggggggg. System action: Processing ends. The client is unable to send and receive messages to the Tools Online System Interface. User response: See the IXCJOIN macro in the z/OS V1R9.0 MVS Authorized Assembler Services Reference (EDT-IXG) for RC and Reason Code (RSNC). Correct the error, and resubmit the initialization process.
Explanation: The IMS Tools Online System Interface client was successful in sending a message to every
83
FOI531W FOI541W
IMS Tools Online System Interface element in the server list. System action: Processing continues. User response: None. FOI531W REQUEST COMPLETED RC=rc, RSN=rsn Contact IBM Software Support if necessary and provide them with documentation. 300 The TOSI client application encountered an error with the TOSI server list. User response: Try the operation again. Contact IBM Software Support if necessary and provide them with documentation. FOI540I RESPONSE COMPLETED SUCCESSFULLY
Explanation: The IMS Tools Online System Interface client was successful in sending a message to IMS Tools Online System Interface element in the server list, but one more returned a warning condition. System action: Processing continues. User response: Review the RC/RSN for proper action. v Return Code: 4 = Warning v Reason Codes: 100 The TOSI client application received a non-zero return code while sending a XCF message to the TOSI server elements in the server list User response: Retry the operation with ONERROR = CONTINUE. Contact IBM support if necessary and provide them with documentation. 101 The TOSI client application received a non-zero return code while sending a XCF message to at least one of the TOSI server elements in the server list but ONERROR = CONTINUE allowed the operation to continue processing. User response: The RC/RSN for IXCMSGO is returned to the TOSI client applications response buffer for the subject TOSI server element. Contact IBM support if necessary and provide them with documentation. FOI532E REQUEST FAILED RC=rc, RSN=rsn
Explanation: The IMS Tools Online System Interface client was successful in receiving a message from every IMS Tools Online System Interface element in the server list. System action: Processing continues. User response: None. FOI541I RESPONSE TIMEOUT VALUE NOT NUMERIC. TIMER=HHMMSSth KEYWORD IGNORED
Explanation: The IMS Tools Online System Interface client received an invalid TIMER value. System action: Processing continues with no TIMER value. User response: For RESPONSE TIMEOUT processing, ensure that the TIMER= format is the same decimal format as DINTVL of the STIMER macro. FOI541W RESPONSE COMPLETED RC=rc, RSN=rsn
Explanation: The TOSI client application was successful in the receive processing of a message from the TOSI server elements in the server list, but one more returned a warning condition. System action: Processing continues. User response: Review the RC/RSN and correct the problem if possible. Contact IBM Software Support if necessary and provide them with documentation. v Return Code: 4 = Warning v Reason Codes: 100 The TOSI client application processed the RESPONSE request successfully; however, there were no messages to process. User response: If a response message is expected, then try the operation again with the TIMER parameter. Contact IBM Software Support if necessary and provide them with documentation. 101 The TOSI client application processed the RESPONSE request successfully; however, there were no messages to process in the time that was specified. User response: If a response message is expected, then ensure that the TOSI server component is
Explanation: The IMS Tools Online System Interface client was not successful in sending a message to IMS Tools Online System Interface elements in the server list. System action: Processing continues. User response: Review the RC/RSN for proper action and correct the error if it is possible. If not, contact IBM Software Support if necessary and provide them with documentation. v Return Code: 8 = Critical Error v Reason Codes: 200 The TOSI client application received an error with the XCF environment while sending a XCF message to the TOSI server elements in the server list. User response: Try the operation again after allowing some time for the condition to clear.
84
User's Guide
FOI542E FOI560I
active and then try the operation again. Contact IBM Software Support if necessary and provide them with documentation. 102 The TOSI client application processed the RESPONSE request successfully; however, there were no messages to process in the current cycle. User response: If a response message is expected, then try the operation again. Contact IBM Software Support if necessary and provide them with documentation. FOI542E RESPONSE FAILED. RC=rc, RSN=rsn FOI550I RETURN RESPONSE BUFFER COMPLETED SUCCESSFULLY
Explanation: The IMS Tools Online System Interface client was successful in returning all cell pool storage for processing. System action: Processing continues. User response: None. FOI551W RETURNBUF COMPLETED. RC=rc, RSN=rsn
Explanation: The IMS Tools Online System Interface client was not successful in sending a message to IMS Tools Online System Interface elements in the server list. System action: Processing continues. User response: Review the RC/RSN for proper action and correct the error if possible or contact IBM Software Support if necessary and provide them with documentation. v Return Code: 8 = Critical v Reason Codes: 200 The TOSI client application was unable to establish timer services. User response: Try the operation again. Contact IBM Software Support if necessary and provide them with documentation. 201 The TOSI client application encountered an error when setting timer services with the specified interval. User response: Try the operation again. Contact IBM Software Support if necessary and provide them with documentation. 202 The TOSI client application encountered an error when setting timer services with the remaining time interval. User response: Try the operation again. Contact IBM Software Support if necessary and provide them with documentation. 203 The TOSI client application encountered an error with the timer interval returned from timer services. User response: Try the operation again. Contact IBM Software Support if necessary and provide them with documentation. 204 The TOSI client application encountered an error during termination of timer services. User response: For recursive messages with this reason code, contact IBM Software Support if necessary and provide them with documentation. 300 The TOSI client application encountered an error with the TOSI server list. User response: Try the operation again. Contact IBM Software Support if necessary and provide them with documentation.
Explanation: The IMS Tools Online System Interface client encountered a warning in returning cell pool storage. System action: Processing continues. User response: Review the RC/RSN for proper action and correct the error if possible, otherwise contact IBM Software Support and provide them with documentation. v Return Code: 4 = Warning v Reason Codes: 100 The TOSI client application could not process the RETURNBUF request because an address for the buffer was not provided. User response: Try the operation again with a valid address. FOI552E RETURNBUF FAILED. RC=rc, RSN=rsn
Explanation: The IMS Tools Online System Interface client encoutered an error in returning cell pool storage. System action: Processing continues. User response: Review the RC/RSN for the proper action and correct the error if possible, otherwise contact IBM Software Support and provide them with documentation. v Return Code: 8 = Critical v Reason Codes: 300 The TOSI client application encountered an internal error while processing the RETURNBUF function. User response: Try the operation again or contact IBM Software Support if necessary and provide them with documentation. FOI560I QUERYGROUP COMPLETED SUCCESSFULLY
Explanation: The IMS Tools Online System Interface client was successful in querying every IMS Tools Online System Interface in the XCF group and generating a server list. System action: Processing continues.
85
FOI561W FOI572E
User response: None. FOI561W QUERYGROUP COMPLETED RC=rc, RSN=rsn User response: Try the operation again and contact IBM Software Support if necessary and provide them with documentation. 301 The TOSI client application encountered an internal error while obtaining storage for the server list. User response: Try the operation again and contact IBM Software Support if necessary and provide them with documentation. FOI570I DISCONNECT COMPLETED SUCCESSFULLY
Explanation: The IMS Tools Online System Interface client was successful in querying the XCF group. System action: Processing continues, but a server list might not have been generated. User response: Review the RC/RSN for the proper action and correct the error if possible, otherwise contact IBM Software Support and provide them with documentation. v Return Code: 4 = Warning v Reason Codes: 100 The TOSI client application processed the QUERYGROUP request but the group did not return any members. User response: Try the operation again. 101 The TOSI client application processed the QUERYGROUP request but the server list is truncated. User response: Try the operation again. 102 The TOSI client application could not process the QUERYGROUP because there was an active server list detected. User response: Free the active server list by issuing a RETURNBUF BUFFER=ALL command and then try the operation again. 103 The TOSI client application could not process the QUERYGROUP because the group name was not provided. User response: Try the operation again with a group name. FOI562E QUERYGROUP FAILED RC=rc, RSN=rsn
Explanation: The IMS Tools Online System Interface client has successfully disconnected from the XCF group. System action: Processing continues. User response: None. FOI571W DISCONNECT COMPLETED RC =rc, RSN=rsn
Explanation: The IMS Tools Online System Interface client disconnected from the XCF group with a warning condition. System action: Processing continues. User response: Review the RC/RSN and correct the error if possible, otherwise contact IBM software support and provide them with documentation. v Return Code: 4 = Warning v Reason Codes: 701 The TOSI client application processed the DISCONNECT request but detected an active server list. FOI572E CLIENT API XCF LEAVE FAILED, XCF GROUP=gggggggg RC =rc, RSN=rsn
Explanation: The IMS Tools Online System Interface client was not successful in querying the XCF group. System action: Processing continues, but a server list is not generated. User response: The Return and Reason Codes in this message are described in the z/OS V1R9.0 MVS Authorized Assembler Services Reference (EDT-IXG). Review the RC/RSN for proper action, correct the problem if possible, and try the operation again. Contact IBM Software Support if necessary and provide them with documentation. v Return Code: 8 = Critical v Reason Codes: 300 The TOSI client application encountered an internal error while obtaining storage for the IXCQUERY request.
Explanation: The IMS Tools Online System Interface client could not disconnected from the XCF group. System action: Processing continues. User response: Review the RC/RSN, correct the error if possible, and contact IBM Software Support if necessary and provide them with documentation. v Return Code: 16 = Critical v Reason Codes: 703 The TOSI client application encountered an internal error while obtaining storage for the DISCONNECT request. User response: Try the operation again. Contact IBM Software Support if necessary and provide them with documentation.
86
User's Guide
FOI580I FOI999E
FOI580I TOOLS ONLINE INTERFACE CLIENT API DISABLED, XCF GROUP=gggggggg FOI997E SDUMP FAILED FOR ABEND abend, RC=retcode, RSN=rsncode
Explanation: The IMS Tools Online System Interface client has successfully been disabled and control is returned to the caller. System action: Processing continues. User response: None. FOI581W DELETING modxname FAILED, RC=rc
Explanation: The IMS Tools Online System Interface XCF SRB Message Exit error recovery attempted to issue an SDUMP macro or service to capture diagnostic information for the ABEND abend in the message. The SDUMP macro or service returned a nonzero return code retcode. rsncode is the SDUMP reason code.
Explanation: The IMS Tools Online System Interface client termination module could not delete the module. System action: Termination processing continues. User response: None. FOI582W UNABLE TO OBTAIN DYNAMIC STORAGE, RC=rc
System action: The XCF SRB Message Exit is terminated. The SDUMP failure has no impact on the IMS Tools Online System Interface ITASK. User response: Additional information about SDUMP return codes and reason codes can be found in the z/OS z/OS V1R4.0 MVS Authorized Assembler Services Reference Vol 3 (LLACOPY-SDUMPX). If the problem persists, contact IBM Software Support. FOI998I DAE SUPPRESSED DUMP FOR ABEND abend
Explanation: The IMS Tools Online System Interface client was not successful in obtaining storage for termination processing. System action: Processing to disable the client environment was ended. User response: See the section about STORAGEObtain and Release Storage in the z/OS MVS Programming Authorized Assembler Services Reference Vol 4 (SETFRR-WTOR). Correct the error, and resubmit the initialization process. FOI583W UNABLE TO RELEASE STORAGE, RC=rc
Explanation: The IMS Tools Online System Interface XCF SRB Message Exit error recovery attempted to issue an SDUMP macro or service to capture diagnostic information for the ABEND abend in the message. The SDUMP was suppressed by MVS dump analysis and elimination (DAE). IMS Tools Online System Interface SRB recovery routines gather symptom string data related to an abend and provide this data to MVS when an SDUMP is requested. If DAE is enabled, MVS suppresses duplicate (symptom strings identical to previously captured) dumps. DAE is controlled through the MVS ADYSETxx PARMLIB member and the MVS SET DAE command. For details on specifying DAE options, see MVS Initialization and Tuning Reference. System action: The SDUMP is skipped. The generated dump is suppressed if its symptom strings match a previous dump, and if the current DAE setting in ADYSETxx is set to either SUPPRESS or SUPPRESSALL. User response: None. FOI999E IMS XCF MESSAGE EXIT RTNE ABEND abend
Explanation: The IMS Tools Online System Interface client was not successful in releasing storage obtained for termination processing. System action: Termination processing continues. User response: None. FOI996I SHUTDOWN AWE ENQUEUE FAILED
Explanation: When the IMS Tools Online System Interface FRR (Function Recovery Routine) for the XCF message exit gets control from MVS, it tries to enqueue an AWE (asynchronous work element) to IMS Tools Online System Interface for shutdown processing. FOI996I is issued if the enqueue fails. System action: Processing continues. User response: Client programs might hang if they are waiting for IMS Tools Online System Interface response notification. Client programs should provide for timeout processing. Notify the client program administrator that you received this error message.
Explanation: IMS Tools Online System Interface XCF Message Exit error recovery detected an ABEND abend in component IMS Tools Online System Interface and subcomponent XCF Message Exit RTNE. System action: The XCF SRB Message Exit error recovery attempts to generate a system dump to capture diagnostic data.
87
0200 4005
User response: Retain the generated system dump and contact IBM Software Support.
IMS Tools Online System Interface abend codes

This reference section provides detailed information about IMS Tools Online System Interface abend codes. For each abend code, the following information is provided where applicable: Explanation: The Explanation section explains what the abend code means, why it occurred, and what its variable entry fields are (if any) System Action: The System Action section explains what the system will do next User Response: The User Response section describes whether a response is necessary, what the appropriate response is, and how the response will effect the system or program During IMS QCF processing, you might encounter abend codes that are issued by IMS or DFS. For these abend codes, see the following IMS manuals: v Message and Codes, Volume 1, GC26-9433. v Messages and Codes, Volume 2, GC27-1120.
0200 Explanation: A nonrecoverable and possible installation error occurred in the IMS Tools Online System Interface XCF Message Exit routine. The abend reason codes further describe the reasons for the error: X'10' X'30' X'40' X'50' Unable to obtain a Short-Stack Block (SSBL) from the CPOOL. Unable to obtain the requested message area from the CPOOL. An XCF IXCMSGI macro or service returned a nonzero return code. The DFSAW FUNC=ENQ failed when an attempt was made to enqueue the AWE with the input message buffer received from the client to the Tools Online System Interface Q-HDR. Reason Code=10 System action: IMS Tools Online System Interface abnormally ends IMS command processing. User response: Determine the cause for the Cell Pool Manager initialization failure. 4005 Explanation: The IMODULE LOAD of IMS dependent or independent routines failed during IMS Tools Online System Interface initialization. This user abend is preceded by messages FOI201E, FOI203E, or FOI204E. The subcodes describe the nature of the failure: X'133' X'151' An error occurred loading IMS dependent or independent routines. The LOAD and initialization of SRB routines failed.
400
Explanation: Internal Error indicating the requested cell pool (CPOOL) size is not available. System action: IMS Tools Online System Interface abnormally ends IMS command processing. User response: Update the Cell Pool Manager accordingly to support the requested pool size. 400 Reason Code=20
Explanation: Internal error indicating the Cell Pool Manager is not initialized.
88
User's Guide
Chapter 7. IMS Online Reorganization Facility messages and codes

This topic lists the messages and abends that might be issued during the execution of IMS Online Reorganization Facility.
Return codes and abend codes

The following table shows the possible return codes and abend codes for IMS Online Reorganization Facility processing, their associated reason codes, and their meanings.
Table 2. Return codes and abend codes of the IMS Online Reorganization Facility process Return code or abend code Return code 0 Return code 4 Reason code None None Meaning IMS Online Reorganization Facility processing completed successfully. v Data sets were found for a DBD change with ONLINECHANGE(Y) specified, and with no IMSACBA or IMSACBB specified. The database was left in the PROHIBIT.AUTH state. v A job reached TAKEOVER phase successfully and you specified TAKEOVER(DELAY). Restart information was saved in the RESTART data set. The database is left offline and in the PROHIBIT.AUTH state. Return code 20 Abend code U999 None None A critical error occurred. Processing terminated with a U999 abend. IMS Online Reorganization Facility processing did not complete successfully. Processing terminated. See MSGPRINT for more information.
Messages
The following messages are issued by IMS Online Reorganization Facility.
HRF01000I text User response: None. HRF01002I Utility driver started | ended | terminated with error.
Explanation: The text of this message provides information about the error. System action: None. User response: None. HRF01001I Control cards used in this run
Explanation: This message indicates the start or termination of a batch run. Previous messages indicate a possible error reason. System action: None. User response: None. HRF01003I Highest return code is nnnn
Explanation: Displays the control statements that you supplied. System action: None.
89
HRF01004E HRF01014I
Explanation: The highest return code of the utilities and functions is nnnn. System action: None. User response: None. HRF01004E Error return code is nnnn, reason code rrrr HRF01009E Invalid syntax for keyword key in line nnn.
Explanation: The keyword requires syntax rules. Syntax rules are: numeric, ddname, dsname, or simply yes, or no. Message HRF01014I is issued to show the reason for the error. System action: Processing terminates. User response: Correct the control statement and resubmit the job. HRF01010E Duplicate keyword key in line nnn.
Explanation: A utility function ended with an error. The return code is indicated by nnnn, and the reason code is indicated by rrrr. System action: The utility has been terminated. User response: Evaluate the preceding error messages to determine the cause of the problem and resolve the error condition. HRF01005E Expected continuation not received.
Explanation: The keyword key is being used more than once in the same command. System action: Processing terminates. User response: Remove the duplicate keyword and resubmit the job. HRF01011E No command found in line nnn.
Explanation: The control statements are in error. A continuation was indicated, but no additional control statement was found. System action: Processing terminates. User response: Correct the control statement error and resubmit the job. HRF01006E No commands found.
Explanation: A command must start within the first 20 bytes of a control statement. No command was found. System action: Processing terminates. User response: Correct the control statement and resubmit the job. HRF01012E Command cmd requires keyword key.
Explanation: The HRFSYSIN file was specified, but no control statements were specified. System action: Processing terminates. User response: Provide the necessary control statements. HRF01007E Invalid command cmd found in line nnn.
Explanation: The indicated keyword key is required for this command cmd. System action: Processing terminates. User response: Add the keyword and resubmit the job. HRF01013E Keyword key and key are mutually exclusive.
Explanation: The command cmd is invalid. The control statement line is indicated by nnn. System action: Processing terminates. User response: Correct the control statement and resubmit the job. HRF01008E Invalid keyword key found in line nnn.
Explanation: Mutually exclusive keywords have been specified. System action: Processing terminates.
Explanation: The keyword key is not valid for the specified command. System action: Processing terminates. User response: Correct the control statement and resubmit the job.
User response: Correct the control statement and resubmit the job. HRF01014I Reason is rsn
Explanation: This message explains control statement errors. The variable rsn provides information about the control statement errors. System action: None. User response: None.
90
User's Guide
HRF01015E HRF01025E
HRF01015E Keyword key requires keyword key v The index DBD has more than one target DBD. IMS HALDB Toolkit does not support multiple target DBDs. v The target DBD is an IMS HALDB Toolkit DBD, but the index DBD is not. v The index DBD is an IMS HALDB Toolkit DBD, but the target DBD is not. System action: Processing stops. HRF01016I Command ccccc started/ended/ terminated User response: Correct the invalid DBDs, and restart the process. HRF01021E IMS or DBDLIB DD-statement missing
Explanation: Both of the specified keywords are required and must be specified. System action: Processing terminates. User response: Add the missing keyword and resubmit the job.
Explanation: Command ccccc has either started or ended. System action: None. User response: None. HRF01017E Nothing to schedule
Explanation: The JCL is missing one or both of these statements. System action: Processing stops. User response: Add the IMS DD statement that describes the appropriate DBDLIBs. HRF01022E RESLIB not in STEPLIB concatenation
Explanation: After all control cards have been checked, no command was scheduled to be processed. System action: Processing stops. User response: Keep the output listing, and contact IBM Software Support. HRF01018E No control cards specified.
Explanation: The IMS RESLIB (IMSxxx.SDFSRESL) is not available to this job step. System action: Processing stops. User response: Add the IMS RESLIB to the STEPLIB, for example, IMS710.SDFSRESL. HRF01023I RESLIB is on lower than 7.1 version
Explanation: The file HRFSYSIN is empty. System action: Processing terminates. User response: Provide control statements. HRF01019I IMS batch driver started/ended
Explanation: To support additional functionality, the IMS batch driver component is used to run IMS applications in a shell. System action: None. User response: None. HRF01020E DBD nnnnn is in error, reason: rrr
Explanation: The IMS RESLIB is on a version that is earlier than 7.1. Any function that needs IMS HALDB Toolkit cannot be processed. Additional messages are issued. System action: None. This message is informational only. However, functions that require IMS HALDB Toolkit will return an error code. User response: Use a RESLIB that exists on IMS version 7.1 or higher. HRF01024E DBD is not a PSINDEX DBD
Explanation: The DBD decoder found errors for DBD nnnnn. These errors are typically caused by one or more of the following conditions: v The DBD version is IMS/360. v The DBD type is not supported. v DBD nnnnn is not a valid DBD. v The DBD name is different from the member name. The member name in the DBD library and the name inside the DBD are different. The name inside the DBD is the valid name. v DOS does not support this DBD. v The index DBD has no primary DBD.
Explanation: A HALDB function was requested, but the selected DBD is not a PSINDEX DBD. System action: The function (step) ends. User response: Select a PSINDEX DBD, which is a secondary index DBD that has been converted to HALDB. HRF01025E DBD nnnnn not found
Explanation: DBD nnnnn was requested, but is not in the DBD library. System action: The job step ends. User response: Ensure that the correct DBD library is
91
HRF01026E HRF01036E
being used. The IMS DD statement is pointing to those files. HRF01026E KEYLEN + KEYOFF exceeds root key length of nnn User response: If no request to DBRC is required, this message might be appropriate. However, if subsequent errors are displayed, the reason might be an error in DBRC connection. HRF01032E HALDB master DBD nnnnn is not in the RECON
Explanation: The PSEXIT command is used to show the results of the partition selection exit IHCPSEL0. System action: The job step ends. User response: Correct the KEYLEN specification, the KEYOFF specification, or both, and restart the process. HRF01027E DBD xxxxx is already HALDB
Explanation: The master DBD definition of a HALDB is kept in the RECON. A HALDB DBD named nnnnn was requested. The RECON does not have a record for this DBD. System action: Processing stops.
Explanation: The PSEXIT command is used with full function databases to test the functionality and distribution of a partition selection exit. The specified DBD is already HALDB. System action: The job step ends. User response: None.
User response: Correct the DBD name if this is the error. Otherwise, you might be using the wrong RECON. Ensure that the correct DBD name is being requested. If the correct DBD name is being requested, the RECON that was specified might be incorrect. HRF01033E DBD nnnnn is not HALDB
HRF01028E
No keys specified
Explanation: The DBD nnnnn is not a HALDB DBD. System action: Processing stops. User response: Ensure the correct DBDLIB is being used. If the DBDLIB is correct, you must convert the specified DBD to HALDB. HRF01034E Partition nnnnn is not in master DBD ddddd
Explanation: The partition selection exit, IHCPSEL0, requires that key strings be specified. No keys were found. System action: The job step ends. User response: Provide keys in the //KEYS DD statement. HRF01029E Error during initialization of nnnnn
Explanation: The partition selection exit, nnnnn, returned an error during its initialization phase. System action: The job step ends. User response: If the exit is IHCPSEL0, the reason is located in the messages job log. Otherwise, check with the author of the identified exit to determine the reason for the error. HRF01030E DBRC not operational
Explanation: Partition nnnnn was requested. However, nnnnn is not defined within its master DBD ddddd. System action: Processing stops. User response: Ensure the partition and the DBD names are correct. If the partition and the DBD names are correct, then the RECON that was specified might be incorrect. HRF01035I Partition pppp authorized nnnn
Explanation: DBRC was requested, but DBRC initialization failed. System action: Processing stops. User response: Keep the output listing and contact IBM Software Support. HRF01031I DBRC subsystem nnnnn signon/signoff successful/failed
Explanation: Partition pppp has been authorized with DBRC. nnnn is the authorization scope. It can be read, read exclusive, update, or exclusive. System action: The specified partition is authorized with DBRC. User response: None. HRF01036E Partition pppp not authorized, reason is nn
Explanation: This message is displayed at the start or the end of the DBRC connection. nnnnn indicates the specified subsystem name. System action: None.
Explanation: Partition pppp could not be authorized with DBRC. The reason code cc can be found in message DFS047I. System action: Processing stops.
92
User's Guide
HRF01037I HRF01046E
User response: Make the database available by issuing the appropriate IMS commands. HRF01037I Partition pppp authorization released HRF01041I Data set dsname in use
Explanation: Dynamic allocation returned an error when allocating the data set. The data set is allocated in an exclusive state by a different job. System action: The process terminates. User response: Wait until the other job releases the data set and resubmit your job. HRF01042E Subtask task id has terminated abnormally.
Explanation: Partition pppp is no longer authorized for the current function. System action: None. User response: None. HRF01038E Error during START of ISPF, reason code is xx
Explanation: The ISPF application failed during startup. The code can be 20 to 24. System action: The application terminated. User response: Apply the appropriate action based on the reason code: v Reason code 20 indicates that a previous error occurred. Save the trace screen, and contact IBM Software Support. v Reason code 21 is accompanied by a trace screen. Save the trace screen, and contact IBM Software Support. v Reason codes 22 to 24 indicate that an internal error occurred. Contact IBM Software Support. HRF01039E orphaned split data is nnn
Explanation: The functions of IMS Online Reorganization Facility run as subtasks. Some of them might be in parallel. The subtask did not complete normally. System action: The process is terminated. The final abend code will be U999. User response: Collect the job output, including the dump, and contact IBM Software Support. HRF01043E Abend code is code
Explanation: This message follows HRF01042E to display the abend code. System action: The process terminates. User response: Collect the job output, including the dump, and contact IBM Software Support. HRF01044E Unexpected end of service task task
Explanation: When IMS Online Reorganization Facility scanned the primary database to build a shadow copy of the primary index, it detected that there were data portions of split root segments that did not have the corresponding segment portions. System action: The IMS Online Reorganization Facility job continues. User response: The number of orphaned split data segments should be small. If you receive this message and the number that is displayed as nnn is 10 or more, it indicates that the primary database might have a problem. Check the primary database. HRF01040I Data set dsname not found
Explanation: The service task task terminated unexpectedly. System action: The process terminates. User response: Collect the job output, including the dump, and contact IBM Software Support. HRF01045I Return code is nnnn
Explanation: The command ended with return code nnnn. System action: None. User response: None. HRF01046E Data set nnnn is migrated
Explanation: Dynamic allocation returned an error when allocating the data set named dsname. The data set was not found. System action: If the data set is essential the process terminates with error. User response: The data set name comes from the MDALIB or from the RECON. Correct the data set name in those places and resubmit the job.
Explanation: The data set named nnnnn could not be accessed. System action: Processing stops. User response: Recall the prior data set and rerun it.
93
HRF01047E HRF01057E
HRF01047E Partition selection module nnnnn not found HRF01052E Error from Sort
Explanation: The PSEXIT command could not find the specified partition selection exit. System action: Processing stops. User response: Provide the library that contains the exit in the STEPLIB. HRF01048I Partition selection size set to 2048 MB
Explanation: Standard sort is used. The sort returned with an error. System action: Processing terminates. User response: Collect the sort job output, including the dump, and contact IBM Software Support. HRF01053E VSAM func error DD=ddname, RC=rc, RPL feedback=fdbk.
Explanation: A HALDB conversion or maintenance was requested that specifyed a fixed number of target partitions. However, the size of the partitions would exceed 4 GB. System action: The selection of a fixed number of partitions is ignored. Processing continues with the partition size set to 2 GB. This setting increases the number of partitions beyond the requested number. User response: None. The conversion or maintenance is valid. The conversion or maintenance does not need to be restarted with a different parameter. HRF01049E Pointer error detected. Index must be rebuilt.
Explanation: The indicated VSAM function experienced an error. System action: Processing terminates. User response: Collect the VSAM job output, including the dump, and contact IBM Software Support. HRF01054E Key table xxxxx not in project KSDS
Explanation: This is an internal error. System action: Processing stops. User response: Keep the output listing, and contact IBM Software Support. HRF01055E Errors in control cards.
Explanation: The index pointer healer detected that an index EPS pointer requires healing. The corresponding ILE (the record in the target partition ILDS) was not found. System action: The index pointer healer stops. User response: Rebuild the invalid index or ILDS. If the index is invalid, rebuild it by using either recovery or a PSINDEX rebuild tool. If the ILDS is invalid, rebuild it by using the ILDS tool. HRF01050E DD statement ddname not found in JCL
Explanation: This message is preceded by other messages that identify errors in control statements. System action: Processing terminates. User response: Correct control statement errors and resubmit the job. HRF01056E Project KSDS is invalid
Explanation: The DD statement named ddname is required. It is not present in the JCL. System action: Processing terminates. User response: Provide the specified DD statement and resubmit the job. HRF01051E HD unload file is from HALDB database
Explanation: The project KSDS has been provided through the IHCPROJ DD statement. This data set does not contain the required project information. System action: Processing stops. User response: Keep the output listing, and contact IBM Software Support. This JCL has been created by a conversion or maintenance project. HRF01057E Data set dsname ignored
Explanation: The PSEXIT command is using an unload file that is already from a HALDB database. System action: Processing stops. User response: Provide an unload file from a full function database.
Explanation: The IDCAMS rebuild process is attempting to retrieve the data set attributes from existing data sets. The specified data set name dsname could not be found. System action: No IDCAMS statements are created for the target file. User response: Manually allocate the file that is to be copied.
94
User's Guide
HRF01058I HRF01071E
HRF01058I No pointer to heal in file ddname HRF01065I Application program pgm started/ended
Explanation: The pointer healer function was requested, but the file does not have a pointer to heal. System action: None. User response: None. HRF01059I File ddname has nnn1 pointer. nnn2 needed healing.
Explanation: The application program pgm is participating in the PROCOPT=L support function. The message shows the start and the end of the program. System action: None. User response: None. HRF01066I PSB is psb
Explanation: The pointer healer function was requested. The index file ddname has nn1 pointer. However, only nn2 pointer needed healing. System action: None. User response: None.
Explanation: The message shows the PSB that was used by this application. System action: None. User response: None. HRF01067I Application program return code is nnnn
HRF01060I
Total records in index xxxxx are nnnn
Explanation: The message displays the number of records in index xxxxx. System action: None. User response: None.
Explanation: The application ended with the specified return code. System action: None. User response: None. HRF01068I IMS version is vers
HRF01061I
Initial load for DBD dbd
Explanation: The specified DBD is loading the database by using a PROCOPT=L PSB. System action: None. User response: None.
Explanation: The message shows the IMS version that is currently being used. System action: None. User response: None. HRF01069I DDname ddn is not part of the DBD dbd
HRF01062I
Loading index DBD dbd
Explanation: While the primary database is loaded (see 01061I), the secondary index dbd is also loaded. System action: None. User response: None. HRF01063I Loading index file ddname
Explanation: The DD name ddn was found in the MDA member, but does not belong to the given DBD. System action: None required; however, consider checking the DBD to ensure that all other members belong there. User response: None. HRF01070E DBD dbd is OSAM, but file allocated is VSAM
Explanation: The PSINDEX file ddname is loaded as part of loading the secondary index. System action: None. User response: None. HRF01064I Number of records in file ddname is nnn
Explanation: During data set verification, a mismatch was found between the DBD type and the file type. System action: Processing stops. User response: Verify that both the MDA library and the DBD library are correct. HRF01071E DBD dbd is VSAM, but file allocated as OSAM
Explanation: The PSINDEX file ddname has been loaded. The number of records in this file is nnn. System action: None. User response: None.
Explanation: During data set verification, a mismatch was found between the DBD type and the file type. System action: Processing stops.
95
HRF01072E HRF01084I
User response: Verify that both the MDA library and the DBD library are correct. HRF01072E File ddn is OSAM/KSDS/ESDS but should be OSAM/KSDS/ESDS again. The initial boundary selection might be incorrect. HRF01078I High key: kkkkkkkkkkkkkkkkkk
Explanation: The DD name ddn has an invalid file type. System action: Processing stops. User response: Assign the correct data set to the file that is indicated by ddn. HRF01073I IMS region controller started or ended
Explanation: This message is related to 01075E. It shows the highest key that this DBD is allowed to accept. System action: Processing stops. User response: Begin the boundary selection process again. The initial boundary selection might be incorrect. HRF01079I HSSR region controller started or ended.
Explanation: This message is issued to indicate the start or the end of an IMS Batch region. System action: None. User response: None.
Explanation: This message is issued during the unload phase. HSSR is used to assist the unload function. System action: None. User response: None. HRF01080I Start of ddname listing.
HRF01074I
Sorting index file ddn
Explanation: This is part of the initial load support function. The PSINDEX file ddn is now being sorted and created. System action: None. User response: None. HRF01075E Database record key out of range
Explanation: The specified file is being listed. The possible DDNAMEs are DFSVSAMP and DFSHALDB. System action: None. User response: None. HRF01081I End of ddname listing
Explanation: This message indicates that the listing of the specified file has ended. System action: None. User response: None. HRF01082I Unloading DBD dbd
Explanation: The current function unloads a DBD that is participating in a user-partitioning conversion, during which multiple identical DBDs are converted to one HALDB. The high-level qualifier key of each DBD has been specified. The unload function of this DBD now detects that a key is not within its boundaries. System action: Processing stops. User response: Begin the boundary selection process again. The initial boundary selection might be incorrect. HRF01076I Key: kkkkkkkkkkkkkkkkkk
Explanation: The database dbd is currently being unloaded. System action: None. User response: None. HRF01083I Loading DBD dbd
Explanation: This message is related to 01075E. It shows the key in process. System action: Processing stops. User response: Begin the boundary selection process again. The initial boundary selection might be incorrect. HRF01077I Low key: kkkkkkkkkkkkkkkkkk
Explanation: The database dbd is currently being loaded. System action: None. User response: None. HRF01084I nnnn database records read [FINAL]
Explanation: This message is related to 01075E. It shows the lowest key that this DBD is allowed to accept. System action: Processing stops. User response: Begin the boundary selection process
Explanation: This is a progress message that is issued every 250,000 database records (root segments). FINAL is appended to the message when it is issued for the last set of records. System action: None.
96
User's Guide
HRF01085E HRF01096E
User response: None. HRF01085E Error in partition part part, data set ddn HRF01091E MDA dbdname DDname ddname not found
Explanation: This message is accompanied by 01086E or 01087E. System action: Processing stops. User response: Keep the output listing, and contact IBM Software Support. HRF01086E Expected partition part, found part
Explanation: The MDA member dbdname does not have the specified DD defined. System action: The process terminates. User response: Correct the specified MDA member, and resubmit the job. HRF01092I DBDGEN complete for DBD dbdname
Explanation: The partitioning scheme is in the wrong order. System action: Processing stops. User response: Keep the output listing, and contact IBM Software Support. HRF01087E Status code cc received
Explanation: The specified DBD has been compiled and linked. System action: None. User response: None. HRF01093E DDname dbdname not found
Explanation: The specified DD statement was not found in the JCL. System action: The process terminates. User response: Add the specified DD statement, and resubmit the job. HRF01094E DBD dbdname has external logical relationship.
Explanation: The status code cc was received as a response from an IMS call. System action: Processing stops. User response: If the status code indicates that a database is unavailable, make the database available and rerun the job. In all other cases, keep the output listing, and contact IBM Software Support. HRF01088E Utility terminates with error
Explanation: An error condition has occurred. Previous messages have been issued to explain the error. System action: Processing stops. User response: Proceed as instructed in previous messages that were issued to explain the error. HRF01089I Analyzing DBD dbdname
Explanation: The specified DBD has a logical relationship to a different DBD. This type of relationship is not supported by IMS Online Reorganization Facility therefore, the specified DBD cannot be reorganized with IMS Online Reorganization Facility. System action: Processing terminates. User response: None. HRF01095E DBD dbdname has HALDB OLR active.
Explanation: The specified DBD is analyzed. System action: None. User response: None. HRF01090E Last partition is already empty
Explanation: IMS OLR is currently reorganizing this partition. IMS Online Reorganization Facility cannot run with OLR active. This situation can also occur when OLR is paused. The indication is that both the A-J and M-V data sets are active. System action: Processing terminates.
Explanation: The last partition does not contain any data. The request to add an empty partition at the end is not necessary. System action: The request to add an additional empty partition is ignored. The requested process is not performed. User response: None. Because the last partition is already empty, you do not need to run the process again.
User response: Reorganize a different partition or wait until OLR completes to resubmit your job. HRF01096E DBD dbdname is HALDB with logical relationship
Explanation: The specified DBD is a HALDB and also has a logical relationship. IMS Online Reorganization Facility can process a HALDB with a logical relationship only if all partitions are processed in the IMS Online Reorganization Facility job.
97
HRF01097E HRF01107E
System action: Processing terminates. User response: To process all partitions in one IMS Online Reorganization Facility job, specify the PARTITION(*) keyword and resubmit the job. HRF01097E DBD dbdname is not registered. User response: This message is accompanied by another message that indicates the cause of the error. If you cannot resolve the problem, contact IBM Software Support. HRF01103E DBD dbdname does not have DBDS ddname in DBRC
Explanation: The specified DBD is not in DBRC. IMS Online Reorganization Facility requires that the DBDs must be registered. This requirement also applies to the index DBDs. System action: Processing terminates. User response: Register this DBD and all its index DBDs and resubmit the job. HRF01098E DBD dbdname has conflicting DBRC definitions.
Explanation: The specified DBD does not have the DBDS record defined in DBRC. The DBD definition in DBRC is incomplete. System action: The process terminates. User response: Add the specified DBDS to the RECON. Use the INIT.DBDS function of the DBRC utility. HRF01104E Dynamic allocation failed, DSN dsname
Explanation: The specified DBD does not match its DBRC definition. System action: Processing terminates. User response: Compare your DBD to a LIST.RECON of that DBD. Correct the errors and resubmit the job. HRF01099E DBD dbdname has dbrc status.
Explanation: The data set that is indicated by dsname is probably a database data set. The data set name was obtained from the RECON. Additional messages explain the reason for the allocation failure. System action: Processing terminates. User response: Correct the reason for the allocation failure and resubmit the job. HRF01105E DSN dsname is too long.
Explanation: The specified DBD has a DBRC status that does not allow the processing of this DBD. System action: Processing terminates. User response: Correct the DBRC exception and resubmit the job. HRF01100I process started in sub address space
Explanation: The length of the specified database data set name exceeds the maximum allowable length. Database data set names are appended with ".S", which means that database data set names can be a maximum of 42 characters. System action: Processing terminates. User response: The data set names must be shortened. If they cannot be shortened, the specified DBD cannot be processed by IMS Online Reorganization Facility. HRF01106I Allocating the shadow files.
Explanation: The specified process started in a dependent address space. System action: None. User response: None. HRF01101I process ended in sub address space, return code code
Explanation: The shadow files are being defined and allocated. This message precedes the IDCAMS list from the allocation. System action: None. User response: None. HRF01107E Online subsystem imsid not available.
Explanation: The specified process ended in a dependent address space. System action: None. User response: None. HRF01102E Sub address space terminated abnormally
Explanation: The dependent address space did not end normally. System action: The primary address space terminates. The messages will be displayed in the message file.
Explanation: The RECON subsystem records show this subsystem as an online IMS subsystem. However, IMS Online Reorganization Facility is not active in this subsystem. System action: Processing terminates. User response: Add the IMS Online Reorganization Facility load library to the online system STEPLIB.
98
User's Guide
HRF01108I HRF01119I
Verify that IMS Online Reorganization Facility has been properly set up. HRF01108I AOI interface connected to imsid. User response: Collect the output and contact IBM Software Support. HRF01114I Secondary index build started or ended.
Explanation: The IMS Online Reorganization Facility job established operator command capability with the IMS subsystem that is named in the message. System action: None. User response: None.
Explanation: This message indicates that a secondary index build process has either started or has ended. System action: None. User response: None. HRF01115I DDname ddname found in JCL. It is deallocated.
HRF01109I
No online subsystem active.
Explanation: No online IMS subsystem was active at this time. System action: The process continues. User response: None. HRF01110E HIDAM root segment has compressed key.
Explanation: The specified DD statement is allocated internally. System action: None. User response: Remove the DD statement from the JCL and resubmit the job. HRF01116I Shared index written with index DBD dbdname.
Explanation: The root segment of a HIDAM or PHIDAM database is compressed. The compression is not only DATA, but also KEY. IMS Online Reorganization Facility does not allow compressed root keys for HIDAM databases. System action: Processing terminates. User response: The database must not have key compression. Remove the key compression by using the offline utilities and perform a DBD change between unload and reload. HRF01111E Software for product not available.
Explanation: The shared secondary index will be assigned to the first DBD. System action: None. User response: None. HRF01117I Pre Reorganization Utility started or ended
Explanation: This message indicates that the prereorganization utility has either started or has ended. System action: None. User response: None. HRF01118I Prefix Resolution started or ended.
Explanation: The named product is required for IMS Online Reorganization Facility to do the reorganization. System action: Processing terminates. User response: Add the program library for the specified product to the STEPLIB. Make sure that the library is APF authorized. HRF01112I Reloading DD ddname DSN dsname
Explanation: This message indicates that the prefix resolution has either started or has ended. System action: None. User response: None. HRF01119I Prefix Update started or ended.
Explanation: The target data sets that are identified in this message will be used to load the database. System action: None. User response: None. HRF01113E OPEN failed for DDname ddname.
Explanation: This message indicates that the prefix update has either started or has ended. System action: None. User response: None.
Explanation: The OPEN operation failed for the DD name indicated by ddname. System action: Processing terminates.
99
HRF01120E HRF01130E
HRF01120E Primary DBD dbdname is NONRECOV. User response: Provide a unique DD statement for each image copy and resubmit the job. HRF01126E Inconsistent shared index dbdname DBD. Reason rsn.
Explanation: The primary DBD is defined as NONRECOV in DBRC. This is not permitted. System action: Processing terminates. User response: Change the DBD to RECOV in DBRC and resubmit the job. HRF01121E DBD dbdname is not supported for this function.
Explanation: Shared secondary indexes are being used. They must point to the same primary DBD in order to be supported by IMS Online Reorganization Facility. Additionally, all shared secondary indexes must have the same DBDS in DBRC. System action: Processing terminates. User response: IMS Online Reorganization Facility does not support shared secondary indexes that point to different primary DBDs. HRF01127E No IC1 found for ddname.
Explanation: The specified DBD has an unsupported DBD type. HSAM, DEDB, or Index DBDs are not supported. System action: Processing terminates. User response: The specified DBD cannot be reorganized with this tool HRF01122I IC ddname specified but ignored. DBD is NONRECOV.
Explanation: The ICDDN keyword for the database DD ddname does not have a primary image copy specified. System action: Processing terminates. User response: You cannot specify a secondary IC without a primary IC. Change the ICDDN keyword and resubmit the job. HRF01128E IC ddname DSN for icddn too long.
Explanation: The specified database DDNAME was specified to be image copied. However, the DBD is defined as NONRECOV. Therefore, an image copy is unnecessary. System action: None. User response: If you need an image copy, run the offline utility. HRF01123E IC ddname is not a valid DDname.
Explanation: Dynamic allocation for image copy data sets is being used. The generated ddname is too long. System action: Processing terminates. User response: Create a shorter IC data set name and resubmit the job. HRF01129E IC DDname ddname is for database.
Explanation: The ICDDN keyword specifies a database DD statement. Neither the Primary DBD nor its index DBDs contain this DD. System action: Processing terminates. User response: Correct the ICDDN keyword and resubmit the job. HRF01124E IC ddname DDname icddn specified, but not in JCL.
Explanation: The ICDDN keyword specified a database as target for image copy. System action: Processing terminates. User response: Provide a unique file for the image copy and resubmit the job. HRF01130E DSname for ddname is the same as for ddname
Explanation: The ICDDN keyword specifies an image copy DD icddn for the database DD ddname. The icddn was not found in the JCL. System action: Processing terminates. User response: Provide a DD statement for the image copy and resubmit the job. HRF01125E Duplicate DDname ddname in ICDDN keyword.
Explanation: The image copy data sets that are identified by the ICDDN keyword have different DD statements, but have the same data set name. System action: Processing terminates. User response: Provide different data sets for the image copies and resubmit the job.
Explanation: The ICDDN keyword is used to describe the image copies. The specified DDNAME is used more than once. System action: Processing terminates.
100
User's Guide
HRF01131E HRF01141I
HRF01131E dsname for icddn is the same as for database ddname. HRF01137E DBD dbdname compare error. Reason is: rsn
Explanation: The data set name that was used for an image copy is a database data set name. System action: Processing terminates. User response: Provide a different data set name for the image copy and resubmit the job. HRF01132E GDG gdgbase not defined.
Explanation: The NEWDBD keyword was specified in the control statement. The old and new DBD are compared. The new DBD contains changes that are not supported. The reason text is provides an explanation. System action: Processing terminates. User response: The changes that can be made to the DBD are restricted when IMS Online Reorganization Facility is used. Use offline utilities for this reorganization. HRF01138E Primary DBD dbdname is not in NEWDBD.
Explanation: GDG was specified as a data set name for image copy. However, the GDG base does not exist. System action: Processing terminates. User response: Create the GDG base and resubmit the job. HRF01133E Index DBD dbdname for primary DBD dbdname in error.
Explanation: The NEWDBD keyword was specified in the control statements. However, the library does not have the primary DBD in it. System action: Processing terminates. User response: If you intended to make a DBD change, move your changed DBD to the file that is identified by the NEWDBD keyword. HRF01139E Post reorganization processing failed in phase:
Explanation: The index DBD that is indicated by dbdname for the primary DBD that is indicated by dbdname is in error. System action: Processing terminates. User response: Collect the output, the specified DBD source, and contact IBM Software Support. HRF01134E NEWDBD DD not in JCL.
Explanation: The takeover process failed. System action: Processing terminates. User response: Use the RESTART parameter to restart the takeover process. The database is still in prohibit authorization status. Do not change the prohibit authorization status. The takeover phase must complete. The takeover process will restart where the last operation stopped. HRF01140I Attempting to restart in phase phase
Explanation: The NEWDBD keyword was specified in the control statements. The specified DD statement has not been provided. System action: Processing terminates. User response: Provide the DD statement that specifies the library that contains the changed DBDs and resubmit the job. HRF01135E No DBD specified.
Explanation: No DBD keyword was specified in the control statements. System action: Processing terminates. User response: Provide a DBD and resubmit the job.
Explanation: This informational message is issued at the point that the RESTART function continues the takeover process. System action: None. User response: None. HRF01141I Last phase completed was phase.
HRF01136E
Multiple REORG commands specified
Explanation: More than one REORG command was found in HRFSYSIN. System action: Processing terminates. User response: Run each REORG as separate job step.
Explanation: This message is issued during restart. The last phase completed is indicated by phase. System action: None. User response: None.
101
HRF01142E HRF01153E
HRF01142E Neither data set dsname or dsname was found. HRF01148I DBD dbdname has non-unique segments
Explanation: During the takeover phase, the data sets are to be renamed. In this case, none of the data sets were found. System action: The process terminates. User response: This error typically occurs during a RESTART process. Because a database data set has been deleted, the database must be recovered. HRF01143E Index dbdname not in NEWDBD library
Explanation: The DBD has segment types that do not have a sequence field or that have a non-unique sequence field. System action: None. User response: None. HRF01149E IMSACB DD required with NEWDBD and ONLINECHANGE(Y).
Explanation: A secondary index has been changed, but the new DBD has not been provided. System action: The process terminates. User response: Correct the changed DBD and resubmit the job. HRF01144E New primary DBD has external logical relationships.
Explanation: The new DBD will be propagated to the online system, which requires the staging library ACBLIB. System action: Processing terminates. User response: Add the ACBLIB DD to the JCL and resubmit the job. HRF01150E Invalid attrib for ddname DD
Explanation: The attributes for a KSDS are invalid. System action: The process terminates. User response: Correct the attributes for the shadow data sets and resubmit the job. HRF01151I Temporary RECON created or deleted.
Explanation: The NEWDBD keyword has been specified. The new DBD added external logical relationships which are not supported. System action: Processing terminates. User response: Use offline utilities for this process. HRF01145I NEWDBD library now in effect.
Explanation: This message is issued after unload has completed. System action: None. User response: None.
Explanation: A HALDB partition was specified. A temporary RECON was created to define the partitions and the shadow data set names. This RECON is used for the reorganization process. System action: None. User response: None. HRF01152E NEWDBD specified with HALDB database.
HRF01146I
Prior job jobname at time for DBD dbdname in phase phase
Explanation: This message indicates a pending restart. A previous job ran at the specified time for the specified DBD and stopped at the specified phase. System action: None. User response: None. HRF01147I (param) specified for this execution.
Explanation: IMS Online Reorganization Facility reorganized only one partition. A DBD change is not allowed when processing only one partition. You do not need a DBD change to modify the randomizing parameter for a HALDB partition. System action: Processing terminates. User response: Use an offline utility and reorganize all partitions. HRF01153E ddname DD cannot be a temporary data set.
Explanation: The RESTART function is used. System action: None. User response: None.
Explanation: A temporary data set was specified for the indicated DD. System action: Processing terminates. User response: Specify a permanent data set and resubmit the job.
102
User's Guide
HRF01154E HRF01163E
HRF01154E Unable to load module modname. User response: Shorten the data set name and resubmit the job. HRF01160E Primary DSN dsname and shadow have different attributes
Explanation: The specified module modname was not found. System action: Processing terminates. User response: Make the user exit available in the JCL and resubmit the job. HRF01155I Rebuilding primary index.
Explanation: Preallocated shadow data sets were used. The data set attributes of the shadow data sets must match the original data sets. The specified data set attributes and the attributes of the shadow data sets do not match. System action: The process terminates. User response: Provide the correct attributes. If this data set is an index data set, you probably specified the wrong keylen, key offset, or record length and resubmit the job. HRF01161E HALDB partition name is on M-V data sets
Explanation: A HIDAM or PHIDAM database is being used. The primary index is created in the shadow data set. System action: None. User response: None. HRF01156E Error creating interim LOG
Explanation: IMS Online Reorganization Facility was unable to allocate a data set for use as a batch log during the apply process. The allocation parameters of this interim data set are based on the IEFRDER DD statement in the JCL. System action: The IMS Online Reorganization Facility job terminates. User response: Review the preceding messages to determine why the allocation failed. Resolve the allocation problems and resubmit job. HRF01157E Shadow data set for ddname too small
Explanation: The partition that is identified by name is currently on the M-V data sets. IMS Online Reorganization Facility was unable to create a copy of the data sets on the shadow file. System action: IMS Online Reorganization Facility processing terminates. User response: Use an offline reorganization or another IMS Online Reorganization to switch the active data sets, to make them the A-J data sets, and resubmit the job. HRF01162E Invalid subparameter for PTRCHECK keyword
Explanation: The space allocation for the specified predefined shadow data set was insufficient. System action: The process terminates. User response: Increase the size of the specified data set and resubmit the job. HRF01158E Partition keyword required for HALDB
Explanation: The PTRCHECK keyword has a Y or N in the first position and up to four additional parameters. The specified parameters are invalid. System action: The process terminates. User response: Provide valid parameters for the PTRCHECK keyword and resubmit the job. HRF01163E Pointer error detected
Explanation: A HALDB database was specified; however, no partition was specified. You must specify the partition that you want reorganized. System action: The process terminates. User response: Specify a partition with the PARTITION HRFSYSIN DD statement keyword and resubmit the job. HRF01159E Invalid component DSN dsname
Explanation: HP Pointer Checker detected a pointer error during the image copy process of the newly reorganized shadow database data sets. System action: Processing terminates. User response: Collect the job output, including the HP Pointer Checker output, and contact IBM Software Support.
Explanation: The specified dsname is a component name of a VSAM cluster. The dsname is too long to use to create shadow data sets. System action: The process terminates.
103
HRF01164E HRF01174E
HRF01164E Dynamic allocation failed, DD ddname User response: Use a different method to process this DBD. HRF01172I DBD dbdname was excluded, reason is: reason
Explanation: IMS Online Reorganization Facility was unable to dynamically allocate a required DD. Messages that are issued prior to this one explain the reason for the allocation failure. System action: Processing terminates. User response: Correct the reason for the allocation failure and resubmit the IMS Online Reorganization Facility job. HRF01165E Invalid PARTITION specified
Explanation: The current function converts an entire DBDLIB. The specified DBD was excluded from this function due to one or more of the following reasons: v DBD construct error v DBD is not supported v DBD is HALDB v DBD has logical relation v Primary index is missing v Secondary index is missing v Primary database is missing v MDA library member missing v MDA DDname not in member v Data set not catalogued v Index DBD in error System action: The DBD is excluded from the conversion. User response: Make the changes that are indicated by the reason and resubmit the job. Alternately, you can run the conversion as is, and work on those DBDs that failed at a later time. HRF01173I DBD dbdname is an index
Explanation: A name was entered in the PARTITION keyword, but the partition name is not part of the master DBD. System action: Processing terminates. User response: Correct the partition name and resubmit the IMS Online Reorganization Facility job. HRF01166I DBD dbdname has internal logical relationship
Explanation: This is an informational message that informs you that the dbdname that you specified contains at least one internal logical relationship. System action: Processing continues. IMS Online Reorganization Facility performs any prefix resolution and update processing that is required for the process that is being performed. User response: None. HRF01169E More than 255 RAPS
Explanation: The specified DBD is a PSINDEX or a secondary index. The selected function does not allow for an index DBD. System action: The process terminates. User response: Specify a primary DBD. HRF01174E Orphaned split segment found
Explanation: More than 255 reset attached processes (RAPS) have been specified for a partition, which exceeds the limit in IMS. System action: The process terminates. User response: Specify a smaller number of RAPS. HRF01170E Byte limit too large
Explanation: The byte limit exceeded the maximum size, which is 16 MB. System action: The process terminates. User response: Specify a smaller byte limit. HRF01171E DBD dbdname has logical relationship
Explanation: When scanning the primary database in order to build a shadow copy of the primary index, IMS Online Reorganization Facility detected that there was a root that had been split, and the pointer to the data portion was invalid. System action: Processing terminates. User response: When this message is issued it likely indicates that there is a pointer error in the original database data set. Run IMS High Performance Pointer Checker or an equivalent tool against the original database to determine the pointer errors. Resolve the pointer errors and resubmit the IMS Online Reorganization Facility job.
Explanation: The purpose of the current function is to convert an entire DBDLIB. However, this function does not allow for logically related DBDs. System action: The DBD is excluded from this process.
104
User's Guide
HRF01175E HRF01204E
HRF01175E All partitions required for NONRECOV DBD locate other non-VIO unit names. HRF01200E FROMDBD ddname1 TODBD dbdname2 compare failed: reason
Explanation: A nonrecoverable HALDB was specified in the DBD keyword. The command that was specified requires that IMS Online Reorganization Facility change the database to be recoverable during the IMS Online Reorganization Facility processing. IMS Online Reorganization Facility can be run only at the master DBD level for a HALDB, so all partitions must be included in the IMS Online Reorganization Facility processing System action: Processing terminates. User response: Either remove the PARTITION keyword from the command so that all partitions are processed, or manually change the DBD to recoverable and resubmit the IMS Online Reorganization Facility job. HRF01176E Data set found empty
Explanation: The merge process detected one or more errors. Potential reasons include: v DBD names are identical v Segment structure is different v Segment definition is different v DBD type is different v DBD has secondary index v DBD has logical relation v DBD has different partition selection exits v IHCPSEL0 is defined different System action: The process terminates. User response: None. Merging these two HALDBs is not possible. HRF01201E DBD ddname is PSINDEX
Explanation: This message is preceded by message HRF01085, which identifies the primary database DDname and DSname. One record that contains the partition ID and the reorg number should be found. System action: The process terminates. User response: Verify the load process of that partition. Run the partition initialization, and reload for that partition. HRF01177E Shadow data set dsname defined as NOREUSE but data set is not empty
Explanation: The specified DBD is an index DBD. System action: The process terminates. User response: A PSINDEX DBD cannot be specified for merging. HRF01202E PGM name not found
Explanation: The specified program was not found. System action: The process terminates. User response: Correct the program name, and resubmit the job. HRF01203E PSB name not found
Explanation: The specified data set must be empty. System action: The process terminates. User response: Either specify the data set as REUSE, or DELETE and DEFINE it prior to this process. HRF01178E Dynamic allocation limit reached. Specify larger DYNAMNBR.
Explanation: The specified PSB was not found. System action: The process terminates. User response: Correct the PSB name, and resubmit the job. HRF01204E PSB not found or valid
Explanation: The maximum dynamic allocation limit has been reached. System action: The process terminates. User response: Specify the DYNAMNBR parameter on the EXEC statement. A value of DYNAMNBR=999 typically resolves this problem. HRF01179E VIO has been allocated to ddname
Explanation: The specified PCB is not in the PSB or does not have PROCOPT=L. System action: The process terminates. User response: Correct the PSB or PCB parameter, and resubmit the job.
Explanation: The current process does not support VIO data sets. System action: The process terminates. User response: Specify a unit name that is not VIO. Use the IHCXUNIT member in IHCXSAMP file to
105
HRF01301W HRF01505E
HRF01301W Dynamic allocation failed, SVC 99 reason code 'xxxx' Explanation: IMS Online Reorganization Facility was unable to dynamically allocate a data set. You can find information about the SVC 99 reason codes in the z/OS MVS Authorized Assembler Services Guide. System action: If the data set is a required data set, then processing terminates. Otherwise, processing continues. User response: Correct the reason for the allocation failure and resubmit the IMS Online Reorganization Facility job. HRF01500E Online Reorg Facility initialization failed for imsid, RC=xxxx System action: IMS startup continues. User response: None. HRF01501W DEBUG setup failed: reason, RC=xxxx Explanation: IMS Online Reorganization Facility was unable to start up additional debugging options. The reason specified explains why setup failed. System action: Processing continues with DEBUG off. User response: Report the reason and RC to IBM Software Support. HRF01502I Online Reorg Facility DEBUG status
Explanation: This informational message indicates that the DEBUG services have been activated or stopped. System action: None. User response: None. HRF01503I action XCF group groupname as member membername
Explanation: During IMS control region startup, IMS Online Reorganization Facility was not initialized in the IMS subsystem, imsid. System action: IMS startup continues but IMS Online Reorganization Facility will be active for the IMS subsystem, imsid, only when it is restarted. User response: Review the previous error messages and try to correct the problem. If you are unable to correct the problem, contact IBM Software Support. The following table lists the HRF01500E return codes and their meanings. Table 3. Message HRF01500E return codes and their meanings
Return Meaning code 2 3 4 5 Unable to locate SCD. Contact IBM Software Support. Unable to locate IMS Online Reorganization Facility anchor. Logger exit initialization failed. IEANTRT call failed. The error was returned from IEANTRT. BLDL failed for the required module. Unable to load IMS Online Reorganization Facility module into ECSA. Verify that the complete IMS Online Reorganization Facility library is in the STEPLIB. LOAD failed for required module. Verify that the complete IMS Online Reorganization Facility library is in the STEPLIB. Unable to obtain ECSA. Unsupported IMS release. Logger exit initialization failed.
Explanation: This informational message indicates that the job has either joined or left an XCF group. System action: None. User response: Verify that groupname is the same groupname as other address spaces in order to be able to communicate with them. HRF01504E Target IMS system imsid is not active on this host
Explanation: An IMS Online Reorganization Facility maintenance utility was run on an MVS system and the target IMS subsystem, imsid, is not active on that MVS system. System action: The IMS Online Reorganization Facility job terminates. User response: Resubmit the job on the same MVS system where the target IMS subsystem is active. HRF01505E Online Reorg Facility is not active in target IMS system
7 8 9
Explanation: An IMS Online Reorganization Facility maintenance utility was run but IMS Online Reorganization Facility is not active in the target IMS subsystem. System action: The IMS Online Reorganization Facility job terminates. User response: Verify that the target IMS subsystem is correct. IMS Online Reorganization Facility must initially be activated in an IMS subsystem with a restart of the IMS control region. Verify that this was done and that the HRF01500I message was issued to indicate that
HRF01500I
Online Reorg Facility initialization completed for imsid
Explanation: During IMS control region startup, IMS Online Reorganization Facility was initialized successfully in the IMS subsystem, imsid.
106
User's Guide
HRF01506I HRF01513E
the IMS Online Reorganization Facility was initialized successfully. HRF01506I DEBUG status for IMS imsid already state must be added to the STEPLIB of the IMS control region. HRF01510I Online Reorg Facility Vv.r maintenance successfully installed in imsid
Explanation: An IMS Online Reorganization Facility utility was run to set the DEBUG state. The DEBUG state for the IMS subsystem was already in the requested state. System action: None. DEBUG status is left in previous state. User response: Verify the DEBUG status is in the appropriate state. HRF01507I DEBUG action request for IMS imsid completed
Explanation: This informational message indicates that a new maintenance level has successfully been installed into the imsid online IMS subsystem. System action: The new maintenance level is now in effect in the target IMS subsystem. User response: None. HRF01511E Target member membername action reason
Explanation: An IMS Online Reorganization Facility utility was run and has successfully changed the DEBUG state for an IMS subsystem. System action: The requested DEBUG state is now in effect for the target IMS subsystem. User response: None. HRF01508W Unable to install new maintenance: reason Explanation: The IMS Online Reorganization Facility maintenance utility was unable to install new maintenance into an IMS online subsystem. System action: The previous maintenance level is still in effect for the IMS subsystem. User response: Correct the reason that new maintenance was unable to be installed and resubmit the job. HRF01509W IMS using ORF library datasetname, new maintenance being loaded from datasetname Explanation: IMS Online Reorganization Facility maintenance utility is being executed with a different library than the IMS control region was initially started with. System action: New maintenance is installed into the IMS control region from the different library. User response: The next time the IMS subsystem is restarted it will activate IMS Online Reorganization Facility from the library in the control region STEPLIB. If you want the installation of the new maintenance level to be permanently installed into the IMS subsystem, the new maintenance level must either be copied into the STEPLIB data set for the IMS control region, or the library with the new maintenance level
Explanation: An attempt to connect to the IMS Online Reorganization Facility or IMS Tools Online System Interface component in an IMS control region address space failed for the specified reason. System action: The IMS Online Reorganization Facility job terminates. User response: If the IMS subsystem is down, it must either be restarted or the SUBSYS record must be removed from DBRC. If the IMS subsystem is active, verify that either the IMS Online Reorganization Facility or IMS Tools Online System Interface component was successfully initialized in that subsystem and that the component joined the same XCF group. HRF01512I Connected with target member membername
Explanation: This informational message indicates that the job has successfully connected to the corresponding member. System action: Processing continues. User response: None. HRF01513E ORF subtask failed RC=xxxx
Explanation: The IMS Online Reorganization Facility subtask in the IMS control region terminated unexpectedly. System action: IMS Online Reorganization Facility processing in the IMS control region is no longer available. User response: Report the problem to IBM Software Support. The IMS subsystem must be restarted in order to reactivate IMS Online Reorganization Facility in that IMS subsystem.
107
HRF01514I HRF01521W
HRF01514I capturetype capture for DBD(dbdname) action HRF01517E Error encountered during capturetype capture for DBD dbdname: FUNC=function RC=xxxx RSN=xxxx
Explanation: This informational message indicates that capturing log or change records for the DBD has either been started or has just ended. System action: If capture has been activated, the captured records will begin being sent to the remote IMS Online Reorganization Facility utility. If capture has been stopped, no more change records for the DBD will be sent to the IMS Online Reorganization Facility utility. User response: None.
Explanation: The IMS Online Reorganization Facility was unable to capture a change record for a DBD. System action: Record capture is terminated for the DBD. The IMS Online Reorganization Facility job is notified of the records that were being captured. The IMS Online Reorganization Facility job abends. User response: Report the problem to IBM Software Support HRF01518E command call failed: RC=xxxx RSN=xxxx
HRF01515W action from member membername reason Explanation: An unexpected XCF message was received from the corresponding member. System action: If the message is from an IMS Online Reorganization Facility utility, that job terminates. If the message is received in the IMS control region, capturing changes for the remote IMS Online Reorganization Facility utility ends. User response: This is usually a result of an error or sudden termination of the remote IMS Online Reorganization Facility job or IMS control region. Correct the problem with the remote system and resubmit the IMS Online Reorganization Facility job. HRF01516E XCF buffer limit exceeded
Explanation: The IMS Online Reorganization Facility utility encountered an error when issuing the IMS command, command. System action: The IMS Online Reorganization Facility utility abends. User response: Review the return and reason codes that are described in the IMS Application Programming EXEC DLI Commands for CICS and IMS. HRF01519I Number of records captured was xxxx
Explanation: Number of records captured was xxxx. System action: None. User response: None. HRF01520E calltype call ended with statuscode status code
Explanation: The maximum amount of storage for incoming XCF messages has been exceeded; no further incoming XCF messages can be received. System action: The IMS Online Reorganization Facility job terminates. User response: The maximum amount of storage that is used for incoming XCF messages is controlled by the XCFMAX parameter in the HRFSETOP member. This situation is usually the result of the IMS Online Reorganization Facility utilitys inability to process the number of captured change records from the IMS control regions. It might be the result of an extreme amount of online activity and of the IMS Online Reorganization Facility utility running at a priority at which it cannot obtain any CPU cycles to receive pending XCF messages. Resubmit the IMS Online Reorganization Facility job at a higher priority and at a less active time, or set the XCFMAX value slightly higher. This situation might also occur if the IMS Online Reorganization Facility utility does not receive the pending messages when it should. This situation would likely be an outstanding WTOR or CPU loop.
Explanation: When applying captured changes to the reorganized shadow data sets, the IMS Online Reorganization Facility utility encountered an unexpected status code. System action: The IMS Online Reorganization Facility job abends. User response: Report the problem to IBM Software Support. HRF01521W Error from modulename: FUNC=function RC=xxxx RSN=xxxx Explanation: An error was encountered while capturing records in the IMS control region. System action: The IMS Online Reorganization Facility job abends. User response: Report the problem to IBM Software Support.
108
User's Guide
HRF01522E HRF01531I
HRF01522E DBRC request request for DBD dbdname DDN ddname failed, RC=xxxx User response: Either wait for the jobs that are listed to end, or manually end the jobs in order to release control of the DBD. HRF01527W reply is an invalid reply Explanation: An invalid response to the previous WTOR was entered. System action: The previous WTOR is reissued. User response: Enter a valid reply. HRF01528I The reply was reply
Explanation: A DBRC request failed. System action: The IMS Online Reorganization Facility job abends. User response: Review the return and reason code listed in the IMS DBRC Guide and Reference to see if it can be corrected. The IMS Online Reorganization Facility job can be restarted and as part of that restart. The DBRC request is also reattempted. If the error cannot be corrected, report the problem to IBM Software Support. HRF01523E DBRC request request for LOGDSN datasetname failed, RC=xxxx
Explanation: This informational message indicates the operator response for the previous outstanding WTOR. System action: Processing continues according to reply. User response: None. HRF01529W Takeover processing delayed due to TAKEOVER(DELAY) Explanation: TAKEOVER(DELAY) was specified in the control statements. The IMS Online Reorganization Facility job ends without doing takeover processing. System action: Restart information is saved and the IMS Online Reorganization Facility job ends with RC=4. The original database is left in a DB recovery needed state with PROHIBIT AUTH status set in DBRC. User response: Determine the reason for delaying the takeover processing. When takeover processing is required, resubmit the IMS Online Reorganization Facility job with TAKEOVER(YES) specified. HRF01530I datasetname allocated to DD ddname
Explanation: A DBRC request for a log data set failed. System action: The IMS Online Reorganization Facility job abends. User response: Review the return and reason code listed in the IMS DBRC Guide and Reference to see if it can be corrected. The IMS Online Reorganization Facility job can be restarted and the DBRC request will be retried. If the error can not be corrected, report the problem to IBM Software Support. HRF01524I The following jobs currently have DBD dbdname allocated:
Explanation: This message is issued in conjunction with messages HRF01525I and HRF01526I. System action: None. User response: None. HRF01525I Jobname jobname IMSID imsid Reg# regionnumber
Explanation: This message is issued in conjunction with messages HRF01524I and HRF01526I. System action: None. User response: None. HRF01526I The jobs must be stopped before jobname can continue
Explanation: During restart, IMS Online Reorganization Facility allocates certain DD statements to the data sets that were in effect at the time the previous job terminated. If the ddname is in the JCL that is used to restart the job, it will be deallocated first. System action: Processing continues. User response: None. HRF01531I TOIrequest request for DBD dbdname action
Explanation: This message is issued in conjunction with messages HRF01525I and HRF01526I when an IMS Online Reorganization Facility job needs to run the /STOP or /DBRECOVERY command on a DBD and it is unable to do so until the jobs that are listed relinquish control of the DBD. System action: The IMS Online Reorganization Facility job waits for operator reply to either retry the /STOP or /DBRECOVERY command or to terminate processing.
Explanation: This informational message indicates that IMS Tools System Interface requests have been made and have completed to an IMS control region. System action: Processing continues. User response: None.
109
HRF01532I HRF01539I
HRF01532I Restart information save HRF01536I Online Reorg Facility Vv.r maintdate mainttime
Explanation: This informational message is issued before takeover processing to indicate that restart information has been successfully saved in the IMS Online Reorganization Facility restart data set. System action: Takeover processing begins unless TAKEOVER(DELAY) was specified. User response: None. HRF01533W TOIrequest request for DBD dbdname action RC=xxxx RSN=xxxx Explanation: An IMS Tools Online System Interface request to the target IMS subsystem failed. System action: The IMS Online Reorganization Facility job abends. User response: Review the IMS Tools Online System Interface return and reason codes. There might also be additional messages in the IMS control region that describe why the request failed. The most likely cause is the status of a DBD in the IMS control region. If the problem can be corrected, resubmit the IMS Online Reorganization Facility job. If you are unable to correct the problem, contact IBM Software Support. HRF01534E Unknown segment segmentname in change record
Explanation: This informational message indicates the version, release, maintenance date, and maintenance time of IMS Online Reorganization Facility for the job or IMS control region. System action: Processing continues. User response: None. HRF01537E Change capture already active for DBD dbdname on imsid
Explanation: An IMS Online Reorganization Facility job for a DBD was started and there is already an IMS Online Reorganization Facility job for the same DBD active in the IMS subsystem. Only one IMS Online Reorganization Facility job can be executing for a DBD or HALDB partition. System action: The duplicate IMS Online Reorganization Facility job aben User response: Wait for the current IMS Online Reorganization Facility job for the DBD to end before resubmitting a subsequent IMS Online Reorganization Facility job if it is still needed. HRF01538E AOI command request to imsid failed, RC=return code RSN=reason
Explanation: When applying captured change records to the shadow data sets, IMS Online Reorganization Facility encountered a change record that involved a segment that is not in the DBD for which the IMS Online Reorganization Facility job is running. System action: The IMS Online Reorganization Facility job abends. User response: Verify that the DMB used in the online IMS subsystems corresponds to the DBD for which the IMS Online Reorganization Facility job is running. HRF01535E DBRC command request for Partition partitionname failed, RC=xxxx
Explanation: An IMS Online Reorganization Facility request that was issued to the IMS Tools Online System Interface failed. System action: The IMS Online Reorganization Facility job terminates. User response: Review the return codes for IMS Tools Online System Interface. If the return and reason codes indicate a problem that you can fix in the IMS subsystem, correct the problem and resubmit the job. If you cannot fix the problem, contact IBM Software Support. HRF01539I Caught up with applying changes, waiting for TAKEOVER Window
Explanation: A DBRC request failed. System action: The IMS Online Reorganization Facility job abends. User response: Review the return and reason code listed in the IMS DBRC Guide and Reference to determine if it can be corrected. You can restart the IMS Online Reorganization Facility job and the DBRC request will be reattempted. If the error cannot be corrected, report the problem to IBM Software Support
Explanation: IMS Online Reorganization Facility has reached the point in the job where it can begin the takeover process. A TAKEOVER window was specified and the begin takeover time has not been reached. System action: IMS Online Reorganization Facility begins idling until the begin takeover time that was specified is reached. During this idling time, any changes being applied to the original database are still captured and applied to the shadow database. User response: If no action is taken, IMS Online Reorganization Facility begins the takeover process at the specified time. If you want the takeover performed
110
User's Guide
HRF01540I HRF01546W
sooner, you can enter a TAKEOVER command with an MVS modify command. This will cause the takeover process to begin. HRF01540I command command was entered HRF01544I Specify action to take: N - keep idling until next window, T - do TAKEOVER when ready, C - continue until TAKEOVER then ask again, A - abend job
Explanation: An MVS MODIFY or STOP command was entered by an operator for the IMS Online Reorganization Facility job. System action: If the command is valid, IMS Online Reorganization Facility processes the command. User response: None. HRF01541I Current phase is: phase started at hh:mm:ss
Explanation: The specified TAKEOVER window has expired and WTOR was specified as the action to take. System action: The IMS Online Reorganization Facility job continues processing and waits for an operator response. User response: Determine the action that you want to take at this time and enter a response through the operator console. The options are: N Indicates that the IMS Online Reorganization Facility job continues processing and tries to perform takeover during the same window on the following day. Indicates that you want to finish reorganizing the shadow data sets and perform takeover when the job reaches that point. Indicates that you want to finish reorganizing the shadow data sets and then ask the operator what to do when the takeover point is reached. Indicates that you want to abend the job. Ready for Takeover
Explanation: This message indicates the current status of the IMS Online Reorganization Facility job. The message is the result of the MONITOR keyword being specified or a MONITOR request on the MODIFY command by an operator. System action: Processing continues. User response: None HRF01542I nnnnn type records captured, nnnnn type records applied nnn%
Explanation: This message is the second part of monitor information. It indicates the number of log records or change records that were captured by the online systems, and how many and what percentage of those records have been applied to the shadow data sets being reorganized. The message is the result of the MONITOR keyword being specified or a MONITOR request on a MODIFY command by an operator. System action: Processing continues. User response: None. HRF01543W Takeover window has expired Explanation: The end time that was specified by the TAKEOVER.WINDOW parameter has been reached and IMS Online Reorganization Facility is not yet ready to perform takeover processing for the job. System action: IMS Online Reorganization Facility will take the action specified by the endaction operand of the TAKEOVER.WINDOW parameter. User response: If WTOR was specified as the action to take when the takeover window expired, determine the action that you want to take and reply to message HRF01544I accordingly.
HRF01545I
Explanation: The IMS Online Reorganization Facility job is ready for takeover. System action: The IMS Online Reorganization Facility job issues HRF01544I and waits for an operator response. User response: See message HRF01544I. HRF01546W Unable to complete ONLINECHANGE reason Explanation: The Online Reorganization Facility job detected DBD changes. ONLINCHANGE(Y) was in effect, but IMS Online Reorganization Facility was unable to locate any IMSACBA or IMSACBB data sets to copy new ACBs into. System action: The IMS Online Reorganization Facility job continues takeover processing but ends with RC=4. The databases are left in PROHIBIT AUTH state. User response: The new ACBs have been generated into the IMSACB data set. You must manually copy these ACBs into the appropriate IMSACBA and IMSACBB data sets. After copying the ACBs, reset the PROHIBIT AUTH flag in DBRC. In future runs of IMS Online Reorganization Facility, if all online IMS subsystems are down, you can supply the appropriate
111
HRF01547E HRF01556E
IMSACBA and IMSACBB DD statements in the IMS Online Reorganization Facility job to identify the appropriate data sets. HRF01547E Backout failed for DBD dbdname on imsid original database is in inconsistent state returned a return code that requested a source segment to be deleted. For HALDB databases, IMS Online Reorganization Facility does not support deletion of index source segments. System action: The IMS Online Reorganization Facility job terminates abnormally. User response: Either resubmit the job without the USEREXIT, or change the USEREXIT so that it does not delete any index source segments. HRF01551E Another ORF job already running for DBD dbdname [1]
Explanation: When IMS Online Reorganization Facility was replicating changes that were made to the original database in the online IMS subsystems to the shadow database, the online IMS subsystem encountered an error when it attempted to backout some of the changes that were made to the original database. System action: IMS stops the original database and leaves it with some changes that have not been backed out. The IMS Online Reorganization Facility job cannot determine which changes should or should not be applied to the shadow database, so the job terminates. User response: Correct the problem with the original database and resubmit the IMS Online Reorganization Facility job. HRF01548E Change capture terminated with inflight changes
Explanation: IMS Online Reorganization Facility is already running for this DBD. System action: The process terminates. User response: None. HRF01552E Error saving information in restart data set
Explanation: The restart data could not be saved. System action: The process terminates. User response: Contact IBM Software Support. HRF01553E nn status code from nnnn call to HSSR for segment segname
Explanation: IMS Online Reorganization Facility is terminating the apply phase; however, it cannot determine if some of the captured changes should be committed or if they should be backed out. System action: The IMS Online Reorganization Facility job terminates abnormally. User response: This is likely a logic error in IMS Online Reorganization Facility. Contact IBM Software Support. HRF01549E Unexpected return code (return code) from USEREXIT
Explanation: An unexpected status code was received. System action: The process terminates. User response: Contact IBM Software Support. HRF01554E dsname not found in catalog
Explanation: A database data set that should have been in the catalog was not found. System action: The process terminates. User response: Contact IBM Software Support. HRF01555E Information in catalog for dsname is different
Explanation: During the apply phase, IMS Online Reorganization Facility received the return code from the USEREXIT that was specified in the RELOAD.USEREXIT keyword. The return code is an invalid return code from the USEREXIT. System action: The IMS Online Reorganization Facility job terminates abnormally. User response: Correct the problem with the USEREXIT that caused it to return the invalid return code, and resubmit the IMS Online Reorganization Facility job. HRF01550E USEREXIT requested source segment (segment name) in HALDB database be deleted
Explanation: The allocated and cataloged data sets have discrepancies. This message is followed by messages HRF01556E and HRF01557E. System action: The process terminates. User response: Contact IBM Software Support. HRF01556E type in catalog is/are: text
Explanation: See message 01555E. System action: The process terminates. User response: Contact IBM Software Support.
Explanation: During the apply phase, the USEREXIT
112
User's Guide
HRF01557E HRF01567E
HRF01557E type in this job is/are: text HRF01562E Unable to locate RECON data sets
Explanation: See message 01555E. System action: The process terminates. User response: Contact IBM Software Support. HRF01558W DBs are left in prohibit auth state Explanation: The takeover process did not finish completely. The databases are left in a prohibit auth state. System action: The process ended. User response: Run a RESTART to finish the takeover process. HRF01559E DBD dbdname is not in prohibit auth state
Explanation: The RECON data sets were not allocated. System action: The process terminates. User response: Provide RECON data sets by: v Specifying RECONx DDs, or v Specifying IMSDALIB that has the RECON MDAs HRF01563E Captured change records out of sequence
Explanation: A sequence error was detected when the captured change records were applied. System action: The process terminates. User response: Resubmit the job and contact IBM Software Support to inform them about this error. HRF01564W Unable to imscmd DBD dbdname on IMS imsid Explanation: The specified IMS command failed on the indicated IMS system for this DBD. This message is followed by message IHC01565A and a WTOR to ask for an action. System action: Respond to the reply message. User response: Act on the WTOR. HRF01565A text Explanation: This message follows message 01564W and is self-explanatory. System action: None. User response: None. HRF01566E DBD dbdname has been allocated by unknown subsystem since IMS Online Reorganization facility stopped capturing changes
Explanation: The specified DBD should still be in prohibit auth state. However, it is not in that state anymore. The previous IMS Online Reorganization Facility operation did not finish normally. This problem was probably detected during an IMS Online Reorganization Facility restart operation during which the database was activated by an operator command. The database might have been updated in between two IMS Online Reorganization Facility runs. The current status of the database is not known. System action: The process terminates. User response: Collect all output, including output from the previous runs, and check the IMS messages from the CTL and DLISAS region for information that might be related to this database. A timestamp recovery also might be necessary. Contact IBM Software Support. HRF01560E SORT|IDCAMS failed, Return code is retcode
Explanation: The call to the specified utility failed. Additional error messages are issued. System action: The process terminates. User response: Refer to the additional messages for information about how to resolve this error. HRF01561E RESTART data set can only be single volume
Explanation: The database has been allocated since the changes have been applied, but before the takeover process has been started. System action: The function ends abnormally. User response: The original database might have been updated. These updates will be lost if a takeover is performed; therefore, restart the process from the beginning. HRF01567E Not all DBDs defined to imsid
Explanation: The file allocation of the restart data set is invalid. System action: The process terminates. User response: Resubmit the IMS Online Reorganization Facility restart data set definition.
Explanation: The database definition in the online system is inconsistent. The primary DBD or some index DBDs might be missing. System action: The process terminates.
113
HRF01568I
User response: Correct the IMS GEN. HRF01568I DBDs not defined to imsid
Explanation: The requested DBDs are not defined in the specified IMS system. System action: The XCF connection to this IMS system is terminated. User response: None.
114
User's Guide
Chapter 8. Reference
These reference topics are designed to provide you with quick access to information about IMS Online Reorganization Facility sample members. Topics: v Sample library members v Examples for IMS Online Reorganization Facility on page 65
Sample library members

The sample library (SAMPLIB) that is supplied with IMS Online Reorganization Facility contains JCL that you can use as a model to create your own jobs. The IMS Online Reorganization Facility SAMPLIB includes the following samples: HRF This member contains sample JCL to run the reorganization.
HRFBMP This member contains sample JCL to link the DFSRRC00 module as a USERMOD to IMS to ensure that the IMS Online Reorganization Facility detects any BMPs that are running during the reorganization process. | | | | | | | | | | | | | | | | HRFCICS This member contains the JCL to install the CICS and ODBA pause function. Two versions of the JCL are provided: v A test version is provided that installs the modification into the IMS Online Reorganization Facility load library. v A permanent version is provided that creates a USERMOD for you to apply to your IMS system. You can resubmit this job if you removed the USERMOD for IMS maintenance purposes. HRFERA10 This member allows you to select and format the IMS Online Reorganization Facility change records. Use this member for debugging. HRFFOI This member contains a sample to set up the cross-system coupling facility (XCF) connection with IMS Tools Online System Interface. It also contains a sample to set up IMS Tools Online System Interface and IMS Online Reorganization Facility in IMS Tools Generic exits. HRFINST This member contains the JCL for initially installing or customizing tailoring IMS Online Reorganization Facility. You are required to run this member for the initial installation. This JCL creates the Environment Setup Options module (HRFSETOP) and defines the restart data set (KSDS). | | | HRFLKFLG You must use this member to activate DFSFLGX0 in your system. Attention: Do not use this member when generic exits are available.
HRFLKPPU You must use this member to activate DFSPPUE0 in your system.
115
Attention:
Do not use this member when generic exits are available.
HRFRECOV This member contains sample JCL to synchronize image copy timestamps to recover a database data set from image copy by using the standard IMS recovery utility. HRFREST This member contains sample JCL to perform a restart of a delayed or failed IMS Online Reorganization Facility job. The previous job must have been delayed in TAKEOVER (TAKEOVER(DELAY)) or it must have failed during the Takeover phase. HRFSET HRFSET is the macro that is used in HRFINST. HRFSETOP This member contains the JCL for creating alternate IMS Online Reorganization Facility Environment Setup Options modules. You can run this member after the initial installation. This JCL creates alternate Environment Setup Options modules (whose names you define) and defines the corresponding restart data set (KSDS). | | | | | | HRFSMP1 This member contains the JCL to configure the BMP pause function (as in HRFBMP) using SMP/E. HRFSMP2 This member contains the JCL to configure the DBRC function using SMP/E.
116
User's Guide
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 user's 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 give 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: Intellectual Property Licensing Legal and Intellectual Property Law IBM Japan Ltd. 1623-14, Shimotsuruma, Yamato-shi Kanagawa 242-8502 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.
117
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 J46A/G4 555 Bailey Avenue San Jose, CA 95141-1003 U.S.A. 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 information 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. 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. The sample programs are provided "AS IS", without warranty of any kind. IBM shall not be liable for any damages arising out of your use of the sample programs.
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. These and other IBM trademarked terms are marked on their first occurrence in this information with the appropriate symbol ( or ), indicating US 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 complete and current list of IBM trademarks is available on the Web at http://www.ibm.com/legal/copytrade.shtml. Adobe, Acrobat, PostScript and all Adobe-based trademarks are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States, other countries, or both. 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.
118
User's Guide
| |
Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both. Linux is a 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 Unites States, other countries, or both. UNIX is a registered trademark of The Open Group in the United States and other countries. Other company, product, and service names may be trademarks or service marks of others.
Notices
119
120
User's Guide
Index Special characters

/DBR command 5 /DBR FEOV command /START command 5 5 commands (continued) UNLOAD 42 comments methods for providing vii communication interface implementation editing BMP JCL 17, 20 editing BMP JCL, example 20 linking method 17, 20 compatibility, data 3 Completion phase 5 concurrent BMPs 17 configuration considerations 15 prerequisites 14 configuring IMS Online Reorganization Facility base environment 16 communications, IMS Online Reorganization Facility and BMPs 17 default runtime options 29 HRFTOI 22 IMS subsystems and XCF group names 22 Installing the BMP pause feature 20 jobs XCF group names 23 runtime environment 25 runtime options 29 the communication interface 17 verifying XCF connections 23 XCF connections 22 connecting an IMS Online Reorganization Facility job to an online IMS subsystem 72 control regions 16 controlling BMPs during reorganization 17 controlling CICS and ODBA access 21 conventions highlighting v Copy phase 5 DBD (continued) replacement 3 DBDCOPY 51 DBDCOPY keyword 43, 63 DBDLIB 63 DBDLIST keyword 43 DBDS name length 36 DBRC notifications 5 PROHIBIT AUTH 3 DBSTART HRFSETOP option 26 DBSTART keyword 44 DD statements DFSPRINT 36 DFSRESLB 36 DFSUINPT 36 DFSURGU1 36 DFSURWF1 37 HRFSYSIN 37 ICEPRINT 38 IEFRDER 38 imagecopy 38 IMS 39 IMSACB 39, 63 MSGPRINT 39 NEWDBD 40 RECON 40 STEPLIB 40 summary of 36 SYSPRINT 41 SYSUDUMP 41 TRACE 41 DEBUG diagnostic record formatting 69 DEBUG HRFSETOP option 26 DELETE keyword 44 DFSFLGX0 16 DFSPPUE0 16 DFSPRINT DD statement 36 DFSRESLB DD statement 36 DFSRRC00 15 DFSUINPT DD statement 36 DFSURGU1 DD statement 36 DFSURWF1 DD statement 37 diagnostic information 71 gathering 69 diagnostics activation utility (HRFYUTIL) description 32, 71 start JCL sample 72 stop JCL sample 72 disabling CICS and ODBA application communication 21 disallowed DBD changes 13 DMB replacement 3 DMB or ACBLIB replacement 5 DMB replacement 3, 63 documentation accessing 9 documentation changes 10 DUMP 76
A
abend codes IMS Tools Online System Interface 88 ABEND TAKEOVER.WINDOW action 62 ACB replacement 3 ACBGEN 5 ACBLIB 63 ACBLIB or DMB replacement 5 access methods, database 1 accessibility overview 10 actions, TAKEOVER.WINDOW ABEND 62 add checkpoints 19 APF-authorization 16 Apply phase 5 authorization, APF 16 availability of databases 3
B
BMP jobs 18, 19 BMPRETRY HRFSETOP option 26 BMPs controlling during reorganization 17 editing JCL 20 BMPS concurrent and the same database 17 started during reorganization 17 buffer pool analysis overview 1
D C
changes ACBGEN 63 DBD 63 checkpoint intervals 18, 19 CHKP call 18, 19 CHKPNTS DD-statement 18, 19 CICS 115 CICS access, controlling 21 commands /DBR 5 /DBR FEOV 5 /START 5 INSTALL 32, 71 REORG 42 Copyright IBM Corp. 1996, 2011 data database administration and change management solutions 2 data flow 5 database authorization 5 data set name length 36 database administration change management comprehensive solutions 2 comprehensive solutions 2 database types IMS Online Reorganization Facility 1 DATACLAS keyword 42 DBD changes not allowed 13 keyword 42
121
E
editing BMP jobs JCL 20 ENQNAME HRFSETOP option EXEC statement 35 26
F
feedback methods for providing vii FEOV keyword 44 flow of data 5 formatting diagnostic records 69 full-function sample JCL 42 functions overview 1 functions of IMS Online Reorganization Facility 3
G
GDGLIMIT keyword 44 GDGMODEL keyword 45 generic exits 115 group names, XCF 23
H
hardware requirements 14 HD unload data set 1 HDAM VSAM database JCL sample 66 HIDAM OSAM database sample JCL 65 highlighting conventions v HOLDDATA HRFSETOP option 26 how data flows through IMS Online Reorganization Facility 5 HRF 115 HRFBMP 115 HRFBMP9 20 HRFCICS 115 HRFERA10 115 HRFFOI 115 HRFINST 115 HRFLKFLG 115 HRFLKPPU 115 HRFRECOV 115 HRFREST 115 HRFSET 115 HRFSETOP 115 HRFSETOP module options, ENQNAME 26 HRFSMP1 20 HRFSMP9 20 HRFSYSIN 71 HRFSYSIN DD keyword DATACLAS 42 DBD 42 DBDCOPY 43, 63 DBDLIST 43 DBSTART 44 DELETE 44 FEOV 44 GDGLIMIT 44 GDGMODEL 45 IC.COMP 45
HRFSYSIN DD (continued) keyword (continued) IC.COMPRTN 45 IC.VIC 50 IC.VICDSN 50 IC1DSN 46 IC2DSN 47 ICDDN 46 ICDYN 46 ICEIN 47 ICHLQ 48 ICID 48 ICMID 48 ICNUM 49 ICTRLR 49 ICVOLCT 50 IMSID 51 ITKBSERVER 51 LOG1DSN 51 LOG2DSN 52 LOGPRI 53 LOGSEC 53 MGMTCLAS 53 MONITOR 53 NEWDBD 54 ONLINECHANGE 54, 63 OPTID 55 PARTITION 55 PRERES.ALLOWLC 55 PRERES.ALLOWLP 56 PRERES.AVGRLEN 56 PRERES.FILSZ 56 PRERES.OPRTLC 56 PRERES.OPRTLP 57 PRERES.UPDLPC 57 PRERES.XAVGRLEN 57 PRERES.XFILSZ 57 PTRCHECK 58 RELOAD.DBIOBUF 58 RELOAD.DBRLBUF 58 RELOAD.FRSPC 58 RELOAD.HPIO 59 RELOAD.OADSPR 59 RELOAD.RAAFORMAT 59 RELOAD.SEARCH 59 RELOAD.SORT 60 RELOAD.USEREXIT 42 RESTART 60 SHADOW 61 STORCLAS 61 TAKEOVER 61 TAKEOVER.WINDOW 62 required keywords 42 HRFSYSIN DD keywords summary 42 HRFSYSIN DD statement 37 HRFUTIL 32, 71 HRFYUTIL 71 description 32, 71 syntax 32, 71 HRFYUTIL JCL 31 HRFYUTIL- diagnostics activation utility start JCL sample 72 stop JCL sample 72
I
IC.COMP keyword 45 IC.COMPRTN keyword 45 IC.VIC keyword 50 IC.VICDSN keyword 50 IC1DSN keyword 46 IC2DSN keyword 47 ICDDN keyword 46 ICDYN keyword 46 ICEIN keyword 47 ICEPRINT DD statement 38 ICHLQ keyword 48 ICID keyword 48 ICMID keyword 48 ICNUM keyword 49 ICTRLR keyword 49 ICVOLCT keyword 50 IEFRDER DD statement 38 imagecopy DD statement 38 implementing communication interface editing BMP JCL 17, 20 editing BMP JCL, example 20 linking method 17, 20 IMS DD statement 39 IMS Library Integrity Utilities 51, 63 IMS Program Restart Facility 17 IMS Tools Online System Interface 75 abend codes 88 implementation 75 messages 78 overview 75 PROCLIB member keyword parameter syntax 78 PROCLIB member keyword parameters 76 return and reason codes 79 setup PROCLIB member 76 IMSACB DD statement 39, 63 IMSID keyword 51 input length limit 75 INSTALL command 32, 71 INSTALL command keyword ACTION 32, 71 FORCE 32, 71 IMSID 32, 71 MODULE 32, 71 TEST 32, 71 installing IMS Online Reorganization Facility 22 maintenance 31 internal logical relationships 1 INTNUM 76 INTTIME 76 invoking DFSERA10 file select and print utility 69 IMS Online Reorganization Facility in batch mode 66 ITKBSERVER keyword 51
J
JCL example HRFYUTIL 31
122
User's Guide
JCL samples EXEC statement 35 full-function 42 PROC 66 reorganization of a PSINDEX partition 67 start diagnostics activation utility (HRFYUTIL) 72 stop diagnostics activation utility (HRFYUTIL) 72 UNLOAD 42 unload of a HIDAM OSAM database 67 with DBD changes 66 without DBD changes 65 job pause 18, 19 jobs sample 115
keywords (continued) PRERES.XFILSZ 57 PTRCHECK 58 RELOAD.DBIOBUF 58 RELOAD.DBRLBUF 58 RELOAD.FRSPC 58 RELOAD.HPIO 59 RELOAD.OADSPR 59 RELOAD.RAAFORMAT 59 RELOAD.SEARCH 59 RELOAD.SORT 60 RELOAD.USEREXIT 42 required for HRFSYSIN DD 42 RESTART 60 SHADOW 61 STORCLAS 61 TAKEOVER 61 TAKEOVER.WINDOW 62
O
ODBA access, controlling 21 one-step reorganization 3 Online Change 63 ONLINECHANGE 51 ONLINECHANGE keyword 54, 63 OPTID keyword 55 options, environment setup 25 options, HRFSETOP 26 out-of-sync 63 output length limit 75
P
parameters keyword PROCLIB 76 PARTITION keyword 55 Partner Product Exits (DFSPPUE0) 16 pause job 18, 19 phases of IMS Online Reorganization Facility apply 5 completion 5 copy 5 reorganization 5 takeover 5 verification 5 prerequisites configuration 14 PRERES.ALLOWLC keyword 55 PRERES.ALLOWLP keyword 56 PRERES.AVGRLEN keyword 56 PRERES.FILSZ keyword 56 PRERES.OPRTLC keyword 56 PRERES.OPRTLP keyword 57 PRERES.UPDLPC keyword 57 PRERES.XAVGRLEN keyword 57 PRERES.XFILSZ keyword 57 problems diagnostic information about 69 PROC JCL sample 66 PROHIBIT AUTH DBRC 3 status 5 prohibit authorization 63 PSINDEX 1 PTRCHECK keyword 58
K
keywords DATACLAS 42 DBD 42 DBDCOPY 43, 63 DBDLIST 43 DBSTART 44 DELETE 44 FEOV 44 GDGLIMIT 44 GDGMODEL 45 IC.COMP 45 IC.COMPRTN 45 IC.VIC 50 IC.VICDSN 50 IC1DSN 46 IC2DSN 47 ICDDN 46 ICDYN 46 ICEIN 47 ICHLQ 48 ICID 48 ICMID 48 ICNUM 49 ICTRLR 49 ICVOLCT 50 IMSID 51 ITKBSERVER 51 LOG1DSN 51 LOG2DSN 52 LOGPRI 53 LOGSEC 53 MGMTCLAS 53 MONITOR 53 NEWDBD 54 ONLINECHANGE 54, 63 OPTID 55 PARTITION 55 PRERES.ALLOWLC 55 PRERES.ALLOWLP 56 PRERES.AVGRLEN 56 PRERES.FILSZ 56 PRERES.OPRTLC 56 PRERES.OPRTLP 57 PRERES.UPDLPC 57 PRERES.XAVGRLEN 57
L
legal notices notices 117 trademarks 118 length limit, input and output 75 length of DBDS names 36 linking DFSRRC00 17 log recovery 5 LOG1DSN keyword 51 LOG2DSN keyword 52 LOGDATAC HRFSETOP option 26 Logger Exits (DFSFLGX0) 16 LOGHLQ HRFSETOP option 26 logical relationships, internal 1 LOGPRI keyword 53 LOGSEC keyword 53 LOGUNIT HRFSETOP option 26 LookAt vi
M
maintenance installation utility 32, 71 message retrieval tool LookAt v message setup 16 messages methods for accessing v messages and codes IMS Tools Online System Interface 78, 79 MGMTCLAS keyword 53 MONITOR keyword 53 MSGPRINT data set 3 MSGPRINT DD statement 39 MySupport 9
Q
quick reference 15
R
RCDATAC HRFSETOP option 26 RCVOL HRFSETOP option 26 reason codes 79 RECON HRFSETOP option 26 RECON DD statement 40 recovery, log 5 reference abend codes 88 Index
N
NEWDBD DD statement 40 NEWDBD keyword 54 NEXTDAY TAKEOVER.WINDOW action 62 notices 117 notifying DBRC 5
123
reference (continued) messages 78 return and reason codes 79 region types 13 regions, control 16 relationships, internal logical 1 RELOAD.DBIOBUF keyword 58 RELOAD.DBRLBUF keyword 58 RELOAD.FRSPC keyword 58 RELOAD.HPIO keyword 59 RELOAD.OADSPR keyword 59 RELOAD.RAAFORMAT keyword 59 RELOAD.SEARCH keyword 59 RELOAD.SORT keyword 60 RELOAD.USEREXIT keyword 42 REORG command 42 reorganization of a PSINDEX partition JCL sample 67 Reorganization phase 5 replacement ACBLIB or DMB 5 DBD and ACB or DMB 3 replacement DMB 63 replacing a DMB 3 reports reorganization progress 3 statistical 3 required keywords, HRFSYSIN DD 42 requirements hardware and software 14 RESTART 76 data set 64 keyword 60 option 65 restart processing 3 restrictions IMS Online Reorganization Facility 13 return and reason codes 79 RSTRTDSN HRFSETOP option 26
summary of changes 10 support required information 69 support information v swap of databases 5 SYSIN control statement 32, 71 SYSPRINT DD statement 41 SYSUDUMP DD statement 41
V
valid keywords for the UNLOAD command 42 Verification phase 5
W
WTOR TAKEOVER.WINDOW action 62
T
TAKEOVER keyword 61 Takeover phase 5 Takeover restart 3, 64 Takeover Restart utility 5 TAKEOVER.WINDOW keyword 62 actions 62 technotes 9 TOIGROUP 22 TOIGROUP HRFSETOP option 26 Tools Online System Interface 75 abend codes 88 messages 78 overview 75 PROCLIB member keyword parameter syntax 78 PROCLIB member keyword parameters 76 return and reason codes 79 setup PROCLIB member 76 Tools Online System Interface, IMS implementation 75 TRACE DD statement 41 trademarks 118 troubleshooting IMS Online Reorganization Facility connections cause 72 description 72 solution 72 symptoms 72 types of databases supported by IMS Online Reorganization Facility 1
X
XCF XCFGROUP 76 XCF connections 22 XCF group names 22, 23 XCFGROUP 22, 76 XCFGROUP HRFSETOP option 26 XCFMAX HRFSETOP option 26
S
sample library members overview 115 screen readers and magnifiers 10 secondary index 1 secondary indexes 1 service information v setup IMS Online Reorganization Facility 16 messages 16 options, environment 25 shadow data set deletion of 5 primary index 5 SHADOW keyword 61 software requirements 14 software, required 16 statement DD 36 EXEC 35 SYSIN 32, 71 statistic reports 3 STEPLIB DD statement 40 STORCLAS keyword 61
U
ULOGID HRFSETOP option 26 unload 1 UNLOAD command 42 UNLOAD command valid keywords 42 UNLOAD sample JCL 42 unloading a HIDAM OSAM database JCL sample 67 UNLSPAC HRFSETOP option 26 UNLUNIT HRFSETOP option 26 utilities diagnostics activation (HRFYUTIL) 72 maintenance 31 maintenance installation 32, 71 related to IMS Online Reorganization Facility 1 Takeover Restart 5
124
User's Guide
Product Number: 5655-H97
Printed in USA
SC27-1577-06

IMS CHKP

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

IMS CHKP

Uploaded by

Copyright:

Available Formats

IBM IMS Online Reorganization Facility for z/OS

IBM IMS Online Reorganization Facility for z/OS

Chapter 3. Applying maintenance . . . 31

Chapter 1. IMS Online Reorganization Facility overview . . . . . . . . . . . 1

Chapter 2. Configuring IMS Online Reorganization Facility . . . . . . . . 13

Chapter 4. Using IMS Online Reorganization Facility . . . . . . . . 35

Chapter 6. IMS Tools Online System Interface . . . . . . . . . . . . . . 75

Chapter 7. IMS Online Reorganization Facility messages and codes . . . . . 89

Chapter 8. Reference . . . . . . . . 115

Copyright IBM Corp. 1996, 2011

About this information

Service updates and support information

How to look up message explanations

Searching an information center

Using a Web search

How to send your comments

About this information

Chapter 1. IMS Online Reorganization Facility overview

What does IMS Online Reorganization Facility do?

Database administration and change management

IMS Online Reorganization Facility and other IMS Tools

IMS Online Reorganization Facility features and benefits

Chapter 1. IMS Online Reorganization Facility overview

Overview of the online reorganization process

Chapter 1. IMS Online Reorganization Facility overview

Original DBs / DSs

Temp DBs / DSs

Image Copy Process

Figure 1. Data flow of the online reorganization process

The Verification phase

The Copy phase

The Reorganization phase

Chapter 1. IMS Online Reorganization Facility overview

The Apply phase

The Takeover phase

Related concept: v Takeover restart processing on page 64

The Completion phase

IMS Online Reorganization Facility documentation and updates

IMS Online Reorganization Facility information on the Web

Receiving documentation updates automatically

Chapter 1. IMS Online Reorganization Facility overview

Chapter 2. Configuring IMS Online Reorganization Facility

Hardware and software prerequisites

IMS Online Reorganization configuration road map

Chapter 2. Configuring IMS Online Reorganization Facility

Configuring the base environment

8. 9. 10. 11. 12.

Managing BMP pauses

How BMPs are affected during a reorganization

Concurrent BMPs and the same database

BMPs started during reorganization

3. The BMP is automatically restarted and runs to completion:

How large checkpoint intervals are affected by BMP pauses

About this task

Installing the BMP pause feature

About this task

BMP example (with JCL changes):

Managing pauses for CICS and ODBA applications

About this task

Enabling XCF connections

Setting up online IMS subsystems and XCF group names

Setting up IMS Online Reorganization Facility jobs XCF group names