Submitting and Scheduling Process Requests

This chapter provides an overview of run control IDs and discusses how to:

Submit process requests.
Schedule process requests.

Note. This chapter is intended for the PeopleSoft application user who uses PeopleSoft Process Scheduler from a web browser to run background processes, such as PeopleSoft Application Engine, COBOL, or Structured Query Report (SQR). Depending on your security authorizations, you can run background processes on your browser or on a network server.

Understanding Run Control IDs

To run a report, you must tell the system when and where you want the report to run. For example, you might tell the system to run the report on the database server at midnight or on a Windows server every Sunday afternoon, or you might tell it to run the report immediately. For most reports, you must also set parameters that determine the content of the report, such as the business unit or time period on which to report.

A run control is a database record that provides values for these settings. Instead of entering the same values each time you run a report, you create and save a run control with those settings. The next time that you run the report, you select the run control, and the system fills in the settings.

You can create run controls that apply to several related reports. For example, suppose that all of the reports you run at the end of a month require the same parameters: business unit, department, and from and to dates. You can create a single run control that provides values for these parameters and use it for every report.

Conversely, you can create several run controls for the same report to handle different situations. For example, you can create one run control that sets the parameters for a quarterly report and another run control that sets them for a year-to-date version of the same report. Each time that you run the report, you select the appropriate run control. This way, you can print several variations of the same report without changing the settings every time.

A run control ID is used as a key (with a user ID) for records that contain the parameters that a process needs at runtime. Storing the parameters in a table that the process can query using the run control ID and user ID enables the process to run without user intervention. Run control IDs are stored in a minimum of two tables: an application run control table and the Tools Run Control table (PSPRCSRQST). You can examine the PS_PRCSRUNCNTL table as a sample application run control table.

The PeopleTools Run Control table stores information required by PeopleSoft Process Scheduler, such as output type, format, distribution, file dependency, and destination. The application run control table stores information required to run a process, such as the from date, department ID, employee ID, and so on. All application run control tables are keyed by user ID and run control ID.

Note. Run control IDs are product-specific. See your PeopleSoft product documentation for details on the run control IDs that you will be using.

Submitting Process Requests

This section discusses how to use the Process Request Dialog page.

Pages Used to Submit Process Requests

Page Name	Object Name	Navigation	Usage
Process Request Dialog	PRCSSAMPLEPNL1	PeopleTools, Process Scheduler, System Process Requests.	Select a run control ID and submit a process request.

Using the Process Request Dialog Page

The Process Request Dialog page shows the run control ID that you selected or added for submitting your process request. It also includes links to Report Manager and Process Monitor, so that you can check the progress of your job and view its content immediately after it is posted.

The Process Request Dialog page has two additional pages that show your options for submitting requests if you do not run the process from the browser:

The Component Interface page enables you to run the process from a component.
The ProcessRequest PeopleCode page enables you to run the process using PeopleCode.

This chapter is written with the primary focus of submitting process requests from the browser. Click the Run button to access the Process Scheduler Request page.

Using the PeopleCode ProcessRequest Class

Running Processes from PeopleSoft Applications

To expedite the process of running reports, PeopleTools delivers Run Control subpages for application developers. Using these subpages, application developers can run reports without navigating to the Process Request Dialog page.

The following subpages are recommended for application developers to use:

PRCSRUN_LC_SBP
PRCSRUN_RL_SBP
PRCSRUN_SBP
PRCSRUN_SBP2

The subpages comprise the following buttons:

Run Now	Click this button to request a process to run without launching the Process Request Dialog page. Process Scheduler will run the first process as listed on the Process Request Dialog page. If the process has previously been run, the system will retain the default output type based on the Run Control record.
Advance Schedule	Click this button to launch the Process Scheduler Request page to submit request(s) and customize the output type and output format of the process. This option is synonymous to the Run button on the Process Request Dialog page.

See Also

Defining a Subpage

Scheduling Process Requests

This section provides an overview of PeopleSoft Process Scheduler Requests and discusses how to:

Specify process variables.
Set job detail information.
Select output types and formats.
Set report distribution.
Set log/output directory and report repository.

