PS_RUN_PROCESS

Use the PS_RUN_PROCESS script element to create a process request for a PeopleSoft process and monitor its execution. The end of this PeopleSoft process is recognized based on its run status which is stored in the PeopleSoft database. Some parameters of this script element depend on the PeopleSoft version that you use and are indicated in the syntax table.

Syntax

PS_RUN_PROCESS

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

[,OUTREGISTER]=...]
[,REPLICATE=...]

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

Parameters

• PS_RUN_PROCESS
  Starts and monitors a PeopleSoft process
• PROCESSNAME=
  Name of the PeopleSoft process that should be initialized and monitored.
  Format: script literal
  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.
• 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
  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.
• RUNCONTROLID=
  Run Control ID of the PeopleSoft process.
  Format: script literal
• OUTPUTDEST=
  (Optional) Directory to which the PeopleSoft process writes its output.
  Format: script literal
• OUTDESTTYPE=
  (Optional) Output type of the PeopleSoft process (for example file, printer or email).
  Format: script literal
  Use the following database query to see all valid values:

select XLATSHORTNAME from XLATTABLE where FIELDNAME = 'OUTDESTTYPE';

Interface: PROCESSREQUEST and PROCESSREQUEST_SBB
PeopleSoft Version: 8+

• OUTDESTFORMAT=
  (Optional) Output type of the PeopleSoft process (for example file, printer or email).
  Format: script literal
  Use the following database query to see all valid values:

select XLATSHORTNAME from XLATTABLE where FIELDNAME = 'OUTDESTFORMAT';

Interface: PROCESSREQUEST and PROCESSREQUEST_SBB
PeopleSoft Version: 8+

• 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 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 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: