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 execute 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

Parameters

PS_RUN_JOB
Starts and monitors a PeopleSoft job
JOBNAME=
Name of the PeopleSoft job that should be started and monitored
Note: The name of the PeopleSoft job refers to the definition in the PeopleSoft Process Scheduler. The name of the assigned Process Scheduler Batch Server (RUNLOCATION parameter) must also comply with the corresponding definition if you use this parameter.
Format: script literal
RUNCONTROLID=
Run Control ID of the PeopleSoft job
Format: script literal
RUNLOCATION=
(Optional) Name of an assigned PeopleSoft Process Scheduler Batch Server, such as PSUNX or PSNT
Note: The name of the PeopleSoft job (JOBNAME parameter) refers to the definition in the PeopleSoft Process Scheduler. The name of the assigned Process Scheduler Batch Server must also comply with the corresponding definition if you use this parameter.
Format: script literal
OUTPUTDEST=
(Optional) Directory to which the PeopleSoft job writes its output
OUTDESTTYPE=
(Optional) Output type of the PeopleSoft job, such as a file, printer or email
Format: script literal
Use the following database query to see all valid values:
select XLATSHORTNAME from XLATTABLE where FIELDNAME = 'OUTDESTTYPE';
Format: script literal
OUTDESTFORMAT=
(Optional) Output type of the PeopleSoft job, such as TXT, HTM or PDF
Format: script literal
Use the following database query to see all valid values:
select XLATSHORTNAME from XLATTABLE where FIELDNAME = 'OUTDESTFORMAT';
OUTREGISTER=
(Optional) Indicates whether the output file generated by the PeopleSoft command should be registered in the Automation Engine or not.
Allowed values:
- NO (default
- YES
  The effect is that the output file is available for download from the Reports window in the AWI. See External (Directory) Reports.

Notes:

The name of the output file is composed of the PS command parameters OUTDESTTYPE, OUTDESTFORMAT, and OUTPUTDEST plus the instance number. Sample 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. Consequently, the PS agent must be either 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. Doing so is a prerequisite to enable 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 this case, the PS system falls back to a default value. However, the PS agent does not have an influence on this behavior. Therefore, the report output file is not available because it assumes the selected output format.

REPLICATE=
(Optional) Indicates whether child jobs/processes should be registered as JOBDs in the Automation Engine. If set to YES, they are displayed in the Tasks list of the Process Monitoring perspective.

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'