Understanding PeopleSoft Process Scheduler Support InformationThis chapter provides an overview of PeopleSoft Process Scheduler support information and discusses how to define:
System settings.
Process types.
Process definitions.
Recurrence definitions.
Note. PeopleSoft recommends mapping out the types of processes that you plan to schedule. Then, gather the parameter information for each process before you begin.
Understanding PeopleSoft Process Scheduler Support InformationBefore you can schedule processes to run, you must first define the basic information that PeopleSoft Process Scheduler uses. PeopleSoft Process Scheduler is delivered with a complete set of process type, process, and server definitions for all processes that are delivered with each PeopleSoft application. You might need to configure some of the definitions to suit your specific needs, but otherwise, they are set up to run immediately.
PeopleSoft Process Scheduler uses the concept of process types and process definitions to define the kinds of processes that you typically run. All process definitions are grouped under a process type. For example, most Structured Query Report (SQR) reports are defined in the PeopleSoft system with the process type of SQR Report, which contains settings that apply to all SQR process definitions under that process type. Within each process type, you must define specific process definitions, such as an SQR report named XRFWIN that you can run on a regular or as-needed basis.
You can also define the servers on which you want to run the process types or use the server definitions that PeopleSoft delivers with Process Scheduler. You must analyze the processes that you plan to schedule and group them logically, both to maximize server resources and to simplify procedures for users. Typically, a developer must establish PeopleSoft Process Scheduler definitions only once and then maintain them.
You must also consider other factors when incorporating PeopleSoft Process Scheduler into applications, including:
Third-party application programming interface (API) support for COBOL and SQR.
Types of PeopleCode that you can employ to interact with PeopleSoft Process Scheduler.
See Also
Defining System SettingsPeopleSoft Process Scheduler maintains a single-row table that stores system-wide parameters and system defaults that are related to all processes.
This section discusses how to define:
Process system settings.
Process output types.
Process output formats.
System purge options.
Distribution file options.
Report folders.
Event notifications.
Process categories.
Pages Used to Define System Settings|
Page Name |
Object Name |
Navigation |
Usage |
|
System Settings |
PRCSSYSTEM |
PeopleTools, Process Scheduler, System Settings, Process System. |
Enter system settings and default settings that are related to all processes. |
|
Process Output Type Settings |
PRCSOUTDESTTYPELST |
PeopleTools, Process Scheduler, System Settings, Process Output Type. |
Specify active and default output types for each process type. |
|
Process Output Format Settings |
PRCSOUTPUTSETTINGS |
PeopleTools, Process Scheduler, System Settings, Process Output Format |
Specify active and default output formats for each process type. |
|
Purge Settings |
PRCSSYSTEMPURGE |
PeopleTools, Process Scheduler, System Settings, System Purge Options. |
Enter purge settings to empty the PeopleSoft Process Scheduler tables and file system. |
|
Distribution File Options |
PRCSCDMFILE |
PeopleTools, Process Scheduler, System Settings, Distribution File Options. |
Identify all the different types of files and the manner of how they are distributed throughout the system. |
|
Report Folders Administration |
PSRF_FOLDER_ADM |
PeopleTools, Process Scheduler, System Settings, Report Folders Administration. |
Create folders for organizing reports in Report Manager. |
|
Event Notification |
PRCSRENSRV |
PeopleTools, Process Scheduler, System Settings, Event Notification. |
View information for REN Servers that have been configured with the REN Server Cluster Owner as either Reporting or All (PeopleSoft Multi-Channel Framework, Optimization, and Reporting). |
|
Test REN Server |
PRCSRENSRV_TEST |
Click the Test button on the Event Notification page. |
Perform Buffer and Ping tests on the REN Server. |
|
Process Categories Administration |
PRCS_GROUP_ADM |
PeopleTools, Process Scheduler, System Settings, Process Category Admin |
Create process categories for grouping processes together for the purpose of server load balancing and prioritization. |
Defining Process System SettingsAccess the System Settings page.
|
Enter the number of days before the files that are on the report repository are deleted. This value is used with the current date to calculate the expiration date on reports in Report Manager. |
|
|
Enter the default operating system. A run location of Any picks a server of this type. Note. If blank, the request will be scheduled by a Process Scheduler server with the default O/S. |
|
|
Select to assign to Primary O/S Only or Server in Any O/S. Assign To Primary O/S Only: Select to have Master Scheduler reassign workload to another Process Scheduler server with the primary O/S Assign To Server In Any O/S: Select to have Master Scheduler reassign workload to any available Process Scheduler server. When Do Not Use Option is selected on the Server Definition page, the server takes a request only when the name of the server has been specified on the Process Request page or in any of the definition tables. Note. This is used in conjunction with a Master Scheduler server. This field will be ignored if no Master Scheduler server is available to perform the load balancing. |
Set system settings for the following sequence keys: Process Instance, Report Instance, and Transfer Instance. The instance number acts as a counter.
|
Sequence |
Indicates the last instance used. |
|
Min Seq (minimum sequence) |
Indicates the lowest instance number used. |
|
Max Seq (maximum sequence) |
Indicates the highest number to be used. When this number is reached, system starts numbering again from the minimum sequence number. |
Defining Process Output TypesAccess the Process Output Type Settings page.
Use the Process Output Type page to specify active and default output types for each process type.
Note. When scheduling a process through PeopleCode using the ProcessRequest object, the default output type is used when the output type specified has been deactivated, or the output type was left blank.
|
Process Type |
Select the process type you wish to edit, or leave blank to display all process types. |
|
Type |
Lists the output types that are available for the selected process type. This field is display-only. |
|
Active |
Select the appropriate check box to make the output type active for the selected process type. |
|
Default Output |
Select the check box next to the output type that you want to display as the default on the Process Request page. |
Note. The Process Output Format Settings page uses information regarding output types, therefore it’s important to save any changes made to output type settings before attempting to change an output format setting.
Defining Process Output Formats
Access the Process Output Format Settings page.
Use the Process Output Format Settings page to specify active and default output formats for each process type.
Note. When scheduling a process through PeopleCode using the ProcessRequest object, the default output format is used when the output format specified has been deactivated, or the output format was left blank.
|
Process Type |
Select the process type, or leave blank to display all process types. |
|
Output Destination Type |
Further define the contents of the process output format settings list by selecting a specific output type. Select Any to list all active output types. Only output types specified as Active are displayed. |
|
Format |
Lists the format types that are available for the selected process type and output type. This field is display-only. |
|
Active |
Select the appropriate check box to make the format type active for the selected process type and output type. |
|
Default |
Select the check box next to the format type that you want to display as the default output on the Process Request page. A message appears, informing you that the format type is disabled if you select a format type for which the Active check box is cleared. |
Defining System Purge OptionsAccess the Purge Settings page.
Use the Purge Settings page to empty the PeopleSoft Process Scheduler tables and file system. This operation will schedule the Application Engine program PRCSYSPURGE.
The PRCSYSPURGE program performs the following:
Updates statistics to all of the process request tables before deleting content.
Purges all process requests with a last update date that is past the Days Before Purge value for the specified run statuses.
Deletes all of the subdirectories in the Log_Output directory that are associated with the process requests that are purged from the process request table if the Purge Process Files option was specified.
Purges the report repository tables with expired dates, based on the specified number of retention days.
Deletes all directories from the report repository that are associated with processes purged from the report repository tables.
Schedule the Application Engine PRCSRVCLN program if more than one active Process Scheduler server exists. PRCSRVCLN cleans up the Log/Output directory for all active servers.
|
Next Purge Date |
Enter the date on which the next file purge process is to run on the server. This is based on the recurrence schedule. |
|
Next Purge Time |
Enter the time at which the next file purge process is to run on the server. This is based on the recurrence schedule. |
|
Recurrence |
Select a recurrence schedule for the purge process. |
|
Purge Process Files |
Select to purge files that are associated with all of the processes from the table. |
|
Archive Process Request |
Not used. Reserved for future use. |
Specify purge criteria for each process run status listed.
|
Days Before Purge |
Enter the number of days before a process should be physically deleted from the request table. |
|
Enabled |
If clear, process requests with this run status are not purged. |
See Also
Defining Recurrence Definitions
Defining Distribution File OptionsAccess the Distribution File Options page.
Use the Distribution File Options page to identify all the different types of files and the manner of how they are distributed throughout the system. File types are identified based on the file extensions. This is used by the Distribution Agent to determine how a specific file type will be transferred to the Report Repository using FTP or HTTP. Also, this determines the description displayed in the Report Manager.
Use the Add and Delete buttons to add and remove available file types.
|
File Type |
The file extension used to identify the type of file. |
|
Binary File |
When selected, the report distribution system will not perform a conversion on the file when moving it between operating systems. Clear this check box for TXT and HTML files. |
|
System File |
Select to mark this file type as a System File. The file will be available to be viewed in the Process Monitor regardless of output type. Note. This feature requires that the Process Scheduler server definition has the attribute Transfer System Files to the Report Repository selected. |
|
Display |
Select to have the file shown on the report list page. |
|
Description |
Enter a description to be used for this file when displayed for viewing. If a description is not specified, the name of the file is used. |
Defining Report FoldersAccess the Report Folders Administration page.
Report Folders Administration page to create folders for organizing reports in Report Manager.
See Also
Defining Event Notifications and Configuring a REN ServerEvent Notification is a feature associated with PeopleTools Reporting's process output type Window. It is also used by Multi-Channel Framework. A new Application Server process called PSRENSRV is required, which acts as a special web server to deliver report results to a new browser window.
Any Process Scheduler can use a REN Server. The REN Server is an optional component of the PeopleSoft Application Server. There are four parameters located in the PSRENSRV section of the Application Server configuration file that may have to be configured.
If you already have a REN Server configured, you can bypass the remainder of this section, and go to Testing Event Notification.
Note. To configure a REN Server, you must enter an Authentication Token Domain when installing PeopleSoft Pure Internet Architecture.
To edit the PeopleSoft Application Server configuration file:
Select Start, Command Prompt.
Change the directory to <PS_HOME>\appserv\.
Type psadmin, and press Enter.
Select Application Server from the Server Administration menu by typing 1 and pressing Enter.
Select to Administer a Domain by typing 2 and pressing Enter.
Select the domain number to administer from the list of existing domains. Press Enter.
Select to configure the domain by typing 4 and pressing Enter.
Reply y to the question: This option will shutdown the domain. Do you want to continue? <y/n> [n] Press Enter.
Reply y to the question: Do you want to change any config values <y/n>? [n] Press Enter.
Reply n to the question: Do you want to change any values <y/n> [n]? for all sections until you get to the PSRENSRV section, and then answer y.
Note. The PSRENSRV section is near the end of the configuration, and will require approximately 28 returns to reach it.
Make the following changes:
|
Parameter |
Value |
|
log_severity_level |
Accept the default value of Warning. |
|
io_buffer_size |
Change the buffer size to 56000 if the REN Server is configured on NT. |
|
default_http_port |
Accept the default value of 7180. |
|
default_auth_token |
The fully qualified domain name of the application server. This value should match the value of the Web server's Authentication Token Domain. See PeopleTools 8.45 Installation Guide for your database platform. |
Accept the defaults for the remaining options except Do you want Event Notification configured <PSRENSRV> <y/n>? [n].Enter y, and press enter.
When the configuration is complete, boot the Application Server.
See Also
Testing Event NotificationsAccess the Event Notification page.
Note. A REN Server must be configured before you can test Event Notification.
See Defining Event Notifications and Configuring a REN Server.
Multiple REN Servers can be used by the system. However, only information for REN Servers that have been configured with the REN Server Cluster Owner as either Reporting or ALL (PeopleSoft Multi-Channel Framework, Optimization, and Reporting), will be listed on this page.
To verify the REN Server Cluster Owner, go to PeopleTools, REN Server Configuration, REN Server Cluster - Select the desired REN Server, REN Server Cluster Owner.
|
Cluster ID |
Displays the unique ID for the REN Server. |
|
Cluster URL |
Displays the following URL: http://<hostname>:7180 hostname: Application Server machine name. 7180: Default REN Server port number. Note. If you change the default, then you must change the values for the Cluster and Browser URLs. |
|
Displays the following URL: http://<hostname>.<default_auth_token>:7180 hostname: Application Server machine name. default_auth_token: PIA Auth Token Domain name, specified as the default_auth_token when configuring the REN Server. |
|
|
Active Flag |
Indicates whether the REN Server is Active or Inactive. An active REN Server enables the Window output type. An inactive REN Server does not accept the Window output type. However, pending reports will complete on current popup windows. |
|
Test |
Click to display the Test REN Server page. Use this page to verify the URLs are valid. |
Testing Cluster and Browser URLs
Access the Test REN Server page.
There are two different tests that can be performed:
Buffer: This test is performed on the Cluster URL. Tests the ability of PSRENSRV to break up and send a large file (over 50,000 characters) using multiple internal buffers. The numbered blocks count visible characters, but invisible HTML markup commands are on every line, so the actual server reply Content-Length is 55,902 characters.
The test is successful if all characters are shown and there is an End of file message at the bottom of the page.
Ping: This test is performed on the Browser URL. Sends a sequence of ping events to the PSRENSRV, waiting for each to respond before the next is sent.
The test is successful if Events Sent and Events Received both reach the same final value. The average latency depends on network configuration, machine load, and if debugging is turned on.
To perform a Buffer test:
Click the Buffer Test button.
The Buffer Test for PSRENSRV page is displayed in a new browser window.
Verify all characters are displayed, and there is an End of File message at the bottom of the page.
Close the browser window.
To perform a Ping test:
Click the Ping Test button.
The Ping Test for PSRENSRV page is displayed in a new browser window.
Select the Run Ping Test button.
System performs a total of 10 pings.
Close the browser window.
Select the Return button to return to the Event Notification page.
Defining Process CategoriesAccess the Process Categories Administration page.
Use process categories to group processes together for the purpose of server load balancing and prioritization. You can select to run jobs or processes belonging to certain process categories on specific servers, and then you can set a priority of high, medium, or low for each category.
For example, you can group your manufacturing processes into one category and your General Ledger (GL) processes into another category. You can then set the priority for your GL category to high so that they will always run first.
|
Process Category and Description |
Enter the name and description for each new process category. Note. The category Default is delivered with your system. If this is the only category available, all process or job definitions are automatically assigned to this category. |
Defining Process Type Definitions
This section provides an overview of process type definitions and discusses how to:
Enter global definitions for processes.
Set OS390 options.
Understanding Process Type DefinitionsThe primary purpose of the process type definition is to globally define the command line, parameter list, working directory and other general parameters for a specific process type. Consequently, the information doesn’t need to be duplicated for each process definition of the same type, and you can vary these global parameters as needed, depending on the target operating system and database platform.
PeopleSoft Process Scheduler supports all operating systems and database environments that are supported by PeopleSoft. However, not every operating system and database environment combination supports every process type. For example, process types of Crystal or PS/nVision are supported on Windows 2000 operating systems only, but SQR, COBOL, and PeopleSoft Application Engine can run on other operating systems, as well.
PeopleSoft Process Scheduler uses the following variables during run time:
Meta-strings.
Meta-strings provide runtime values to the definition and support the management of sensitive data, such as passwords, which are not written to the database.
In-line bind variables.
Client and server variables.
For each process request, all defined variables are evaluated and expanded, if possible. (For security reasons, %%OPRID%% is not expanded.) All variables that are not resolved through any of these sources might cause the process request to fail. Unresolved variables are easy to detect by reviewing the Process Request Detail page for the failed request.
The predefined meta-strings must be enclosed in a set of double percent signs. When processing a request, if PeopleSoft Process Scheduler encounters a string that is enclosed inside a set of double percent signs, it compares the variable name with an internal list of predefined meta-strings. If the variable name is not one of these meta-strings, it is assumed to be a server-based environment variable.
The following table includes all predefined meta-strings and their associated runtime values.
|
Predefined Meta-String |
Runtime Value |
|
%%ACCESSID%% |
Database Access ID. |
|
%%ACCESSPSWD%% |
Database Access Password. |
|
%%DBNAME%% |
Database Name. |
|
%%INSTANCE%% |
Process Instance. |
|
%%OPRID%% |
User’s Signon ID. |
|
%%OPRPSWD%% |
User’s Password (encrypted). |
|
%%OUTDEST%% |
Output Destination. For example, C:\%TEMP%; \\PrintServer1\Printer1. |
|
%%OUTDESTTYPE%% |
Output Type. For example, File, Printer; Web, Window, Email. |
|
%%OUTDESTFORMAT%% |
Output Format. For example, SPF; HTM; PDF; TXT. |
|
%%PRCSNAME%% |
Process Name. For example, XRFAPFL, GLPJEDIT. |
|
%%RUNCNTLID%% |
Run Control ID. For example, NTClient, CrystalServer. |
|
%%SERVER%% |
Reference the Database Server Name. |
|
%%EMAILID%% |
User's email address that is stored in Manage Security. |
|
%%CLIENTTIMEZONE%% |
Time zone specified for the client initiating the request. |
|
%%APPSERVER%% |
Application Server (used for three-tier). |
|
%%LOG/OUTPUTDIRECTORY%% |
Directory in the PeopleSoft Process Scheduler Server Agent to which a file generated from a process request is written. |
|
%%DEFAULTPRINTER%% |
Default printer defined in the Process Scheduler Configuration file. |
The parameter list may contain in-line bind variables. In-line bind variables represent any field (record.field) used in the current page and are defined as follows:
:RECORD.FIELD
For example, specify the following to pass the value of the User ID field from the RPT_RQST_WRK record as a parameter:
:RPT_RQST_WRK.OPRID
Variables must be enclosed in a set of double percent signs, as in %%OutputDirectory%%. At runtime, Process Scheduler first looks at all double-percent variables to determine if these represent a predefined meta-string value, such as %%OPRID%%. Because the meta-string is predefined, it can resolve the variable at initiation of each request. If the variable is not defined as a meta-string, Process Scheduler tries to find it in the Process Scheduler configuration file. If none is found it leaves the value unresolved.
Note. This documentation is not a substitute for the PeopleSoft Application Engine, COBOL, SQR, or Crystal Reports documentation. If you need additional information about parameters that are discussed here, the documentation from the appropriate vendor is your best reference.
Pages Used to Define Process Type Definitions|
Page Name |
Object Name |
Navigation |
Usage |
|
Type Definition |
PRCSTYPEDEFN |
PeopleTools, Process Scheduler, Process Types. |
Enter or update global definitions for processes. |
|
Type Definition Options |
PRCSTYPEDEFNOPT |
PeopleTools, Process Scheduler, Process Types, Type Definition Options. |
Set OS390 options. Note. This page is necessary only if you are using an OS390 operating system for the database. |
Entering Global Definitions for ProcessesAccess the Type Definition page.
Use the Type Definition page to enter or update global definitions for processes.
A process type must be defined for each database and operating system platform on which you want processes to run. PeopleSoft delivers process type definitions for many of the following types of processes, so if you’re adding a new process definition, it’s likely that you can associate it with an existing process type, rather than having to add a new one.
PeopleSoft Application Engine.
SQR.
COBOL.
Crystal.
Data Mover.
Important! Insert two colons (::) to define a colon in any variable string, as in C::\PT80\<executable>, if you are not using the %%<value>%% variable. The extra colon is required to distinguish these types of parameters from in-line bind variables, which use a single colon to prefix the record name.
|
Indicates the type of process that you are updating. For example, AppEngine (PeopleSoft Application Engine), COBOL, Crystal, Cube, Other, SQR, Winword (Microsoft Word for Windows), or nVision (PS/nVision). |
|
|
Command Line |
Indicates the executable program based on the generic process type selected. Enclose local (client) environment strings within a single pair of percent signs. For example, %TOOLBIN%. Enclose all server environment strings within a double pair of percent signs. For example, %%TOOLBIN%%. Note. If the path contains spaces you will need to add quotes around the entry. For example, " %%WINWORD%%\WINWORD.EXE". |
|
Parameter List |
Indicates the string of command line variables that are passed to the program. |
|
Indicates the directory containing the database drivers. The working directory is applicable only to the client and Windows 2000 servers. |
|
|
Output Destination |
Indicates the output destination for this process type. This is used for any process definition with an output destination source of Process Type, meaning that the process uses the values in the process type definition to determine where to send the output. |
|
Restart Enabled? |
Select to enable a process request to be restarted from Process Monitor. Restarting is allowed only if the user or class of users can currently update a request (Cancel or Delete). The parameter list for the failed request is modified to append the current process instance before assigning a new instance and reinserting the request with a status of Queued. All date and time stamps and runtime variables are reset, as appropriate. Note. If this is selected and fails, the status is No Success (not Error). |
This section discusses the specific values for:
PeopleSoft Application Engine process type definitions.
SQR report process type definitions.
COBOL SQL process type definitions.
Crystal process type definitions.
Data Mover process type definitions.
PeopleSoft Application Engine Process Type Definitions
When the generic process type is AppEngine, the Type Definition page contains these values:
|
Command Line |
Indicates the executable program PSAE.EXE, which is preceded by the directory name or environment string where the program resides. |
|
Output Destination |
Not required for PeopleSoft Application Engine processes. |
PSAE.EXE requires the following arguments in the Parameter List field:
-CT %%DBTYPE%% -CD %%DBNAME%% -CO %%OPRID%% -CP %%OPRPSWD%% -R %%RUNCNTLID%% -I %%INSTANCE%% -AI %%PRCSNAME%%
Following these arguments, you can add additional arguments, as needed. This table contains details about the required and optional arguments that apply to all PeopleSoft Application Engine process requests.
|
Value and Notes |
|
|
-CT |
Connect database type. |
|
-CS |
Connect server name, if required on logon dialog page. |
|
-CD |
Database to which you are connected. |
|
-CO |
User ID with which you are signed on. |
|
-CP |
User password (encrypted). |
|
-R |
Process run control ID. |
|
-I |
Process instance. |
|
-AI |
Name of the PeopleSoft Application Engine program. |
|
-FP |
The full path of the directory where files will be generated thru FileObject. To use the value assigned to this flag, use the PeopleCode system variable %FilePath |
|
-DEBUG |
Enables PeopleSoft Application Engine trace. This is equivalent to values assigned to TraceAE in the Process Scheduler Configuration file. |
|
-DBFLAGS |
Bit flag that enables or disables running statistics to a table when the meta-SQL %Update Stats% is coded in the PeopleSoft Application Engine program: 0: Enable. 1: Disable. |
|
-TOOLSTRACESQL |
Enables PeopleSoft SQL trace. This is equivalent to values assigned to TRACESQL in the Process Scheduler Configuration file. |
|
-TOOLSTRACEPC |
Enables PeopleCode trace. This is equivalent to values assigned to TracePC in the Process Scheduler Configuration file. |
SQR Report Process Type Definitions
When the generic process type is SQR, the Type Definition page contains these values:
|
Command Line |
Indicates the executable program PSSQR.EXE, a wrapper program to run SQR reports. |
Important! PSSQR.EXE is not designed to run manually outside of Process Scheduler.
PSSQR.EXE requires the following arguments in the Parameter List field:
-CT %%DBTYPE%% -CS %%SERVER%% -CD %%DBNAME%% -CA %%ACCESSID%% -CAP %%ACCESSPSWD%% -RP %%PRCSNAME%% -I %%INSTANCE%% -R %%RUNCNTLID%% -CO %%OPRID%% -OT %%OUTDESTTYPE%% -OP "%%OUTDEST%%" -OF %%OUTDESTFORMAT%%
Following these arguments, you can add additional arguments, as needed. This table contains details about the required and optional arguments that apply to all SQR process requests.
|
Value and Notes |
|
|
-CT |
Connect database type. |
|
-CS |
Connect server name, if required on the logon page. |
|
-CD |
Database to which you are connected. |
|
-CA |
Access ID with which you are signed on. |
|
-CAP |
Access password (encrypted). |
|
-RP |
Name of the report (.SQR) file. No path is required. PSSQR searches for the SQR report in configuration setting PSSQR1-4. |
|
-I |
Process instance. |
|
-R |
Process run control ID |
|
-CO |
User ID with which you are signed on. |
|
-OT |
Output type: 0: Any. 1: None. 2: File. 3: Printer. 5: Email. 6: Web. 7: Default. |
|
-OP |
Output path. If the output type is 1(printer), you can specify a logical printer name, such as \\printserver1\printer1. If the output type is 2 (file), you must specify a file path. |
|
-OF |
Output destination format, such as HTML. |
Note. Determine the output format for the output file by specifying the output format on the Process Scheduler Request page.
COBOL SQL Process Type Definitions
When the generic process type is COBOL, the Type Definition page contains these values:
|
Command Line |
Indicates the command to start the Windows-based COBOL program, preceded by the directory name or environment string that indicates where the program resides. |
|
Output Destination |
Not required for COBOL. |
Crystal Process Type Definitions
When the generic process type is Crystal, the Type Definition page contains these values:
|
Command Line |
Indicates the executable program PSCRRUN.EXE, a PeopleSoft API program to run Crystal reports, which is prefaced by the directory name or environment string that indicates where the program resides. |
|
Output Destination |
Not required for Crystal. |
PRCRRUN.EXE requires the following arguments in the Parameter List field:
-CT MICROSFT -CD%%DBNAME%% -CO%%OPRID%% -CP%%OPRPSWD%% -I%%INSTANCE%% -RP"%%PRCSNAME%%" -OT%%OUTDESTTYPE%% -OP%%OUTDEST%% -LG:PRCSRUNCNTL.LANGUAGE_CD -OF%%OUTDESTFORMAT%%
Following these arguments, you can add additional arguments, as needed. This table contains details about the required and optional arguments that apply to all Crystal process requests.
|
Value and Notes |
|
|
-CT |
Connect database type. |
|
-CS |
Connect server name, if required in the logon (NULL for client requests). |
|
-CD |
Database to which you are connected. |
|
-CO |
User ID with which you are signed on. |
|
-CP |
User password (encrypted). |
|
-I |
Process instance. |
|
-CX |
Application server name (if applicable). |
|
-RP |
Name of the report (.RPT) file. The .RPT extension is optional. PSCRRUN searches the directories specified by the Process Scheduler configuration file variable CRWRPTPATH. |
|
-OT |
Output type: 0: Any. 1: None. 2: File. 3: Printer. 5: Email. 6: Web. 7: Default. |
|
-OP |
Output Path. If Output Type = 3 (printer), then you can specify a logical printer name, such as \\printserver1\printer1 If Output Type = 2 (file), you must specify a file path. |
|
-LG |
Defines the requested language code for the specified Crystal report. This corresponds to a child directory below the Crystal Reports base directory, where the report should exist in the specified language. Various child directories can exist for each supported language. |
|
-OF |
Specifies the output destination format, such as HTML and so on. |
Crystal requires the following printer orientation and other report-specific arguments to be set in the process definition.
|
Value and Notes |
|
|
-ORIENT |
NULL. P: Portrait. L: Landscape. If the output type is 3 (printer), and the output destination is not NULL, you must specify a printer orientation. This should be specified as an appended parameter in the process definition. |
|
-SP |
Optional. Separate page indicator for HTML reports. Blank or 0: One HTML file - Default. 1: Separate HTML file for each page. |
|
-DHTML |
Optional. HTML type indicator for HTML reports. Blank or 0: HTML 3.2 std - Default. 1: HTML 4.0 (DHTML) |
|
-LX |
Optional. Disable locale formatting option. 0: Disables the automatic adjustment of report formats based on the user's International and Regional personalizations. Note. This flag should only be used if you require dates, times and numbers, in Crystal Report output, to always be formatted in the locale of the server machine instead of the locale of the user submitting the report. |
|
-PAPERLG |
Print Crystal reports using legal sized paper. |
|
-PAPERLT |
Print Crystal reports using letter sized paper. Note. This flag is used as the default for printer paper size. |
|
-CPI |
Set the character per inch parameter when you export a file to text. <Value> If the value is not set, a default of 12 is used. |
Note. Determine the output format for the output file by specifying the output format on the Process Scheduler Request page.
You must also set the following environment strings on the Crystal page in Configuration Manager.
|
Parameter |
Description |
|
Crystal EXEs Path |
Path to Crystal executable programs (PSCRRUN.EXE). |
|
Default Crystal Reports |
Path to Crystal report (.RPT) files. |
Data Mover Process Type Definitions
When the generic process type is Data Mover, the Type Definition page contains these values:
|
Command Line |
Indicates the executable program PSDMTX.EXE, which is preceded by the directory name or environment string where the program resides. |
PSDMTX.EXE requires the following arguments in the Parameter List field:
-CT %%DBTYPE%% -CD %%DBNAME%% -CO %%OPRID%% -CP %%OPRPSWD%% -I %%INSTANCE%% -FP %%PRCSNAME%%.dms
Following these arguments, you can add additional arguments, as needed. This table contains details about the required and optional arguments that apply to all PeopleSoft Data Mover process requests.
|
Value and Notes |
|
|
-CT |
Connect database type |
|
-CS |
Connect server name, if required on logon dialog page. |
|
-CD |
Database to which you are connected. |
|
-CO |
User ID with which you are signed on. |
|
-CP |
User password (encrypted). |
|
-I |
Process instance. |
|
-FP |
File name of the Data Mover script. If the value doesn’t include the absolute path, Data Mover will search the script from the directory specified in LastScriptsDir parameter found in the Data Mover section of the Process Scheduler configuration file. |
By default, Process Scheduler will use the name specified in the Process Definition as the Data Mover script file name value for the –FP flag. It will formulate the Data Mover script as <Process Definition Name>.dms
Note. If you want to assign a specific Data Mover script, you can do so by entering the in the Parameter List field found in the Override Options tab of the Process Definition page. For example, -FP userexport.dms.
See Also
Modifying Values Passed to Processes
Setting OS390 OptionsSelect PeopleTools, Process Scheduler, Process Types to access the Type Definition Options page.
Note. This page is necessary only if you are using an OS390 operating system for the database.
|
Job Shell ID |
Enter the ID that relates the process type to the Job Control Language (JCL) shell that contains the replaceable parameters for the process. |
|
Meta Parameter |
Enter the Meta-string parameter contained in the job shell. |
|
Meta Parm Value (Meta Parameter Value) |
Enter the value that replaces the meta-string parameter. |
Note. SQR for PeopleSoft now supports configurable space allocation for datasets on the zOS platform. The space allocation can be defined at the process level. For example, you can enter a setting to allocate 1 track for a small report or 100 cylinders for a large one.
Defining Process Definitions
This section provides an overview of process definitions and discusses how to:
Add new process definitions.
Set process definition options.
Modify values passed to processes.
Set destination options.
Set page transfer options.
Set notification options.
Set notification messages.
Set OS390 options.
Associate URLs.
Understanding Process DefinitionsAfter you specify a process type, you must create a process definition, specify the available options, and set up associated page transfers that might apply.
Use the following pages to complete the tasks for creating a process definition:
Process Definition.
Process Definition Options.
Override Options.
Destination.
Page Transfer.
Notification.
Message.
OS390 Option.
URL Links.
Pages Used to Define Process Definitions|
Page Name |
Object Name |
Navigation |
Usage |
|
Process Definition |
PRCSDEFN |
PeopleTools, Process Scheduler, Processes, Process Definition. |
Add new process definitions, or update existing. |
|
Process Definition Options |
PRCSDEFNOPT |
PeopleTools, Process Scheduler, Processes, Process Definition, Process Definition Options. |
Specify that a process runs from a specific location, server, component, or process group. Also specify system recovery processes and file dependency information. |
|
Override Options |
PRCSDEFNOVRD |
PeopleTools, Process Scheduler, Processes, Process Definition, Override Options. |
Modify values that are passed to the process. |
|
Destination |
PRCSDEFNCNTDIST |
PeopleTools, Process Scheduler, Processes, Process Definition, Destination. |
Set destination options. |
|
Page Transfer |
PRCSDEFNXFER |
PeopleTools, Process Scheduler, Processes, Process Definition, Page Transfer. |
Enables a user to go directly from the Process Monitor to a designated page in the PeopleSoft application. Specify navigational route that an end user must follow through the PeopleSoft menu interface. |
|
Notification |
PRCSDEFNNOTIFY |
PeopleTools, Process Scheduler, Processes, Process Definition, Notification. |
Send messages to a group (using a rile ID) or individuals (using a user ID) when a specific activity occurs with the process, such as an error or a successful completion of the job. |
|
Message |
PRCSDEFNMESSAGE |
PeopleTools, Process Scheduler, Processes, Process Definition, Message. |
Specify the messages that are sent when the Notification feature is used. |
|
OS390 Option |
PRCSDEFNOS390OPT |
PeopleTools, Process Scheduler, Processes, Process Definition, OS390 Option. |
Enter additional meta-string parameters for a process definition. Note. This page is necessary only if you are using an OS390 operating system for the database. |
|
URL Links |
PRCSDEFNURLS |
PeopleTools, Process Scheduler, Processes, Process Definition, URL Links. |
Associate multiple URLs with a process definition. The links appear on the Report detail page accessible from the Process Monitor and Report Manager. |
|
Edit URL Details |
PRCSDEFNURLDETAILS |
Click the URL Keys link on the URL Links page. |
View and edit key fields for the selected URL. |
Adding New Process DefinitionsAccess the Process Definition page.
|
Process Type |
The Process Type selected. |
|
Name |
This name must match the file name of the process you are defining. For example, if you are defining a SQR report named MYSQR.SQR, you must define the process name as MYSQR. |
|
Long Description |
This field is optional. |
|
Priority |
Select High, Medium, or Low to define the relative priority used by the PeopleSoft Process Scheduler Agent to determine which process to initiate first if multiple processes are queued to run on a server. |
|
Process Category |
Select a process category for this process. Note. The process category Default is delivered with your system. If this is the only category available, all process definitions are automatically assigned to this category. If additional process categories are created, this field value is blank. |
|
Select this check box if this is an API-aware process. If this is selected for any process that is not API-aware, PeopleSoft Process Scheduler includes this process in the concurrent task count. This can result in improper server load balancing. Selecting this option does not mean that the process becomes API-aware. You must still add API code to the process. The PeopleSoft Application Engine, COBOL, SQR, Cube Builder, nVision, Crystal, Data Mover, and Database Agent process types should be API-aware. If API Aware is cleared for any of these process types, it is recorded on the SYSAUDIT report. |
|
|
Restart Enabled? |
Select if the system should attempt to automatically restart this process if its marked with a run status of Error. |
|
Enter the number of times the system should attempt to automatically restart this process. Note. This field becomes active only if the Restart Enabled? check box is selected. |
Access the System Constraints section.
Important! For system constraints to be evaluated, you must configure the system with a master scheduler. In the absence of a master scheduler, the system will ignore settings for the following options.
|
Enter the maximum number of occurrences of this process that can be active at one time across all process schedulers. If this field is left blank (default), the value becomes Unlimited. Processes exceeding the maximum will appear n the process Monitor with a run status of Blocked. As active occurrences complete, blocked processes are released and queued. |
|
|
Enter the maximum processing time for this process. If this field is left blank (default), the value becomes Unlimited. The system will cancel the process if processing exceeds the time entered here. Important! This field is not supported for SQR and COBOL process types scheduled on a OS390 operating system, and run from UNIX System Services (USS). |
|
|
Enter the type and name all the processes that must not run at the same time as this process. Processes failing this constraint will appear on the Process Monitor with a run status of Blocked. When mutually exclusive processes complete, blocked processes are released and queued. |
See Also
Setting Process Definition OptionsSelect PeopleTools, Process Scheduler, Processes to access the Process Definition Options page.
Use the Process Definition Options page to specify a specific location, server, component, or process group that a process runs from.
|
(Optional) Server Name |
Specify a server on which the process should run. Specify the server name only to restrict this particular process to this server definition (or if you have only one server platform to submit your requests). Leave blank to have the process requested for the first server or default operating system that can process requests for the specified process class. This enables you to balance the load between multiple process servers, because your request is initiated by the first available server on the default operating system. Important! For the system to evaluate values entered for the On File Creation feature, you must provide a server name. This is validated when you save your process definition. |
|
(Optional) Recurrence Name |
Specify a predefined recurrence definition for this process. |
Access the On File Creation section.
|
File Dependency |
Select to activate the On File Creation feature. |
|
Wait for File |
Enter the location and name of the file this process is dependent upon. The process will not run until this file has been found. Processes on hold due to dependent files not being found will appear on the Process Monitor with a run status of Blocked. When the dependent files have been located, blocked processes are released and queued. Note. This information can also be entered or changed at runtime as long as the File Dependency check box has been selected. |
|
Time Out Max. Minutes |
Enter a time limit for the system to locate the dependent files. The system compares the current datetime to the timestamp of the time the process was queued. If the time limit is exceeded, the process is marked as Error and the restart procedure is attempted. |
See Specifying Process Variables.
Access the System Recovery Process section.
|
Process Type and Process Name |
Enter the type and name of an optional process that can be run in case this process runs to an error. The original process will not restart until the system recovery optional process entered here has run. |
Access the Process Security section.
|
Attach the process to components. Adding a component to a process definition causes that process definition to appear on the Process Scheduler Request page when you select File, Run in that component, if you have security to run the process. |
|
|
Process Group |
Make the process definition a member of the group. A process definition can be a member of multiple process groups. Process groups are then assigned to security profiles in PeopleSoft Security Administrator, which enables you to specify the process requests that classes of users can run. |
Modifying Values Passed to ProcessesAccess the Override Options page.
Use the Override Options page to modify values that are passed to the process.
|
Override Options |
Select a value if you have custom values to send through the parameter list, command line, or working directory: Append: Adds custom parameters to the end of the PeopleSoft string. Override: Sends custom parameters in place of the PeopleSoft defaults. Prepend: Adds custom parameters to the front of the PeopleSoft string. |
|
Parameters |
Enter the custom parameter values. |
Setting Destination OptionsNote. The output source destinations are enforced for users who are not allowed to override the output destination by their operator process profiles. If a user is allowed to override it, the user run control destination is used in the process request.
|
Type |
Select the default destination type for this process: None: Uses the user run control values. Any: User can specify any valid option. Default: Applicable to PS/nVision only. Depending on the type of process, other selections include Email, File, Printer, Window and Web. The value specified here overrides the value specified in the System Settings-Process Output Type page. If the value specified here is deactivated, the value designated as the default will be used. |
|
Format |
Select the format for this process. The value specified here overrides the value specified in the System Settings-Process Output Format page. If the value specified here is deactivated, the value designated as the default will be used. |
|
Destination Source |
Specify the output destination source for this process: None: Use for processes that do not create output or for processes for which you do not want to produce an output file or report. Process Definition: This request uses the output destination specified by the process definition. Process Type Definition: This request uses the output destination specified by the process type definition. User Specified: This is the default. The output destination for this request is determined by the process run control designation. For an SQR process, the destination source must be User Specified. |
|
Folder Name |
Select the folder the report will be displayed in the Explorer and List tables of the Report Manager. |
|
Output Destination |
Use to hard code the output destination into the process definition. This is enabled only when the source value is Process Definition. |
Setting Page Transfer OptionsAccess the Page Transfer page.
The Page Transfer or Log Transfer feature enables a user to go directly from the Process Monitor to a designated page in the PeopleSoft application to view the results from a successfully completed process.
To enable users to go directly from the Process Monitor to a page, specify the navigational route that an end user must follow through the PeopleSoft menu interface.
Note. If the search keys are not in the level 0 buffer of the current component, the Search page will be displayed.
|
Select the type of transfer for this process: None: Disables this feature for this process. The remaining fields become unavailable when this value is selected. Msg Log (message log): Enables the Log Transfer feature for this process. Next Page: Enables the Page Transfer feature for this process. |
|
|
Menu Name, Menu Bar Name, Menu Item, and Page Name |
Select the navigation path that the user follows through the PeopleSoft menu interface. |
|
Select one of the following menu actions that the user can perform when the page is selected: Add, Correction, Update, or Update All. |
Setting Notification Options
Use the Notification page to send messages to a group (using a role ID) or individuals (using a user ID) when a specific activity occurs with the process, such as an error, warning, or a successful completion of the process.
|
ID Type |
Select User or Role. |
|
Distribution ID |
Select the user ID of the user or group. |
|
On Error |
Select to notify the user or group when an error occurs in the process. |
|
On Warning |
Select to notify the user or group when a warning occurs for the process. |
|
On Success |
Select to notify the user or group when the process successfully completes. |
|
Disabled |
Select if you do not want to send notifications to the user or group. |
Setting Notification Messages
Use the Message page to specify the messages that are sent when the Notification feature is used. You can specify messages for successful completion and errors.
|
Select the message type: Default Message: Use the basic default message. Customized Message: Create your own message. Message Catalog: Select a message from the Message Catalog. |
|
|
Message Set/Number |
Select the Message Catalog set and number of the message. Complete these fields when the message type is Message Catalog. |
|
Text |
Enter the message text when the message type is Customized Message. |
Setting OS390 OptionsAccess the OS390 Option page.
The JCL shell and meta-string parameters used for constructing JCL that relates the process type to the JCL shell containing the replaceable parameters for the process have already been determined. Use this page to enter additional meta-string parameters for this process definition.
Note. This page is necessary only if you are using a OS390 operating system for the database.
|
Meta Parameter |
Enter the Meta-string parameter contained in the Job Shell. |
|
Meta Parm Value (Meta Parameter Value) |
Enter the value that replaces the meta-string parameter. |
Associating URLs
Use this page to associate multiple URLs with a process definition. he links appear on the report Detail page, which is accessible from the Process Monitor and the Report Manager.
|
Show URL for current component |
Select to create a link to the current component. |
|
Description |
Enter a description for the link. |
|
Menu Name, Market, Component, and Page Name |
Select to create the URL path and destination. |
|
URL Keys |
Click to go to the Edit URL Detail page. |
Access the Edit URL Details page.
Use this page to view or edit the key fields of the selected URL.
Defining Recurrence Definitions
This section discusses how to:
Set up recurrence definitions.
Set recurrence exceptions.
Understanding Recurrence DefinitionsRecurrence definitions enable you to make sure that important process requests and jobs that you must run on a regular basis always run automatically in the background. This eliminates the possibility of anyone forgetting to submit a process request or submitting one incorrectly. Once you specify a recurrence definition, the process request continues the cycle until you stop it manually.
Pages Used to Define Recurrence Definitions|
Page Name |
Object Name |
Navigation |
Usage |
|
Recurrence Definition |
PRCSRECURDEFN |
PeopleTools, Process Scheduler, Recurrences, Recurrence Definition. |
Specify recurrence definitions. |
|
Recurrence Exception |
PRCSRECUREXEMPT |
PeopleTools, Process Scheduler, Recurrences, Recurrence Exception |
Enter specific dates to ignore during recurrence definition schedule. |
Setting Up Recurrence Definitions
Access the Recurrence Definition page.
|
Recurrence Name |
This value appears in process and job definitions, so should be readily identifiable. |
|
Description |
Enter a description for this recurrence definition. The default is the recurrence name. |
|
Current request is initiated and Prior recurrence has completed |
Specify when the next recurrence should start. Note. When Prior recurrence has completed is selected, the definition is set to recur on success of the last instance. When the last instance runs to Warning, the scheduler treats the instance the same as Success. |
The contents of this group box change, depending on the recurrence pattern that you select.
Note. When validating the next recurrence date where a recurrence definition is set to run multiple times in a day, the system determines whether the calculated time for the day exceeds the maximum recurrence period for that day. For example, the definition is set up to run every hour for eight hours, beginning at 8:00 A.M. You select the definition for a process at 5:00 P.M. Due to the lateness of the day, the process cannot run every hour, eight times, so the process does not run until 8:00 A.M. the following day.
|
Daily |
When you select this option, also select either Everyday or Every Weekday. The system automatically selects check boxes for the days Sunday through Saturday (every day) or Monday through Friday (every weekday). The check boxes are not available for entry to prevent changes. |
|
Weekly |
Select check boxes for the days on which the process should run. For example, every Friday or every Monday, Wednesday, and Friday. |
|
Monthly |
When you select this option, also select either Day of Month to enter a numeric date or The to enter a day of the month. For example, select Day of Month and enter 15 to define the process to run on the 15th day of every month. Enter 31 to have the process run on the last day of every month. The system automatically adjusts for the varying number of days in each month. Note. Typically, the value for the Day of Month should match the Start Request Date. For example, if you select August 27, 2004 as the Start Request Date, you must ensure that the value for the Day of Month is 27 in order to define the process to run on the 27th day of every month. Otherwise, more than one recurrence run may occur. If you select The, select either 1st, 2nd, 3rd, 4th, or Last. Then select a specific day. For example, select 1st and Thursday to have the process run on the first Thursday of every month. |
|
Customized Dates |
Use this option when processes must run automatically on:
When you select this option, add the specific run dates in the Run on Specific Dates group box. |
|
Date and Time |
Enter the effective date and time at which the recurrence definition should become active. |
|
Do not schedule any processes missed from the recurrence pattern |
Select to run recurring process only at the times specified. Leave blank to run recurring process in catch up mode. Note. This option is used in situations such as when processes have been scheduled after the run time, or when servers are down when the processes should have run. Example 1: A process is scheduled to run daily at 10:00am. but the recurrence isn't set up until 2:00pm. If this option is selected, the process will not run until 10:00am the following day. If this option is not selected, the process will run immediately to catch up for the missed 10:00am run. Example 2: A process is scheduled to run hourly every day from 9:00am - 3:00pm. The process runs successfully at 9:00am and then the server goes down. It is not recovered until 5:00pm. If this option is selected, the process will not run until again until 9:00am the following day. If this option is not selected, the process will run six times to catch up for the missed runs scheduled for 10:00am, 11:00am, 12 noon, 1:00pm, 2:00pm, and 3:00pm. |
|
Date and Time |
Enter the date and time at which the recurrence definition should become inactive. Leave blank to keep the recurrence definition active indefinitely. |
|
Every and For |
Indicate how many times the process repeats. For example, you might specify that the process runs every 10 minutes for an hour. |
Use this group box when the recurrence pattern is Customized Dates.
|
Run Date (From) |
Select the date on which you want this process to run. |
|
Run Date (To) |
To run the process every day for a specific period, select the last date of the period. Leave blank if the process is to run for only one day. |
|
Effective Until (Year) |
To end the schedule after a specific number of years, enter the four-digit year. Leave blank for the schedule to continue indefinitely. |
Setting Recurrence ExceptionsAccess the Recurrence Exception page.
Use the Recurrence Exception page to enter specific days to ignore. For example, your schedule is set up to run every Monday. However, you don’t want the report to run on holidays, such as Labor Day and Memorial Day. When you enter the date as an exception, the system skips running the report on that day.
|
Exception Date (From) |
Select the date that you want this process to skip. |
|
Run Date (To) |
If you want the process to skip every day for a specific period, select the last date of the period. Leave blank to skip only one day. |
|
Effective Until (Year) |
To end the exception after a specific number of years, enter the four-digit year. Leave blank for the schedule to continue indefinitely. |