Command Line Interface

Optim™ provides a command line interface that allows you to run an Extract, Insert, Load, or Convert Process, run one or more processes from a file, or run a scheduled job, without opening the graphical user interface.

The command line interface can be run from the command line, or automatically—in a batch file, or from another program.

Command Line Tasks

Use the command line interface to:

  • Browse an Extract or Control File.
  • Run an Extract, Insert, Load, or Convert Process.
  • Run a scheduled job that includes several action requests.
  • Run multiple processes from a file.
  • Override original specifications for a process.
  • Restart or retry an Insert Process.

The following sections explain and describe how to perform each type of task. Process return codes are listed in the last section of this chapter.

Guidelines

The typical command begins with PR0CMND followed by command-line keywords and associated arguments. The following guidelines apply:

  • Command-line keywords can be specified in any order, separated by one or more spaces without commas.
  • Keywords can be specified in mixed case. (Most keywords are shown in this chapter using bold and uppercase for emphasis.)
  • Command-line keywords and associated arguments must be separated with an equal sign (=) or a colon (:).
  • An override keyword must be separated from the associated argument with a blank space.
  • The first operation argument must be prefixed by a forward slash (/) or dash (-).
  • A command-line keyword may be prefixed by a forward slash (/) or a dash (-). Example: PST, /PST, and -PST are equal keywords.
  • An argument associated with a command-line keyword that includes spaces must be enclosed in single or double quotes.
  • Use double quotes to enclose a command-line keyword argument that includes a macro.
  • You can include all keywords and arguments in a parameter file and then specify 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 a process request.
  • 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 override keyword END must follow the last override, and must also be on a separate line.
  • If you use a keyword that is inappropriate for the type of processing requested, a fatal conflicting-parameter error may result.
  • 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 (//).

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.
{ }
Indicates a choice of two or more settings from which only one must be selected.
|
Separates options.