Understanding PeopleSoft Process Scheduler Requests

The Process Scheduler Request page enables you to submit a job or process to run. This page is commonly integrated into applications to support process requests made from a PeopleSoft application by clicking Run.

When you click Run, the Process Scheduler Request page appears, showing all of the jobs and processes that you have the security to run.

The Process Scheduler Request page enables you to specify variables, such as where a process runs and in what format the process output is generated. You can set:

Server name.
Run date, run time, and time zone.
Recurrence.
Output type.
Output format.
Output destination.
Distribution.

Pages Used to Schedule Process Requests

Page Name	Object Name	Navigation	Usage
Process Scheduler Request	PRCSRQSTDLG	PeopleTools, Process Scheduler, System Process Requests, Process Request Dialog. Click Run.	Specify process variables.
Job Detail	PRCSRQSTITEMS_DLG	Click a job description listed on the Process Scheduler Request page.	Specify output options for processes contained within a job.
Distribution Detail	PRCSRQSTCDMAUTH	Click a Distribution link on the Process Scheduler Request page.	Set report distribution options.
File Dependency	PRCSRQST_FILE	Click a File Dependency link on the Process Scheduler Request page	Change the file dependency filename.

Specifying Process Variables

Access the Process Scheduler Request page.

Server Name

Select the name of server on which you want the process to run.

Recurrence

Select the recurring time intervals for the process to run.

For example, to run a process every weekday at 5:00 P.M., select the predefined recurrence definition M-F at 5pm.

Time Zone

Select the time zone in which the process will run.

For example, you might be in Eastern Standard Time (EST) and schedule a process to run in Pacific Standard Time (PST).

Run Date

Select the date on which you want the process to run.

Run Time

Select the time at which you want the process to run.

Reset to Current Date/Time

Click to reset the run date and time to the present date and time.

Select

Select a job or process to run. You can select multiple jobs and processes.

Description

Identifies a process or job. Jobs are listed as links. Click the link to display the Job Detail page, which shows all of the individual processes and jobs that are associated with the selected main job.

Process Name and Process Type

Identifies the name and type (such as COBOL or Crystal) of the process as it appears in the process or job definition.

Type

Select the output type for this job or process:

An output type selected for a process at the process definition level overwrites the output type and the output type drop-down list box becomes unavailable. An output type selected for a job at the main job level carries through to the job items. An output type selected for individual job items overwrites the output type that is entered for the parent job.

File: Writes the output to the file that you indicate in the Output Destination field.

Note. For PS/nVision, the Output Destination must contain the full path and the name of the file.

Printer: Sends the output to a printer. You can enter a custom printer location in the Output Destination field if you have the appropriate security access. If the Output Destination field is left blank, the printer that is defined on the Process Profile Permissions page is used. If that printer is undefined, the default printer defined for the process scheduler is used.

Email: Sends the output through an email. To distribute a report to an email list, enter the appropriate information on the Distribution Detail page by clicking the Distribution link. By default, the output is sent through email to the person running the process. This option is available for SQR, PS/nVision, and Crystal reports.

Web: Sends all output of the process to the report repository, including log and trace files. The format of the report is specified by the format list.

Window: Sends the output to a new browser window. The status of the process now appears in the new browser window before displaying the results. The different states can be Queued, Initiated, Processing, Success, Error, or Warning. All output for the process is also sent to the report repository, including log and trace files. The format of the report is specified by the format list.

When multiple processes are requested, a new browser window is opened for each request.

Note. This output type is not available if the user does not have REN Server Report Window permission, or there is no active REN Server cluster available for Reporting.

To grant access to the new browser window, the permission lists of the users must include full access for the Realtime Event Notification for Reporting Window and the WEBLIB_RPT web library with full access.

Format

Select the output format for this job or process.

When an output format is selected for a process at the process definition level it cannot be changed. Therefore, output format drop-down list box becomes unavailable.

Note. An output format selected for a job at the main job level carries through to the job items. The format selected for individual processes or jobs that are attached to a job override the format entered for the parent job.

Distribution

