Extract, Insert, Load, and Convert Process Command-line Keywords
This topic discusses Extract, Insert, Load, and Convert Process command-line keywords.
General
- PR0CMND
- Type PR0CMND to initiate command-line processing. Note: the character following PR is the number 0 (zero).
- /R
- Command to run the specified job, process(es) specified in a parameter file, or process specified on the command line. Specify /R or –R.
- 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. Note: See the Common Elements Manual section on the Scheduling Editor for additional information.
- jobname
- Name or description of the job (30 character maximum).
- @parameterfilename
- Specify @ followed by the fully qualified path and name of a text file containing the parameters for the process(es) to be run.
- parameters
- Specify parameters for the process on the command line.
Parameters
Use the following parameters, whether in a parameter file or specified on the command line, as needed:
- TYPE=
- Specify the type of process request. Specify TYPE=
and one of the following:
- requesttype
- The type of process request: Extract, Insert, Load, or Convert.
- REQUEST=
- Name of the action request (identifier.name).
- identifier.name
- The qualifier and name of the Extract, Insert, Load, or Convert Request.
- OUTPUT=
- Name of the output file for the process report.
Specify OUTPUT= followed by a file name. To append the report
to an existing file, place a plus sign (+) after the file name.
- If you do not use this keyword, the report displays automatically after each process completes. You must close the report dialog before the next process can begin.
- If you do not specify a full directory path, the file is saved in your default Data Directory (specified in Personal Options).
- For a UNIX or Linux® environment, if this keyword and value are not specified, the output is displayed to the console.
Note: The OUTPUT file is used for all processes in a parameter file. If you use the keyword more than once, the last file specified is used.- filename
- The output file name.
- QUIET
- Indicator for prompts or error dialogs during a process. Specify QUIET directly followed by a plus ( + ) or minus ( - ) sign. (Do not insert a space.)
- The QUIET indicator applies to all process requests in
a parameter file. If you use the keyword more than once, the last
specification is used.Note: For a UNIX or Linux environment, the QUIET keyword is ignored, because prompts and error dialogs are unavailable.
- +
- Do not display prompts or error dialogs (default).
- –
- Display prompts and error dialogs. (Invoke privilege is required to run a process that requires the display of editor interfaces. For example, Invoke Create privilege is required to run an Insert or Load Process that requires creating destination database tables.)
- MONITOR
- Indicator for the display of the Progress dialog during a process. Specify MONITOR directly followed by a plus ( + ) or minus ( - ) sign. (Do not insert a space.)
- The MONITOR indicator applies to all process requests in
a parameter file. If you use the keyword more than once, the last
specification is used.Note: For a UNIX or Linux environment, the MONITOR keyword is ignored. Use the P parameter, shown below.
- +
- Display the Progress dialog.
- –
- Do not display the Progress dialog (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.
- RST
- For a load process only, produces a Resource Estimation Report showing calculated amount of storage needed to load each object in the Load Request. Specify RST directly followed by a plus ( + ) or minus ( - ) sign. (Do not insert a space.) For information on the Resource Estimation Report, see Resource Estimation. The RST indicator applies to all load process requests in a parameter file. If you use the keyword more than once, the last specification is used.
- +
- Create a Resource Estimation Report.
- -
- Do not create a Resource Estimation Report (default).
- STOP=
- Error processing indicator. Specify STOP= followed
by the type of error. The STOP keyword can be used only in
a parameter file, not on the command line. The error code is applied
immediately after a process runs, before the next process,
if any, begins. Note: The STOP keyword does not apply to scheduled jobs, and if specified, is ignored.
- N (None)
- Continue processing, regardless of errors (default).
- I (Information)
- Stop processing if an informational, warning, or fatal error occurs (return code of 4 or greater).
- W (Warning)
- Stop processing if a warning or fatal error occurs (return code of 8 or greater).
- F (Fatal)
- Stop processing if a fatal error occurs (return code 12).
- SERVER=
- Override for the server on which to process the
specified job, all request(s) specified in a parameter file, or a
request specified on the command line. A value assigned to the SERVER
command-line keyword overrides any server specification in the action
request(s). This keyword cannot be used unless the Optim Server option is installed.
- servername
- Name of the Optim Server on which the job is processed.
- PST=
- Specify the Optim Directory
for the action request(s). If you do not use this keyword, the current
(default) Optim Directory is
used.
- pstdirectory
- Name of the Optim Directory for the request.
- OV=
- Indicates that process overrides are specified.
The argument for the OV command-line keyword can
be a text file name (OV=overridefilename)
or, when the process is defined in a parameter file, an asterisk (OV=*).
When the OV keyword is used in a parameter file, the asterisk
is used to indicate that override parameters follow on successive
lines.
- overridefilename
- Specify the name of the text file containing the process override arguments.
- *
- Specify that the process overrides are defined in the successive lines of the parameter file.