UPPS 7.6.x Quick Reference Guide - Commands

Usage

Each execution of Universal Connector for PeopleSoft (upps) is followed by:

  1. A single command.
  2. One or more configuration options for program execution from required and optional categories.
  3. One or more configuration options associated with the specified command.
     
upps command  HOST  USER  [ COMMAND FILE  INFORMATIONAL  LOCAL  MESSAGE  SSL ] [Command-Specific Options ]

There is a long form and, for some commands and options, a short form available for specifying commands and options on the command line. The long form is not case-sensitive; the short form is case-sensitive.

Commands and options must be prefixed with a dash ( - ) character. If an option value is specified, the option and its value must be separated by at least one space.
 

Command Categories

{ CANCEL | DELETE | DISPLAY | HOLD | START | SUBMIT | WAIT }


CANCEL Commands

CANCEL PROCESS -cancel -ProcessInstance

Long Form

Short Form

Description

-cancel

n/a

Cancels the specified process instance in the PeopleSoft system.

-ProcessInstance

n/a

PeopleSoft process instance number identifying the request to be returned.


DELETE Commands

DELETE PROCESS -delete -ProcessInstance

Long Form

Short Form

Description

-delete

n/a

Deletes the specified process instance from the PeopleSoft system.

-ProcessInstance

n/a

PeopleSoft process instance number identifying the request to be returned.


DISPLAY Commands

DISPLAY {OUTPUT TYPES | PRCS GET REPORT | PRCS GET REQUEST | PRCS GET SERVER CONSTRAINTS | PRCS PARAMS | PRCS PRINT JOB HTML REPORT | PRCS PRINT JOB REQUEST REPORT | PRCS PRINT SCHED HTML REPORT | PRCS PROMPT | PROCESS NAMES | REQUESTS}


DISPLAY OUTPUT TYPES -display prcs_get_outputtypes [-ProcessType] [-ProcessName} [-LangCode] [-outfmt]

Long Form

Short Form

Description

-display prcs_get_outputtypes

-D prcs_get_outputtypes

Displays a list of available output types for the specified process resource.

-ProcessType

n/a

Specific type of PeopleSoft process.

-ProcessName

n/a

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

-LangCode

n/a

Filter requests by language code.

-outfmt

n/a

Format of the output from a PeopleSoft process.


DISPLAY PRCS GET REPORT -display prcs_getreport -ProcessInstance [-outfmt]

Long Form

Short Form

Description

-display prcs_getreport

-D prcs_getreport

Displays a report from the PeopleSoft Report Repository.

-ProcessInstance

n/a

PeopleSoft process instance number identifying the request to be returned.

-outfmt

n/a

Format of the output from a PeopleSoft process.


DISPLAY PRCS GET REQUEST -display prcs_getrequest -ProcessInstance [-outfmt]

Long Form

Short Form

Description

-display prcs_getrequest

-D prcs_getrequest

Displays Get process request information for a specific request instance.

-ProcessInstance

n/a

PeopleSoft process instance number identifying the request to be returned.

-outfmt

n/a

Format of the output from a PeopleSoft process.


DISPLAY PRCS GET SERVER CONSTRAINTS -display prcs_getserverconstraints [-ServerName] [-ProcessType] [-outfmt]

Long Form

Short Form

Description

-display prcs_getserverconstraints

-D prcs_getserverconstraints

Displays server constraint information for servers matching the specified criteria.

-ServerName

n/a

Specific server name for which constraints will be returned.

-ProcessType

n/a

Specific type of PeopleSoft process.

-outfmt

n/a

Format of the output from a PeopleSoft process.


DISPLAY PRCS PARAMS -display prcs_params {-JobName | -ProcessName} -ProcessType [-outfmt]

Long Form

Short Form

Description

-display prcs_params

-D prcs_params

Displays the list of parameter values for a PeopleSoft job or process.

-JobName

n/a

Name of the job being referenced by a command.

-ProcessName

n/a

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

-ProcessType

n/a

Specific type of PeopleSoft process.

-outfmt

n/a

Format of the output from a PeopleSoft process.


DISPLAY PRCS PRINT JOB HTML REPORT -display prcs_print_jobhtmlreport -JobName [-outfmt]

Long Form

Short Form

Description

-display prcs_print_jobhtmlreport

-D prcs_print_jobhtmlreport

Displays a report with all items in a job or jobset, as defined in the job definition component.

-JobName

n/a

Name of the job being referenced by a command.

-outfmt

n/a

Format of the output from a PeopleSoft process.


DISPLAY PRCS PRINT JOB REQUEST REPORT -display prcs_print_jobrequestreport -ProcessInstance [-ItemInstance] [-PrintJobTree] [-PrintDistList] [-PrintSystemMessage] [-PrintApplicationMessage] [-PrintParamList] [-outfmt]

Long Form

Short Form

Description

-display prcs_print_jobrequestreport

-D prcs_print_jobrequestreport

Displays a report containing the current status of a specific process, job, or jobset.

-ProcessInstance

n/a

PeopleSoft process instance number identifying the request to be returned.

-ItemInstance

n/a

Instance number of a scheduled job or jobset.

-PrintJobTree

n/a

Controls whether or not the job tree is included in the Job Report.

-PrintDistList

n/a

Controls whether or not the report-recipient distribution list is included in the Job Report.

-PrintSystemMessage

n/a

Controls whether or not to print the system messages for the monitored processes are included in the Job Report.

-PrintApplicationMessage

n/a

Controls whether or not the application messages for the monitored processes are included in the Job Report.

-PrintParamList

n/a

Controls whether or not the parameter list job items are included in the Job Report.

-outfmt

n/a

Format of the output from a PeopleSoft process.


DISPLAY PRCS PRINT SCHED HTML REPORT -display prcs_print_schedhtmlreport -MainSchedName -MainJobName [-PrintJobTree] [:-PrintDistList] [-PrintNotifyList] [-PrintMessageList] [-PrintParamList] [-outfmt]

Long Form

Short Form

Description

-display prcs_print_schedhtmlreport

-D prcs_print_schedhtmlreport

Displays a report listing all items in a job or jobset, as defined in the Scheduled Jobset Definition component.

-MainSchedName

n/a

Name of the jobset schedule.

-MainJobName

n/a

Name of the job within the jobset schedule.

-PrintJobTree

n/a

Controls whether or not the job tree is included in the Job Report.

-PrintDistList

n/a

Controls whether or not the report-recipient distribution list is included in the Job Report.

-PrintNotifyList

n/a

Controls whether or not the job notify list is included in the report.

-PrintMessageList

n/a

Controls whether or not the messages that will be emailed upon completion of a job item are included in the report.

-PrintParamList

n/a

Controls whether or not the parameter list job items are included in the Job Report.

-outfmt

n/a

Format of the output from a PeopleSoft process.


DISPLAY PRCS PROMPT -display prcs_prompt -prompt [-outfmt]

Long Form

Short Form

Description

-display prcs_prompt

-D prcs_prompt

Displays a list of the specified prompt values available in the PeopleSoft system.

-prompt

n/a

Type of prompt values in the PeopleSoft system that will be displayed by the DISPLAY PRCS PROMPT command.

-outfmt

n/a

Format of the output from a PeopleSoft process.


DISPLAY PROCESS NAMES -display process_names -ProcessType [-outfmt]

Long Form

Short Form

Description

-display process_names

-D process_names

Displays the list of process names in the PeopleSoft system for a specified process type.

-ProcessType

n/a

Specific type of PeopleSoft process.

-outfmt

n/a

Format of the output from a PeopleSoft process.


DISPLAY REQUESTS -display prcs_findrequests [-ProcessInstanceFrom] [-ProcessInstanceTo] [-OperatorId] [-ProcessType] [-ProcessName] [-ServerRun] [-RunStatus] [-DistributionStatus] [-LangCode] [-FilterValue -FilterUnit | {[-FromDate] [-ToDate]}] [-ProcessRequestCount] [-outfmt]

Long Form

Short Form

Description

-display prcs_findrequests

-D prcs_findrequests

Displays a list of request status information records from the PeopleSoft system that match the specified criteria.

-ProcessInstanceFrom

n/a

Starting (lower) process instance ID in a range of instance IDs to be displayed.

-ProcessInstanceTo

n/a

Ending (upper) process instance ID in a range of instance IDs to be displayed.

-OperatorId

n/a

Filter requests by this operator ID.

-ProcessType

n/a

Specific type of PeopleSoft process.

-ProcessName

n/a

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

-ServerRun

n/a

Filter requests by this server name.

-RunStatus

n/a

Filter requests by run status.

-DistributionStatus

n/a

Filter requests by distribution status.

-LangCode

n/a

Filter requests by language code.

-FilterValue

n/a

Integer value that will be interpreted in -filterunit units to provide a time range for filtering requests.

-FilterUnit

n/a

Unit used to interpret -filtervalue to provide a time range for filtering requests.

-FromDate

n/a

Explicit from date in the form of yyyy-mm-dd.

-ToDate

n/a

Latest date to use for job selection or syslog request.

-ProcessRequestCount

n/a

Limit of the number of requests that will be returned.

-outfmt

n/a

Format of the output from a PeopleSoft process.


HOLD Commands

HOLD PROCESS -hold -ProcessInstance

Long Form

Short Form

Description

-hold

n/a

Places the specified process instance on hold in the PeopleSoft system.

-ProcessInstance

n/a

PeopleSoft process instance number identifying the request to be returned.


START Commands

START JOBSET -start -MainSchedName -MainJobName [-poll] [-wait [-PrintJobTree] [-PrintDistList] [-PrintSystemMessage] [-PrintApplicationMessage] [-PrintParamList] [-report] [-cntfilter] ]

Long Form

Short Form

Description

-start

n/a

Starts a JobSet based on the settings defined in the Process Scheduler's Scheduled JobSet Definition component.

-MainSchedName

n/a

Name of the jobset schedule.

-MainJobName

n/a

Name of the job within the jobset schedule.

-poll

n/a

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

-PrintJobTree

n/a

Controls whether or not the job tree is included in the Job Report.

-PrintDistList

n/a

Controls whether or not the report-recipient distribution list is included in the Job Report.

-PrintNotifyList

n/a

Controls whether or not the job notify list is included in the report.

-PrintMessageList

n/a

Controls whether or not the messages that will be emailed upon completion of a job item are included in the report.

-PrintParamList

n/a

Controls whether or not the parameter list job items are included in the Job Report.

-report

n/a

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

-cntfilter

n/a

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


SUBMIT Commands

SUBMIT PROCESS -sub {filename -deffmt} | {-RunControlId -ProcessType {-ProcessName | -JobName}} [-ServerName] [-RunDateTime] [-TimeZone] [-RecurrenceName] [-OutputDestinationType] [-OutputDestinationFormat] [-OutputDestinationString] [-ReportFolderName] [-ProcessFileName] [-RetentionDays] [-wait [-poll] [-PrintJobTree] [-PrintDistList] [-PrintSystemMessage] [-PrintApplicationMessage] [-PrintParamList] [-report] [-cntfilter] ]

Long Form

Short Form

Description

-sub filename

-U filename

Submits a process, job, or jobset to the PeopleSoft Process Scheduler for execution.

-deffmt

n/a

Format of the definition file.

-RunControlId

n/a

Run control ID to be used for the process submission.

-ProcessType

n/a

Specific type of PeopleSoft process.

-ProcessName

n/a

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

-JobName

n/a

Name of the job being referenced by a command.

-ServerName

n/a

Specific server name for which constraints will be returned.

-RunDateTime

n/a

Custom run date time for the submitted process.

-TimeZone

n/a

Time zone to use for Run_Date_Time.

-RecurrenceName

n/a

Named recurrence definition to apply to the process submission.

-OutputDestinationType

n/a

Type of output for a submitted process.

-OutputDestinationFormat

n/a

Override of the default output format for the submitted process.

-OutputDestinationString

n/a

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

-ReportFolderName

n/a

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

-ProcessFileName

n/a

Override for the dependent file name for the submitted process.

-RetentionDays

n/a

Override for the retention days defined for a submitted process.

-wait

n/a

Specification that UPPS will monitor the specified process to completion.

-poll

n/a

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

-PrintJobTree

n/a

Controls whether or not the job tree is included in the Job Report.

-PrintDistList

n/a

Controls whether or not the report-recipient distribution list is included in the Job Report.

-PrintSystemMessage

n/a

Controls whether or not to print the system messages for the monitored processes are included in the Job Report.

-PrintApplicationMessage

n/a

Controls whether or not the application messages for the monitored processes are included in the Job Report.

-PrintParamList

n/a

Controls whether or not the parameter list job items are included in the Job Report.

-report

n/a

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

-cntfilter

n/a

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


WAIT Commands

WAIT for PROCESS -wait -ProcessInstance [-poll] [-PrintJobTree] [-PrintDistList] [-PrintSystemMessage] [-PrintApplicationMessage] [-PrintParamList] [-report] [-cntfilter] ]

Long Form

Short Form

Description

-ProcessInstance

n/a

PeopleSoft process instance number identifying the request to be returned.

-wait

n/a

Specification that UPPS will monitor the specified process to completion.

-poll

n/a

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

-PrintJobTree

n/a

Controls whether or not the job tree is included in the Job Report.

-PrintDistList

n/a

Controls whether or not the report-recipient distribution list is included in the Job Report.

-PrintSystemMessage

n/a

Controls whether or not to print the system messages for the monitored processes are included in the Job Report.

-PrintApplicationMessage

n/a

Controls whether or not the application messages for the monitored processes are included in the Job Report.

-PrintParamList

n/a

Controls whether or not the parameter list job items are included in the Job Report.

-report

n/a

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

-cntfilter

n/a

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