Updates to IMS Online Reorganization Facility for z/OS V1.3 User's Guide

Product documentation


Abstract

Updates that apply to IMS Online Reorganization Facility Version 1 Release 3 User's Guide (SC19-3967-00).

Content

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



Update 6
Date of change: July 2014
Change description: User's Guide updates.
Topic: Changes are made to the following multiple topics:

> 4.0 Using IMS Online Reorganization Facility
>> 4.4 HRFSYSIN DD statement keywords
>>> 4.4.33 NEWDBD keyword

Description of the NEWDBD keyword has been updated as follows:

NEWDBD keyword

Use this keyword 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.

This keyword is required for REORG HRFSYSIN DD statements if you are requesting DBD changes. It is not applicable for UNLOAD HRFSYSIN DD statements.

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. Start of changeThe NEWDBD keyword cannot be specified for HALDB databases. End of change

See the ONLINECHANGE, DBDCOPY, and TAKEOVER keywords for mutual exclusivity considerations.
=============
> 5.0 Troubleshooting
>> 5.3 Messages and codes
>>> 5.3.2 Messages

Messages HRF01152E has been updated as follows:

Start of change HRF01152E NEWDBD specified for HALDB database. End of change

Explanation: Start of changeIMS Online Reorganization Facility does not support DBD changes for HALDB databases. You do not need a DBD change to modify the randomizing parameter for a HALDB partition. End of change



Update 5
Date of change: June 2014
Change description: User's Guide updates.
Topic: Changes are made to the following multiple topics:

> 2.0 Configuring IMS Online Reorganization Facility
>> 2.1 Restrictions

The restriction list has been modified as follows:

IMS Online Reorganization Facility does not support the following items:
  • Batch jobs that run as DLI, DBB, or ULU region types and that access the database during the reorganization process
  • Automatic detection of applications that update the database during the reorganization process by using a PCB that references a logical DBD
    Attention: If you have logical DBDs that reference the database you are reorganizing, specify the names of the logical DBDs by using the LOGICALDBD keyword.
  • HALDB databases that have internal logical relationships and allow update of logical parent segments by using a logical path
    Attention: For HALDB databases that have internal logical relationships, the following restrictions apply to the insert, delete and replace rules. The rules are specified by using the RULES= keyword of a SEGM statement in the physical DBD.
    • Insert rules L and V are not supported for logical parents. Only the P insert rule is supported.
    • Delete rules L and V are not supported for logical parents. Only the P deletion rule is supported.
    • Replace rule V is not supported for logical parents.
  • Start of changeApplications that update the HALDB during the reorganization process by using a PCB with PROCSEQ= codedEnd of change
  • HSAM databases
  • HIDAM databases with compressed root keys
  • Databases and database data sets that are not registered to DBRC
  • Start of changeDatabases that are registered as non-recoverable with DBRC
    Attention: When the primary database to be reorganized is an index, IMS Online Reorganization Facility temporarily stops the database before the reorganization to make it recoverable during the reorganization, and then restores it to non-recoverable after the reorganization.End of change
  • Start of changeDatabases that have external logical relationshipsEnd of change
  • Fast Path databases
  • HALDB DBD changes
  • Reorganization of HALDB M-V data sets
  • Uncataloged or corrupted databases
  • Databases using PDF
  • Start of changeMulti-volume OSAM databases that are allocated on non-SMS managed volumesEnd of change
  • Start of changeMulti-volume OSAM databases that are not created by using the standard DFSMS methodsEnd of change
=============
> 2.0 Configuring IMS Online Reorganization Facility
>> 2.3 Configuration considerations

This topic has been modified as follows:

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. Start of changeThe USERMOD provided with IMS Program Restart Facility is the best version to use. If IMS Program Restart Facility is not installed, the USERMOD provided with IMS Online Reorganization Facility is the next best version to use. End of change

Start of changeThe CICS and ODBA applications pause feature is independent of the BMP pause feature. You can use the CICS and ODBA applications pause feature even when you use IMS Program Restart Facility or IMS Recovery Solution Pack: Database Recovery Facility: Extended Functions for BMP pause. End of change

If you have DBDs that contain virtual segments, you must provide a DFSURGU1 DD statement because standard IMS utilities are used during the reorganization.

=============
> 2.0 Configuring IMS Online Reorganization Facility
>> 2.9 Configuring your IMS Online Reorganization Facility runtime environment
>>> 2.9.2 HRFSETOP and HRF#ssid module parameters

Descriptions of the following parameters have been added:

Start of change
NOTINIT= ERROR | IGNORE
    If the database is defined to an IMS subsystem, IMS Online Reorganization Facility checks whether the corresponding ACBLIB member exists in that subsystem and ends with an error when the ACBLIB member is not found. Specify NOTINIT=IGNORE if you want the job to continue even when the ACBLIB member is not found in that subsystem. When NOTINIT=IGNORE is specified, IMS Online Reorganization Facility treats the database the same as it treats a database that is not defined to the IMS subsystem.

    Default: ERROR
End of change

Start of change
UNITPOOL= uuuuuuuu
    A 1- to 8-character unit name to be used for OSAM shadow data set allocations. This value is required only if you want to have shadow data sets allocated in the specified unit pool. This parameter is effective only for OSAM databases.

    Default: None.
End of change

Start of change
VOLPOOL= vvvvvv
    A 1- to 6-character volume serial to be used for OSAM shadow data set allocations. This value is required only if you want to have shadow data sets allocated in the specified volume pool. This parameter is effective only for OSAM databases.

    Default: None.
End of change

=============
> 4.0 Using IMS Online Reorganization Facility
>> 4.4 HRFSYSIN DD statement keywords
>>> 4.4.14 IC1DSN keyword

The following variable has been added to the description of the IC1DSN keyword:

&DBD
    The DBD name. This value changes to the first partition name when not all partitions are processed.

Start of change&DDNAME
    The DDNAME of the database data set. End of change

&DATE1
    This variable is substituted as Dyyyyddd.

=============
> 4.0 Using IMS Online Reorganization Facility
>> 4.4 HRFSYSIN DD statement keywords
>>> 4.4.15 IC2DSN keyword

Description of the IC2DSN keyword has been modified as follows:

IC2DSN keyword
This keyword 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. Start of changeThis keyword is ignored when ICNUM(2) is not specified. End of change

This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements.

=============
> 4.0 Using IMS Online Reorganization Facility
>> 4.4 HRFSYSIN DD statement keywords
>>> 4.4.22 IC.VIC keyword

Description of the IC.VIC keyword has been modified as follows:

IC.VIC keyword
This keyword is used to indicate whether all index image copies are registered as virtual.

This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements.

Start of changeSpecifying 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. This keyword is effective only for the index databases that are registered as recoverable with DBRC. End of change

=============
> 4.0 Using IMS Online Reorganization Facility
>> 4.4 HRFSYSIN DD statement keywords
>>> 4.4.47 PTRCHECK keyword

Description of the PTRCHECK keyword has been modified as follows:

PTRCHECK keyword
Start of changeThis keyword is used to indicate whether the pointers of the image copies are checked concurrently by HASH Check. If PTRCHECK is set to (Y), you must be licensed for the IBM IMS High Performance Pointer Checker and it must be in the STEPLIB. If PTRCHECK is set to (Y), the IMS High Performance Pointer Checker load library must be in the STEPLIB. End of change

This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements.

=============
> 4.0 Using IMS Online Reorganization Facility
>> 4.5 Keywords that affect DBD and DMB replacements

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.

Start of changeYou can specify two keywords that affect the final stages of DBD or DMB replacement: ONLINECHANGE and DBDCOPY. These keywords are ignored when one of the following conditions is met:
  • NEWDBD keyword is not specified
  • TAKEOVER(N) is specified

If you have DBD changes, it is recommended that you specify both ONLINECHANGE(Y) and DBDCOPY(Y) so that the databases do not require manual intervention at the end of the reorganization. End of change

