Command Line Interface — Processing Utilities

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:

Note: You may also use the command line interface to automate Archive Directory Maintenance functions. See Command Line Interface — Maintenance Utilities for details.

Guidelines

A typical command begins with PR0CMND, followed by an operation argument, command‑line keywords and associated arguments. The following guidelines apply:

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.)