/
SUBMIT PROCESS - UPPS Command

SUBMIT PROCESS - UPPS Command

Feb 06, 2023

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.

-sub { {filename -deffmt {xml | upps} [-RunControlIdID] [-ProcessTypetype}]} | {-RunControlIdID-ProcessTypetype} {-ProcessNamename | -JobNamename}} [-ServerName name] [-RunDateTime dateTime] [-TimeZone zone] [-RecurrenceName name] [-OutputDestinationType type] [-OutputDestinationFormat format] [-OutputDestinationString string] [-ReportFolderName name] [-ProcessFileName name] [-RetentionDays days] } [-wait [-poll seconds] [-PrintJobTree {yes | no}] [-PrintDistList {yes | no}] [-PrintSystemMessage {yes | no}] [-PrintApplicationMessage {yes | no}] [-PrintParamList {yes | no}] [-report {yes | no}] [-cntfilter filterList] ]

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
Option Name

Command Line
Long Form

Description

Configuration
Option Name

Command Line
Long Form

Description

CNT_FILTER

-cntfilter

Comma-delimited list of report file suffixes that will not be returned.

DEFINITION_FILE_FORMAT

-deffmt

Format of the definition file.

JOB_NAME

-JobName

Name of the job being referenced by a command.

OUTPUT_DESTINATION_FORMAT

-OutputDestinationFormat

Override of the default output format for the submitted process.

OUTPUT_DESTINATION_STRING

-OutputDestinationString

Override for the file path or printer destination for the output, if the output type for a submitted process is File or Printer.

OUTPUT_DESTINATION_TYPE

-OutputDestinationType

Type of output for a submitted process.

PROCESS_FILE_NAME

-ProcessFileName

Override for the dependent file name for the submitted process.

PROCESS_NAME

-ProcessName

Name of a PeopleSoft process for which parameter names will be returned.

PROCESS_TYPE

-ProcessType

Specific type of PeopleSoft process.

RECURRENCE_NAME

-RecurrenceName

Named recurrence definition to apply to the process submission.

REPORT

-Report

Specification for whether or not the reports associated with a process are returned.

REPORT_FOLDER_NAME

-ReportFolderName

Override for the folder name for the main job or process.

RETENTION_DAYS

-RetentionDays

Override for the retention days defined for a submitted process.

RUN_CONTROL_ID

-RunControlId

Run control ID to be used for the process submission.

RUN_DATE_TIME

-RunDateTime

Custom run date time for the submitted process.

SERVER_NAME

-ServerName

Specific server name for which constraints will be returned.

TIME_ZONE

-TimeZone

Time zone to use for the RUN_DATE_TIME configuration option.

POLL

-poll

Length of time to wait between status calls to the PeopleSoft system.

PRINT_APPLICATION_MESSAGE

-printapplicationmessage

Specification for whether or not application messages are printed for the monitored processes when the work completes.

PRINT_DIST_LIST

-printdistlist

Specification for whether or not to print the report-recipient distribution list for the monitored process when the work completes.

PRINT_JOB_TREE

-printjobtree

Specification for whether or not to print the job tree when the monitored process completes.

PRINT_PARAM_LIST

-printparamlist

Specification for whether or not the parameter list for job items are included in the report.

PRINT_SYSTEM_MESSAGE

-printsystemmessage

Specification for whether or not system messages for the monitored processes when the work completes.

WAIT for PROCESS

-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

upps -userid USERNAME1 -pwd PASSWORD1 -host qapsft.stone.branch -port 8000 -sub .\TM_parms.txt -processname TREEMOVER -runcontrolid ESS1A -processtype "Application Engine" UNV6830E Universal Connector for PeopleSoft Process Scheduler ending with exit code 0. upps -userid USERNAME1 -pwd PASSWORD1 -host qapsft.stone.branch -port 8000 -sub .\TM_parms.txt -processname TREEMOVER -runcontrolid ESS1A -processtype "Application Engine" -wait UNV6817I Process status for TREEMOVER/140607 is now queued. UNV6817I Process status for TREEMOVER/140607 is now no success. Process Instance..........: 140607 Process Name..............: TREEMOVER Process Type..............: Application Engine Run Control Id............: ESS1A Server Name Run...........: PRCS1090 Operator Id...............: USERNAME1 Request Date Time.........: 2018-02-08-14.44.14.514964 Run Date Time.............: 2018-02-08-14.44.14.000000 Begin Date Time...........: 2018-02-08-14.44.23.302174 End Date Time.............: 2018-02-08-14.44.23.500502 Output Destination Format.: TXT Output Destination Type...: WEB Run Status................: no success Distribution Status.......: n/a UNV6834I Distribution status for TREEMOVER/140607 is now posted. Process Instance..........: 140607 Process Name..............: TREEMOVER Process Type..............: Application Engine Run Control Id............: ESS1A Server Name Run...........: PRCS1090 Operator Id...............: USERNAME1 Request Date Time.........: 2018-02-08-14.44.14.514964 Run Date Time.............: 2018-02-08-14.44.14.000000 Begin Date Time...........: 2018-02-08-14.44.23.302174 End Date Time.............: 2018-02-08-14.44.38.407472 Output Destination Format.: TXT Output Destination Type...: WEB Run Status................: no success Distribution Status.......: posted Content Id................: 29626 ******************************************************************************* Report URL.........: http://qapsft.stone.branch:8000/psreports/ps/29626/AE_TREEMOVER_140607.stdout Report Description.: Redirected Terminal Output ******************************************************************************* PeopleTools 8.55.09 - Application Engine Server Copyright (c) 1988-2018 Oracle and/or its affiliates. All Rights Reserved PSAESRV started service request at 14.44.23 2018-02-08 Begin: PeopleSoft TreeMover (125,2) A file with the name ESS1A-TreeExp1 already exists. Cannot overwrite. (125,498) PeopleSoft TreeMover Completed Unsuccessfully. (125,5) End: PeopleSoft TreeMover (125,3) PeopleCode Exit(1) Abort invoked by Application at TREEMOVER.Export.Step01. (108,543) Process 140607 ABENDED at Step TREEMOVER.Export.Step01 (PeopleCode) -- RC = ? (108,524) Process %s ABENDED at Step %s.%s.%s (Action %s) -- RC = %s PSAESRV completed service request at 14.44.23 2018-02-08 UNV6830E Universal Connector for PeopleSoft Process Scheduler ending with exit code 6.