Enterprise PeopleTools 8.51 PeopleBook: PeopleSoft Process Scheduler

Defining PeopleSoft Process Scheduler Support Information

This chapter provides an overview of PeopleSoft Process Scheduler support information and discusses how to:

Define system settings.
Define process type definitions.
Define process definitions.
Define recurrence definitions.

Note. You should plan the types of processes that you plan to schedule. Then, you should gather parameter information for each process before you begin.

Understanding PeopleSoft Process Scheduler Support Information

Before 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 concepts 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

Using Process Request APIs

Defining System Settings

PeopleSoft 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.
Define process output types.
Define process output formats.
Define system purge options.
Define distribution file options.
Define report folders.
Define event notifications and configure a real-time event notification (REN) server.
Test event notifications.
Define process categories.

Pages Used to Define System Settings

Page Name	Definition Name	Navigation	Usage
System Settings	PRCSSYSTEM	PeopleTools, Process Scheduler, System Settings, Process System	Define process system settings.
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 in which 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.
Console Preferences	PTRC_DISPLAY_IMG	PeopleTools, Process Scheduler, System Settings, Console Preferences	Define icons to display in the Reporting Console for each process type.

Defining Process System Settings

To access the System Settings page, select PeopleTools, Process Scheduler, System Settings, Process System.

Retention Days

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 when retention days are not specified in Process Type definition, Process definition, or Run Control.

See Defining System Purge Options.

Primary Operating System

Enter the default operating system. A run location of Any picks a server of this type.

Note. If this field is left blank, the request will be scheduled by a Process Scheduler server with the default O/S.

System Load Balancing Option

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 the 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 field 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.

System Settings

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 number that was used.
Min Seq (minimum sequence)	Indicates the lowest instance number to be used.
Max Seq (maximum sequence)	Indicates the highest instance number to be used. When this number is reached, the system starts numbering again from the minimum sequence number.

Note. The maximum value for Process Instance is 2,147,483,646. The maximum value for Report Instance and Transfer Instance is 999,999,999,999,999.

Defining Process Output Types

To access the Process Output Type Settings page, select PeopleTools, Process Scheduler, System Settings, Process Output Type.

Use this page to specify active and default output types for each process type.

Note. When you are scheduling a process through PeopleCode using the ProcessRequest object, the default output type is used when the output type that is specified has been deactivated or the output type was not specified.

Process Type	Select the process type that you want 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 about output types; therefore, you need to save any changes that were made to output type settings before attempting to change an output format setting.

Defining Process Output Formats

To access the Process Output Format Settings page, select PeopleTools, Process Scheduler, System Settings, Process Output Format.

Use the Process Output Format Settings page to specify active and default output formats for each process type.

Note. When you are scheduling a process through PeopleCode using the ProcessRequest object, the default output format is used when the output format that is specified has been deactivated, or the output format was not specified.

Process Type	Select the process type, or leave blank to display all process types.
Process Name	For process types that have registered non-unique processes, this field is used to identify the non-unique process. Note. Non-unqiue processes include Connected Query (PSCONQRS), Query (PSQUERY), and XML Publisher (PSXPQRYRPT).
Output Destination Type	Select a specific output type to further define the output format options. Only output types specified as Active appear.
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 appear 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 deselected.

Defining System Purge Options

To access the System Purge Options page, select PeopleTools, Process Scheduler, System Settings, System Purge Options.

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:

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 selected.
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 that were purged from the report repository tables.
Schedules the Application Engine PRCSRVCLN program if more than one active Process Scheduler server exists.

PRCSRVCLN refreshes the Log/Output directory for all active servers.
Purges the BusinessObjects Enterprise XI report repository.
Schedules the Application Engine PSXPARCHATTR program for XML Publisher reports to archive report-related metadata and the URLs of the report files.

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 when 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 Settings

Specify purge criteria for each process run status that is listed.

Days Before Purge	Enter the number of days before a process should be physically deleted from the request table.
Enabled	If this check box is cleared, process requests with this run status are not purged.

See Also

Defining Recurrence Definitions

Defining Distribution File Options

To access the Distribution File Options page, select PeopleTools, Process Scheduler, System Settings, Distribution File Options.

Use the Distribution File Options page to identify all the different types of files and the manner in which 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 File Transfer Protocol (FTP) or HTTP. Also, this determines the description that is displayed in the Report Manager.

Use the Add and Delete buttons to add and remove available file types.

File Type	Identifies the type of file.
Binary File	Deselect for TXT and HTML files. Note. When this check box is selected, the report distribution system will not perform a conversion on the file when moving it between operating systems.
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 it is displayed for viewing. If a description is not specified, the name of the file is used.

Defining Report Folders

To access the Report Folders Administration page, select PeopleTools, Process Scheduler, System Settings, Report Folders Administration.

Use the Report Folders Administration page to create folders for organizing reports in Report Manager.

Folder Name

Use the Add and Delete buttons to add and remove folder names.

Description

Enter a more detailed description for the folder to identify its use.

Default

Select the check box next to the folder that you want to display as the default. The default folder is automatically selected on the Process Scheduler Request-Distribution Detail page.

Note. A default folder is required.

See Also

Understanding Report Folders

Defining Event Notifications and Configuring a REN Server

Event Notification is a feature that is associated with the PeopleTools Reporting 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. Four parameters are located in the PSRENSRV section of the Application Server configuration file that may have to be configured.

See Configuring REN Servers.

Testing Event Notifications

To access the Event Notification page, select PeopleTools, Process Scheduler, System Settings, Event Notification.

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), are listed on this page.

To verify the REN server cluster owner, select 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.
Browser URL	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 finish on current popup windows.
Test	Click to display the Test REN Server page. Use this page to verify that the URLs are valid.

Testing Cluster and Browser URLs

Access the Test REN Server page.

Two different tests can be performed:

Buffer: This test is performed on the Cluster URL. It 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.

Note. The test is successful if all characters are shown and an End of file message appears at the bottom of the page.
Ping: This test is performed on the Browser URL. It sends a sequence of ping events to the PSRENSRV, waiting for each to respond before sending the next.

Note. 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 whether debugging is enabled.

To perform a Buffer test:

Click the Buffer Test button.

The Buffer Test for PSRENSRV page appears in a new browser window.
Verify that all characters are shown and that an End of File message appears 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 appears in a new browser window.
Click the Run Ping Test button.

The system performs a total of 10 pings.
Close the browser window.

Click the Return button to return to the Event Notification page.

Defining Process Categories

To access the Process Categories Administration page, select PeopleTools, Process Scheduler, System Settings, Process Category Admin.

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 GL processes always run first.

Process Category and Description

Enter the name and description for each new process category.

Note. The categories Default and LOADCACHE are delivered with your system.

Note. The process category LOADCACHE is only used to run the Parallel LoadCache job.

See Also

Load Application Server Cache

Defining Console Preferences

To access the Console Preference page, select PeopleTools, Process Scheduler, System Settings, Console Preferences.

This page is used to identify the icons that are displayed in the Reporting Console for each process type.

If you add any custom process types, you will need to add the custom process type to the Console Preferences.

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 Definitions

The 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 Microsoft Windows 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 runtime:

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. You can detect unresolved variables easily by reviewing the Process Request Detail page for the failed request.

Meta-Strings

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 the user profile.
%%CLIENTTIMEZONE%%	Time zone that is 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 that is generated from a process request is written.
%%DEFAULTPRINTER%%	Default printer defined in the Process Scheduler Configuration file.

In-Line Bind Variables

The parameter list may contain in-line bind variables. In-line bind variables represent any field (record.field) that is used in the current page and they are defined like this:

:RECORD.FIELD

For example, specify the following code 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 whether 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.

Parameter List Formatting

The parameter list consists of a series of tokens that make up the parameters to be used for the process. Tokens are separated by unquoted space characters. Single or double quote characters can be used for quoting. Both types of quotes are treated equivalently, but the starting and ending quotes for a quoted portion of a token must match. A quoted string may not contain quotes of the same type but a single quoted string can contain double quote characters and vice versa. A single token may consist of multiple adjacent quoted characters however no spaces are permitted between the quoted fragments. Unterminated quoted fragments will result in an error.

This table shows examples of parameter lists that require formatting:

Example Parameter Value	Format
A parameter that contains spaces. parameter value = 1 2 3	“1 2 3” or '1 2 3' Note. Use either single or double quotes.
A parameter that contains space and apostrophe (single quote) characters. parameter value = customer's update	“customer's update” Note. Use double quotes for the parameter so that the apostrophe (single quote) and space characters are passed correctly.
A parameter that contains space, apostrophe (single quote), and double quote characters. Parameter value = John's comments “Hello There”	“John's comments” '“Hello There”' Note. The first fragment is enclosed in double quotes so that the single quote and space characters are passed correctly and the second fragment is enclosed in single quotes so that the double quote and space characters are passed correctly. Note that there are no spaces between the quoted fragments.

Example Parameter Value

Format

A parameter that contains spaces.

parameter value = 1 2 3

“1 2 3”

'1 2 3'

Note. Use either single or double quotes.

A parameter that contains space and apostrophe (single quote) characters.

parameter value = customer's update

“customer's update”

Note. Use double quotes for the parameter so that the apostrophe (single quote) and space characters are passed correctly.

A parameter that contains space, apostrophe (single quote), and double quote characters.

Parameter value = John's comments “Hello There”

“John's comments” '“Hello There”'

Note. The first fragment is enclosed in double quotes so that the single quote and space characters are passed correctly and the second fragment is enclosed in single quotes so that the double quote and space characters are passed correctly. Note that there are no spaces between the quoted fragments.

Meta-variables can be used either quoted or unquoted and may contain quoted fragments themselves. Meta-variables are expanded before quotes are processed.

This table shows examples of parameter lists containing meta-variables that require formatting:

Example Parameter Values	Parameter List Format	Explanation
1st parameter = -p 2nd parameter = Param 2 3rd parameter = Param 3	-p %%METASTRING%%	METASTRING = ”Param 2” ‘Param 3’ This parameter list that uses a single meta-variable to pass multiple parameters containing spaces. Note. The meta-variable contains quotes so that the single meta-variable can be used to pass multiple parameters containing spaces.
1st parameter = -p 2nd parameter = Param 2	-p “%%METASTRING1%% %%METASTRING2%%”	METASTRING1 = Param METASTRING2 = 2 This parameter list uses two meta-variable to pass a single parameter containing spaces. Note. The meta-variables are enclosed in quotes in order to pass the expanded meta-variables as part of a single parameter.
1st Parameter = -p 2nd Parameter = Param 3rd Parameter = 1 4th Parameter = John’s comment	-p “%%METASTRING1%%” “%%METASTRING2%%”	METASTRING1 = “Param 1” METASTRING2 = John’s comment This parameter list demonstrates behavior that can occur when meta-variables are quoted and themselves contains quotes. Care must be taken when quoting meta-variables or using meta-variables containing space, single quote, or double quote characters to ensure parameters are passed as intended. Note. The double quotes around METASTRING1 and in its value cancel each other out resulting in the contents of METASTRING1 becoming two parameters. Additionally, note that if METASTRING2 were not quoted with double quotes, an error would occur as the single quote in METASTRING2 would be seen as the start of an unterminated quote

Pages Used to Define Process Type Definitions

Page Name	Definition 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.

Page Name

Definition 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 Processes

To access the Type Definition page, select PeopleTools, Process Scheduler, Process Types.

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 are adding a new process definition, you may be able to associate it with an existing process type rather than having to add a new one.

PeopleSoft Application Engine.
SQR.
COBOL.
Crystal.
Data Mover.
XML Publisher.

Note. Be sure to use unique names when defining new process types. This makes it easier to select a process based on the process type.

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.

