This appendix provides an overview of the PeopleSoft Process Scheduler configuration file and discusses how to edit the configuration file.
Note. This appendix does not discuss how to install and configure a PeopleSoft Process Scheduler Server.
See Also
PeopleTools 8.45 Installation Guide for your database platform.
Configure and administer the PeopleSoft Process Scheduler Server Agent with the PSADMIN utility. PSADMIN is supported only on Windows 2000 and UNIX. However, in some cases, you can run the PSADMIN utility on operating systems that are not supported application servers.
Configuring a PeopleSoft Process Scheduler server is similar to configuring application servers and web servers. From the PeopleSoft Process Scheduler Administration menu, you invoke a text-driven interface that prompts you for parameter values. All of the PeopleSoft Process Scheduler server configuration information for a specific database is contained in the PSPRCS.CFG configuration file, and the PSADMIN provides an interface to edit this file.
PeopleSoft automatically archives the Process Scheduler configuration file whenever it is changed. The older version is archived as PSPRCS_<Time Stamp>.CFG and the current version becomes psprcs.cfg. The archive directory path is <PS_Home>\Appserv\prcs\<database>\Archive\. For example, c:\pt844\Appserv\prcs\fin844\Archive\
Note. The PSPRCS.CFG file supports environment variables. For example, the TEMP setting in the [Process Scheduler] section can look like this: TEMP=%TEMP%.
This section discusses how to:
Accessing the PeopleSoft Process Scheduler configuration through PSADMIN.
Using the PSADMIN Quick-configure menu.
Edit the PeopleSoft Process Scheduler configuration file.
Edit the PeopleSoft Process Scheduler configuration file for UNIX and OS390.
Although you edit PSPRCS.CFG through the PSADMIN utility, in Windows 2000 the PSPRCS.CFG file is in the following batch server directory:
<PS_HOME>\appserv\prcs\<DBNAME>
To create a PeopleSoft Process Scheduler configuration:
Select Start, Command Prompt.
Change the directory to <PS_HOME>\appserv\.
Type psadmin.
Press ENTER
The PeopleSoft Server Administration menu appears.
Select option 2 (Process Scheduler).
Press ENTER.
The PeopleSoft Process Scheduler Administration menu appears.
Select option 4 (Create a Process Scheduler Configuration) from the Process Scheduler Administration menu.
Enter the name of the desired database.
Press ENTER.
The Quick-configure menu appears.
Note. To edit a process scheduler configuration file, select option 6 (Edit a Process Scheduler Configuration file) from the Process Scheduler Administration menu. Enter the number that corresponds to the appropriate database from the database list.
The Quick-configure menu allows you to create a process scheduler configuration by entering just the basic information. If you need to change a parameter that is not displayed, select Custom configuration.
The menu is divided into the following three sections:
Features: Each item in this list is a feature that uses one or more server processes. If set to Yes, the feature becomes active for users of the server. Select the number that corresponds to the desired option to toggle Yes/No.
Settings: Commonly changed parameters are listed in this section. Select the number that corresponds to the desired parameter to change its setting.
Actions: Select to load the scheduler with the server and settings displayed, run a complete custom scheduler configuration, display help information, or return to the previous menu.
The Quick-configure menu consists of the following features:
Master Schdlr |
Flag to enable the Master Scheduler Server (PSMSTPRC). Default is to disable the server. |
App Eng Server |
Flag to initiate Application Engine programs through the AE Tuxedo Server (PSAESRV). Default is set to run AE using PSAESRV. |
Opt Eng Server |
Flag to enable Analytic Engine processing in this server. Default is to disable the server. Enable this flag if the application is packaged with Analytic Engine programs. |
The Quick-configure menu consists of the following settings:
DBNAME |
Enter the database name that is associated with a PeopleSoft Process Scheduler Server Agent, such as HRDMO, FSDMO, SADMO, and so on. |
DBTYPE |
Enter the database type: DB2UNIX, DB2ODBC (for DB2/OS390), INFORMIX, MICROSFT, ORACLE, or SYBASE. |
PrcsServer |
Enter the process server name. This must match the name defined in the Server Definition table. For example, PSNT. |
UserID |
Enter the user ID. For Enterprise Resource Planning (ERP), this is typically VP1, and for Human Resources (HR) it's PS. |
UserPswd |
Enter the user password. For Enterprise Resource Planning, this is typically VP1, and for Human Resources its PS. |
ConnectID |
Enter the connect ID. This value is required for all platforms. |
ConnectPswd |
Enter the connect password. This value is required for all platforms. |
ServerName |
This value is required for Informix and Sybase users. |
Log/Output Dir |
Enter the directory in which files that are generated by the program are written. When PeopleSoft Process Scheduler initiates a process request, it creates a subdirectory in the format <Process Type ID>_<Program Name>_<Process Instance> that contains the generated files. For instance, the SQR program has all reports, trace, and log files in the subdirectory SQR_XRFWIN_20. It is also the optional directory used with the Output Destination field when scheduling a request. This variable (%%OutputDirectory%%) can be used in the File/Printer field of the Process Scheduler Request dialog box. Note. The output directory has an extra slash attached at the end. |
SQRBIN |
Enter the path to the SQR executables. |
AddToPATH |
(Optional for Tuxedo). Enter an additional directory that is appended to the PATH environment variable. |
DBBIN |
Enter the path to the database drivers; that is, your connectivity software. |
See Also
Understanding PeopleSoft Master Scheduler Functions
Setting Parameters for the Application Engine Server
The sections in the PeopleSoft Process Scheduler configuration file vary, depending on the operating system from which the PeopleSoft Process Scheduler Server is started. For instance, servers that run only in BEA Tuxedo (that is, PSAESRV, PSANALYTICSRV) are not available in OS390. However, the OS390 section applies when the PeopleSoft Process Scheduler Server is started in the OS390 UNIX System Services (USS).
The following table lists which sections can be found in the PeopleSoft Process Scheduler configuration file, based on the operating system.
Section |
Windows 2000 |
UNIX |
OS390 |
Startup |
X |
X |
X |
Database Options |
X |
X |
|
Trace |
X |
X |
X |
OS390 |
|
|
X |
Process Scheduler |
* |
* |
* |
Tuxedo Settings |
X |
X |
|
Interface Driver |
X |
X |
X |
PSTools |
* |
* |
* |
PSAESRV |
X |
X |
|
PSAEOSRV |
X |
X |
|
PSDSTSRV |
X |
X |
|
PSANALYTICSRV |
X |
X |
|
Application Engine |
|
|
X |
SQR |
* |
* |
* |
Remote Call |
X |
X |
X |
nVision |
X |
|
|
Crystal |
X |
|
|
SMTP Settings |
X |
X |
X |
Cache Settings |
X |
X |
X |
Integration Broker |
X |
X |
|
* Denotes where parameters found in this section differ, based on the operating system in which the PeopleSoft Process Scheduler configuration file is located.
The PeopleTools 8.45 Installation Guide provides the procedure for configuring a PeopleSoft Process Scheduler Server using the basic default values. This section discusses each value that is available in each section.
This is the first section that you encounter when using PSADMIN to configure a PeopleSoft Process Scheduler Server Agent.
Parameter |
Description |
DBName |
Specify the database name that is associated with a PeopleSoft Process Scheduler Server Agent, such as HRDMO, FSDMO, SADMO, and so on. |
DBType |
Specify the database type: DB2UNIX, INFORMIX, MICROSFT, ORACLE, or SYBASE. |
UserId |
Enter the user ID. For Enterprise Resource Planning (ERP), this is typically VP1, and for Human Resources (HR) it’s PS. |
UserPswd |
Enter the user password. For Enterprise Resource Planning, this is typically VP1, and for Human Resources it’s PS. |
ConnectId |
Enter the connect ID. This value is required for all platforms. |
ConnectPswd |
Enter the connect password. This value is required for all platforms. |
ServerName |
This value is required for Informix and Sybase users. |
When you change the UserPswd or ConnectPswd field, you are prompted for an option to encrypt the value entered for the password field. The default is to encrypt the password.
Use this section for database-specific configuration options.
Parameter |
Description |
SybasePacketSize |
Specify the Sybase packet size. The default is 512. See PeopleTools 8.45 Installation Guide for your database platform. |
UseLocalOracleDB |
Indicate whether the PeopleSoft database to which you are connecting is in a local Oracle System Identifier (SID). The default is 0. This means that the PS database to which you are connecting is remote. See PeopleTools 8.45 Installation Guide for your database platform. |
Use this section to set trace values for performance monitoring and troubleshooting.
Parameter |
Description |
TraceFile |
This applies to Windows only. Indicates the file to which SQL traces are written when TraceSQL has a value greater than zero. SQL traces for the following programs are written to this file: Crystal, nVision, and Cube Manager. Other processes—such as Application Engine, SQR, and COBOL—have the SQL traces written to a separate subdirectory under the directory specified for the Log/Output Directory parameter. See the Log/Output Directory parameter. |
TraceSQL |
Specify a SQL trace value for troubleshooting. It is implemented as a bit field. Possible values for TraceSQL are listed later in this section. |
TracePC |
Specify a trace value for troubleshooting PeopleCode. This is used by PeopleSoft Application Engine when it runs PeopleCode. Possible values for TracePC are listed later in this section. |
TraceAE |
Specify the trace options that are specific to PeopleSoft Application Engine. Trace information based on this option is written to a file with the following format: <Application Engine program name>_<Process Instance>.AET Possible values for TraceAE are listed later in this section. |
TraceOpt |
Specify the trace options that are specific to PeopleSoft Analytic Engines. The values set enable logging for OptEngine components beyond the standard LogFence setting. For example, TraceOpt=3510 sets full trace on all components. Possible values for TraceOpt are listed later in this section. Note. Full trace logging can produce a large amount of output, therefore PeopleSoft recommends setting TraceOpt=0 unless a specific optimization related problem needs to be investigated. |
TraceOptMask |
Not used. |
The following table lists the possible values for TraceSQL.
Bit |
Constant |
Type of Tracing |
0 |
%TraceSQL_None |
No output. |
1 |
%TraceSQL_Statements |
SQL statements. |
2 |
%TraceSQL_Variables |
SQL statement variables. |
4 |
%TraceSQL_Connect |
SQL connect, disconnect, commit, and rollback. |
8 |
%TraceSQL_Fetch |
Row fetch (indicates that it occurred and the return code, not data). |
16 |
%TraceSQL_MostOthers |
All other application-programming interface (API) calls, except Set Select Buffers (ssb). |
32 |
%TraceSQL_SSB |
Set Select Buffers (identifies the attributes of columns to be selected). |
64 |
%TraceSQL_DBSpecific |
Database API-specific calls. |
128 |
%TraceSQL_Cobol |
COBOL statement timings. |
256 |
%TraceSQL_SybBind |
Sybase bind information. |
512 |
%TraceSQL_SybFetch |
Sybase fetch information. |
1024 |
%TraceSQL_DB2390Server |
Turn on the tracing of diagnostic messages returned by the DB2/390 %UpdateStats() command. |
The following table lists the possible values for TracePC. Use these by adding the numbers together, or by specifying more than one constant.
Bit |
Constant |
Type of Tracing |
1 |
%TracePC_Functions |
Provide a trace of the program as it is run. This implies options 64, 128, and 256. |
2 |
%TracePC_List |
Provide a listing of the entire program. |
4 |
%TracePC_Assigns |
Show the results of all assignments made to variables. |
8 |
%TracePC_Fetches |
Show the values fetched for all variables. |
16 |
%TracePC_Stack |
Show the contents of the internal machine stack. This option is normally used for debugging the PeopleCode language, not PeopleCode programs. |
64 |
%TracePC_Starts |
Provide a trace showing when each program starts. |
128 |
%TracePC_ExtFuncs |
Provide a trace showing the calls made to each external PeopleCode routine. |
256 |
%TracePC_IntFuncs |
Provide a trace showing the calls made to each internal PeopleCode routine. |
512 |
%TracePC_ParamsIn |
Show the values of the parameters to a function. |
1024 |
%TracePC_ParamsOut |
Show the values of the parameters as they exist at the return from a function. |
The following table lists the possible values for TraceAE.
Bit |
Type of Tracing |
1 |
Trace STEP execution sequence to AET file. |
2 |
Trace Application SQL statements to AET file. |
128 |
Timings report to AET file. |
256 |
Method/BuiltIn detail, instead of summary in AET Timings report. |
1024 |
Timings report to tables. |
2048 |
DB optimizer trace to file. |
4096 |
DB optimizer trace to tables. |
8192 |
Trace Integration Broker transform programs. |
The following table lists the possible values for TraceOpt.
Bit |
Type of Tracing |
1 |
OptEngine LSB |
2 |
OptEngine |
4 |
OptEngine MSB |
8 |
Utilities LSB |
16 |
Utilities |
32 |
Utilities MSB |
64 |
DataCache LSB |
128 |
DataCache |
256 |
DataCache MSB |
512 |
Plug-in LSB |
1024 |
Plug-in |
2048 |
Plug-in MSB |
After you set trace values, use the Process Scheduler section to set the environment variables that are associated with PeopleSoft Process Scheduler.
Warning! The default values for PS_HOME here and in future sections assume that you set up SQR, Crystal, and nVision locally on the batch server. You can point to those items on the file server, but if so, you must use a full path. You cannot use a PS_HOME environment variable, because PSADMIN employs the PS_HOME environment variable to point to a local directory on the batch server.
Parameter |
Description |
PrcsServerName |
Specify the process server name. This must match the name defined in the Server Definition table, such as PSNT. |
DBBIN |
Enter the path to the database drivers; that is, your connectivity software. |
Max Reconnect Attempt |
Specify the maximum number of attempts that the PeopleSoft Process Scheduler Server Agent will try reconnecting to the database when the connection is lost. When the maximum number of attempts is reached and the agent hasn’t successfully connected to the database, the agent shuts down. |
Reconnection Interval |
Specify the interval, in seconds, between attempts to reconnect to the database when the connection is lost. |
Authentication Timeout |
Specify the duration, in minutes, allotted before PeopleTools security module will time-out authenticating a process released by Process Scheduler. The timer starts from the time Process Scheduler initiates the request |
Allow Dynamic Changes |
Specify dynamic changes to certain settings without having to reboot the domain. The settings that can be dynamically changed are: Recycle Count, Consecutive Service failures, Trace SQL, Trace Mask SQL, TracePC, TracePCMask, TracePpr, TracePprMask, Log Fence, Enable DB Monitoring, and Enable Debugging. |
Specify the directory in which files that are generated by the program are written. When PeopleSoft Process Scheduler initiates a process request, it creates a subdirectory in the format <Process Type ID>_<Program Name>_<Process Instance> that contains the generated files. For instance, the SQR program has all the reports, trace, and log files in the subdirectory SQR_XRFWIN_20. It is also the optional directory used with the Output Destination field when scheduling a request. This variable (%%OutputDirectory%%) can be used in the File/Printer field of the Process Scheduler Request dialog box. Note. The output directory has an extra slash attached at the end. |
|
Enter the PeopleSoft Process Scheduler tracing levels, such as 3. Note. The default value is 3. If the value is set to 5, the transfer files and the delete files will not deleted from the log_output directory. |
|
Specify the space threshold, in megabytes (MB), for the log/output directory. Once the space goes below this threshold, Process Scheduler will stop processing until more disk space becomes available. The Server Monitor will show a status of Suspended — Disk Low. |
|
Specify the size of memory in KB, allocated to store the value read from a file when transferring files to the Report Repository via HTTP. The default is 4096 KB (4 MB). |
|
CBLBIN |
Enter the path to COBOL executables, such as %PS_HOME%\CBLBIN. |
CRWRPTPATH |
Enter the path to Crystal Report files, such as %PS_HOME%\CRW. Note. Use semicolons to separate multiple directories. |
TEMP |
Enter the local temporary directory, such as %TEMP%. |
TOOLBIN |
Enter the location of the PeopleTools executables, such as %PS_HOME%\bin\client\winx86. |
TOOLBINSRV |
Enter the location of the server version of PeopleTools executables, such as %PS_HOME%\bin\server\winx86. |
WINWORD |
Enter the path to Microsoft Word executables, such as c:\apps\office97\winword. Note. If spaces exist in the path you will need to modify the Process Type Definition and add quotes around the entry in the Command
Line field, for example " %%WINWORD%%\WINWORD.EXE". |
DEFAULTPRINTER |
Enter the universal naming convention (UNC) path of the printer where reports are printed when the %DefaultPrinter% was specified as the output destination. |
Update Table Stats on Purge |
Set to run statistics for the Process Request and Report Manager tables during the Process Scheduler server purge process. 0: Disable. 1: Enable. Note. This flag will be ignored if the DBFlags bitfield parameter is disabled. |
The following table lists the possible values for LogFence.
Level |
Type of Tracing |
0 |
Status information. |
1 |
General errors. |
2 |
Warnings. |
3 |
Informational. |
4 |
Tracing Level 1. |
5 |
Tracing Level 2 (detail). |
See Understanding Logging Systems.
The following table describes each parameter in the Tuxedo Settings section.
Parameter |
Description |
Restartable |
Specify Y or N to instruct Tuxedo to restart a PeopleSoft Process Scheduler Server Agent or Distribution Agent if it is terminated abruptly. |
Grace Period |
Specify the period time, in seconds in which Tuxedo will attempt to restart the Process Scheduler Server. For example, Grace Period =600, Max Restart Attempt = 5. Tuxedo will attempt to restart the Process Scheduler server five times within 30 minutes of when the server comes down. |
Max Restart Attempt |
Specify the maximum number of restarts in the grace period. |
(Optional) Specify an additional directory that is appended to the PATH environment variable. |
Cognos/Cube Manager Installs: Make sure to specify the proper path for Cognos in the Add to Path parameter. By default, that path is C:\Program Files\Cognos\cer2\bin;C:\ODI\OStore\bin.
Note. The Cognos and ODI are the important top level directories, and could change depending on the install.
The following table describes the parameter in the Interface Driver section.
Parameter |
Description |
SCP_LOCALE |
Defines the RPS_LOCALE string that is sent to the PeopleSoft Supply Chain Planning (SCP) server. |
Use this section to specify a character set. The default value is Latin1.
Parameter |
Description |
JavaVM Shared Library |
Indicate which Java Virtual Machine (JVM) library to use. Note. The psprc.cfg file will need to be updated manually as this option is not available using the PSADMIN utility. |
Add to CLASSPATH |
The CLASSPATH environment variable tells the JVM and other Java applications where to find the java class libraries, including user-defined class libraries. Because PeopleTools automatically generates CLASSPATH entries for core PeopleSoft-delivered class libraries, use this field to specify any custom or additional class libraries that must be accessed by PeopleSoft. |
JavaVM Options |
Set options to the list of parameters required. Use a space to separate parameters. For example, -Xmx256m -Xms128m Set option -Xrs if you have Process Scheduler set up as a NT service on Windows. Options need to be set if you are using HTTP transfer protocol and receiving Java exception thrown: java.lang.OutOfMemoryError. Note. The psprc.cfg file will need to be updated manually as this option is not available using the PSADMIN utility. |
Character Set |
Specify the default character set for non-Unicode processing performed by this process server. The default value is latin1. This is the character set PeopleSoft supports for use with all Western European languages, including English. If the process server will be used only to process Western European data, accept the default. Otherwise, select one of the valid character set choices listed later in this section. Note. The character set selected for the process server should be the same as the character set specified for the application sever. |
Proxy Host |
This setting is used by the distribution agent if your architecture includes a firewall between the process scheduler server and the report repository (webserver). Note. If your architecture includes a firewall between the process scheduler server and the report repository (webserver), the distribution agent will need to tunnel through this firewall via a proxy server in order to transfer reports successfully. Set this value to the domain name of the proxy server only if your architecture includes a firewall between the process scheduler and the report repository (webserver). The firewall should be configured to allow outgoing HTTP or TCP connections to originate only from the proxy server host. The proxy server can be configured to restrict access to just PeopleSoft, and perform tasks such as logging HTTP activity. |
Proxy Port |
If PeopleSoft Process Scheduler is behind a proxy server, set this value to the port of the proxy server. |
DbFlags |
Enter 0 to issue the command to update table statistics to the database. Programs like PeopleSoft Application Engine and COBOL use the metaSQL %UpdateStats to run the command that runs statistics to a specific table. Otherwise, select one of the valid choices listed later in this section. Note. The Update Table Stats on Purge parameter is ignored if this parameter is disabled. |
Suppress App Error Box |
Use to suppress the console's Application Error dialog box after an application error occurs. Y suppresses the dialog box. |
Process exit grace period |
When a PeopleSoft Application Engine job completes, it has a specified number of seconds to exit. If the process has not exited when the grace period expires, it is terminated through a psreaper process. A grace period of 0 disables the psreaper process. |
The following table lists valid character set choices.
Character Set |
Description |
latin1 |
(Default). Latin-1 - ISO 8859-P1 - Microsoft codepage 1252 |
sjis |
Japanese Shift-JIS - Microsoft codepage 932 |
big5 |
Traditional Chinese - Microsoft codepage 950 |
gb |
Simplified Chinese - Microsoft codepage 936 |
ks-c-5601-1987 |
Korean Wansung - Microsoft codepage 949 |
ks-c-5601-1992 |
Korean Johab - Microsoft codepage 1361 |
See PeopleTools 8.45 PeopleBook: Global Technology.
The following table lists possible values for DBFlags bitfield.
Bit |
Description |
0 |
(Default). Issue the command to update table statistics to the database. |
1 |
Ignore metaSQL to update database statistics (shared with COBOL). |
2 |
Not yet allocated. |
4 |
Disable second database connection. |
8 |
Disable persistent secondary database connection. |
16 |
Not yet allocated. |
32 |
Not yet allocated. |
64 |
Not yet allocated. |
128 |
Not yet allocated. |
256 |
Not yet allocated. |
The following table describes each parameter in the PSAESRV (Application Engine Tuxedo Server) section.
Parameter |
Description |
Specify the maximum concurrency set for process types with a generic process type of Application Engine, as defined on the Server Definition page in Process Scheduler Manager. |
|
Specify the number of services after which PSAESRV automatically restarts. If this is set to 0 (default), PSAESRV is never recycled. |
|
Allowed Consec Service Failures (allowed consecutive failures) |
Specify the number of consecutive service failures after which PSAESRV automatically restarts. If this is set to 0 (default), PSAESRV is never recycled. |
The following table describes each parameter in the PSAEOSRV (Analytic Engine Tuxedo Server) section.
Parameter |
Description |
Max Instances |
Specify the maximum concurrency set for process types with a generic process type of Analytic Engine, as defined on the Server Definition page in Process Scheduler Manager. This should equal the number of Analytic Engines, if synchronous Tux service calls are used. |
Recycle Count |
Specify the number of services after which PSAEOSRV automatically restarts. If this is set to 0 (default), PSAEOSRV is never recycled. |
Allowed Consec Service Failures |
Specify the number of consecutive service failures after which PSAEOSRV automatically restarts. If this is set to 0 (default), PSAEOSRV is never recycled. |
Max Fetch Size |
Specify the maximum result set size, in KB, for a SELECT query. The default is 5000KB. Use 0 for no limit. |
The following table describes each parameter in the PSANALYTICSRV (Analytic Engine Tuxedo Server) section.
Parameter |
Description |
Max Instances |
Specify the total number of OptEngines = number of single queues + number in the MSSQ (read by ubbgen.cpp to calculate MAXSERVERS and MAXSERVICES in psprcsrv.ubb). Only MSSQ allows spawning. |
Service Timeout |
Limit the period that PSANALYTICSRV might block PSPRCSRV. |
Opt Max General Services |
Specify the number of each service declared in the corresponding .ubx file. |
Opt MSSQ Instances |
Specify the number of OptEngines in the MSSQ. |
The following table describes each parameter in the PSDSTSRV (Distribution Agent Tuxedo Server) section.
Parameter |
Description |
Max Instances |
Specify the maximum number of PSDSTSRVs that can be started within BEA Tuxedo. Default is 1. |
Recycle Count |
Specify the number of services after which PSDSTSRV automatically restarts. If this is set to 0 (default), PSDSTSRV is never recycled. |
Allowed Consec Service Failures |
Specify the number of consecutive service failures after which PSAEOSRV automatically restarts. If this is set to 0 (default), PSDSTSRV is never recycled. |
The following table describes each parameter in the SQR section.
Parameter |
Description |
SQRBIN |
Enter the path to the SQR executables. |
PSSQRFLAGS |
Specify the SQR report arguments required for launching SQR. |
Print Log |
Indicate whether the SQR log files are also be printed when the output destination is Printer. |
Enhanced HTML |
Indicate whether reports are in enhanced HTML format when the output destination is HTM. |
PSSQR1 |
Enter the first SQR report file search path. |
PSSQR2 |
Enter the second SQR report file search path. |
PSSQR3 |
Enter the third SQR report file search path. |
PSSQR4 |
Enter the fourth SQR report file search path. |
Note. In some cases, Application Engine programs require Java Runtime Engine (JRE) to be installed on the batch server.
See PeopleTools 8.45 Installation Guide for your database platform.
The following table describes each parameter in the Data Mover section.
Note. The values entered here should be the same as the values specified in the Configuration Manager.
Parameter |
Description |
InputDir |
Specify the path for the Data Mover input directory. For example, %PS_HOME%/data |
OutputDir |
Specify the path for the Data Mover output directory. For example, %PS_HOME%/data |
LogDir |
Specify the path for the Data Mover log directory. For example, %PS_SERVDIR%/log_output |
The following table describes each parameter in the RemoteCall section.
Parameter |
Description |
RCCBL Timeout |
Specify the maximum allotted time, in seconds, to run Remote Call with PeopleSoft Application Engine. |
RCCBL Redirect |
If this parameter is set to 0, log files that are generated from Remote Call are not retained. If this parameter is set to 1, log files are redirected to the directory specified in the Log/Output Directory parameter. |
RCCBL PRDBIN |
Specify the location of the COBOL executable. In Windows, the default location of the COBOL executable is %PS_HOME%\cblbin%PS_COBOLTYPE%. In UNIX, the default location is$PS_HOME/cblbin. |
If you plan to have PeopleSoft Process Scheduler invoke PS/nVision jobs, specify the appropriate parameters in this section.
Parameter |
Description |
DrillDownDir |
Specify the location of PS/nVision DrillDown files, such as %PS_HOME%\NVSION\LAYOUT\DRILLDN. |
ExcelDir |
Leave blank. |
InstanceDir |
Enter the location where PS/nVision places report instances, such as %PS_HOME%\NVSION\INSTANCE. |
LayoutDir |
Specify the location of the PS/nVision layout, such as %PS_HOME%\NVISION\LAYOUT. |
MacroDir |
Enter the directory containing macros for PS/ nVision and Query Link, such as %PS_HOME%\EXCEL. |
StyleDir |
Enter the default location where PS/nVision keeps nPlosion Styles (these are usually inherited by the layout that the user is designing). |
TemplateDir |
Enter the location of the QUERY.XLT file, which defines the Microsoft Excel styles for formatting output. The default is the \MacroDir, such as %PS_HOME%\EXCEL. |
EnableDrillDownForFile |
Using PS/nVision on the web. Indicate whether you want to enable drilldown on a report with the output type of file. 1 = Enable drilldown. 0 = Disable drilldown. (Default). |
EnablePollDialogs |
Using PS/nVision on the web. Indicate whether you want the system to poll and automatically kill unattended dialogs generated from PS/nVision in batch mode. For example, dialog messages from Excel displaying on the webserver. 1 = Enable poll dialogs. 0 = Disable poll dialogs. (Default) |
PollDialogSeconds |
Enter the time, in seconds, used to cycle polling for the dialog. |
TraceLevel |
Using PS/nVision on the web. Indicate whether you want the system to generate independent trace/log files, and at what level, for each nVision process. Trace files can be viewed from the Process Monitor Details - View Log/Trace page. 0 = Disable trace files. (Default) 1 = Generate basic high level information. 2 = Generate level 1 tracing plus high level code flow. 3 = Generate level 2 tracing plus SQL statements. 4 = Generate level 3 tracing plus most function calls and output values. Note. Extensive tracing will impact performance. |
If you plan to have PeopleSoft Process Scheduler invoke Crystal jobs, specify the appropriate parameters in this section.
Parameter |
Description |
Trace |
Enter YES or NO to indicate whether you want tracing enabled. |
TraceFile |
Enter the name of the trace file, such as %TEMP%\CRYSTAL.TRC. |
If you plan to use Simple Mail Transfer Protocol (SMTP) mail server gateways, specify the appropriate parameters in this section.
When changes are made to any of the parameters in the SMTP section of the process scheduler configuration file (psprcs.cfg), the effect is immediate. Even before the updated configuration file has been loaded by PSADMIN.
Note. The Allow Dynamic Changes flag; located in the General Settings section of the configuration file, has no effect on the SMTP parameters. Changes to the SMTP parameters are always dynamic.
Parameter |
Description |
SMTPServer |
Specify the name of the corporate mail server gateway machine. Leave blank for an initial installation. |
SMTPPort |
Specify the port used by SMTP mail server gateways. |
SMTPServer1 |
Specify the failover corporate mail server gateway machine. Leave blank for an initial installation. |
SMTPPort1 |
Specify the port used by failover SMTP mail server gateways. |
SMTPSender |
Specify the sender’s internet address. This must be a valid internet address, such as [email protected]. Leave blank for an initial installation. |
SMTPSourceMachine |
Specify the sender’s source machine name and internet address in the form of MACHINE.XYZCORP.COM. Leave blank for an initial installation. |
SMTPCharacterSet |
Specify the character set used on the sender’s machine. |
SMTPEncodingDLL |
Specifies the name of a DLL used to translate the mail message to a non-Unicode character set. By default, all outgoing SMTP mail is sent in Unicode UTF-8. |
SMTPTrace |
Enter 1 to enable the tracing of all email details to the log file when LogFence is set to 5. Enter 0 to disable it. With this option, you can reduce the log file size for high-volume email users. |
SMTPSendtime |
Enter 1 to have messages contain a send time that is populated by the application server. Enter 0 to leave the send time blank and have it populated by the receiving gateway (depending on the gateway). |
PeopleSoft Application Engine and Process Scheduler require a cache directory, which you specify in this section.
Parameter |
Description |
CacheBaseDir |
Enter the location of the cache directory. Leave the default selected, unless you have a compelling reason to change it. |
EnableServerCaching |
Specify a bit flag instructing how file caching is set up. The default value is 2. Note. This option is not included in the delivered psprcs.cfg file. However, if you need to override the default setting you can manually enter the option into the psprcs.cfg file. |
ServerCacheMode |
Set to 0 for one cache directory per process or 1 for a shared cache. The default value is 0. Note. This option is not included in the delivered psprcs.cfg file. However, if you need to override the default setting you can manually enter the option into the psprcs.cfg file. |
The following table lists the possible values for EnableServerCaching.
Bit |
Type of Caching |
0 |
Server file caching disabled. |
1 |
Server file caching is limited to most used classes. |
2 |
Server file caching for all types. |
The following table describes each parameter in the Integration Broker section.
Parameter |
Description |
Min Message Size For Compression |
Specify the minimum size of message data for synchronous handler to enable compression. |
Note. If you decide to edit the configuration file directly, make sure that there are no spaces between the equal sign and the entries and no trailing spaces. After making the necessary changes, save this file.
The following table describes each parameter in the Search Indexes section.
Parameter |
Description |
Search Indexes |
Use this option to specify the location of all the files pertaining to the search index. Index name is same as the location |
This section discusses the differences in parameter descriptions for UNIX and OS390 operating system.
This is an additional section located after the Trace section.
Parameter |
Description |
ODBC Initialization File |
Specify the file containing the Open Database Connectivity (ODBC) setting to connect to the DB2 through subsystem vid ODBC for OS390 where the PS database is created. |
Shell JCL Library |
Specify the directory location where the JCL shell templates are stored. |
High Level Qualifier for System Datasets |
Specify the datasets to which PeopleSoft installation are copied during batch transfer. For example, PT.PT840TA. |
High Level Qualifier for Log Datasets |
Specify the datasets that represent the high level qualifier for all logs and reports generated from processes submitted through Process Scheduler. |
Plan name for PTPSQLRT with CAF |
Specify the DB2 plan used to run COBOL called within an Application Engine program through Remote Call. |
Plan name for PTPSQLRT with TSO |
Specify the DB2 plan used to run COBOL from TSO through JCL that is created from the COBOL shell JCL template (SHECBL.JCT). |
DB2 Sub-System= |
Specify the DB2 subsystem name where the database resides. For example, DSND. |
VIO eligible unit group |
Specify the DASD volume group used by Remote COBOL when triggered from PeopleSoft Application Engine. |
Enable Parallel Processing |
Specify Y or N to set the Parallel processing parameter In the COBOL shell JCL template (SHECBL.JCT). |
DECIMAL |
This value should reflect the setting of the DECIMAL parameter found in the ZPARM of the DB2 subsystem where the database resides. The valid values are PERIOD (default) and COMMA. |
TSO Character Set |
Specifies the codepage for the TSO environment. The default value is CP037(IBM037: Latin1 code page). Note. For example, in Japanese setting, the recommended TSO Character Set is CCSID930 See Character Sets in the PeopleSoft Pure Internet Architecture. |
The following table lists the Process Scheduler section parameters for UNIX (rather than Windows 2000).
Parameter |
Description |
ProgramName |
Specify the name of the PeopleSoft Process Scheduler program, PSPRCSRV. |
PrcsServerName |
Specify the process server name. This must match the name defined in the server definition, such as PSUNX. |
Max Reconnect Attempt |
Specify the maximum number of times that the PeopleSoft Process Scheduler Server Agent will try to reconnect to the database when the connection is lost. When the maximum number of attempts is reached and the agent hasn’t successfully connected to the database, the agent shuts down. |
Reconnection Interval |
Specify the interval, in seconds, between attempts to reconnect to the database when a connection is lost. |
Log/Output Directory |
Specify the directory in which files that are generated by the program are written. When PeopleSoft Process Scheduler initiates a process request, it creates a subdirectory in the format <Process Type ID>_<Program Name>_<Process Instance> that contains the generated files. For instance, the SQR program has all reports, trace, and log files in the subdirectory SQR_XRFWIN_20. It is also the optional directory used with the Output Destination field when scheduling a request. This variable (%%OutputDirectory%%) can be used in the File/Printer field of the Process Scheduler Request dialog box. Note. The output directory has an extra slash attached at the end. |
LogFence |
Enter the PeopleSoft Process Scheduler tracing levels. |
DEFAULTPRINTER |
Specify the UNC path of the printer where reports are printed when the %DefaultPrinter% was specified as the output destination. |
The following table lists the Process Scheduler section parameters for OS390 (rather than Windows 2000).
Parameter |
Description |
Prcs Job Name |
Specify the job name that is assigned to the Process Scheduler program. This is set in USS using the __BPX_JOBNAME environment variable setting. |
Prcs Job Account= |
Specify the job account that is assigned to the Process Scheduler program. This is in USS using the __BPX_ACCT_DATA environment variable setting. |
ProgramName |
Specify the name of the Process Scheduler program, PSPRCSRV. |
PrcsServerName |
Specify the process server name. This must match the name defined in the database, such as PSOS390. |
Max Reconnect Attempt |
Specify the maximum number of times that the PeopleSoft Process Scheduler Server Agent will try to reconnect to the database when the connection is lost. When the maximum number of attempts is reached and the agent hasn’t successfully connected to the database, the agent shuts down. |
Reconnection Interval |
Specify the interval, in seconds, between attempts to reconnect to the database when the connection is lost. |
TOOLBIN |
Specify where executables reside. For example, %PS_HOME%/bin. |
DEFAULTPRINTER |
Specify the UNC path of the printer where reports are printed when the %DefaultPrinter% was specified as the output destination. |
Log/Output Directory |
Specify the directory in which files that are generated by the program are written. When PeopleSoft Process Scheduler initiates a process request, it creates a subdirectory in the format <Process Type ID>_<Program Name>_<Process Instance> that contains the generated files. |
LogFence |
Enter the PeopleSoft Process Scheduler tracing levels. |
For UNIX and OS390, the Character Set parameter is at the beginning of the table.
The first description is for OS390, and the second description is for UNIX.
Parameter |
Description |
USS (UNIX System Services) Character Set |
Specifies the character set based on the UNIX System Services locale’s code page. The default value is CCSID1047( Latin1 code page). Note. For example, in Japanese setting, the recommended USS Character Set is CCSID939 See Character Sets in the PeopleSoft Pure Internet Architecture. |
Report Repository Character Set |
Specifies the code page used by the Distribution Agent when migrating text files from USS into the Report Repository. The default value is CP1252 Note. For example, in Japanese setting, the recommended Report Repository Character Set is Shift_JIS See Character Sets in the PeopleSoft Pure Internet Architecture. |
This is an additional OS390 section located after the SQR section.
Parameter |
Description |
AE Job Name |
Specify the job name assigned to an Application Engine program. This is set in USS using the __BPX_JOBNAME environment variable setting. |
AE Job Account |
Specify the account assigned to an Application Engine program. This is set in USS using the __BPX_ACCT_DATA environment variable setting. |