Click the Distribution link to access the Distribution Detail page, where you enter additional distribution information when the output type is Web, Window, or Email. Also use this page to select a folder name to which the output should be distributed when the output type is Web or Window.

File Dependency

Click the File Dependency link to access the File Dependency page, where you can change the name of the file currently listed.

Note. File dependency information is saved with the run control ID. Therefore, information changed in the process definition will not show here.

Output Destination

Enter the file path or printer destination for the output. This field is available only when the output type that you select is File or Printer.

If you select an output destination for a process at the process definition level, this field is populated with that output destination.

Note. For PS/nVision, if the output type is File, the output destination must contain the full path and the name of the file.

See Also

Defining Recurrence Definitions

Defining Process Type Definitions

Defining Process Output Types

Defining Process Output Formats

Setting Process Definition Options

Defining Permissions

Setting Job Detail Information

Access the Job Detail page.

When a job or JobSet is listed, only the main job appears on the Process Scheduler Request page. The Job Detail page displays all of the jobs and processes that are attached to the main job in a hierarchical view that assists you with specifying output options and distribution information for individual processes.

Note. You can specify the output options for jobs either at the main job level or for each job or process in the job.

See Also

Defining Jobs and JobSets

Selecting Output Types and Formats

Access the Process Scheduler Request page.

You can choose from several file output types and formats for your process. The following table lists file output types, listed by process type. The output type for PS/nVision is the same as the default output type on the PS/nVision Report Request page.

Note. TheWindow output type is not available if the user does not have REN Server Report Window permission, or there is no active REN Server cluster available for Reporting.

To grant access to the new browser window, the permission lists of the users must include full access for the Realtime Event Notification for Reporting Window and the WEBLIB_RPT web library with full access.

See Defining Permissions.

Note. If you select the Window output option for your process on the Process Request Dialog page, a message indicating that report notification is not supported on Apple Safari will appear. The process will be submitted to the web instead.

Process Type	Output Type	Default
AppEngine (PeopleSoft Application Engine)	FILE, WEB, WINDOW	WEB
COBOL	NONE, WINDOW, WEB	NONE
Crystal	WEB, WINDOW, EMAIL, FILE, PRINTER	WEB
Cube	NONE	NONE
nVision (PS/nVision)	WEB, WINDOW, EMAIL, FILE, PRINTER, DEFAULT	DEFAULT
SQR	WEB, WINDOW, EMAIL, FILE, PRINTER	WEB
WinWord (Microsoft Word)	WEB, WINDOW	WEB
Data Mover	FILE, WEB, WINDOW	WEB
OTHER	WEB, WINDOW, EMAIL, FILE, PRINTER, NONE	NONE

The following table shows a list of valid file output formats listed by process type.

Process Type	Output Type	Output Format	Default
AppEngine	FILE	PDF, XLS, TXT, HTM	TXT
AppEngine	WEB	PDF, XLS, TXT, HTM	TXT
AppEngine	WINDOW	PDF, XLS, TXT, HTM	TXT
COBOL	NONE	NONE	NONE
COBOL	WEB	TXT	TXT
COBOL	WINDOW	TXT	TXT
Crystal	EMAIL	DOC, HTM, RPT, RTF, TXT, XLS, PDF	HTM
Crystal	FILE	DOC, HTM, RPT, RTF, TXT, XLS, PDF	HTM
Crystal	PRINTER	RPT	RPT
Crystal	WEB	DOC, HTM, RPT, RTF, TXT, XLS, PDF	HTM
Crystal	WINDOW	DOC, HTM, RPT, RTF, TXT, XLS, PDF	HTM
Cube	NONE	NONE	NONE
nVision	EMAIL	HTM, XLS	XLS
nVision	FILE	HTM, XLS	XLS
nVision	PRINTER	HTM, XLS	XLS
nVision	WEB	HTM, XLS	XLS
nVision	WINDOW	HTM, XLS	XLS
nVision	DEFAULT	DEFAULT	DEFAULT
SQR	EMAIL	CSV, HP, HTM, LP, PDF, PS, SPF,OTHER	PDF
SQR	FILE	CSV, HP, HTM, LP, PDF, PS, SPF,OTHER	PDF
SQR	PRINTER	HP, LP, PS, WP	PS
SQR	WEB	CSV, HP, HTM, LP, PDF, PS, SPF,OTHER	PDF
SQR	WINDOW	CSV, HP, HTM, LP, PDF, PS, SPF,OTHER	PDF
WinWord	WEB	DOC	DOC
WinWord	WINDOW	DOC	DOC
Data Mover	FILE	TXT	TXT
Data Mover	WEB	TXT	TXT
Data Mover	WINDOW	TXT	TXT
OTHER	NONE	NONE	NONE

