PS_RUN_PROCESS

Starts and monitors a PeopleSoft process.

Syntax

PS_RUN_PROCESS

     

    PROCESSNAME=...
    ,PROCESSTYPE
    =...
    ,RUNLOCATION
    =...
    ,
    RUNCONTROLID=...
    [
    ,OUTPUTDEST=...]
    [
    ,OUTDESTTYPE=...]
    [
    ,OUTDESTFORMAT=...]

    [,OUTREGISTER]=...

    [,REPLICATE=...]

Syntax

Description/Format

PROCESSNAME=

Name of the PeopleSoft process that should be initialized and monitored.
Format: script literal

PROCESSTYPE=

Process type of the PeopleSoft process.
Format: script literal

RUNLOCATION=

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

RUNCONTROLID=

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

OUTPUTDEST=

Directory to which the PeopleSoft process writes its output.
Format: script literal

OUTDESTTYPE=

Output type of the PeopleSoft process (for example 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';

Interface: PROCESSREQUEST and PROCESSREQUEST_SBB
PeopleSoft Version: 8+

OUTDESTFORMAT=

File format in which the PeopleSoft process 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';

Interface: PROCESSREQUEST and PROCESSREQUEST_SBB
PeopleSoft Version: 8+

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 creates a process request for a PeopleSoft process and monitors its execution. The end of this PeopleSoft process is recognized on the basis of its run status which will be stored in the PeopleSoft database.

The name and type of a PeopleSoft process refers to the process definitions in the PeopleSoft "Process Scheduler Manager". The name of the assigned Process Scheduler Batch Server must also correspond to a definition.

OUTPUTDEST, OUTDESTTYPE and OUTDESTFORMAT are additional optional parameters that can be used to specify the output of the PeopleSoft process.

Some parameters of the script element depend on the PeopleSoft version that is used and indicated in the syntax table.

Examples

The first example runs the PeopleSoft process THR200 of the process type SQR report.

PS_RUN_PROCESS PROCESSNAME='THR200',PROCESSTYPE='SQR

Report',RUNLOCATION='PSUNX',RUNCONTROLID='mlc',OUTPUTDEST='/tmp/'

The second example uses the optional parameters in order to store the output of the PeopleSoft process in a temporary directory as a PDF file.

PS_RUN_PROCESS PROCESSNAME='DDDAUDIT',PROCESSTYPE='SQR

Report',RUNLOCATION='PSNT',RUNCONTROLID='sbb',OUTDESTTYPE='FILE',OUTDESTFORMAT='PDF',OUTPUTDEST='c:\temp'

See also: