The following syntax is used to generate a statement for
each exported Archive Request definition:
Keywords
The
keywords correspond to values that can be specified for an Archive
Request.
- ARCH id.name
- The name of the Archive Request, specified in two
parts (identifier.name) is required following the CREATE
ARCH keyword.
- DESC //description//
- A description of the Archive Request, delimited
by double slashes.
General
- AF archivefile
- The fully qualified name of the Archive File, which
is the output of the Archive Process.
- AFX archiveindexfile
- The fully qualified name of the Archive Index File,
which is the file created when Archive index criteria is specified
in the Access Definition for the Archive Process.
- GROUP group
- Logical group name to help qualify and categorize
the Archive File and corresponding archived data.
- STORAGE_PROFILE storprofname
- The name of the Storage Profile for the Archive
Request. The name of the Storage Profile follows the keyword.
- ROWLIMIT n
- A limit for the number of rows (n)
that can be archived. If the Archive Definition does not include a
Row Limit, the value is “0.”
- SERVERNAME server
- If the optional Optim™ Server
is installed on your network, specifies the server on which to process
the request.
- DEFER_DAA {Y|N}
- When the Access Definition includes instructions
to delete archived rows, this keyword can instruct Archive to bypass
those instructions.
- Y
- Do not delete archived rows as part of the Archive
Process.
- N
- Delete archived rows
- REVIEW_DELETE {Y|N}
- Displays the Delete After Archive Specifications dialog
during processing for review and override of Access Definition delete
options for the tables to be archived.
- COMPRESSFILE {Y|N}
- Indicator for whether to compress the Archive File
after processing.
- GENSTATISTIC {Y|N}
- Indicates if statistical information is included
in the Archive Process Report.
- PROCESS_FILEATTACH {Y|N}
- Indicates if file attachments specified in the
Access Definition are extracted.
- CREATEREPORT {Y|N}
- Indicator for whether to create a Report on the
Archive File after processing.
AD Keywords
An
Access Definition parameter must be included. The Access Definition
can be Local or Named.
- AD adname
- The full two-part name of the Named Access Definition
being used.
- LOCALAD (addef)
- A full definition of the Local Access Definition
being used, contained in parentheses, follows this keyword. The syntax
and parameters for the definition of a Local Access Definition are
identical to those for a Named Access Definition.
Report Keywords
The
optional Report parameter can be defined as Local or Named:
- REPORT id.name
- The full two-part name of the Named Report Request
Definition being used.
- LOCALREPORT (reportdef)
- A full definition of the Local Report being used,
contained in parentheses, follows this keyword. The syntax and parameters
for the definition of a Local Report are identical to those for a
Named Report Request.
Objects
This
parameter relates to the ability to archive objects when performing
the Archive Process.
- INCLPK {Y|N}
- Indicates whether primary keys are included in the
Archive Process.
- INCLFK {Y|N}
- Indicates whether foreign keys and relationships
are included in the Archive Process.
- INCLIDX {Y|N}
- Indicates whether indexes are included in the Archive
Process.
- INCLALIAS {Y|N}
- Indicates whether aliases are included in the Archive
Process.
- INCLFUNCTION {Y|N}
- Indicates whether functions are included in the
Archive Process.
- INCLPACKAGE {Y|N}
- Indicates whether packages are included in the Archive
Process.
- INCLPROCEDURE {Y|N}
- Indicates whether procedures are included in the
Archive Process.
- INCLSEQUENCE {Y|N}
- Indicates whether sequences are included in the
Archive Process.
- INCLTRIGGER {Y|N}
- Indicates whether triggers are included in the Archive
Process.
- INCLVIEW {Y|N}
- Indicates whether views are included in the Archive
Process.
- INCLDEF {Y|N}
- Indicates whether defaults are included in the Archive
Process.
- INCLRULE {Y|N}
- Indicates whether rules are included in the Archive
Process.
- INCLUDT {Y|N}
- Indicates whether UDTs are included in the Archive
Process.
Point and Shoot
The PNSOPT, LOCALRL and ROWLIST keywords
are related:
- PNSOPT or PNSOVERRIDE specifies
the Point and Shoot option for the Archive Request.
- If PNSOPT is F, the ROWLIST parameter
must follow.
- If PNSOPT is L, the LOCALRL parameter may follow,
as an option (you can select LOCAL for Point and Shoot without defining
a Row List file).
- ROWLIST may be included
in the exported definition even if the PNSOPT is
N or L (or omitted), because the Archive Request may have previously
had a ROWLIST in use. A previously used Named
Row List file reference will be retained as part of the Archive Request,
even if the PNSOPT is no longer F.
- PNSOVERRIDE {Y|N}
- Indicates whether to override the Point and Shoot
Definition in the Access Definition for the Archive Request. Specify
Y to override the Point and Shoot Definition in the Access Definition.
Specify N to use the Point and Shoot Definition in the Access Definition.
- PNSOPT {L|F|N}
- (Point and Shoot) indicates
the Point and Shoot option for the Archive Request. The options are:
- L
- Local Row List; LOCALRL and ROWLIST are
optional additional keywords.
- F
- Named Row List; ROWLIST must
follow.
- N
- None; ROWLIST is an optional
additional keyword.
- ROWLIST filename
- The fully qualified name of the external Named Row
List for the Archive Request.
- LOCALRL //string//
- The definition of the Local Row List for the Archive
Request. Long character strings such as Row List definitions are delimited
by two forward slashes (//). Continuation characters are not used,
and no spaces or indentations are added. If additional spaces or continuation
characters are inserted, the string is imported incorrectly. The text
continues for the complete length of the line, wrapping to the next
line until the forward slashes are reached, indicating the end of
the text.
Variables
There
is a VARS entry only when a variable(s) has
been defined for the Access Definition being used in the Archive Request.
- VARS //string//
- A list of the variables used in the Archive Request:
- The information is delimited by double slashes.
- Commas are used between variables.
- Single slashes are used between variable names and
default values.
- ALWAYSPROMPT {Y|N}
- (Always Prompt for Values at Run Time)
indicates whether a prompt for variable values is automatically displayed
during Archive Processing.
- Y
- The prompt for variable values is automatically
displayed during Archive Processing.
- N
- The prompt for variable values is not automatically
displayed during Archive Processing.
Note: Prompt strings are not exported as part of the
Archive Request, only variable names and default values. If the Access
Definition used in the Archive Request is exported as a subordinate
object (or if a Local Access Definition is used), prompt strings are
exported as part of the Access Definition.
Delete
There
are Delete options only when the keyword value for DEFER_DAA is N.
- CF control file
- The fully qualified name of the Control File for
the Delete Process, as applicable.
- DELCF {Y|N}
- Indicator for whether to discard the Control File
if action is successful.
- DISCARDLIMIT n
- The maximum number of rows (n)
that can be discarded.
- COMMITFREQ n
- The frequency (every nth row)
at which commits are issued.
- LOCKTBLS {Y|N}
- Indicates whether tables are locked during the Delete.
- Y
- Tables are locked.
- N
- Tables are not locked.
Object List
This
parameter relates to the ability to extract extended objects.
- OBJQUAL dbalias.creator
- The name of the Default Qualifier for the extended
objects (dbalias.creator).
- IGNOREUNKNOWN {Y|N}
- Indicator for ignoring unknown or unavailable objects.
- OBJECT objname=type
- Each extended object, identified by name, and type
of object: function, package, procedure, sequence, view, default,
rule, or UDT.
Notify
This
parameter relates to the ability to send notification via email about
the outcome of the process.
- EMAILNOTIFY {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.