Generic Process Type	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). Note. The Generic Process Type for XML Publisher is AppEngine.
Command Line	Indicates the executable program based on the generic process type that is 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 quotation marks around the entry, for example, " %%WINWORD%%\WINWORD.EXE".
Parameter List	Indicates the string of command line variables that are passed to the program. Note. If the parameter value will contain spaces, you will need to add quotation marks around the argument, for example -OP is entered as, " %%OUTDEST%%. See Parameter List Formatting.
Working Directory	Indicates the directory containing the database drivers. The working directory is applicable only to the client and Microsoft Windows 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 the request is assigned a new instance and reinserted with a status of Queued. All date and time stamps and runtime variables are reset, as appropriate. Note. If this check box is selected and the request fails, the status is No Success (not Error).
Retention Days	Set the retention days that are used to determine the expiration date. The expiration date is determined by adding the retention days from the date on which the report was generated. Note. The retention days value entered for a process type will be the default retention days for process definitions using the process type.

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.
Essbase Cube Builder process type definitions.
XML Publisher process type definitions.

PeopleSoft Application Engine Process Type Definitions

When the generic process type is AppEngine, the Type Definition page contains these fields:

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%% -OT %%OUTDESTTYPE%% -FP "%%OUTDEST%%" -OF %%OUTDESTFORMAT%%

To start an Application Engine program from the command line, you must specify the Application Engine executable (PSAE.EXE) followed by the required parameters, as shown in the following example:

psae -CT dbtype -CS server -CD database_name -CO oprid -CP oprpswd⇒ -R run_control_id -AI program_id -I process_instance -DEBUG (Y|N)⇒ -DR (Y|N) -TRACE tracevalue -DBFLAGS flagsvalue -TOOLSTRACESQL value⇒ -TOOLSTRACEPC value -OT outtype -OF outformat -FP filepath

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.

Flag	Value and Notes
-CT	Connect database type.
-CS	Connect server name, if required on sign-in dialog page.
-CD	Database to which you are connected.
-CO	User ID with which you are signed in.
-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 through FileObject. To use the value that is assigned to this flag, use the PeopleCode system variable %FilePath
-DEBUG	Enables PeopleSoft Application Engine trace. This is equivalent to values that are 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 that are assigned to TRACESQL in the Process Scheduler Configuration file.
-TOOLSTRACEPC	Enables PeopleCode trace. This is equivalent to values that are assigned to TracePC in the Process Scheduler Configuration file.
-FP	File path.
-OT	Output type: 2: File. 5: Email. 6: Web.
-OF	Output destination format, such as HTML.

SQR Report Process Type Definitions

When the generic process type is SQR, the Type Definition page contains this field:

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 -CT %%DBTYPE%% -CS %%SERVER%% -CD %%DBNAME%% -CA %%ACCESSID%% -CAP %%ACCESSPSWD%% -RP %%PRCSNAME%% -I %%INSTANCE%% -R %%RUNCNTLID%% -CO %%OPRID%% -OT %%OUTDESTTYPE%% -OP "%%OUTDEST%%" -OF %%OUTDESTFORMAT%% -LG %%LANGUAGECD%%

Note. If the path for the Log/Output Directory in the psprcs.cfg contains spaces, you will need to add quotation marks around the argument for -OP as shown in the preceding example, " %%OUTDEST%%".

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.

Flag	Value and Notes
-CT	Connect database type.
-CS	Connect server name, if required on the sign-in 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 in.
-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.
-LG	Defines the requested language code for the specified SQR report.

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

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.

Note. The executable program for Crystal Reports 2008 is PSCRRUN.EXE. PSBOERUN.EXE is the executable used with BusinessObjects Enterprise XI. The command line executable changes when you convert your reports to the Crystal XI format.

See the Enterprise PeopleTools 8.51 Installation guide for your database platform, Installing and Configuring Software for Crystal Reports, Converting Crystal Reports, Converting Reports from Crystal Reports 9 format to Crystal Reports XI format.

Output Destination

Not required for Crystal.

PSCRRUN.EXE requires the following arguments in the Parameter List field:

-CT%%DBTYPE%% -CD%%DBNAME%% -CO%%OPRID%% -CP%%OPRPSWD%% -I%%INSTANCE%% -RP"%%PRCSNAME%%" -OT%%OUTDESTTYPE%% -OP"%%OUTDEST%%" -LG%%LANGUAGECD%% -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.

Flag	Value and Notes
-CT	Connect database type.
-CS	Connect server name, if required in the sign-in (NULL for client requests).
-CD	Database to which you are connected.
-CO	User ID with which you are signed in.
-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 that are specified by the Process Scheduler configuration file variable CRWRPTPATH. PSBOERUN searches the directories in the BusinessObjects Enterprise report repository.
-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 PDF.

Crystal requires the following printer orientation and other report-specific arguments to be set in the process definition.

Argument	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 be used only 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.
-LN	Optional. Sets the number of lines per page when exporting to text format. <Value> Omitting this option or specifying a value of 0 results in non-paginated text output.

Note. Determine the output format for the output file by specifying the output format on the Process Scheduler Request page.

Data Mover Process Type Definitions

When the generic process type is Data Mover, the Type Definition page contains this field:

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%%

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.

Flag	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 in.
-CP	User password (encrypted).
-I	Process instance.

Essbase Cube Builder

When the generic process type is Essbase Cube Builder, the Type Definition page contains these values:

Command Line	Indicates the executable program PS2ESSBASE.EXE.
Output Destination	Not required forEssbase Cube Builder.

PS2ESSBASE.EXE requires the following arguments in the Parameter List field:

-CT%%DBTYPE%% -CD%%DBNAME%% -CO%%OPRID%% -CP%%OPRPSWD%% -I%%INSTANCE%% -R%%RUNCNTLID%% -OP "%%OUTDEST%%"

This table contains details about the required that apply to Essbase Cube Builder process requests.

Flag	Value and Notes
-CT	Connect database type.
-CD	Database to which you are connected.
-CO	User ID with which you are signed in.
-CP	User password (encrypted).
-I	Process instance.
-R	Process run control ID.
-OP	Log files output destination

XML Publisher Process Type Definitions

When the process type is XML Publisher, the generic process type is AppEngine and the Type Definition page contains these fields:

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 XML Publisher 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%% -OT %%OUTDESTTYPE%% -FP "%%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 PeopleSoft XML Publisher process requests.

Flag	Value and Notes
-CT	Connect database type.
-CS	Connect server name, if required on sign-in dialog page.
-CD	Database to which you are connected.
-CO	User ID with which you are signed in.
-CP	User password (encrypted).
-R	Process run control ID.
-I	Process instance.
-AI	Name of the PeopleSoft Application Engine program.
-OT	Output type: 2: File. 3: Printer. 5: Email. 6: Web.
-FP	The full path of the directory where files will be generated through FileObject. To use the value that is assigned to this flag, use the PeopleCode system variable %FilePath
-OF	Specifies the output destination format, such as HTML.
-DEBUG	Enables PeopleSoft Application Engine trace. This is equivalent to values that are 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 that are assigned to TRACESQL in the Process Scheduler Configuration file.
-TOOLSTRACEPC	Enables PeopleCode trace. This is equivalent to values that are assigned to TracePC in the Process Scheduler Configuration file.

Note. For Process Type XML Publisher, available output options are based on the report definition template type.

See Creating Report Definitions.

Setting OS390 Options

To access the Type Definition Options page, select PeopleTools, Process Scheduler, Process Types, Type Definition Options.

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 that is 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 that are passed to processes.
Set destination options.
Set page transfer options.
Set notification options.
Set notification messages.
Set runtime parameters.
Set OS390 options.
Associate URLs.

Understanding Process Definitions

After you specify a process type, you must create a process definition, specify the available options, and set up associated page transfers that might apply.

Pages Used to Define Process Definitions

