Using the Restore Request Editor

Use the Restore Request Editor to create, modify, or delete a Restore Request. You can save a set of parameters as a named Restore Request to be reused, or to use as a model for future Restore Requests. Restore Requests are stored in the Optim™ Directory.

Restore Request Editor. The elements of the Restore Request Editor are described as follows.

In addition to providing processing instructions, a Restore Request lists Archive Files that serve as templates for categories of Archive Files or that contain the archived data to restore. The Restore Request also lists Insert or Load Requests that may be used to restore selected data.

The Restore Request Editor allows you to describe a precise set of archived data and easily restore it to a database. You can define criteria to list Archive Files that are likely to contain the data to restore, and define additional criteria to select specific data from the Archive Files. You can also browse the Archive Files to confirm and review the archived data before you begin the Restore Process.

Description
Text that describes the purpose of the Restore Request (up to 40 characters). This information can help identify a Restore Request in a selection list.
Global Selection Criteria Defined
Indicator for global selection criteria. This check box is available and selected when you click Tools > Apply Global Selection Criteria and define criteria on the Global Selection Criteria dialog. Clear this check box to remove global selection criteria and disable the check box. See Define Search or Selection Criteria.
Automatically Generate Subset Extract Files at Runtime

When you restore part of an Archive File (that is, when you perform a selective restore), the subset of data to restore is extracted from the Archive File and stored in a Subset Extract File. Select this check box to generate a name for each Subset Extract File, as needed. Generated file names are in the form pstnnn.xf, where nnn is a number that is not used in the name of an existing Subset File. The files are stored in the default Data Directory or in the Temporary Work Directory, according to the option selected on the Archive tab in Personal Options.

If you clear this check box, you must provide a Subset Extract File name for each Archive File to which you have applied selection criteria. If the name you provide is not fully qualified, the Subset Extract File is stored in the default Data Directory.

Compress Subset Extract Files
Select this check box to compress Subset Extract Files automatically.
Delete Subset Extract File after successful Restore

Select this check box to delete any Subset Extract Files created during a successful Restore Process automatically. Subset Extract Files saved on secondary media (for example, a drive for removable media) are not deleted. You can choose to retain a Subset Extract File and reuse it.

Continue Processing if Errors
Select this check box to continue processing any unprocessed Archive Files after an error condition. (No prompt is displayed.)
Archive Files List

A list of the Archive Files that are referenced by the Restore Request.

For a detailed description of the items in this list, see Archive Files List.

Restore Process

Options allow you to choose the method used to restore data. Select one of the following options:

Insert
Use the Insert Process to restore data. The database is available to other users during Insert Processing. Also, an Insert Process can provide one-step Update/Insert Processing. See Insert for more information about the Insert Process.
Load
Use a Load Process to transform the data into a format appropriate for a DBMS loader and start the database load utility used to restore the data. For a large volume of data or because of referential integrity cycles, a Load Process may be preferred over an Insert Process. See Load for more information about the Load Process.
Insert Request Selection Mode (or Load Request Selection Mode)

Because the data model of your production database may change over time, you can list several Insert or Load Requests in the Restore Request and provide criteria needed during processing to match an Archive File with the appropriate Insert or Load Request. Use these options to specify the type of criteria used. During processing, an Archive File is matched with listed Insert or Load Requests on the basis of the Request Selection Mode and the criteria provided. The first request that matches the Archive File is used to restore data in that Archive File. If no match is found, data from the Archive File is not restored, and an error occurs.

To be used to restore data from an Archive File, an Insert or Load Request must be compatible with the Archive File. In general, an Insert or Load Request is compatible with an Archive File if the data model for the Source File, specified in the Insert or Load Request is the same as the data model for the Archive File.

The heading on the list reflects the Restore Process option you select. For example, if you select Insert as the Restore Process, the title is Insert Request Selection Mode. If Load is the Restore Process, the title is Load Request Selection Mode.

The options are:

Data Model
Use the first listed Insert or Load Request that matches the data model of the Archive File to be restored. To match the Archive File, the Source File in an Insert or Load Request must contain the same number of tables with the same names.

