Appendix: Understanding Logging Systems

This appendix discusses:

• Log and output directory.

• Logging system for PeopleSoft Process Scheduler Server.

• Logging system for Distribution Agent.

Log and Output Directory

Specify the Log/Output Directory variable in the configuration file to set a common log and output directory. The default is:

Log/Output Directory=%PS_SERVDIR%\log_output

For each process request, a subdirectory is created in the log and output directory. The naming convention that is used for the subdirectory is:

<Process ID>_<Program Name>_<Process Instance>

The assigned process ID is based on the process request’s process type.

For example:

• In psprcs.cfg, set Log/Output Directory=%PS_SERVDIR%\log_output.

• Set PS_SERVDIR=c:\pt800\appserv\prcs\ptdmo.

  c: represents the drive on the PeopleSoft Process Scheduler server, not the client workstation.

• User runs the SQR report XRFWIN.SQR.

• Process instance is 23.

Using the preceding information, the system writes the output to the following location:

c:\pt800\appserv\prcs\ptdmo\log_output\SQR_XRFWIN_23

Usually, the log files and reports are written to the subdirectory in the log and output directory. Reports and log files are not written to this directory when:

• A user specifies a directory on the Process Request Dialog page.

  This option is available only for the output destination type of File.

• The process definition is set for a process to restrict the output destination type of File, and a specific directory is specified, other than the meta-string %%OutputDirectory%%.

• A process profile that is assigned for the user who submitted the request indicates an output directory other than %%OutputDirectory%%.

• A program hard-codes the directory to which the log or report should be written.

To control this location and prevent users from sending output to another location, use the process profile for a permission list in PeopleSoft Security Administrator by:

• Specifying a file and printer destination in the Server Destinations group box.

• Disabling the Override Output Destination parameter in the Allow Requester To group box.

Deleting the Log and Output Subdirectory

The subdirectory, which is created by the Process Scheduler server to store all the logs and reports that are generated by the initiated process, will be deleted when the output destination type is Web and the files are successfully posted to the report repository.

For output destination types of anything other than Web, the subdirectory will be deleted during the purging process when the process request that is associated with the subdirectory is deleted from the process request table.

See Also

Setting Up PeopleSoft Process Scheduler Security

Log Space Threshold

If the Process Scheduler Server detects that the space capacity of the log/output directory is below the threshold, it will stop processing any queued requests. This threshold is the bottom line minimum before the Process Scheduler considers the log to be full. By default, the threshold is set to 10 MB.

During the maintenance check, based on the HeartBeat, if the space capacity threshold drops below the threshold:

• A disk full message gets logged in SCHDLR.LOG.

• The status of Process Scheduler server in the Process Monitor will reflect LOG DISK FULL.

• An email notification is sent to the administrator.

Logging System for PeopleSoft Process Scheduler Server

This section discusses:

• Logging system.

• Logging levels.

Logging System

The log directory stores the PeopleSoft Process Scheduler server logs and SQL trace files. Each server that is started in the PeopleSoft Process Scheduler server has its own set of log and trace files. The user does not normally need to review these files unless a problem occurs while running a process or some reason exists to verify that a process ran as expected.

Location of the Log and SQL Trace Files

The location and name of the PeopleSoft Process Scheduler log files depend on the operating system on which the PeopleSoft Process Scheduler Server is started.

The <Log Directory> corresponds to the directory that is specified in the Log/Output Directory variable in the PeopleSoft Process Scheduler configuration file (psprcs.cfg).

For each server that is started, two files are generated in the log directory:

• The server log contains messages that are written by the server to the log file.

  These messages are translated to the languages that are supported by the PeopleSoft system. The language of the messages is based on the language that is designated in the user profile.

  The LogFence parameter, which is set in the PeopleSoft Process Scheduler configuration file, controls the detail of the message that is written to this log file.

• The SQL trace file contains the traces of all SQL that is issued by the server.

  This file is generated when the TraceSQL parameter in the PeopleSoft Process Scheduler configuration file has a value other than zero.

  If a PeopleSoft Application Engine or Analytic Engine request is initiated by PSAESRV or PSAEOSRV respectively, the SQL traces that are generated from that process are stored in the process subdirectory that is located in the log and output directory.

Log and SQL Trace File Name in Windows and UNIX

