This syntax is used for each exported Restore Request definition:
Keywords
The
keywords correspond to values that can be specified for a Restore
Request. For additional information, see the Archive User Manual.
- REST identifier.name
- The name of the Restore Request, specified in two
parts (identifier.name) is required following the CREATE
REST keyword.
- DESC //description//
- A description of the Restore Request, delimited
by double slashes.
- ACTION {INSERT|LOAD}
- The type of process to use for the Restore Request,
Insert or Load.
- SELECTION_MODE {DATAMODEL|GROUP| DATE|DESC}
- Indicator for type of criteria used to match Archive
Files to Restore with the appropriate Insert or Load Request.
- DELETE_XFFILES {Y|N}
- Indicator for deleting subset Extract Files, if
any, after the Restore Process. When selection criteria are applied
to Archive Files in a Restore Request, subset Extract Files are created.
Y causes the subset Extract Files to be deleted at the successful
conclusion of the Restore Process.
- AUTO_GEN {Y|N}
- Indicator for subset Extract File names, as applicable.
If selection criteria are applied to Archive Files for the Restore
Process, subset Extract Files are created. Y indicates the names are
automatically generated. If N, the keyword XF is used to identify
the subset Extract File name.
- CONTINUE_ON_ERROR {Y|N}
- Indicator for processing when errors occur.
- COMPRESSFILE {Y|N}
- Indicator for whether to compress the Subset Extract
File after processing.
- FILE archivefile
- The fully qualified name of the Archive File used
as input for the Restore Process.
- ARCHIVE_ID n
- The numerical Archive File identifier, which can
be used instead of the file name.
- SERVERNAME server
- Name of the server on which the specified Archive
File resides.
- XF subsetextractfile-name
- The name of the subset Extract File. If global
or local selection criteria are specified, a subset Extract File is
created.
- AD_OVERRIDE //string//
- Indicates changes made to the Access Definition
for the Archive File.
- PARMS //string//
- There is a PARMS entry only
when a variable(s) has been defined for the specified Archive File
in the Restore Request.
Each variable is listed
in the following form:
(name,“prompt
string”,default value )
- Each variable is enclosed in parentheses and is
separated by commas.
- Commas are used between variable names, default
values, and prompt strings.
- ROWLIM n
- A limit for the number of rows (n)
that can be restored from the Archive File. If the Restore Request
does not include a Row Limit, the keyword is not included in the definition.
- SELCRIT_USE {N|G|L}
- Indicator for type of selection criteria to use.
- N
- None
- G
- Global
- L
- Local
- TABLEOP {A|O}
- Criteria connector for when multiple local selection
criteria or SQL statements are specified.
- A
- And
- O
- Or
- TABLE tablename
- The fully qualified name of the table for which
local selection criteria is defined.
- PREDOP {A|O}
- Criteria connector for when multiple selection
criteria or multiple SQL statements are specified.
- A
- And
- O
- Or
- SQL //string//
- An SQL WHERE clause for the specified table.
- COLUMN column
- The column name for which local selection criteria
applies.
- OP operator
- Indicates the relational operator used for the
local selection criteria.
- PRED //string//
- Value for the local selection criteria.
- PARM
- Indicates each of the Insert or Load Requests contained
in the Restore Request.
- LOCALDEF text for insert|text for load
- Parameters for each local Insert or Load Request
follow this keyword, as applicable.
- DEF id.name
- The name of the Insert or Load Request, specified
in two parts (identifier.name).
- VALUE1 //string//
- The value used as criteria to match the Insert
or Load Request with the Archive File to be restored. Provide two
values if specifying a date range.
- GLBLCRIT
- Global selection criteria for a specified table
applied to one or more Archive Files in a Restore Process.
- TABLEOP {A|O}
- Criteria connector for when multiple global table
selection criteria or SQL statements are specified.
- A
- And
- O
- Or
- TABLE tablename
- The fully-qualified name of the table for which
global selection criteria is defined.
- PREDOP {A|O}
- Criteria connector for when multiple global column
selection criteria or SQL statements are specified.
- A
- And
- O
- Or
- SQL //string//
- An SQL WHERE clause for the specified table.
- COLUMN column
- The column name for which global selection criteria
applies.
- OP operator
- Indicates the relational operator used for the
global selection criteria.
- PRED //string//
- Value for the global selection criteria.
Notify
This parameter relates to the ability
to send notification via email about the outcome of the process.
- EMAIL NOTIFY {A|S|F} emailaddress
- Indicates the process outcome under which to send
notification to the corresponding email address.
- A
- Always send notification.
- S
- Send notification when process succeeds.
- F
- Send notification when process fails.