Also, if the Table Map used with the Insert or Load Request references a Column Map, the Column Map must apply to the same columns as in the corresponding table in the Archive File, with compatible data types.

Date
Use the first listed Insert or Load Request for which the specified date range includes the creation date of the Archive File to be restored.
Description
Use the first listed Insert or Load Request for which the specified description matches the Description for the Archive File to be restored.
Group
Use the first listed Insert or Load Request for which the specified group matches the Group designation for the Archive File to be restored.
Insert Requests List (or Load Requests List)

This lists the Insert Requests or the Load Requests that you can use to restore data.

The heading on the list reflects the Restore Process option you select. For example, if you select Insert as the Restore Process, the title is Insert Requests List. If Load is the Restore Process, the title is Load Requests List.

For a detailed description of the items in this list, see Insert Requests List (or Load Requests List).

Archive Files List

This lists the Archive Files that are referenced by the Restore Request. The Archive Files list contains the following:

Archive File
The names of Archive Files referenced by the Restore Request. Archive Files are processed in the order in which they are listed. You can change the order by dragging a grid row number to the desired position.
Note: The order in which files are processed might inadvertently cause old data to supersede new data.
To remove, add, or replace Archive File names, right-click and select a command from the shortcut menu. To browse a listed Archive File, click Browse in the shortcut menu.
Status
The status of each Archive File. Archive automatically provides status information about a listed Archive File, as follows:
(blank)
The Archive File is valid and accessible.
Not Found
The Archive File cannot be found and no Archive Directory information is available.
Inaccessible
The Archive File is not available to the workstation.
Invalid
The listed file is not an Archive File.
Unregistered
The Archive File is not registered in the Archive Directory.
Server
The name of the server on which the Archive File resides or (Local) if the Archive File was created on a workstation. Archive automatically provides this information about a listed Archive File.
Group
Group information from the Archive Directory. If a listed file is not registered, the information is obtained directly from the file and the grid cell is cross-hatched. If a file is stored on a drive that is not accessible directly, the grid cell is blank.
Created Date
The date the file was created. This information is taken from the Archive Directory. If a listed file is not registered, the information is obtained directly from the file and the grid cell is cross-hatched. If a file is stored on a drive that is not accessible directly, the grid cell is blank.
Description
Description information from the Archive Directory. If a listed file is not registered, the information is obtained directly from the file and the grid cell is cross-hatched. If a file is stored on a drive that is not accessible directly, the grid cell is blank.
Modified AD
A modified Access Definition, saved with the Restore Request, is used to select archived data to restore. (For example, a modified Access Definition may be needed to restore data using a Start Table different from that used to archive the data.) The Modified AD check box is selected automatically if you alter the Access Definition in the Archive File and save the modified version with the Restore Request.

To edit the original or a modified Access Definition, right-click the Archive File name and click Browse > Access Definition > Modified or Browse > Access Definition > Original in the submenu. Archive displays the Access Definition in the Access Definition Editor. You can then change the Start Table and the traversal path, or specify reference tables for restoring data from the Archive File.

Clear the check box to revert to the original Access Definition.

Sel Crit
The type of selection criteria applied to the Archive File. You must specify selection criteria to selectively restore archived data.
Local
Criteria specific to this Archive File applies.
  • To copy global criteria as local, right-click a grid cell for the Archive File and click Copy Global Selection Criteria.
  • To set all listed Archive Files to local selection criteria, right-click a grid cell for an Archive File and click Set All > Local in the shortcut menu.
  • To define or edit local criteria, right-click a grid cell for the Archive File and click Apply Local Selection Criteria in the shortcut menu to open the Local Selection Criteria dialog.
  • To use no criteria for an Archive File, right-click a grid cell for the Archive File and click Remove Selection Criteria.
