Scheduling Processes from Outside the PeopleSoft System

The PROCESSREQUEST component interface provides an API to create or update a process request from outside the PeopleSoft system. It returns the process instance of the process request that is created.

Successfully developing the functionality to schedule a process or job to run from outside PeopleSoft requires expertise in:

  • PeopleSoft Process Scheduler definitions.

  • PeopleCode.

  • Component interfaces.

This section provides an overview of the component interface details and discusses how to schedule a process using a component interface in Visual Basic.

The following topics provide the properties and methods that are associated with the component interface that is used to schedule processes from outside of PeopleSoft.

Component Interface Name

ProcessRequest

Properties

The following properties are associated with the component interface:

  • RUNCONTROLID

  • PROCESSTYPE

  • PROCESSNAME

  • JOBNAME

  • RUNLOCATION

  • RUNDATE

  • RUNTIME

  • RUNRECURRANCE

  • OUTDESTTYPE

  • OUTDESTFORMAT

  • OUTDEST

  • RUNSTATUS

  • PROCESSINSTANCE

  • REQUESTTYPE

Methods

The following methods are associated with the component interface:

  • Standard:

    • Cancel

    • Find

    • Get

    • Save

    • Update

    • GetPropertyByName

    • SetPropertyByName

    • GetPropertyInfoByName

  • User-Defined:

    • Create

    • Update

The following example shows how you might schedule a process from outside of PeopleSoft using Visual Basic.

Initializing the component interface:

Dim oSession As New PeopleSoft_PeopleSoft.Session
Dim oBC As ProcessRequest
oSession.Connect(1, "TCHURY072198:7000", "PTDMO", "PTDMO", 0)
'get component from server
Set oBC = oSession.GetComponent("PROCESSREQUEST")
Status = oBC.Get()

Creating a process request:

  • Properties:

    oBC.REQUESTTYPE = "Create"
oBC.RUNCONTROLID = "Test"
oBC.PROCESSTYPE = "SQR Report"
oBC.PROCESSNAME = "XRFWIN"
oBC.RUNLOCATION = "PSNT"
oBC.RUNDATE = "01/01/2000"
oBC.RUNTIME = "09:00:00"
oBC.OUTDESTTYPE = "FILE"
oBC.OUTDESTFORMAT = "SPF"
oBC.OUTDEST = "C:\temp\"

  • Method:

    ProcessInstance = oBC.Create

Updating a process request:

  • Properties:

    oBC.REQUESTTYPE = "Update"
oBC.PROCESSINSTANCE = 10
oBC.RUNSTATUS = "2"

  • Method:

    oBC.Update