UPDATE OLREORG command

If you issue this command as a type-1 command, the command response is returned as a DFS0725I pre-edit message.

Subsections:

• Environment
• Syntax
• Keywords
• Usage notes
• Command responses for /UPDATE OLREORG
• Output fields
• Return, reason, and completion codes
• Examples

Environment

The following table lists the environments (DB/DC, DBCTL, and DCCTL) from which the UPDATE OLREORG command and keywords can be issued.

Syntax

                                 .-,------------.     
                                 V              |     
>>-+-UPDATE--+--OLREORG--NAME--(---+-partname-+-+-)------------->
   +-UPD-----+                     '-*--------'       
   +-/UPDATE-+                                        
   '-/UPD----'                                        

   .-----------------------------.   
   V                             |   
>----+-SET(RATE(rate))---------+-+-----------------------------><
     '-OPTION--(--+-DEL---+--)-'     
                  +-NODEL-+          
                  +-REL---+          
                  '-NOREL-'          

Keywords

The following keywords are valid for the UPDATE OLREORG command:

NAME()

Specifies one or more PHDAM or PHIDAM HALDB partitions to be updated.

For the type-1 version of the command, you can specify only one partition name.

A parameter with the wildcard character (*) is not allowed, except as NAME(*) for all HALDB partitions.

SET(RATE)

Specifies the rate at which the HALDB OLR is run.

rate

You can specify a value of 1 to 100 for the rate value.

You can use the RATE parameter to control the intensity at which the reorganization runs. This can affect both the reorganization's speed and its impact on the rest of the system. The value you specify for rate is the percentage of elapsed time to be devoted to copying records. The remaining time is to be an intentionally introduced delay in the copying process that minimizes the reorganization's impact on other IMS™ work and on the whole system.

An online reorganization's impact on the system is affected by the available system resources, by total system utilization (including other online reorganizations), by total logging volume, by log contention, and by the intensity at which this reorganization was requested to run. These same factors also affect the speed at which the reorganization runs.

A rate value of 50 specifies that 50% of the elapsed time be spent copying records and the remaining 50% be spent in a delay. This causes the reorganization to run approximately twice as long as it would have run with a rate value of 100.

OPTION()

Allows the specification of the DEL, NODEL, REL, or NOREL options.

DEL | NODEL

Specifies whether the deletion of the inactive data sets is to be attempted when the online reorganization completes. DEL and NODEL are mutually exclusive keywords.

DEL

The deletion of the inactive data sets is to be attempted when the online reorganization completes. The attempted deletion occurs regardless of who created the data sets or when the data sets were created.

NODEL

The deletion of the inactive data sets is not to be attempted when the online reorganization completes.

If the partition is tracked at an RSR tracker site, the OPTION (DEL | NODEL) value in effect at the completion of the HALDB OLR also determines whether the inactive data sets for the shadow partition are deleted at the completion of the tracking of the reorganization.

If the HALDB Online Reorganization is stopped before completion, the DEL or NODEL keyword is not remembered and will need to be specified on the INITIATE OLREORG command that is issued to resume the stopped HALDB OLR.

REL | NOREL

Specifies whether the IMS system retains or releases control of the reorganization when it shuts down or terminates. REL and NOREL are mutually exclusive keywords.

REL

Specifies that the IMS system releases ownership of the OLR if it terminates before the online reorganization is completed. Specifying this keyword allows another IMS system to take control of the suspended reorganization.

The Partition Database record in the RECON data set is updated to show that the owning IMS (OLRIMSID=ssid) allows the OLR to be resumed if it terminates the online reorganization process or abnormally terminates itself. RELEASE OLR OWNERSHIP appears in a listing of the Partition Database record.

When OLR is active and running on an IMS and the IMS terminates abnormally, and if release OLR ownership is requested, the LIST.DB command will show OLRIMSID=ssid (instead of OLRIMSID=NULL) and RELEASE OLR OWNERSHIP because IMS was unable to request OLR ownership release.

Requesting release OLR ownership in an XRF environment: In an XRF environment, if release OLR ownership is requested while OLR is running on an active IMS, then OLR will not automatically resume on the new active IMS after an XRF takeover occurs. You must issue the INIT OLREORG command again on the new active IMS.

NOREL

Specifies that the IMS system retains control of the reorganization when it shuts down or terminates.

Usage notes

If an online reorganization is started with the ALTER option to modify the structure of the database, IMS reorganizes all of the partitions in the database. In this case, if you need to update the online reorganizations of all of the partitions in the database, specify an asterisk in the NAME keyword, for example UPDATE OLREORG NAME(*) SET(RATE(rate)). You cannot specify the name of the HALDB master database. You can use either the type-1 or type-2 format of the UPDATE OLREORG command to update alter processing; however, if the altered database is shared, only the type-2 command can be routed to all of the IMS systems that share the database.

Command responses for /UPDATE OLREORG

When the /UPDATE OLREORG command is entered as a type-1 command, the command response is returned in a message format.

When the command completes successfully message DFS0725I is returned to the system console and master terminal with a completion code of 0. If the command results in an error, a nonzero completion code or an error message is returned to the master terminal and system console.

DFS0725I INITIATE|UPDATE|TERMINATE OLREORG COMMAND FOR DB dbnamexx COMPLETE.
CC=  nn 
  where: dbnamexx is the HALDB partition name entered on the command
         nn       is the completion code

Output fields

Return, reason, and completion codes

The OM return and reason codes that might be returned as a result of the UPDATE OLREORG command are standard for all commands that are entered through the OM API.

The following table includes the return and reason codes and a brief explanation of the codes. The return or reason code returned for the command might also indicate an error from a CSL request.

The following table includes an explanation of the completion codes. Errors unique to the processing of UPDATE OLREORG command are returned as completion codes. A completion code is returned for each action attempted on a HALDB partition.