Updates to IMS Database Reorganization Expert V4.1 User's Guide

The most recent update is listed first.

---

Update 6
Date of change: May 2013
Change description: Documentation changes by APAR PM86931. This APAR enhances the Pre-reorganization utility, the Smart Reorg utility, the IPR DB Scan utility, and the Post-reorganization utility to send system notifications to Autonomics Director.
Topics: Changes apply to the following multiple topics.

====================
The content that describes the Pre-reorganization utility and the Post-reorganization utility, which was added by Update 3 of this techdoc (APAR PM68661), has been updated.

IMSDatabaseReorganizationExpert_TechdocMay2013.pdf

Note: Page, figure, table, and cross-reference numbers in this PDF extract might not match your current user guide version. Use this documentation extract for content update purposes only. Change bar markings on the left side of the page indicate the new or changed information. This information will be included in any future refreshes of the entire user guide.

====================
> 1.0 Introduction to IMS Database Reorganization Expert
>> 1.1 IMS Database Reorganization Expert overview
>>> 1.1.6 IMS Database Reorganization Expert terminology

"Autonomics Director" has been added to the following table:

Short name	Product name
...	...
Autonomics Director	IBM Tools Base Autonomics Director for z/OS, Version 1 Release 4 (product number: 5655-V93)
...	...

====================
> 2.0 Installing and configuring IMS Database Reorganization Expert
>> 2.1 Installation overview
>>> 2.1.1 Hardware and software prerequisites

The following prerequisite has been added:

To use the Autonomics Director system notification feature, you must install the following products:

• IBM IMS Database Solution Pack for z/OS, Version 1 Release 2 (product number: 5655-S77) or later
• IBM Tools Base for z/OS, Version 1 Release 4 (product number: 5655-V93) or later

====================
> 3.0 Reorganizing a database
>> 3.5 Smart Reorg JCL statements
>>> 3.5.1 JCL requirements for Smart Reorg
>>>> 3.5.1.2 DD statements
>>>>> 3.5.1.2.1 DD names common to all processing options

Description of the STEPLIB DD has been changed as follows:

STEPLIB DD

Points to the following library data sets:
• IMS tools libraries:
  • ...
  • ...
  • The SHKTLOAD library of Tools Base (optional). This library contains the load modules for IMS Tools KB, Policy Services, and Autonomics Director.
Tip: You can specify the library in the ITKBLOAD control statement instead of the STEPLIB concatenation. However, when you use the CRSS or Autonomics Director, you must specify the load module library of IMS Tools KB in the STEPLIB concatenations.

--------------------
>>> 3.5.2 Control statements for Smart Reorg
>>>> 3.5.2.2 Control statements for the Smart Reorg Driver

New keywords have been added to the following table:

Table x. Control statements for the Smart Reorg Driver
(Table 12 in PDF and BookManager formats)

Keyword	Acceptable values	Default	Description
...	...	...	...
ADDBGRP	dbgrpname or *NO	*NO	Specifies the database group name defined in Autonomics Director. See "ADDBGRP control statement".
ADXCFGRP	xcfgrpname or *NO	*NO	Specifies the XCF group name of the Autonomics Director server. See "ADXCFGRP control statement".
...	...	...	...

--------------------
The following new topics have been added:

ADDBGRP control statement

Specifies the database group name that will be sent with system notification to Autonomics Director.

An Autonomics Director server must be configured. For Autonomics Director configuration information, see the Tools Base Autonomics Director User's Guide.

The name is a 1- to 8-alphanumeric character string. This control statement is used only when ADXCFGRP= xcfgrpname is specified. If you do not explicitly specify this control statement, ADDBGRP=*NO is used.

______*NO_________ >>_______ADDBGRP=____|____dbgrpname_____|______><

--------------------
ADXCFGRP control statement

Specifies the XCF group name of the Autonomics Director server. When the IMS Database Reorganization Expert utility process ends, the utility sends the result of the processing with system notification to the specified Autonomics Director server.

If an error occurs in the initialization process of the utility, system notification is not sent to Autonomics Director.

An Autonomics Director server must be configured. For Autonomics Director configuration information, see the Tools Base Autonomics Director User's Guide.

The name is a 1- to 8-alphanumeric character string. This control statement is optional. If you do not explicitly specify this control statement, ADXCFGRP=*NO is used.

________*NO_________ >>_______ADXCFGRP=____|____xcfgrpname_____|______><

To specify ADXCFGRP= xcfgrpname, the following requirements must be satisfied:

• IBM IMS Database Solution Pack for z/OS, Version 1 Release 2 (FMID: HAHP120) or later must be installed.
• The SHKTLOAD library of IBM Tools Base for z/OS, Version 1 Release 4, or later is specified in the STEPLIB concatenations.
• DBRC is active. If DBRC is not active, the ADXCFGRP control statement is ignored.

--------------------
> 6.0 Scanning a database to resolve logical relationships
>> 6.2 IPR DB Scan JCL statements
>>> 6.2.1 JCL requirements for IPR DB Scan
>>>> 6.2.1.2 DD statements

Description of the STEPLIB DD has been changed as follows:

STEPLIB DD

