PS_RUN_JOB

Starts and monitors a PeopleSoft job .

Interface: PROCESSREQUEST_SBB
PeopleSoft Version: 8+

Syntax

PS_RUN_JOB

 

Syntax

Description/Format

JOBNAME=

Name of PeopleSoft job that should be started and monitored.
Format: script literal

RUNCONTROLID=

Run Control ID of the PeopleSoft job.
Format: script literal

RUNLOCATION=

Name of an assigned PeopleSoft Process Scheduler Batch Server (for example PSUNX or PSNT).
Format: script literal

OUTPUTDEST=

Directory in which the PeopleSoft job writes its output.
Format: script literal

OUTDESTTYPE=

Output type of the PeopleSoft job (for example a file, printer or email).
Format: script literal

All valid values can be displayed with the following database query:
select XLATSHORTNAME from XLATTABLE where FIELDNAME = 'OUTDESTTYPE';

OUTDESTFORMAT=

File format in which the output of the PeopleSoft job should be saved (for example TXT, HTM or PDF).
Format: script literal

All valid values can be displayed with the following database query:
select XLATSHORTNAME from XLATTABLE where FIELDNAME = 'OUTDESTFORMAT';

OUTREGISTER=

Indicates whether the output file generated by the PeopleSoft command should be registered in the Automation Engine or not.

Possible values: "YES" | "NO", where NO is the default.

The name of the output file is made up of the PS command parameters (OUTDESTTYPE, OUTDESTFORMAT and OUTPUTDEST) plus the Instance Number.

Sample format: <path><job/process name>_<Instance Number>.<output type>

Example: c:\temp\DDDAUDIT_31126.PDF

Note: Please make sure 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.

Setting YES results in the output file being available for download from the Reports window on the User Interface. See External (Directory) Reports.

Warning! 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, this cannot be determined by the PS agent and, therefore, the report output file is not available because it assumes the selected output format.

Note: Please make sure 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 to enable the PS agent to transfer the files to the Automation Engine.

REPLICATE=

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.

This script element starts a PeopleSoft job and monitors its execution. A PeopleSoft job can be used to execute several PeopleSoft processes at the same time or one after the other.

The name of the PeopleSoft job refers to the definition in the PeopleSoft Process Scheduler Manager. The name of the assigned Process Scheduler Batch Server must also comply with a definition if this parameter is used.

OUTPUTDEST, OUTDESTTYPE and OUTDESTFORMAT are additional optional parameters that can be used to specify the PeopleSoft job's output.

Attention administrators: This script element can only be used if the administrator has installed and activated the PROCESSREQUEST_SBB interface in the agent's INI file.

Note: PS_RUN_JOB does not work with inline bind variables. For more information, see Using Bind Variables.

Examples

The following example uses optional parameters in order 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'

See also:

seealso

About PeopleSoft JCL