Global
Global criteria applies to this Archive File.
  • To replace global criteria with local criteria, right-click a grid cell for the Archive File and click Replace Global Selection Criteria.
  • To use global selection criteria for this file, right-click a grid cell for the Archive File and click Use Global Selection Criteria.
  • To set all listed Archive Files to global selection criteria, right-click a grid cell for an Archive File and click Set All > Global in the submenu.
  • To define or edit global criteria, click Tools > Apply Global Selection Criteria in the menu to open the Global Selection Criteria dialog.
  • To use no criteria for an Archive File, right-click a grid cell for the Archive File and click Remove Selection Criteria.
None
No selection criteria apply to this Archive File.
  • To use no criteria for an Archive File, right-click a grid cell for the Archive File and click Remove Selection Criteria.
  • To use no selection criteria for all listed Archive Files, right-click a grid cell for the Archive File and click Set All > None in the submenu.
Restore Row Limit
Specify the maximum number of rows to restore. To set no limit to the number of rows to restore, specify zero (0) or leave blank. The Restore Process is terminated if the number of restored rows exceeds this limit.
Subset Extract File
When you restore a subset of data, it is extracted from the Archive File and stored in a Subset Extract File. You must provide a name for the Subset Extract File, unless you select the Automatically Generate Subset Extract Files at Runtime check box. When naming a Subset Extract File, you cannot specify a path to the same drive for removable media on which the Archive File is stored.
Right-click the Archive Files list in the Restore Request Editor to display shortcut menu commands. These commands help you accomplish many tasks needed to define a Restore Request. In addition to typical Cut, Copy, Paste , Clear, and Select All commands, you can select commands to:
Remove
Remove an Archive File name from the list.
Remove All Archive Files
Remove all Archive File names from the list.
Add Archive Files
Add Archive File names on the basis of information in the Archive Directory Index or by browsing the File System.
Replace Archive File
Replace the selected Archive File name with one from the Archive Directory or the File System.
Browse
Browse the original or a modified version of the Access Definition, or the contents of the Archive File. If the Restore Request has run, you can also browse the Control File generated during the Insert or Load Process, any Subset Extract File, or the Restore results pertaining specifically to that Archive File.
When browsing an Access Definition, you can:
  • Change the Start Table used to begin the Restore Process.
  • Redefine the Relationship traversal path.
  • Create new or modify existing substitution variables to be used to specify local selection criteria for an Archive File.
  • Designate a table as a reference table, or remove the reference table designation for any table.
If you make any changes, the modified Access Definition is saved with the Restore Request, without modifying the original.
For more information, see the Common Elements Manual .
Apply Local Selection Criteria
Display the Local Selection Criteria dialog. Use this dialog to define, modify, and apply local selection criteria to the selected Archive File.
Copy Global Selection Criteria
Copy global selection criteria to replace any local selection criteria for the selected Archive File. You can open the Local Selection Criteria dialog and modify the copied criteria, as necessary. The criteria applies only to the selected Archive File.
Use Global Selection Criteria
Apply global selection criteria to the selected Archive File.
Remove Selection Criteria
Remove selection criteria for the selected Archive File.
Replace Global Selection Criteria
Copy local selection criteria for the selected Archive File to replace global selection criteria. You can open the Global Selection Criteria dialog and modify the copied criteria, as necessary. The criteria is used with all Archive Files to which global selection criteria applies.
Set All
Click Set All > None from the shortcut menu to remove selection criteria settings for all Archive Files listed in the Restore Request. Click Set All > Local or Set All > Global from the shortcut menu to apply that setting to all Archive Files listed in the Restore Request. Local selection criteria must be defined in order to apply.
Clear All Modified ADs
Drop any modified Access Definitions for listed Archive Files.
Create Insert (or Load) Request
Open the Insert Request Editor or Load Request Editor to create an Insert or Load Request with the Archive File as the Source File. The type of editor that opens depends on the Restore Process selection in the Restore Request Editor. You can create a new, named request or a local request.
Determine Insert (or Load) Request Selection
Evaluate the compatibility of listed Insert (or Load) Request with the selected Archive File. If a listed Insert or Load Request contains a set of parameters suitable for the Archive File, the row containing the request name flashes briefly. If not, a message is displayed.

Insert Requests List (or Load Requests List)