ONLINECHANGE
    Start of changeYou can use the ONLINECHANGE 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. End of change
    If you specify ONLINECHANGE(Y), the following actions occur:
    • A DMB is loaded before the database is started in online systems.
    • Start of changeThe 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.
      You do not need to specify the IMSACBA and IMSACBB DD statements in the JCL when all the following conditions are true:
      • The online systems are available during this phase.
      • The online systems do not use dynamic allocation for IMSACBA and IMSACBB libraries.
      In this case, IMS Online Reorganization Facility obtains both the active and inactive ACB libraries that are allocated to the online systems; otherwise you need to specify the IMSACBA and IMSACBB DD statements in the JCL.End of change
    • 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:
    • The ACBGEN is performed and placed into the staging IMSACB library.
    • The copy to the IMSACBA and IMSACBB libraries is not performed.
    • The DMB is not replaced.
    • Start of changeThe database is left offline and in prohibit authorization status.End of change

DBDCOPY
    Start of changeYou can use the DBDCOPY keyword to indicate whether the new DBD is copied to the current DBDLIB (IMS DD statement).
    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:
    • You can specify only five new indexes.
    • You must place your new index DBDs in the NEWDBD data set.
    • You must register your new index DBDs with DBRC before running IMS Online Reorganization Facility.
    • 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.

If the Integrity Checker utility of IMS Library Integrity Utilities is activated in your environment, 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 specify both DBDCOPY(Y) and ONLINECHANGE(Y).
  • Include the IMS Library Integrity Utilities in your STEPLIB.
  • Ensure that the value of DBDCOPY is (Y).
  • Ensure that the value of ONLINECHANGE is (Y). End of 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:
  • MSGPRINT
  • The applicable output data sets (such as IEBPRINT and SYSPRINT)

Start of changeIf 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 actions is taken:
  • The system is restarted to complete the process.
  • You manually fix the problem and restart the IMS Online Reorganization Facility job by specifying RESTART(AUTO).
  • You manually fix the problem, complete the unfinished operations, and restart the database.
  • A restart is done to complete the process and manual fixes are made. End of change



Update 4
Date of change: March 2014
Change description: Documentation changes by APAR PI09890. This APAR adds support for a new HRFSYSIN statement keyword.
Topic: Changes are made to the following multiple topics:

> 2.0 Configuring IMS Online Reorganization Facility
>> 2.1 Restrictions

The second item, which has been added by Update 1 of this tech doc, has been modified as follows:

IMS Online Reorganization Facility does not support the following items:
  • Batch jobs that run as DLI, DBB, or ULU region types and that access the database during the reorganization process
    Attention: Running outside of DBRC might cause a data integrity exposure. For example, if a DBB or DLIBATCH job is running with DBRC=N, IMS Online Reorganization Facility does not detect it and proceeds with the reorganization. The Takeover phase then attempts to allocate the database data sets as DISP=OLD and fails if the DBB or DLI job is still running. Additionally, if a DBB or DLIBATCH job that runs with DBRC=N finishes before the Takeover phase, those updates are not captured by IMS Online Reorganization Facility because such a job runs as DLI or DBB region type.
  • Start of changeAutomatic detection of applications that update the database during the reorganization process by using a PCB that references a logical DBD
    Attention: If you have logical DBDs that reference the database you are reorganizing, specify the names of the logical DBDs by using the LOGICALDBD keyword.End of change
  • Start of changeHALDB databases that have internal logical relationships and allow update of logical parent segments by using a logical path
    Attention: For HALDB databases that have internal logical relationships, the following restrictions apply to the insert, delete and replace rules. The rules are specified by using the RULES= keyword of a SEGM statement in the physical DBD.
    • Insert rules L and V are not supported for logical parents. Only the P insert rule is supported.
    • Delete rules L and V are not supported for logical parents. Only the P deletion rule is supported.
    • Replace rule V is not supported for logical parents. End of change
  • HSAM databases
  • HIDAM databases with compressed root keys

=============
> 4.0 Using IMS Online Reorganization Facility
>> 4.4 HRFSYSIN DD statement keywords

