Command-line Keywords For Archive, Delete, Report, and Restore Requests

Use the following commands and parameters on the command line for Archive, Delete, Report, and Restore Requests.

General

PR0CMND
The command to initiate command line processing. The character following PR is the number 0 (zero).
/R
Command to run the specified job, action request(s) specified in a parameter file, or action request specified on the command line. Use /R or -R.
JOB=
Command to run a scheduled job from the command line. A scheduled job can include one or more action requests and corresponding overrides. Use the Scheduling Editor to define the parameters for a scheduled job. Refer to the Common Elements Manual for additional information.

The JOB keyword does not apply in a UNIX or Linux environment and is ignored.

jobname
Name or description of the job (30 character maximum).
@path.paramfilename.txt
@ followed by the full path and name of a text file of parameters for the process(es) to run. Enter all parameters for each request on a single line of the file.
parameters
You can provide parameters for the process on the command line. Enter all parameters on the same line as the rest of the command.

Parameters

Use the following parameters, whether in a parameter file or specified on the command line, as needed:

TYPE=
Type of process as one of the following:
ARCHIVE
Archive data.
DELETE
Delete archived data from the database.
REPORT
Create a report from data in an Archive File.
RESTORE
Place archived data into the original or other database.
REQUEST=
The action request to be processed.
identifier.name
Two-part name of the action request.
STOP=
Error processing indicator. Can be used only in a parameter file, not on the command line or for scheduled jobs. The error code is applied for the action request identified by preceding REQUEST parameter before the next process, if any, begins.

Indicate the level of error for which processing must stop as one of the following:

N
None; continue processing, regardless of errors (default).
I
Stop processing if an informational, warning, or fatal error occurs (return code of 4 or greater).
W
Stop processing if a warning or fatal error occurs (return code of 8 or greater).
F
Stop processing if a fatal error occurs (return code 12).
OUTPUT=
File for process reports for all processes in a parameter file. If you use the OUTPUT keyword more than once, the last file specified is used for all processes.

If you do not use this keyword, the report is displayed after each process and you must close the report dialog to execute the next process. In a UNIX or Linux environment, the report is displayed to the console.

filename
The name of the file. If you do not provide the full path, the file is saved in the default Data Directory, identified in Personal Options.
+
Append the report to an existing file.
QUIET
Indicator for displaying prompts or error dialogs during all processes in a parameter file. If you use the QUIET keyword more than once, the last specification is used for all processes.

In a UNIX or Linux environment, prompts and error dialogs are unavailable and the QUIET setting is ignored.

+
Do not display prompts or error dialogs (default).
Display prompts and error dialogs. If functional security is enabled, Invoke privilege is required to run a process that displays editor interfaces. For example, the Invoke Archive Request and the Invoke Insert Request privileges are required to run an Archive Process that uses a named Insert Process when QUIET– is used.
MONITOR
Indicator for displaying progress dialogs during all processes in a parameter file. If you use the MONITOR keyword more than once, the last specification is used for all processes.

In a UNIX or Linux environment, progress dialogs are unavailable and the MONITOR setting is ignored.

+
Display progress dialogs.
Do not display progress dialogs (default).
SERVER=
The server on which to process. Overrides any server specification in the action requests processed from the command line.

Using this keyword when running a Restore Request, or in conjunction with the SERVER override causes an error.

servername
The name of an Optim™ Server that is referenced in the Product Configuration File.
(local)
Process on the local Server. (Default)
PST=
The Optim Directory for processing. If processing uses the current (default) Optim Directory, this keyword is not needed.
pstdirectory
Optim Directory name.
OV=
Source of process overrides. The OV keyword must follow all other command line keywords.
overridefilename.txt
The name of a text file containing process overrides only, with each override on a separate line.
*
If you use a parameter file, overrides follow on successive lines of the parameter file. The first override (keyword and associated argument) must begin on the following line, and each additional override must be on a separate line.
An override file is the only method available to provide overrides unless you use a parameter file. If using a parameter file, however, you can provide overrides in a text file or in the parameter file with the END keyword following the last override.