The following table lists all the server names, log files, and SQL trace files in Windows and UNIX.

<User_ID> is the user ID that is specified in the PeopleSoft Process Scheduler configuration file that is set to boot PeopleSoft Process Scheduler.

Log and SQL Trace File Name in OS390 USS

The following table lists all the server names, log files, and SQL trace files in OS390 USS

<Process Scheduler Server> is the name of the server that is defined in the server definition (that is, PSOS390).

At midnight, a new log file is created to contain information for the current MMDD value.

SQL Trace File

The SQL trace file is created when the TraceSQL variable in the PeopleSoft Process Scheduler configuration file has a value other than zero. This file contains the SQL traces that are issued by the Distribution Agent program PSDSTSRV.

Use the TraceSQL variable to set the level of SQL trace by selecting the numerical value representing each degree of tracing as described. The list of trace levels from which you can choose appears in the configuration file as shown:

1=SQL Statements
2=SQL statment variables
4=SQL connect, disconnect, commit and rollback
8=Row Fetch (indicates that it occurred, not data)
16=All other API calls except ssb
32=Set Select Buffers (identifies that attributes of columns
		to be selected)
64=Database API specific calls
128=COBOL statement timings
256=Sybase Bind information
512=Sybase Fetch information
1024=SQL Informational Trace
4096=Manager information
8192=Mapcore information

If you want SQL Statements, SQL statement variables, and SQL connect, disconnect, commit, and rollback information, specify TraceSql=7 (1+ 2 + 4).

Note. The SQL trace file doesn’t delete existing traces that are written from prior runs of the PSPRCSRV program, and it appends new SQL activity to the end of the file. Because the file can grow quite large and might fill up your file server, you should reset the TraceSQL to zero after you finish debugging the PeopleSoft Process Scheduler Server Agent.

Logging Levels

The logging system enables you to change the level of detail that is written to the log files. The mechanism that is chosen here uses the concept of a detail level and a fence. Messages are assigned a numeric detail-level value that reflects the importance of the event that triggers the message in the operation of the program. This ranges from simple progress messages (very detailed) to error messages when the program is about to terminate (not detailed).

The fence is used to filter out messages that reflect more detail than necessary in a particular installation. For example, a message must be able to leap the fence to be shown (with a lower number indicating a higher fence). With the fence set to 2, only messages with a detail level that is less than 2 (that is, 0 or 1) appear. The only exception to this is that level 0 messages and messages that are unable to be displayed in the standard message format cannot be filtered out.

The meaning of a level is completely arbitrary, although a consistent convention should be followed. The server uses the following convention:

The fence is determined by an entry in the server configuration file in the [Process Scheduler] section named LOGFENCE. Normal values are in the range of 0−5, with the default being 3 (informational). A setting of 5 is recommended for installation and troubleshooting. A setting of 0 is good for an installed system that is working smoothly.

The log fence of a message can be seen in the PeopleSoft Process Scheduler log file. In the following example, you can see the numeric values enclosed in parentheses following the date and time.

Example of log file

If you receive error messages, complete the following tasks to enable debugging and tracing:

1. Set LOGFENCE=5 in the psprcs.cfg file.

2. Set TraceSQL to the appropriate value to generate the SQL trace.

See Also

Editing the PeopleSoft Process Scheduler Configuration File

Logging System for Distribution Agent

The Distribution Agent detects that files are ready to transfer by querying the Report List table (PS_CDM_LIST).

Transfer Log for FTP and XCopy

When the Distribution Agent transfers files using the File Transfer Protocol (FTP) or XCopy protocol, it tables the information for all of the process requests and assigns a transfer log to this transfer attempt. Any activity from transferring the files for these process requests is recorded in a log file with the following format:

<Log Directory>\_PSDSTSRVLOG\transfer_<Transfer Instance Number>.log

The following examples illustrate the of transfer log files for FTP and XCopy transfer protocols:

Example of transfer log using the FTP command

Example of transfer log using the XCopy command

Transfer Log for HTTP

When HTTP is used to transfer files to the Report Repository, it doesn’t generate a transfer log like FTP and XCopy. All logs relating to the HTTP activities are logged in the Process Message Log table and you can view them by clicking the Message Log link on the Process Monitor Detail page in PeopleSoft Process Scheduler.

Example of HTTP messages displayed on the Message Log page