The following new keyword has been added to the HRFSYSIN DD statement keywords table as follows:

Table. HRFSYSIN DD statement keywords
(Table 2 in PDF and BookManager formats)
Keyword REORG HRFSYSIN DD UNLOAD HRFSYSIN DD Link to topic
... ... ... ...
Start of changeLOGICALDBD Optional Not applicable LOGICALDBD keywordEnd of change
... ... ... ...

The following new topic has been added:

Start of change
LOGICALDBD keyword

Use this keyword to specify the names of the logical DBDs that are defined to the physical database specified by the DBD keyword.

Specify this keyword only if you have applications that update the database during the reorganization process by using a PCB that references a logical DBD. You can specify up to five logical DBD names.

This keyword is optional for REORG HRFSYSIN DD statements, but is not applicable for UNLOAD HRFSYSIN DD statements.

Format
    ( dbdname1[, dbdname2[, dbdname3[, dbdname4[, dbdname5]]]]])

Default value
    None.
End of change
=============
> 5.0 Troubleshooting
>> 5.3 Messages and codes
>>> 5.3.2 Messages

The following messages have been added:

Start of change
HRF01181E Logical DBD dbdname is invalid

Explanation: The indicated logical DBD does not reference the database that is specified by the DBD keyword.
System action: Processing terminates.
User response: Ensure that the indicated logical DBD is defined to the database that you are reorganizing.
End of change
------------
Start of change
HRF01573E Logical DBD dbdname is not specified by the LOGICALDBD keyword.

Explanation: The database was updated by using a PCB that references the indicated logical DBD , but the logical DBD is not specified by the LOGICALDBD keyword. Any logical DBD that applications use for update during the reorganization must be specified with the LOGICALDBD keyword.
System action: Processing terminates.
User response: Specify the logical DBD by using the LOGICALDBD keyword.
End of change
------------
Start of change
HRF01574E DBD dbdname has insert, delete, or replace rules that are not supported.

Explanation: Unsupported path type is specified in the insert, delete, or replace rules of the indicated DBD. For HALDB databases that have internal logical relationships, the following restrictions apply to the insert, delete and replace rules. The rules are specified by using the RULES= keyword of a SEGM statement in the physical DBD.
  • Insert rules L and V are not supported for logical parents. Only the P insert rule is supported.
  • Delete rules L and V are not supported for logical parents. Only the P deletion rule is supported.
  • Replace rule V is not supported for logical parents.
No restrictions apply to the insert, delete, and replace rules of full-function databases.
System action: Processing terminates.
User response: None. You cannot use IMS Online Reorganization Facility to process a HALDB DBD with such rules.
End of change



Update 3
Date of change: July 2013
Change description: Documentation changes by APAR PM91993. This APAR adds two new parameters to the runtime option modules HRFSETOP and HRF#ssid.
Topic: Changes are made to the following multiple topics:

> 2 Configuring IMS Online Reorganization Facility
>> 2.9 Configuring your IMS Online Reorganization Facility runtime environment
>>> 2.9.2 HRFSETOP and HRF#ssid module parameters

The following new parameters have been added by APAR PM91993:

Start of change
DBRCHIPR= N | NO | Y | YES
    Specifies the timestamp precision for DBRC commands. DBRCHIPR=N or NO requests to generate DBRC commands with 12-digit timestamps. DBRCHIPR=Y or YES requests to generate DBRC commands with 16-digit timestamps. DBRC commands that have 16-digit timestamps can be processed only when the MINVERS value in the RECON data set is equal to or higher than 10.1.

    Default: N
End of change

Start of change
FEOV= Y | YES | N | NO
    Specifies whether to include the NOFEOV keyword in the /DBR command during the Takeover phase. FEOV=N or NO specifies to include the NOFEOV keyword, which means that there is no forced end of volume. You can override the value specified on this parameter by using the FEOV keyword in the HRFSYSIN DD statement.

    Default: Y
End of change



Update 2
Date of change: June 2013
Change description: User's Guide updates.
Topic: Changes are made to the following multiple topics:

> 2.0 Configuring IMS Online Reorganization Facility
>> 2.9 Configuring your IMS Online Reorganization Facility runtime environment
>>> 2.9.2 HRFSETOP and HRF#ssid module parameters

Description of the XCFRETRY parameter has been added as follows:

Start of change
XCFRETRY= nn
    A 2-digit numeric value that indicates the number of times that IMS Online Reorganization Facility automatically retries to send XCF messages in situations where sufficient XCF message buffer is not available (IXCMSGORSNNOBUFFER). When the number is exceeded, the IMS Online Reorganization Facility job stops.

    Attention: Use this parameter with caution because it can possibly degrade the performance of IMS when the XCF send errors occur repeatedly.

    Default: 0
End of change

The following obsolete parameter has been removed:

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

=============
> 5.0 Troubleshooting
>> 5.3 Messages and codes
>>> 5.3.2 Messages

The explanation for the following message has been modified:

HRF01517E Error encountered during capturetype capture for DBD dbdname: FUNC= function RC= xxxx RSN= xxxx

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.
Start of changeUser response: If the parameters shown in the message are 'FUNC=IXCMSGO, RC=000C, RSN=0004', the message indicates that an XCF send error, which is caused by an XCF message buffer shortage, has occurred. In this case, consider increasing the MAXMSG value on the CLASSDEF or PATHOUT definition. You can find information about XCF message buffers in z/OS MVS Setting Up a Sysplex. Alternatively you can use the XCFRETRY parameter in HRFSETOP to specify the retry count for such XCF send errors.
For other errors, report the problem to IBM Software Support. End of change

The following new message has been added by APAR PM89930:

Start of change
HRF01572E Waiting for database pause has expired

Explanation: An attempt to pause the database has timed out.
System action: The process terminates.
User response: Resubmit the IMS Online Reorganization Facility job. If the error persists, contact IBM Software Support.
End of change


Update 1
Date of change: March 2013
Change description: User's Guide updates.
Topic: Changes are made to the following multiple topics:

> 2.0 Configuring IMS Online Reorganization Facility
>> 2.1 Restrictions

A new item has been added to the list as follows (second item):

IMS Online Reorganization Facility does not support the following items:
  • Batch jobs that run as DLI, DBB, or ULU region types and that access the database during the reorganization process
    Attention: Running outside of DBRC might cause a data integrity exposure. For example, if a DBB or DLIBATCH job is running with DBRC=N, IMS Online Reorganization Facility does not detect it and proceeds with the reorganization. The Takeover phase then attempts to allocate the database data sets as DISP=OLD and fails if the DBB or DLI job is still running. Additionally, if a DBB or DLIBATCH job that runs with DBRC=N finishes before the Takeover phase, those updates are not captured by IMS Online Reorganization Facility because such a job runs as DLI or DBB region type.
  • Start of changeApplications that update the database during the reorganization process by using a PCB that references a logical DBDEnd of change
  • HSAM databases
  • HIDAM databases with compressed root keys
...

=============
> 5.0 Troubleshooting
>> 5.3 Messages and codes
>>> 5.3.2 Messages

The following new message has been added:

Start of change
HRF01570E Waiting for BMPs has expired

Explanation: The number of retry attempts to stop BMP jobs reached the maximum number that is set by the BMPRETRY parameter in the HRFSETOP runtime option module.
System action: The process terminates.
User response: Wait for the BMP jobs that are shown in the WTOR message to end, and resubmit the IMS Online Reorganization Facility job. You can increase the maximum number of retry attempts by specifying the BMPRETRY parameter in the HRFSETOP runtime option module. If the database is used by long running BMP jobs, consider enabling BMP job pause handling. For more information, see "Managing BMP pauses".
End of change

Publication number

SC19-3967-00

Copyright date

1996, 2013

Original publication date

2013/3/19

Rate this page:

(0 users)Average rating

Document information


More support for:

IMS Tools
IMS Online Reorganization Facility

Software version:

1.3.0

Operating system(s):

z/OS

Reference #:

7038163

Modified date:

2014-07-17

Translate my page

Machine Translation

Content navigation