Page Name	Definition Name	Navigation	Usage
Process Definition	PRCSDEFN	PeopleTools, Process Scheduler, Processes, Process Definition	Add new process definitions or update existing ones.
Process Definition Options	PRCSDEFNOPT	PeopleTools, Process Scheduler, Processes, 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, Override Options	Modify values that are passed to the process.
Destination	PRCSDEFNCNTDIST	PeopleTools, Process Scheduler, Processes, Destination tab	Set destination options.
Page Transfer	PRCSDEFNXFER	PeopleTools, Process Scheduler, Processes, 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, Notification	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 or a successful completion of the job.
Message	PRCSDEFNMESSAGE	PeopleTools, Process Scheduler, Processes, Messages	Specify the messages that are sent when the Notification feature is used.
Runtime Parameters	PRCS_RUNCNTL_PARAM	PeopleTools, Process Scheduler, Processes, Runtime Parameters	Specify runtime parameters for the process.
OS390 Option	PRCSDEFNOS390OPT	PeopleTools, Process Scheduler, Processes, 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, URL Links	Associate multiple URLs with a process definition. The links appear on the Report detail page, which is 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 Definitions

To access the Process Definition page, select PeopleTools, Process Scheduler, Processes.

Process Type

Indicates the Process Type selected.

Name

This name must match the file name of the process that 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 that is 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 categories Default and LOADCACHE are delivered with your system.

API Aware

Select this check box if this process is an API-aware process. If this check box 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 XML Publisher process types should be API-aware. If API Aware is deselected 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 it is marked with a run status of Error.

Read Only

Used only on Oracle databases with Oracle Active Data Guard enabled and configured for use within your PeopleSoft implementation. The Read Only option enables a [component | process] to run against the read-only, standby database, rather than your production database.

See See Enterprise PeopleTools 8.51 PeopleBook: Data Management, "Administering PeopleSoft Databases on Oracle," Implementing Oracle Active Data Guard

Retry Count

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.

Retention Days

Set the retention days that are used to determine the expiration date. The expiration date is determined by adding the retention days from the date on which the report was generated.

Note. The retention days value entered for a process definition will be the default retention days when the process is run.

System Constraints

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 ignores settings for the following options.

Max. Concurrent (maximum concurrent)

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 appear in the Process Monitor with a run status of Blocked. As active occurrences finish, blocked processes are released and queued.

Max. Processing Time (maximum processing time)

Enter the maximum processing time for this process. If this field is left blank (default), the value becomes Unlimited.

The system cancels the process if processing exceeds the time that is entered here.

Important! This field is not supported for SQR and COBOL process types that are scheduled on an OS390 operating system and run from UNIX System Services (USS).

Mutually Exclusive Process(es)

Enter the type and name all the processes that must not run at the same time as this process.

Processes failing this constraint appear on the Process Monitor with a run status of Blocked. When mutually exclusive processes finish, blocked processes are released and queued.

See Also

Using Process Request APIs

Setting Process Definition Options

To access the Process Definition Options page, select PeopleTools, Process Scheduler, Processes, and click the Process Definition Options tab.

Use the Process Definition Options page to specify a location, server, component, or process group from which to run a process.