Points to following libraries:
• ...
• The SHKTLOAD library of Tools Base (optional). This library contains the load modules of Autonomics Director.
• ...

--------------------
>>> 6.2.2 Control statements for IPR DB Scan
>>>> 6.2.2.2 Control statements for IPR DB Scan

New keywords have been added to the following table:

Table x. Control statements for the DB Scan function 
(Table 66 in PDF and BookManager formats)

Keyword	Acceptable values	Default	Description
...	...	...	...
ADDBGRP	dbgrpname or *NO	*NO	Specifies the database group name defined in Autonomics Director. See "ADDBGRP control statement".
ADXCFGRP	xcfgrpname or *NO	*NO	Specifies the XCF group name of the Autonomics Director server. See "ADXCFGRP control statement".
...	...	...	...

--------------------
The following new topics have been added:

ADDBGRP control statement

Specifies the database group name that will be sent with system notification to Autonomics Director.

An Autonomics Director server must be configured. For Autonomics Director configuration information, see the Tools Base Autonomics Director User's Guide.

The name is a 1- to 8-alphanumeric character string. This control statement is used only when ADXCFGRP= xcfgrpname is specified. If you do not explicitly specify this control statement, ADDBGRP=*NO is used.

______*NO_________ >>_______ADDBGRP=____|____dbgrpname_____|______><

--------------------
ADXCFGRP control statement

Specifies the XCF group name of the Autonomics Director server. When the IMS Database Reorganization Expert utility process ends, the utility sends the result of the processing with system notification to the specified Autonomics Director server.

If an error occurs in the initialization process of the utility, system notification is not sent to Autonomics Director.

An Autonomics Director server must be configured. For Autonomics Director configuration information, see the Tools Base Autonomics Director User's Guide.

The name is a 1- to 8-alphanumeric character string. This control statement is optional. If you do not explicitly specify this control statement, ADXCFGRP=*NO is used.

________*NO_________ >>_______ADXCFGRP=____|____xcfgrpname_____|______><

To specify ADXCFGRP= xcfgrpname, the following requirements must be satisfied:

• IBM IMS Database Solution Pack for z/OS, Version 1 Release 2 (FMID: HAHP120) or later must be installed.
• The SHKTLOAD library of IBM Tools Base for z/OS, Version 1 Release 4, or later is specified in the STEPLIB concatenations.
• DBRC is active. If DBRC is not active, the ADXCFGRP control statement is ignored.

====================
> 8.0 Troubleshooting
>> 8.2 Messages and codes
>>> 8.2.3 Messages
>>>> 8.2.3.2 HPSC messages

The following new messages have been added:


HPSC3801I NOTIFICATION HAS BEEN SENT TO AD SERVER

Explanation: A system notification is sent to Autonomics Director.
System action: Processing continues.
User response: None.


----

HPSC3802I *AD API* FUNC= function , parameters...

Explanation: This message is issued only when both ADXCFGRP= grpname and DEBUG=E are specified in the REORG control statement block. The parameters that are passed to the Autonomics Director System Notification Service are shown in the message.
System action: Processing continues.
User response: None.


----

HPSC3804W FAILED TO SEND NOTIFICATION TO AD. FUNC= function , RC= rc , RSN= rsn

Explanation: The utility failed to send system notification to Autonomics Director.
System action: Processing continues.
User response: Ensure that the Autonomics Director server that is specified on the ADXCFGRP control statement is started correctly. If DEBUG=E is specified in the REORG block of HPSIN data set, the parameters that were passed to the Autonomics Director System Notification Service are printed in the HPSC3802I message.


----

HPSC3807W NOTIFICATION TO AD WAS CANCELED. REASON: reason

Explanation: The utility did not send system notification to Autonomics Director because of one of the following reasons:

- DB SOLUTION PACK NOT INSTALLED　
A module of IMS Database Solution Pack could not be loaded.
- IAVNTFY0 LOAD FAILURE
The IAVNTFY0 module could not be loaded from the SHKTLOAD library.
- RECON1 DD NOT FOUND
RECON1 DD is not allocated.

System action: Processing continues without sending a system notification to Autonomics Director.
User response: Complete one of the following tasks depending on the reason shown in the message:

• If the reason is DB SOLUTION PACK NOT INSTALLED, ensure that the IMS Database Solution Pack library is specified in the STEPLIB concatenations correctly.
• If the reason is IAVNTFY0 LOAD FAILURE, ensure that the SHKTLOAD library of IBM Tools Base is specified in the STEPLIB concatenations correctly.
• If the reason is RECON1 DD NOT FOUND, ensure that DBRC=Y is specified.

--------------------
>>>> 8.2.3.3 HPSG messages


HPSG0010W process_option ENDED FOR DATABASE dbdname (RC=04, RSN= xxxxxxxx )

Explanation: ...
If the return code is 04, a hexadecimal reason code xxxxxxxx for the warnings is shown in the message. The reason code has the following meaning:
Reason code Meaning
...
40100017 One or more errors occurred while sending a system notification to Autonomics Director.

----
HPSG0022W [PRE|POST] REORGANIZATION PROCESS ENDED (RC=04, RSN= xxxxxxxx )

Explanation: ...
If the return code is 04, a hexadecimal reason code xxxxxxxx for the warnings is shown in the message. The reason code has the following meaning:
Reason code Meaning
...
40100017 One or more errors occurred while sending a system notification to Autonomics Director.

--------------------
>>>> 8.2.3.5 HPSS messages

The following new messages have been added:


HPSS0019W IMS DB REORG EXPERT IS NOT IN REQUIRED LEVEL FOR ADXCFGRP STATEMENT

Explanation: The release level or the maintenance level of IMS Database Reorganization Expert does not support the ADXCFGRP control statement for the IPR DB Scan utility.
System action: The IPR DB Scan utility continues processing without sending a system notification to Autonomics Director.
User response: If you want to send a system notification to Autonomics Director, apply the required maintenance to IMS Database Reorganization Expert. Otherwise, remove the ADXCFGRP control statement.


----

HPSS3010E RDJFCB MACRO FAILED ON DDNAME: ddname (RC= rc )

Explanation: The RDJFCB MACRO failed for the indicated DD. rc shows the return code from the macro call.
System action: The IPR DB Scan utility ends abnormally.
User response: This is likely to be an internal system error. Contact IBM Software Support.

---

Update 5
Date of change: April 2013
Change description: Documentation changes by APAR PM85664. This APAR fixes a problem in the Post-reorganization utility.
Topics: Changes apply to the following multiple topics.

====================
The content that describes the Pre-reor ganization utility and the Post-reorganization utility, which was added by Update 3 of this te chdoc (APAR PM68661), has been updated.

Updates have been made to this file. Locate the latest version of this file in the Update 6 section of this techdoc.

IMSDatabaseReorganizationExpert_TechdocApril2013.pdf

Note: Page, figure, table, and cross-reference numbers in this PDF extract might not match your current user guide version. Use this documentation extract for content update purposes only. Change bar markings on the left side of the page indicate the new or changed information. This information will be included in any future refreshes of the entire user guide.

====================
> 8.0 Troubleshooting
>> 8.2 Messages and codes
>>> 8.2.3 Messages
>>>> 8.2.3.3 HPSG messages

The following messages have been changed:

HPSG0024E THE SPECIFIED HPSGCTL DATA SET IS INCORRECT

Explanation: The content of the data set that is specified on the HPSGCTL DD statement is incorrect.
System action: The Smart Reorg utility, IPR DB Scan utility, or the Post-reorganization utility ends with a return code of 8.
User response: Ensure that the Pre-reorganization utility job completed successfully and that the correct data set is specified on the HPSGCTL DD statement.

----
HPSG0025E THE RESULT DATA SET FOR dbdname IS INCORRECT.
DSN= dataset_name

Explanation: If message HPSG0122E is issued, this message indicates that the result data set for the indicated database could not be found. Otherwise, this message indicates that inconsistency is detected between the HPSTCTL data set and the result data set.
System action: The Post-reorganization utility ends with a return code of 8 without restoring the authorization flags.
User response: Rerun all the jobs including Pre-reorganization utility, Smart Reorg utility, IPR DB Scan utility, and Post-reorganization utility jobs.

--------------------
The following new message has been added:


HPSG0032E PREVIOUS [REORG|SCAN] PROCESS NOT COMPLETED. DBD= dbd_name

Explanation: The Smart Reorg utility job or the IPR DB Scan utility job that was run before this Post-reorganization utility job has not completed yet for the indicated DBD.
System action: The Post-reorganization utility ends with a return code of 8 without restoring the authorization flags.
User response: Wait until the Smart Reorg utility job or the IPR DB Scan utility job ends and rerun the Post-reorganization utility job.

---

Update 4
Date of change: November 2012
Change description: Documentation changes by APAR PM72877. This APAR adds new reports to the Pre-reorganization utility.
Topics: Changes apply to the following multiple topics.

====================
The content that describes the P re-reorganization utility and the Post-reorganization utility, which was added by Update 3 of this techdoc (APAR PM68661), has been updated.

Updates have been made to this file. Locate the latest version of this file in the Update 6 section of this techdoc.
IMSDatabaseReorganizationExpert_TechdocNovember2012.pdf

Note: Page, figure, table, and cross-reference numbers in this PDF extract might not match your current user guide version. Use this documentation extract for content update purposes only. Change bar markings on the left side of the page indicate the new or changed information. This information will be included in any future refreshes of the entire user guide.

====================
> 8.0 Troubleshooting
>> 8.2 Messages and codes
>>> 8.2.3 Messages
>>>> 8.2.3.3 HPSG messages

The following new messages have been added:

HPSG0030E PREVIOUS [REORG|SCAN] PROCESS NOT SUCCEEDED. DBD= dbd_name

Explanation: The Smart Reorg utility job or the IPR DB Scan utility job that was run before this Post-reorganization utility job did not process the indicated DBD successfully.
System action: The Post-reorganization utility ends with a return code of 8 after restoring the authorization flags.
User response: Identify the error that occurred in Smart Reorg utility or IPR DB Scan utility jobs, and correct the error. Rerun all the jobs including Pre-reorganization utility, Smart Reorg utility, IPR DB Scan utility, and Post-reorganization utility jobs.


----

HPSG0031I DATABASE [REORG|SCAN] IS NEEDED: DBD= dbd_name

Explanation: The indicated DBD must be reorganized or scanned in the subsequent Smart Reorg utility jobs or IPR DB Scan utility jobs.
System action: The Pre-reorganization utility continues processing.
User response: None.


--------------------
In the Explanation section of the HPSG0022W message, a new reason code, 401000016, has been added as follows:

HPSG0022W [PRE|POST] REORGANIZATION PROCESS ENDED (RC=04, RSN= xxxxxxxx )

Explanation: The Pre-reorganization utility or the Post-reorganization utility job ended.
Return code Meaning
00 The job ended normally.
04 A warning message or messages were issued.

If the return code is 04, a hexadecimal reason code xxxxxxxx for the warnings is shown in the message. The reason code has the following meaning:
Reason code Meaning
80800004 One or more warning messages were issued in a subtask or subtasks.
40100007 Deletion of old data sets is not completed because of an error.
40100011 Automated /STA command processing failed and manual processing is required. See message HPSG2104W.
40100013 One or more errors occurred in IMS Tools KB Output repository processing.
40100016 Clean-up processing for the work data sets failed in the Post-reorganization utility process.

System action: The Pre-reorganization utility or the Post-reorganization utility ends.
User response: If the return code is 04, refer to the accompanying warning messages and follow the required user responses for those messages.

----
In the Explanation section of the HPSG0023E message, a new reason code, 80800002, has been added as follows:

HPSG0023E [PRE|POST] REORGANIZATION PROCESS ENDED (RC= rc , RSN= xxxxxxxx )

Explanation: The Pre-reorganization utility or Post-reorganization utility job ended.

Return code Meaning
08 One or more errors were detected.
16 A severe error occurred.

A hexadecimal reason code xxxxxxxx for the error is shown in the message. The reason code has the following meaning:

Reason code Meaning
80800001 An error occurred while the task manager was being initialized.
80800002 An error occurred while the main process was running.
80800003 An error occurred while the task manager was being terminated.
80800005 An error occurred while the reorganization tasks were running.
80800007 An error occurred during report processing of the reorganization tasks.
80800008 An error occurred during prefix resolution processing.
80800009 An error occurred during image copy processing.
80400001 An error occurred while the control statements were analyzed.
80200001 An error occurred while the report manager was being initialized.
40800001 An error was found while the original DBD was being analyzed.
40400002 The status of the database was not satisfied for starting the processing.
40400003 An error was found while the input or output data sets for the database and indexes were being allocated.
40400004 An error was found while the Data Set Information report was being written.
40200001 An error was found while the runtime options were being checked.
40100001 Not all conditions for name swapping were satisfied due to one or more warning messages in a subtask or subtasks.
40100002 The status of the databases was not satisfied for name swapping.
40100003 An error was found during name swapping. Automated backout processing was not done.
40100004 An error was found while the DBRC notification processing was being done.
40100008 An error was found during name swapping and automated backout processing was completed.
40100009 An error was found during name swapping and automated backout processing failed.
40100010 An error was found during /STA DB command processing.
40010001 An error occurred while the utility was being initialized.

System action: The Pre-reorganization utility or the Post-reorganization utility job is aborted.
User response: Locate the accompanying error messages and follow the required user responses for those messages. See also "Recovering from Post-reorganization utility errors" for user actions to recover from the error condition.

----
The Explanation section of the HPSG0122E message has been changed as follows:

HPSG0122E DYNAMIC [ALLOCATION | UNALLOCATION | CONCATENATION] FAILURE. RC= rc , RSN= xxxx,yyyy,zzzz

Explanation: An attempt to dynamically allocate, unallocate, or concatenate the data set that is identified by message HPSG0123I failed. rc is the return code from SVC99, xxxx is the S99ERROR contents, yyyy is the S99INFO contents, and zzzz is the S99ERSN contents. These values are in hexadecimal.
System action: The Smart Reorg utility job step ends with a return code of 16.
User response: If you received this message from the Post-reorganization utility and if the ddname that is indicated in the succeeding HPSG0123I message is DFSURWF1 or HPSLnnnn, this message indicates that one or more databases that were processed by the Pre-reorganization utility are not yet reorganized or scanned. Rerun all jobs including Pre-reorganization utility, Smart Reorg utility, IPR DB Scan utility, and Post-reorganization utility jobs.
See the z/OS MVS Programming: Authorized Assembler Services Reference to determine the meaning of the return code and reason code. Correct the error and rerun the job. If the problem persists, contact IBM Software Support.

---

Update 3
Date of change: July 2012
Change description: Documentation changes by APAR PM68661. This APAR adds the Pre-reorganization utility and the Post-reorganization utility that perform pre-reorganization processing and post-reorganization processing. These utilities help you reorganize databases that have external logical relationships.
Topics: Changes apply to the following multiple topics.

====================
A new part that describes the Pre-reorganization utility and the Post-reorganization utility has been added to the user's guide.

Updates have been made to this file. Locate the latest version of this file in the Update 6 section of this techdoc.
IMSDatabaseReorganizationExpert_TechdocJuly2012.pdf

Note: Page, figure, table, and cross-reference numbers in this PDF extract might not match your current user guide version. Use this documentation extract for content update purposes only. Change bar markings on the left side of the page indicate the new or changed information. This information will be included in any future refreshes of the entire user guide.

====================
> 2.0 Installing and configuring IMS Database Reorganization Expert
>> 2.2 Configuring IMS Database Reorganization Expert environment
>>> 2.2.5 Task 5: Configuring Parallel Reorganization Service for the Smart Reorg utility
>>>> 2.2.5.2 Setting up for using E-MCS console for IMS command processing

Description has been changed to include the Pre-reorganization utility and the Post-reorganization utility as follows:

You can request Smart Reorg utility, Pre-reorganization utility, and Post-reorganization utility jobs to issue some IMS commands through the E-MCS console interface.

...

User ID for E-MCS console

HPSGMAIN is the user ID used for the E-MCS console of the Smart Reorg utility, and HPSCMAIN is the user ID used for the E-MCS console of the Pre-reorganization utility and the Post-reorganization utility. Give authorization to these user IDs so that IMS commands can be accepted by the IMS subsystem.

IMS commands issued through the E-MCS console

The Smart Reorg utility, the Pre-reorganization utility, and the Post-reorganization utility issue the following IMS commands:

• /DBR commands to deallocate the databases from IMS online subsystems
• /DBD commands to make the databases read-only status for the use of IMS online subsystems

Authorization to use MCSOPER macro

The Smart Reorg utility, the Pre-reorganization utility, and the Post-reorganization utility use the MVS MCSOPER macro internally to activate an E-MCS console. You need read access for MVS.MCSOPER.* RACF profile to issue the MCSOPER macro. Otherwise the job abends with code 3103 and message HPSG3103E, showing return code 0C from the MCSOPER macro.

====================
> 3.0 Reorganizing a database
>> 3.5 Smart Reorg JCL statements
>>> 3.5.1 JCL requirements for Smart Reorg
>>>> 3.5.1.2 DD statements

New DD statement, HPSGCTL, has been added as follows:

Table x. DD statements and record format for the Smart Reorg utility
(Table 4 in PDF and BookManager formats)

DDNAME	Use	Format	Need
HPSIN	...	...	...
HPSGCTL	Input	LRECL=800, RECFM=FB	Optional (10)

Notes:
1. ...
....
10. The DD statement is required if the Post-reorganization utility is used for post-reorganization processing.

--------------------
>>>>> 3.5.1.2.1 DD names common to all processing options

Description for HPSGCTL DD has been added as follows:

HPSGCTL DD

Defines the control data set that contains the data that was generated by the Pre-reorganization utility. This DD statement must be specified if the Post-reorganization utility is used for post-reorganization processing. This data set must reside on a direct-access device.

====================
> 6.0 Scanning a database to resolve logical relationships
>> 6.2 IPR DB Scan JCL statements
>>> 6.2.1 JCL requirements for IPR DB Scan
>>>> 6.2.1.2 DD statements

New DD statement, HPSGCTL, has been added as follows:

Table x. DD statements and record format for the IPR DB Scan utility
(Table 65 in PDF and BookManager formats)

DDNAME	Use	Format	Need
HPSIN	...	...	...
HPSGCTL	Input	LRECL=800, RECFM=FB	Optional (3)
...	...	...	...
Notes: 1. ... 2. ... 3. The DD statement is required if the Post-reorganization utility is used for post-reorganization processing.

HPSGCTL DD

Defines the control data set that contains the data that was generated by the Pre-reorganization utility. This DD statement must be specified if the Post-reorganization utility is used for post-reorganization processing. This data set must reside on a direct-access device.

====================
> 8.0 Troubleshooting
>> 8.1 Problem determination

The following new topic has been added after 8.1.4 Identifying problems in IPR DB Scan jobs:


Identifying problems in Pre-Reorganization utility and Post-Reorganization utility jobs

When errors occur in a Pre-reorganization utility job or in a Post-reorganization utility job, you are notified of the error by at least one WTO message and a non-zero job return code.

You can determine which process an error occurred in based on the prefix of the error message.

Error messages that have a prefix of HPSG or HPSC indicate that the error occurred in Pre-reorganization utility or Post-reorganization utility processing.

The Pre-reorganization utility or the Post-reorganization utility provides the following information to help you identify and solve error conditions:

• Messages
• Return codes
• Reason codes
• Abend codes
• Reports for problem determination

All other prefixes indicate that the error might have occurred in other IMS Tools products that run under the Pre-reorganization utility or the Post-reorganization utility. In this case, see "Messages" in topic 8.2.3 and the problem determination topics in the information of the relevant product.

Related reference:

• "Messages" in topic 8.2.3
• "The Pre-Reorganization utility, the Post-Reorganization utility, and the Clean-up utility return codes" in topic 8.2.1.5
• "Abend codes" in topic 8.2.2
• "Pre-Reorganization utility reports" in topic 9.6
• "Report reference table for Pre-Reorganization utility" in topic 9.6.1
• "Post-Reorganization utility reports" in topic 9.7
• "Report reference table for Post-Reorganization utility" in topic 9.7.1

--------------------
>> 8.2 Messages and codes
>>> 8.2.1 Return codes

The following new topic has been added after 8.2.1.4 The IPR DB Scan utility return codes:


This reference topic explains the return codes of the Pre-reorganization utility, the Post-reorganization utility, and the Cleanup utility.

The Pre-reorganization utility, the Post-reorganization utility, and the Cleanup utility return the return codes that are listed in the following table.

Table x. Return codes of the Pre-reorganization utility, the Post-reorganization utility, and the Cleanup utility

Return code	Description
00	Job ended normally without any warning.
04	Warning messages are issued, but the processing completed. See the reason code in message HPSG0022W for the reason of the warnings.
08	One or more errors occurred, and the processing was aborted. See the reason code in message HPSG0023E for the reason of the errors.
12	An image copy task ended with an error or errors, but other tasks ended normally or maybe with some warnings. For necessary actions, see the explanation of message HPSG0028A.
16	A severe error including the system or a user abend occurred, and the processing was aborted. See the reason code in message HPSG0023E.

--------------------
>>> 8.2.3 Messages

The description for the HPSG prefix has been updated as follows:

This topic describes all the messages that are issued by the utilities of IMS Database Reorganization Expert.

Message format
...

Table. Message prefix
(Table 71 in PDF and BookManager formats)

Prefix	Description
...	...
HPSG	Indicates that the message was issued by the Smart Reorg utility, the Pre-Reorganization utility, or the Post-reorganization utility.
...	...

--------------------
>>>> 8.2.3.3 HPSG messages

The following new messages have been added:

Messages that are issued by the Smart Reorg utility, the Pre-reorganization utility, and the Post-reorganization utility begin with HPSG.

----

HPSG0017E INFORMATION ABOUT TWO OR MORE LOGICAL GROUPS IS FOUND IN THE DFSURCDS DATA SET

Explanation: The data set that is specified by the DFSURCDS DD contains information about multiple logical groups. The Pre-reorganization utility can process only one logical group.
System action: The Pre-reorganization utility ends with a return code of 8.
User response: Re-create the DFSURCDS data set by running the IMS Database Prereorganization utility (DFSURPR0), and rerun the Pre-reorganization utility job.

----

HPSG0018I HPSGCTL DD IS FOUND. THE SMART REORG UTILITY WILL NOT PERFORM POST PROCESSING

Explanation: The Smart Reorg utility found an HPSGCTL DD statement in the JCL stream, therefore, the utility will not perform post processing. Post-processing must be performed by running the Post-reorganization utility.
System action: The Smart Reorg utility continues processing.
User response: None.

----

HPSG0019E DFSURCDS DD MUST SPECIFY THE DFSURCDS DATA SET THAT WAS USED IN PRE-REORG JOB

Explanation: A DFSURCDS DD statement is specified. However, the data set name that is specified on the DFSURCDS DD statement does not match the DFSURCDS data set name that was used in the Pre-reorganization utility job.
System action: The Smart Reorg utility ends with a return code of 8.
User response: Remove the DFSURCDS DD statement or specify the correct data set on the DFSURCDS DD statement, and rerun the job.

----

HPSG0020E DATABASE dbd_name IS NOT PREPARED FOR REORGANIZATION

Explanation: The Smart Reorg utility cannot reorganize the indicated database. The DBD name must match the database name that was specified on the DBR or the DBIL control statement in the IMS Database Prereorganization utility job (DFSURPR0).
System action: The Smart Reorg utility ends with a return code of 8.
User response: Specify the correct DBD name in the EXEC statement, and rerun the job.

----
HPSG0021I [PRE|POST] REORGANIZATION PROCESS STARTED

Explanation: This message is an information message that notifies the operator that Pre-reorganization utility or Post-reorganization utility processing has started.
System action: The Pre-reorganization utility or the Post-reorganization utility continues processing.
User response: None.

----

HPSG0022I [PRE|POST] REORGANIZATION PROCESS ENDED (RC=00)

Explanation: The Pre-reorganization utility or the Post-reorganization utility job ended.

Return code meaning
00 The job ended normally.
04 A warning message or messages were issued.

If the return code is 04, a hexadecimal reason code xxxxxxxx for the warnings is shown in the message. The reason code has the following meaning:

Reason code Meaning
80800004 One or more warning messages were issued in a subtask or subtasks.
40100007 Deletion of old data sets is not completed because of an error.
40100011 Automated /STA command processing failed and manual processing is required. See message HPSG2104W.
40100013 One or more errors occurred in IMS Tools KB Output repository processing.

System action: The Pre-reorganization utility or the Post-reorganization utility ends.
User response: If the return code is 04, refer to the accompanying warning messages and follow the required user responses for those messages.

----

HPSG0022W [PRE|POST] REORGANIZATION PROCESS ENDED (RC=04, RSN= xxxxxxxx )

Explanation: The Pre-reorganization utility or the Post-reorganization utility job ended.

Return code meaning
00 The job ended normally.
04 A warning message or messages were issued.

If the return code is 04, a hexadecimal reason code xxxxxxxx for the warnings is shown in the message. The reason code has the following meaning:

Reason code Meaning
80800004 One or more warning messages were issued in a subtask or subtasks.
40100007 Deletion of old data sets is not completed because of an error.
40100011 Automated /STA command processing failed and manual processing is required. See message HPSG2104W.
40100013 One or more errors occurred in IMS Tools KB Output repository processing.

