The Archive command line interface allows you to perform
Archive tasks without using the graphical user interface for Archive.
You can use the command line interface to archive or restore archived
data programmatically.
You can use the command line to run one or more Archive,
Restore, Delete, or Report Processes, or you can use the command line
to schedule a job. The command line interface can be run from the
command line, or automatically—in a batch file, or from another program.
You can also search and restore data in one process from the command
line. The Search and Restore Process is useful for restoring archived
data programmatically, when you are unsure of the exact Archive File
that contains the archived data. Refer to Search and Restore Process for complete information.
Although you can execute these functions using the
graphical user interface, it may be more convenient to create one
or more basic Action Requests (for example, Archive Request or Restore
Request), which can be run from the command line using parameters
in a parameter file or in an override file. The file can be generated
by an external application.
Preparation
In
preparation for command line processing, at least one typical, or
“model” Action Request must be prepared and saved. For example, a
model Restore Request might reference Archive Files that represent
the data model (tables, relationships), and an Insert or Load Request
that similarly matches the data model. This model Restore Request
provides the Request Selection Mode, and the Insert or Load Request
information for Restore processing. The Restore Request can also provide
global selection criteria.
Command Line Tasks
Use
the command line interface to automate:
- Archive, Delete, Restore, or Report Processes, providing
relevant overriding specifications for a previously created Action
request in an application-generated parameter file.
- Multiple processes using a parameter file.
- Scheduled jobs that include several action requests.
- Searches and restorations of archived data.
- Restarting or retrying a Delete or Insert Process.
Guidelines
A
typical command begins with PR0CMND, followed by
an operation argument, command‑line keywords and associated arguments.
The following guidelines apply:
- The first operation argument must be prefixed with
a forward slash (/) or dash (-). To run a process, for example, use /R or -R.
- A command-line keyword may be prefixed by a forward
slash (/) or dash (-), but it is not required. Example: PST, /PST,
and -PST are equal and valid keywords.
- Generally, command-line keywords can be specified
in any order, separated by one or more spaces without commas. When
overrides are specified for a process defined in a parameter file,
the OV keyword must follow other command-line keywords
and precede the override parameters. The first override keyword and
associated argument must begin on the following line, and each additional
override must be on a separate line. The END keyword
must follow the last override, and must also be on a separate line.
- A command-line keyword and associated argument are
separated by an equals sign (=) or a colon (:),
with no intervening spaces.
- An override keyword and associated argument are
separated by a blank space.
- Keywords are recognized without regard to case.
(Most keywords are shown in this chapter using bold and uppercase
for emphasis.)
- Use double quotes to enclose a command-line keyword
argument that includes a macro.
- An argument associated with a keyword that includes
spaces must be enclosed in single or double quotes.
- You can include all keywords and arguments in a
parameter file and reference the parameter file on the command line.
- In a parameter file, command-line keywords corresponding
to a process request can be entered on one or multiple lines. You
can include several process requests in the file; each must begin
with the TYPE parameter.
- Use override keywords and arguments to override
specifications in an action request.
- A keyword that is inappropriate for the type of
processing requested may cause a fatal conflicting-parameter error.
- The following relational operator symbols and mnemonics
are acceptable for use in selection criteria overrides: =, <, >, <=, >=, !=, !<, !>, <>, ^=, ^<, ^>, EQ, NE, LT, GT, LE, GE, BETWEEN, LIKE, IN, IS, NOT, NULL.
- Comments in a parameter or override file must begin
on a separate line and start with two forward slashes (//).
Blank lines may also be included in the parameter stream.
Syntax Conventions
The
syntax conventions used to describe these statements are:
- KEYWORD
- Keywords are shown in uppercase for emphasis, but
can be specified in lower or mixed case.
- text
- Variable text is shown in lowercase italics.
- ( )
- Statement delimiter to group a series of qualifiers
for a parameter.
- [ ]
- Indicates an optional parameter. (Square brackets
are not actually used in the command line.)
- { }
- Indicates a choice of two or more settings from
which one (and only one) must be selected. (Brackets are not actually
used in the command line.)
- |
- Separates options. (The pipe symbol is not actually
used in the command line.)