Command-line Keywords
Keywords used for command line processing are explained in this section.
General
- PR0CMND
- Type PR0CMND to initiate command line processing. Note that the character following PR is the number 0 (zero).
- /X=
- Command to start the Browse Utility.
- extfilename.xf|cmpfilename.cf
- Name of the Extract or Compare File to browse. If the file is not in the default Data Directory, specify the full directory path.
- /R
- Command to run the specified job, action request(s) specified in a parameter file, or action request specified on the command line.
- JOB=
- Use the JOB keyword 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.
- jobname
- Name or description of the job (30 character maximum).
- @path.parameter filename.txt
- Specify @ followed by the fully qualified path and name of a text file containing the parameters for the process(es) to be run.
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:
- COMPARE
- Compare data.
- EXTRACT
- Extract data.
- REPORT
- Create a report from data in a Compare or Extract File.
- 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, the MONITOR setting is ignored. Use the P parameter, shown below.
- +
- Display progress dialogs.
- –
- Do not display progress dialogs (default).
- P
- Controls whether the progress of a process request
is displayed. Note:
- Console progress display requires a Locale specification which supports format settings and language support. For example: export LANG=POSIX
- The display is updated at a rate of 5000 rows. For Windows users, attempting to change this rate by specifying a value less than 5000 for Monitor Update Frequency on the Personal Options Actions tab is not recommended, as it may have a negative impact on performance.
- +
- Displays the request progress.
- -
- Suppresses display of the request progress. This is the default.
- P
- Controls whether the progress of a process request
is displayed. Note:
- Console progress display requires a Locale specification which supports format settings and language support. For example: export LANG=POSIX
- The display is updated at a rate of 5000 rows. For Windows users, attempting to change this rate by specifying a value less than 5000 for Monitor Update Frequency on the Personal Options Actions tab is not recommended, as it may have a negative impact on performance.
- +
- Displays the request progress.
- -
- Suppresses display of the request progress. This is the default.
- FREQUENCY=
- Rate at which the console progress display is refreshed when a request is run from the command line. This parameter is valid only when the P+ parameter is used. Specify a value for FREQUENCY that is a multiple of 5000.
- SERVER=
- The server on which to process. Overrides any server specification
in the action requests processed from the command line.
- optservername
- Optim
- PST=
- The Optim™ Directory for
processing. If processing uses the current (default) Optim Directory, this keyword is not needed.
- optimdirectory
- Optim
- OV=
- Source of process overrides. The OV keyword must follow all other
command line keywords.
- override filename.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.