(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 that are 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.

On File Creation

Access the On File Creation section.

File Dependency

Select to activate the On File Creation feature.

If this option is activated, Process Scheduler checks for the existence of the file. If the file is found and no other process is using it, the process will run.

If the file is not found or is in use, the process does not run but enters a Blocked state. Time counting starts at this point. Process Scheduler continues to check for the file. If the file is found and is not in use, then the process will run.

If the file is not found or it is in use even after the time interval specified in Time Out Max Minutes, the process will go to Error state.

If the Max Time Out Minutes field is left blank, the process scheduler does not schedule the process as long as the file is not found in the specified location.

Wait for File

Enter the location and name of the file that this process depends on. The process will not run until this file has been found if the file dependency option is activated.

Processes on hold due to dependent files not being found 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 if the File Dependency check box is selected.

Time Out Max. Minutes

Enter a time limit for the system to locate the dependent files.

The system compares the current date time to the timestamp of the time that 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.

System Recovery Process

Access the System Recovery Process section.

Process Type and Process Name

Enter the type and name of an optional process that can be run if this process runs to an error. The original process will not restart until the system recovery optional process that is entered here has run.

Process Security

Access the Process Security section.

Component

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.

Select an existing group, or add a new group by entering a unique process group name. To add new rows, click the Add button.

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 that Are Passed to Processes

To access the Override Options page, select PeopleTools, Process Scheduler, Processes, Process Definition, Override Options.

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 Options

To access the Destination page, select PeopleTools, Process Scheduler, Processes and click the Destination tab.

Note. The output source destinations are enforced for users who are not allowed to override the output destination by their user 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 that is specified here overrides the value that is specified in the System Settings - Process Output Type page. If the value that is specified here is deactivated, the value that is designated as the default will be used.
Format	Select the format for this process. The value that is specified here overrides the value that is specified in the System Settings - Process Output Format page. If the value that is specified here is deactivated, the value that is 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 that is specified by the process definition. Process Type Definition: This request uses the output destination that is 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 in which 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 option is enabled only when the source value is Process Definition.

Setting Page Transfer Options

To access the Page Transfer page, select PeopleTools, Process Scheduler, Processes, and click the Page Transfer tab.

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 appear.

Page Transfer Code

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.

Menu Action

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

To access the Notification page, select PeopleTools, Process Scheduler, Processes, and click the Notification tab.

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 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 finishes.
Disabled	Select if you do not want to send notifications to the user or group.

Setting Notification Messages

To access the Message page, select PeopleTools, Process Scheduler, Processes, and click the Message tab.

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.

Message Type

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 Runtime Parameters

To access the Runtime Parameters page, select PeopleTools, Process Scheduler, Processes, and click the Runtime Parameters tab.

Use this page to enable the Run option from the Reporting Console and register runtime parameters associated with the process.

Enable Generic Prompting

Select this check box to allow users to schedule this process from the Reporting Console.

Allow Access By User With

Select the type of permission required to schedule the process from the Reporting Console. It specifies whether full process security or process group security should be applied when the process is run from the Reporting Console or a web service.

Full Process Security indicates that the process security defined on the Process Definition Options page will be used to determine which users can schedule this process from the Reporting Console. The user must have permission to at least one of the Components, as well as be a member of at least one of the Process Groups listed on the Process Definition Options page.
Process Security Group indicates that the user must be a member of at least one of the Process Groups listed on the Process Definition Options page to schedule this process from the Reporting Console.

Note. Users with the role PeopleSoft Administrator will always get the Run option on the Reporting Console if Generic Prompting is enabled.

RunTime Parameters

Application run control records are used to retrieve the parameter values at execution time. In order to run the process from the Reporting Console, the user must be able to enter the runtime parameters necessary for the process with the correct application run control record. This also allows the user to retrieve saved parameter values from an application run control record.

Record (Table) Name

Enter the application-specific run control record used in this process.

Field Name

Enter a row for each field used in the run control record.

Select Label

Use this link to select the field label that will display on the generic prompting page.

Select the Label Type:

Message Catalog

You will be prompted for the Message Set Number and Message Number.
RFT Long

You will be prompted for the Field Label ID.
RFT Short

You will be prompted for the Field Label ID.

Validation?

Select this check box to perform validation on parameter values entered using the Reporting Console.

A Validation link will appear when the check box is selected. Use this link to specify the validation function from the Application Class.

Setting Validation Function

When the user selects Validation for a field, the Validation Function link appears. Select the Validation Function link to enter the location of the validation program.

Root Package ID

Enter the package name that contains the class that you want to specify, or use the Lookup button to search for and select one.

Path	Enter the name or names of any subpackages that contain the application class that you want to specify, or use the Lookup button to search for and select one.
Application Class ID	Enter the name of the application class that contains the method that you want to specify, or use the Lookup button to search for and select one.
Method Name	From the Method drop down list box, select the method from the selected application class that you want to specify.

Setting OS390 Options

To access the OS390 Option page, select PeopleTools, Process Scheduler, Processes, and click the OS390 Option tab.

The JCL shell and meta-string parameters that are 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 an OS390 operating system for the database.

Meta Parameter	Enter the meta-string parameter that is contained in the Job Shell.
Meta Parm Value (meta parameter value)	Enter the value that replaces the meta-string parameter.

Associating URLs

To access the URL Links page, select PeopleTools, Process Scheduler, Processes, and click the URL Links tab.

Use this page to associate multiple URLs with a process definition. The 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 access the Edit URL Detail page.

Editing URL Key Fields

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 provides an overview of recurrence definitions and discusses how to:

Set up recurrence definitions.
Set recurrence exceptions.

Understanding Recurrence Definitions

Recurrence 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. When you specify a recurrence definition, the process request continues the cycle until you stop it manually.

Pages Used to Define Recurrence Definitions

Page Name	Definition 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

To access the Recurrence Definition page, select PeopleTools, Process Scheduler, Recurrences, Recurrence Definition.

Recurrence Name

This value appears in process and job definitions, so it should be readily identifiable.

Description

Enter a description for this recurrence definition. The default is the recurrence name.

Schedule Next Recurrence when

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.

Recurrence Pattern

The contents of this group box change, depending on the recurrence pattern that you select.

Note. When validating the next recurrence date on which 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 field should match that of the Start Request Date field. For example, if you select August 27, 2004 as the start request date, you must ensure that the value for the Day of Month field is 27 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: A schedule that is not daily, weekly, or monthly (for example, quarterly). Specific dates. When you select this option, add the specific run dates in the Run on Specific Dates group box.

Start Request

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 runtime, or when servers are down when the processes should have run.

Example 1: A process is scheduled to run daily at 10:00 a.m. but the recurrence is not set up until 2:00 p.m. If this option is selected, the process will not run until 10:00 a.m. the following day. If this option is not selected, the process will run immediately to catch up for the missed 10:00 a.m. run.

Example 2: A process is scheduled to run hourly every day from 9:00 a.m.– 3:00 p.m. The process runs successfully at 9:00 a.m., and then the server goes down. It is not recovered until 5:00 p.m. If this option is selected, the process will not run again until 9:00 a.m. 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:00 a.m., 11:00 a.m., 12 noon, 1:00 p.m., 2:00 p.m., and 3:00 p.m.

End Request

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.

Repeat

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.

Run on Specific Dates

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.

Bi-Weekly (Every 14 Days) Recurrence Definitions

Use the following procedure to schedule a process to run biweekly (every 14 days) through a recurrence:

To set a recurrence definition for every 14 days (bi-weekly):

Select PeopleTools, Process Scheduler, Recurrences.
Select Add New Value and enter a recurrence name.

The Recurrence Definition page appears.
Select Daily as the recurrence pattern.
Go to the Repeat group box and set the Every value as 336 Hours and the For value as 336 Hours (number of hours in 14 days).

Setting Recurrence Exceptions

To access the Recurrence Exception page, select PeopleTools, Process Scheduler, Recurrences, Recurrence Exception.

Use the Recurrence Exception page to enter specific days or dates to ignore. For example, your schedule is set up to run every Monday. However, you do not want the report to run on holidays. Therefore, when you enter the date as an exception, the system bypasses running the report on that day.

Exception Date (From)	Select the date that you want this process to bypass.
Run Date (To)	If you want the process to bypass every day for a specific period, select the last date of the period. Leave blank to bypass 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.

Process Type	Indicates the Process Type selected.
Name	This name must match the file name of the process that 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 that is 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 categories Default and LOADCACHE are delivered with your system.
API Aware	Select this check box if this process is an API-aware process. If this check box 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 XML Publisher process types should be API-aware. If API Aware is deselected 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 it is marked with a run status of Error.
Read Only	Used only on Oracle databases with Oracle Active Data Guard enabled and configured for use within your PeopleSoft implementation. The Read Only option enables a [component \| process] to run against the read-only, standby database, rather than your production database. See See Enterprise PeopleTools 8.51 PeopleBook: Data Management, "Administering PeopleSoft Databases on Oracle," Implementing Oracle Active Data Guard
Retry Count	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.
Retention Days	Set the retention days that are used to determine the expiration date. The expiration date is determined by adding the retention days from the date on which the report was generated. Note. The retention days value entered for a process definition will be the default retention days when the process is run.

Recurrence Name	This value appears in process and job definitions, so it should be readily identifiable.
Description	Enter a description for this recurrence definition. The default is the recurrence name.