Note. You must install Adobe Acrobat Reader on your workstation to read PDF files.

Setting Report Distribution

Click the Distribution link on the Process Scheduler Request page to access the Distribution Detail page.

Note. You must specify an output type of Web, Window, or Email for the distribution list to be accepted when the process instance is created

Folder Name

Select the folder in which the report results are posted. Folders organize report results into meaningful groups and can be viewed from Report Manager.

Note. This option is available only when the output type on the Process Scheduler Request page for this process is Web or Window.

Distribute To

Select the recipients of the process output. Select an ID type of User or Role and the corresponding distribution ID.

Email recipients must be authorized to view the content of the email and their email addresses must be entered in their security user profiles.

Email Subject

Enter the text that appears in the subject line of the email. If this field is empty, the following default text message is used:

Output from <Program Name>(<Process Instance>).

Email With Log

Select to include log files resulting from the SQR program as attachments to the email file (SQR only).

Email Web Report

Select to send an email with a link to the completed report output. This option is available only when the output type for the request is Web.

Message Text

Enter text to appear in the body of the email. If this field is empty, the following default text message is used:

Message from Process Scheduler running on system <Process Scheduler Server Agent> using database <Database Name>.

Email Address List

Enter a list of email addresses, separated by semicolons, to which the email should be sent.

See Also

Administering User Profiles

Setting Up Process Scheduler Log/Output Directory and Report Repository

When Process Scheduler submits a request, the system creates a new subdirectory to store the log, trace and reports generated by the request. This subdirectory is created in the directory specified in the Log/Output Directory parameter in the Process Scheduler configuration file. When there is a high volume of requests being processed by the Process Scheduler server, limitations imposed by the operating system can prevent additional directories from being generated for the new requests. For instance, certain UNIX flavors only allocate 32K Inodes for a directory.

To prevent the Log/Output directory from reaching the limit imposed by the operating system, you can set up additional subdirectories using meta-variables. You can modify the Log/Output directory parameter to include any of the meta-variables listed below in order to build additional subdirectories.

The meta-variables are as follows:

Meta Variable	Description
%OPRID%	PeopleSoft User ID
%REPORTID%	Report Instance
%PRCSINSTANCE%	Process Instance
%PRCSTYPE%	Process Type
%SERVER%	Process Scheduler Server
%CURRDATE%	Current Date
%CURRHOUR%	Current Hour
%JOBNAME%	Job Name
%JOBINSTANCE%	Job Instance

Log/Output Directory

By default, the Log/Output directory is %PS_SERVDIR%\log_output. You can modify the structure of the subdirectory to include the date and hour as subdirectories by changing the default parameter to:

%PS_SERVDIR%\log_output\%CURRDATE%\%CURRHOUR%

Report Repository

You can use the same mechanism to alter the subdirectory structure for the Report Repository. To change the directory structure in the Report Repository, you need to modify the definition of the Report Node stored in the PS_CDM_DIST_NODE.

In the PS_CDM_DIST_NODE table, the field CDM_DIR_TEMPLATE sets the directory structure as follows:

%DBNAME%/%CURRDATE%/%REPORTID

You can alter the value of the field to include any of the meta-variables listed above.

See Also

Log and Output Directory