System action: The Pre-reorganization utility or the Post-reorganization utility ends.
User response: If the return code is 04, refer to the accompanying warning messages and follow the required user responses for those messages.

----

HPSG0023E [PRE|POST] REORGANIZATION PROCESS ENDED (RC= rc , RSN= xxxxxxxx )

Explanation: The Pre-reorganization utility or Post-reorganization utility job ended.

Return code Meaning
08 One or more errors were detected.
16 A severe error occurred.

A hexadecimal reason code xxxxxxxx for the error is shown in the message. The reason code has the following meaning:

Reason code Meaning
80800001 An error occurred while the task manager was being initialized.
80800003 An error occurred while the task manager was being terminated.
80800005 An error occurred while the reorganization tasks were running.
80800007 An error occurred during report processing of the reorganization tasks.
80800008 An error occurred during prefix resolution processing.
80800009 An error occurred during image copy processing.
80400001 An error occurred while the control statements were analyzed.
80200001 An error occurred while the report manager was being initialized.
40800001 An error was found while the original DBD was being analyzed.
40400002 The status of the database was not satisfied for starting the processing.
40400003 An error was found while the input or output data sets for the database and indexes were being allocated.
40400004 An error was found while the Data Set Information report was being written.
40200001 An error was found while the runtime options were being checked.
40100001 Not all conditions for name swapping were satisfied due to one or more warning messages in a subtask or subtasks.
40100002 The status of the databases was not satisfied for name swapping.
40100003 An error was found during name swapping. Automated backout processing was not done.
40100004 An error was found while the DBRC notification processing was being done.
40100008 An error was found during name swapping and automated backout processing was completed.
40100009 An error was found during name swapping and automated backout processing failed.
40100010 An error was found during /STA DB command processing.
40010001 An error occurred while the utility was being initialized.

System action: The Pre-reorganization utility or the Post-reorganization utility job is aborted.
User response: Locate the accompanying error messages and follow the required user responses for those messages. See also "Recovering from Post-reorganization utility errors" for user actions to recover from the error condition.

----

HPSG0024E THE SPECIFIED HPSGCTL DATA SET IS INCORRECT

Explanation: The content of the data set that is specified on the HPSGCTL DD statement is incorrect.
System action: The Smart Reorg utility or the Post-reorganization utility ends with a return code of 8.
User response: Specify the correct data set on the HPSGCTL DD statement.

----

HPSG0025E THE RESULT DATA SET FOR dbdname IS INCORRECT

DSN= data_set_name

Explanation: The result data set for the indicated database is not found or the content of the result data set is incorrect.
System action: The Post-reorganization utility ends with a return code of 8.
User response: Ensure that the Smart Reorg job or the IPR DB Scan job for the indicated database has completed.

----

HPSG0026I POST-PROCESSING MUST BE PERFORMED BY THE POST REORGANIZATION UTILITY

Explanation: The Smart Reorg utility does not perform post processing. You must run the Post-reorganization utility to complete the reorganization.
System action: The Smart Reorg utility continues processing.
User response: After running the Smart Reorg utility and the IPR DB Scan utility for all the databases that were processed by the Pre-reorganization utility, run the Post-reorganization utility.

----

HPSG0027E THE SPECIFIED DFSURCDS DATA SET IS INCORRECT

Explanation: The data set that is specified on the DFSURCDS DD statement is incorrect.
System action: The Pre-reorganization utility ends with a return code of 8.
User response: Ensure that the correct DFSURCDS data set is specified.

----

HPSG0028A POST REORGANIZATION PROCESS ENDED WITH AN IMAGE COPY ERROR (RC=12)

Explanation: Name swapping, and prefix resolution and update processing are completed successfully, but succeeding image copy processing ended with error.
System action: The Post-reorganization utility ends with a return code of 12.
User response: Discard all the image copy data sets that were created in the Post-reorganization utility job. Check the cause of the image copy error. Resolve the problem in the Image Copy task, and follow the procedure of manual image copy processing, which is described in "Performing manual image copy processing" in topic 3.8.2.3, and the procedure of manual DBRC notification processing, which is described in "Performing manual DBRC notification processing" in topic 3.8.2.2. See also "Recovering from Post-reorganization utility errors" for user actions to recover from the error condition.
If the problem in the Image Copy task cannot be fixed, collect the output reports of the Post-reorganization utility job and contact IBM Software Support.
If any error message or warning message of IMS HP Pointer Checker, which is prefixed with FABP, is issued, there is a possibility that there are pointer errors in the reloaded shadow database or rebuilt indexes. In this case, collect the output report of the Post-reorganization utility job and contact IBM Software Support.

----

HPSG0029E DFSURWF1 DD MUST SPECIFY THE DFSURWF1 DATA SETS THAT WERE USED IN REORG OR SCAN

Explanation: One or more DFSURWF1 data sets that were used in the Smart Reorg utility or IPR DB Scan utility job are not specified on the DFSURWF1 DD statement.
System action: The Post-reorganization utility ends with a return code of 8.
User response: Specify the correct data sets on the DFSURWF1 DD statement or remove the DFSURWF1 DD statement, and rerun the Post-reorganization utility job.

----

HPSG0247E DFSURCDS CONTAINS INFORMATION ABOUT DATABASE xxxxxxxx WHICH IS NOT SUPPORTED

Explanation: The data set specified in the DFSURCDS DD contains information about a database which its database organization is not supported.
System action: The Pre-reorganization utility ends with a return code of 8.
User response: Re-create the DFSURCDS data set by running the IMS Database Prereorganization utility (DFSURPR0), and rerun the Pre-reorganization utility job.

----

HPSG0248E WHEN HPSGCTL DD EXISTS, FOLLOWING OPTION IS INVALID: control_statement

Explanation: The Smart Reorg utility found the indicated control statement option. However, this option is not supported when an HPSGCTL DD statement is specified.
System action: The Smart Reorg utility ends with a return code of 8.
User response: Remove the control statement, and rerun the Smart Reorg utility job.

----

HPSG3109E INTERNAL ERROR OCCURRED WHILE BUILDING DBD NAME LIST: RC= rc , RSN= rsn

Explanation: An internal error occurred while creating a DBD name list.
System action: The subtask that caused the internal error abends with a user completion code of 3109, and the Pre-reorganization utility ends with a return code of 16.
User response: Contact IBM Software Support.

----
HPSG0122E has been changed as follows:


HPSG0122E DYNAMIC [ALLOCATION | UNALLOCATION | CONCATENATION ] FAILURE. RC= rc , RSN= xxxx,yyyy,zzzz

Explanation: An attempt to dynamically allocate, unallocate, or concatenate the data set that is identified by message HPSG0123I failed. rc is the return code from SVC99, xxxx is the S99ERROR contents, yyyy is the S99INFO contents, and zzzz is the S99ERSN contents. These values are in hexadecimal.
System action: The Smart Reorg utility job step ends with a return code of 16.
User response: If you received this message from the Post-reorganization utility and if the ddname that is indicated in the succeeding HPSG0123I message is DFSURWF1 or HPSL nnnn, this message indicates that one or more databases that were processed by the Pre-reorganization utility are not yet reorganized or scanned. Rerun all jobs including Pre-reorganization utility, Smart Reorg utility, IPR DB Scan utility, and Post-reorganization utility jobs.
See the z/OS MVS Programming: Authorized Assembler Services Reference to determine the meaning of the return code and reason code. Correct the error and rerun the job. If the problem persists, contact IBM Software Support.

--------------------
>>>> 8.2.3.5 HPSS messages

The following new messages have been added:


HPSS0017I HPSGCTL DD IS FOUND. THE IPR DB SCAN UTILITY GENERATES A RESULT DATA SET

Explanation: The IPR DB Scan utility found an HPSGCTL DD statement in the JCL stream. The IPR DB Scan utility generates a result data set for the subsequent Post-reorganization utility job.
System action: The IPR DB Scan utility continues processing.
User response: None.

----

HPSS3009E SEGMENT NAME CANNOT BE SPECIFIED ON THE DBS CONTROL STATEMENT

Explanation: A segment name is specified on the DBS control statement. However, a segment name cannot be specified when the HPSGCTL DD statement is specified.
System action: The IPR DB Scan utility ends with a return code of 8.
User response: Correct the DBS control statement specification and rerun the IPR DB Scan utility job.

---

Update 2
Date of change: June 2012
Change description: User's guide update.
Topic:
> 3.0 Reorganizing a database
>> 3.1 Smart Reorg utility
>>> 3.1.4 Smart Reorg restrictions and requirements

Restrictions for Unconditional Reorganization mode

The following restriction item has been added:

• IMS catalog databases are not supported.

---

Update 1
Date of change: March 2012
Change description: User's guide update.
Topic:
> 8.0 Troubleshooting
>> 8.2 Messages and codes
>>> 8.2.3 Messages
>>>> 8.2.3.1 BBE messages
>>>>> BBE1451E

The Explanation and the User response sections of the BBE1451E message have been changed as follows:

BBE1451E SENSOR DATA SERVICE FAILED. FUNC= function , RC= rc , RSN= rsn [, ELEM= data_element xxxx / yyyy ]

Explanation: One or more errors were detected when the function function of the sensor data service was running. Hexadecimal values rc and rsn show the return and reason codes of the error, respectively. If the errors are detected in specific data elements, data_element shows the name of the data element, and hexadecimal values xxxx and yyyy show the return and reason codes of the error, respectively.

If this message contains FUNC=INIT, RC=4, and RSN=X'52', the message indicates that the Sensor Data repository is not initialized.

System Action: DB Sensor processing ends with a return code of 8.

User Response: Determine if the correct load module library for Policy Services is specified in your JCL. See the Tools Base: Policy Services User's Guide to determine the meaning of the return code and reason code. Then, correct the error and rerun the job.

When FUNC=INIT, RC=4, and RSN=X'52', follow the instructions in the topic "Initializing the repositories" in the Tools Base: IMS Tools Knowledge Base User's Guide and initialize the Sensor Data repository. Rerun the job.

If the problem persists, record all the messages issued from the conditional reorganization job and contact IBM Software Support.