Process Scheduler Service Operations

To enable external applications to access PeopleSoft Process Scheduler, a number of service operations are available. Depending on the application, the external application will need to use several service operations in combination. The service operations for Process Scheduler are part of the service PROCESSREQUEST.

Process Scheduler service operations are grouped into the following categories to help describe the service operations:

  • Schedule requests

  • Monitor requests

Schedule Requests

Service operations to schedule requests are used by client applications to schedule process requests to run in the PeopleSoft application. This table lists the service operations:

Service Operation Name

Description

PRCS_GETPROCESSNAMES

Returns a list of process names based on process type.

PRCS_GETPARAMS

Returns the runtime parameters registered for a process in the process definition.

PRCS_GETPROMPT

Returns a list of process types, distribution status, run status, server names, operator IDs or recurrence definitions, time zones, folder names depending on the request.

PRCS_SCHEDULE

Schedules a job or process using all the parameters required to schedule the job or process. Returns the process instance.

PRCS_SCHEDULE_PSQUERY

Schedules a non-unique process query.

PRCS_SCHEDULE_CONQUERY

Schedules a non- unique process connected query.

PRCS_SCHEDULE_BIPUBLISHER

Schedules a non-unique process BIPublisher.

PRCS_SCHEDULE_NVISION

Schedules a non-unique process nVision report request.

PRCS_RUNJOBSETNOW

Schedules a JobSet based on settings defined in the Scheduled JobSet Definition component. kalaiyarasu

Monitor Processes

Service operations to monitor requests and retrieve reports are used by client applications to monitor process requests in the PeopleSoft application. This table lists the service operations:

Service Operation Name

Description

PRCS_GETREQUEST

Returns the process details for a given process instance. The details include the run status, distribution status, output information, distribution information, runtime information, and recurrence information.

PRCS_GETREPORT

Returns report and log file details for the reports posted to the report repository.

PRCS_FINDREQUESTS

Used to search for submitted process requests based on a combination of different filter criteria.

PRCS_UPDATEREQUEST

Used to update the process request.

PRCS_GETSERVERCONSTRAINTS

Retrieves server specific details, such as count of Max API aware, Max concurrent for each process type, Max concurrent for each process category.

PRCS_GETOUTPUTPARAMS

Retrieves the output type and output format for a given process or job name.

PRCS_PRINT_JOB_HTML_REPORT

Retrieves an HTML formatted report displaying all items in a job or jobset as defined in the Job Definition component.

PRCS_PRINT_JOB_REQUEST_REPORT

Retrieves an HTML formatted report displaying the current status of a specific process, job, and jobset.

PRCS_PRINT_SCHEDULE_HTML_REPORT

Retrieves an HTML formatted report displaying all items in a job or jobset as defined in the Scheduled Jobset Definition component.