Server Name	Select the name of server on which you want the process to run.
Recurrence	Select the recurring time intervals for the process to run. For example, to run a process every weekday at 5:00 P.M., select the predefined recurrence definition M-F at 5pm.
Time Zone	Select the time zone in which the process will run. For example, you might be in Eastern Standard Time (EST) and schedule a process to run in Pacific Standard Time (PST).
Run Date	Select the date on which you want the process to run.
Run Time	Select the time at which you want the process to run.
Reset to Current Date/Time	Click to reset the run date and time to the present date and time.
Select	Select a job or process to run. You can select multiple jobs and processes.
Description	Identifies a process or job. Jobs are listed as links. Click the link to display the Job Detail page, which shows all of the individual processes and jobs that are associated with the selected main job.
Process Name and Process Type	Identifies the name and type (such as COBOL or Crystal) of the process as it appears in the process or job definition.
Type	Select the output type for this job or process: An output type selected for a process at the process definition level overwrites the output type and the output type drop-down list box becomes unavailable. An output type selected for a job at the main job level carries through to the job items. An output type selected for individual job items overwrites the output type that is entered for the parent job. File: Writes the output to the file that you indicate in the Output Destination field. Note. For PS/nVision, the Output Destination must contain the full path and the name of the file. Printer: Sends the output to a printer. You can enter a custom printer location in the Output Destination field if you have the appropriate security access. If the Output Destination field is left blank, the printer that is defined on the Process Profile Permissions page is used. If that printer is undefined, the default printer defined for the process scheduler is used. Email: Sends the output through an email. To distribute a report to an email list, enter the appropriate information on the Distribution Detail page by clicking the Distribution link. By default, the output is sent through email to the person running the process. This option is available for SQR, PS/nVision, and Crystal reports. Web: Sends all output of the process to the report repository, including log and trace files. The format of the report is specified by the format list. Window: Sends the output to a new browser window. The status of the process now appears in the new browser window before displaying the results. The different states can be Queued, Initiated, Processing, Success, Error, or Warning. All output for the process is also sent to the report repository, including log and trace files. The format of the report is specified by the format list. When multiple processes are requested, a new browser window is opened for each request. Note. This output type is not available if the user does not have REN Server Report Window permission, or there is no active REN Server cluster available for Reporting. To grant access to the new browser window, the permission lists of the users must include full access for the Realtime Event Notification for Reporting Window and the WEBLIB_RPT web library with full access.
Format	Select the output format for this job or process. When an output format is selected for a process at the process definition level it cannot be changed. Therefore, output format drop-down list box becomes unavailable. Note. An output format selected for a job at the main job level carries through to the job items. The format selected for individual processes or jobs that are attached to a job override the format entered for the parent job.
Distribution	Click the Distribution link to access the Distribution Detail page, where you enter additional distribution information when the output type is Web, Window, or Email. Also use this page to select a folder name to which the output should be distributed when the output type is Web or Window.
File Dependency	Click the File Dependency link to access the File Dependency page, where you can change the name of the file currently listed. Note. File dependency information is saved with the run control ID. Therefore, information changed in the process definition will not show here.
Output Destination	Enter the file path or printer destination for the output. This field is available only when the output type that you select is File or Printer. If you select an output destination for a process at the process definition level, this field is populated with that output destination. Note. For PS/nVision, if the output type is File, the output destination must contain the full path and the name of the file.

Folder Name	Select the folder in which the report results are posted. Folders organize report results into meaningful groups and can be viewed from Report Manager. Note. This option is available only when the output type on the Process Scheduler Request page for this process is Web or Window.
Distribute To	Select the recipients of the process output. Select an ID type of User or Role and the corresponding distribution ID. Email recipients must be authorized to view the content of the email and their email addresses must be entered in their security user profiles.
Email Subject	Enter the text that appears in the subject line of the email. If this field is empty, the following default text message is used: Output from <Program Name>(<Process Instance>).
Email With Log	Select to include log files resulting from the SQR program as attachments to the email file (SQR only).
Email Web Report	Select to send an email with a link to the completed report output. This option is available only when the output type for the request is Web.
Message Text	Enter text to appear in the body of the email. If this field is empty, the following default text message is used: Message from Process Scheduler running on system <Process Scheduler Server Agent> using database <Database Name>.
Email Address List	Enter a list of email addresses, separated by semicolons, to which the email should be sent.