The heading on the Requests list reflects the Restore Process option you select. For example, if Insert is selected as the Restore Process, the heading is Insert Requests. If Load is the Restore Process, the heading is Load Requests.

Archived data is restored using the first Insert or Load Request in the list that matches the Archive File. A match is determined on the basis of criteria provided to the right of the Insert or Load Request name. You can change the order of the requests by dragging a grid row number to the desired position.

Request Name
The Insert or Load Requests that can be used in the Restore Process. If a listed request is stored in the Directory, the name is displayed. If an Insert or Load Request is saved as part of the Restore Request, it is listed as (Local).
Using the shortcut menu, you can add an existing, or create and add a new Insert or Load Request to the list.
  • To add an insert request, right-click the Insert Requests grid and click Add Insert Request > Existing, Add Insert Request > New Local, or Add Insert Request > New Named from the shortcut menu.
  • To add a load request, right-click the Load Requests grid and click Add Load Request > Existing, Add Load Request > New Local, or Add Load Request > New Named from the shortcut menu.
  • To edit a listed request, right‑click the grid and click Edit Request.
See Insert for information needed to create or edit an Insert Request or Load for information needed to create or edit a Load Request.
Note: If the Request Selection Mode is Data Model, it might be helpful to use the shortcut menu from the Archive Files List to create an Insert or Load Request with the selected Archive File as the Source File.
Criteria
The grid column heading and the criteria used to match an Insert or Load Request with an Archive File varies according to the selected Request Selection Mode option.

If the Request Selection Mode is Data Model, the heading is:

Description
The data model is the only criteria for this selection mode. The description for each listed Insert or Load Request is displayed for reference.
If the Request Selection Mode is Date, the headings are:
Start
Enter the beginning date in a range of Archive File creation dates.
End
Enter the ending date in a range of Archive File creation dates.
Notes:
  • If you do not enter a Start or End Date, any date is valid.
  • If you enter a Start Date only, the range includes Archive Files created after the Start Date but before the current date.
  • If you enter an End Date only, the range includes Archive Files created before the End Date.
If the Request Selection Mode is Description, the heading is:
Description
Enter the case-sensitive Archive File Description needed for data to be restored using the Insert or Load Request.
If the Request Selection Mode is Group, the heading is:
Group
Enter the case-sensitive Archive File Group designation needed for data to be restored using the Insert or Load Request.

Right-click the Requests list in the Restore Request Editor to display shortcut menu commands. These commands help you accomplish certain tasks needed to define a Restore Request. In addition to typical Cut, Copy, Paste, Clear, and Select All commands, you can select commands to:

Remove
Remove an Insert or Load Request from the list.
Remove All
Remove all Insert or Load Requests from the list.
Add Insert Request (or Add Load Request)
Add an Insert or Load Request to the list. Select one of the following commands from the submenu:
Existing
Open the Select an Insert Request dialog or the Select a Load Request dialog. Use this dialog to select an existing Request from the Directory and add it to the list.
New Local
Open the Insert Request Editor or the Load Request Editor. Use this dialog to create and list a new local Request that is saved with the Restore Request.
New Named
Open the Insert Request Editor or the Load Request Editor. Use this dialog to create and list a new named Request that is saved in the Directory and can be used with other Restore Requests.
Edit Request
Open the Insert Request Editor or the Load Request Editor to edit the Insert or Load Request selected from the list.

See Insert for information needed to create or edit an Insert Request, or Load for information needed to create or edit a Load Request.

Menu Commands

In addition to the standard File, Edit, and Tools commands, you can select the following commands from the Tools menu.

Apply Global Selection Criteria
Open the Global Selection Criteria dialog and define or edit selection criteria for all files that do not have local selection criteria. After global selection criteria is defined, the Global Selection Criteria Defined check box is available and selected. For information about defining global selection criteria, refer to Define Search or Selection Criteria.
Remove Global Selection Criteria
Delete global selection criteria specifications. The Global Selection Criteria Defined check box is unavailable and cleared. Clearing the Global Selection Criteria check box has the same effect as selecting this menu command.