PS_RUN_JOB

Use the PS_RUN_JOB script element to start a PeopleSoft job and monitor its execution. You can use a PeopleSoft job to run several PeopleSoft processes at the same time or one after the other.

Important!

This script element requires the administrator to install and activate the PROCESSREQUEST_SBB interface in the agent's INI file.
PS_RUN_JOB does not work with inline bind variables. For more information, see Using Bind Variables.

Interface: PROCESSREQUEST_SBB

PeopleSoft Version: 8+

Syntax

PS_RUN_JOB JOBNAME=...,RUNCONTROLID=...[,RUNLOCATION=...][,OUTPUTDEST=...][,OUTDESTTYPE=...][,OUTDESTFORMAT=...][,OUTREGISTER=...][,REPLICATE=...]

Parameters

Parameter	Description	Format	Allowed Values	Default Value
JOBNAME=	Name of the PeopleSoft job to start and monitor. Note: The name refers to the definition in the PeopleSoft Process Scheduler. If you use the RUNLOCATION parameter, the name of the assigned Process Scheduler Batch Server must also comply with that definition.	Script literal	n.a.	n.a.
RUNCONTROLID=	Run Control ID of the PeopleSoft job	Script literal	n.a.	n.a.
RUNLOCATION= (Optional)	Name of an assigned PeopleSoft Process Scheduler Batch Server, such as PSUNX or PSNT. Note: The name of the assigned Process Scheduler Batch Server must comply with the definition in the PeopleSoft Process Scheduler that the JOBNAME parameter refers to.	Script literal	n.a.	n.a.
OUTPUTDEST= (Optional)	Directory to which the PeopleSoft job writes its output	Script literal	n.a.	n.a.
OUTDESTTYPE= (Optional)	Output type of the PeopleSoft job, such as file, printer, or email. To see all valid values, run the following query: select XLATSHORTNAME from XLATTABLE where FIELDNAME = 'OUTDESTTYPE';	Script literal	n.a.	n.a.
OUTDESTFORMAT= (Optional)	Output format of the PeopleSoft job, such as TXT, HTM, or PDF. To see all valid values, run the following query: select XLATSHORTNAME from XLATTABLE where FIELDNAME = 'OUTDESTFORMAT';	Script literal	n.a.	n.a.
OUTREGISTER= (Optional)	Indicates whether the output file generated by the PeopleSoft command is registered in the Automation Engine. Note the following about the generated output file: The output file name is composed of the OUTDESTTYPE, OUTDESTFORMAT, and OUTPUTDEST parameters plus the instance number, in the format <path><job/process name>_<Instance Number>.<output type>, for example, c:\temp\DDDAUDIT_31126.PDF. Ensure that the PS agent can access the generated output file so that it can retrieve it to the Automation Engine. The PS agent must be installed on the same machine as the PS system, or at least have access to its file share. Ensure that the distribution agent of the PS system is configured properly so that the generated output files can be delivered to the directory specified in the job definition. This is a prerequisite for the PS agent to transfer the files to the Automation Engine. The output format depends on the process type. For example, TXT is not available for all process types; in that case the PS system falls back to a default value. The PS agent has no influence on this behavior, so the report output file may not be available in the selected output format.	n.a.	NO — The output file is not registered. YES — The output file is available for download from the Reports window in the AWI. For more information, see External (Directory) Reports.	NO
REPLICATE= (Optional)	Indicates whether child jobs/processes are registered as JOBDs in the Automation Engine. If set to YES, they are displayed in the Tasks list of the Process Monitoring perspective.	n.a.	n.a.	n.a.

Examples

The following example uses optional parameters to store the PeopleSoft job's output in a temporary directory as an SPF file.

PS_RUN_JOB JOBNAME='3SQR',RUNCONTROLID='sbb',RUNLOCATION=PSNT,OUTDESTTYPE='FILE',OUTDESTFORMAT='SPF',OUTPUTDEST='c:\temp'