Description
The SUBMIT PROCESS command submits a process, job, or jobset to the PeopleSoft Process Scheduler for execution.
Command Line Syntax
The following figure illustrates the command line syntax of the SUBMIT PROCESS command, using the command line, long form of its configuration options.
-deffmt
-RunControlId
-ProcessType
-RunControlId
-ProcessType
{-ProcessName
-JobName
-ServerName
-RunDateTime
-TimeZone
-RecurrenceName
-OutputDestinationType
-OutputDestinationFormat
-OutputDestinationString
-ReportFolderName
-ProcessFileName
-RetentionDays
-wait
-poll
-PrintJobTree
-PrintDistList
-PrintSystemMessage
-PrintApplicationMessage
-PrintParamList
-report
-cntfilter
Note
As the command line syntax illustrates, you can specify all of the options before the -wait on the command line to override values (if present) in the definition file.
Command Argument
The SUBMIT PROCESS command can be expressed as either:
- -U (Short form)
- -sub (Long form)
The SUBMIT PROCESS command argument, filename/ddname, specifies the process, job, or jobset or submitted to the PeopleSoft Process Scheduler for execution.
Configuration Options
The following table describes all SUBMIT PROCESS configuration options and provides the command line, long form of each option illustrated in the SUBMIT PROCESS command line syntax, above.
Configuration | Command Line | Description |
|---|---|---|
-cntfilter | Comma-delimited list of report file suffixes that will not be returned. | |
-deffmt | Format of the definition file. | |
-JobName | Name of the job being referenced by a command. | |
-OutputDestinationFormat | Override of the default output format for the submitted process. | |
-OutputDestinationString | Override for the file path or printer destination for the output, if the output type for a submitted process is File or Printer. | |
-OutputDestinationType | Type of output for a submitted process. | |
-ProcessFileName | Override for the dependent file name for the submitted process. | |
-ProcessName | Name of a PeopleSoft process for which parameter names will be returned. | |
-ProcessType | Specific type of PeopleSoft process. | |
-RecurrenceName | Named recurrence definition to apply to the process submission. | |
-Report | Specification for whether or not the reports associated with a process are returned. | |
-ReportFolderName | Override for the folder name for the main job or process. | |
-RetentionDays | Override for the retention days defined for a submitted process. | |
-RunControlId | Run control ID to be used for the process submission. | |
-RunDateTime | Custom run date time for the submitted process. | |
-ServerName | Specific server name for which constraints will be returned. | |
-TimeZone | Time zone to use for the RUN_DATE_TIME configuration option. | |
-poll | Length of time to wait between status calls to the PeopleSoft system. | |
-printapplicationmessage | Specification for whether or not application messages are printed for the monitored processes when the work completes. | |
-printdistlist | Specification for whether or not to print the report-recipient distribution list for the monitored process when the work completes. | |
-printjobtree | Specification for whether or not to print the job tree when the monitored process completes. | |
-printparamlist | Specification for whether or not the parameter list for job items are included in the report. | |
-printsystemmessage | Specification for whether or not system messages for the monitored processes when the work completes. | |
-wait | Specification that UPPS will monitor the specified process to completion. Note In the SUBMIT_PROCESS command line syntax, the WAIT for PROCESS (-wait) is a UPPS command used as a configuration option. |
Example
-userid USERNAME1 -pwd PASSWORD1 -host
-port
-processname
-runcontrolid
-processtype
-userid USERNAME1 -pwd PASSWORD1 -host
-port
-processname
-runcontrolid
-processtype