Using PeopleTools Utilities

This chapter provides an overview of the PeopleTools Utilities and discusses how to:

• Use the System Information page.

• Use administration utilities.

• Use audit utilities.

• Use debug utilities.

• Use international utilities.

• Use optimization utilities.

• Use PeopleSoft Ping.

Understanding the PeopleTools Utilities

As you work with the PeopleSoft system, you find that there are some administrative tasks that you only need to perform occasionally. These tasks include such things as maintaining error messages and setting DDL model defaults. The PeopleTools Utilities menu is where you find tools for accomplishing some of these more infrequent tasks.

The documentation of the utilities matches the menu structure of the Utilities interface. For example, the PeopleTools Options utility is under the Administration menu in the Utilities interface; therefore, the documentation for PeopleTools Options is in the Using Administration Utilities section in this chapter.

Also, in many cases this book refers to other PeopleBooks for the detailed documentation of a utility.

Using the System Information Page

This section provides an overview of the system information page and discusses how to view the system information page

With the combination of accessing PeopleSoft applications with a browser, single signon between databases, and the PeopleSoft Portal, users and system administrators need a quick tool to provide orientation information and information regarding the current environment. For this reason, PeopleSoft provides the system information page.

Understanding the System Information Page

With single-signon and the portal, it may not be apparent to all end users just exactly what databases or applications they are currently accessing. Viewing environment information can help end users orient themselves.

In most cases, the administrators use the system help page to aid in troubleshooting. If a user has trouble accessing a particular application, the system administrator can instruct the user to provide the system information that appears in the help page so that the administrator can immediately identify the current application server, database, software version, operating system, and so on.

Viewing the System Information Page

To view the System Information help page, you press the CTRL+J hotkey while a PeopleSoft page is active. The following example illustrates the type of information that appears.

To return to the previous page, click continue.

The following table briefly describes each item:

Depending on the site's policy, you may not want to reveal the user ID, database name, database type, and application server information that is readily available. You use the Show Connection Information check box on the Debugging page of the current web profile to determine what appears when a user presses CTRL+J.

If you select Show Connection Information, all information appears on the System Information help page. However, if you clear this check box, the User ID, Database Name, Database Type, and Application Server information don't appear on the page.

See Also

Configuring Trace and Debug Options

Using Administration Utilities

This section discusses:

• PeopleTools Options.

• Message Catalog.

• Spell Check System Dictionary.

• Translate Values.

• Load Application Server Cache.

• Tablespace Utilities.

• Tablespace Management.

• DDL Model Defaults.

• Strings Table.

• XML Link Function Registry.

• Merchant Integration Utilities.

• TableSet IDs.

• Record Group.

• TableSet Control.

• Convert Panels to Pages.

• Update Utilities.

• Remote Database Connection.

• URL Maintenance.

• Copy File Attachments.

• Query Monitor.

• Sync ID Utilities.

• Gather Utility.

PeopleTools Options

Select PeopleTools, Utilities, Administration, PeopleTools Options to access the PeopleTools Options page. Use this page to set a number of options that affect multiple PeopleTools and applications, such as language options and change control settings:

Environment Long Name and Environment Short Name	Enter a long name and a short name for the current PeopleSoft environment. PeopleSoft software update tools use this information to identify the database when searching for updates. For example, enter Customer HR Demo Environment for the long name, and HR Demo DB for the short name.
System Type	Select an appropriate system type from the dropdown list, for example, Demo Database. This information helps to further identify the current environment for the purpose of searching for and applying software updates.

Language Settings

General Options

Help Options

Message Catalog

Select PeopleTools, Utilities, Administration, Message Catalog to access the Message Catalog page.

You add and maintain system messages by using the Message Catalog page. PeopleSoft error messages are stored in the Message Catalog, and organized by message set number. Each message set consists of a category of messages, ranging from PeopleTools Message Bar Items and PeopleCode Runtime Messages to PeopleSoft Payroll and PeopleSoft General Ledger application messages.

PeopleTools uses some messages, but the applications use the other messages, which get called by the Error, Warning, Message Box, MsgGet, and MsgGetText built-in PeopleCode functions.

Note. You can create messages and message sets to support new or customized functionality in the system. You can also edit the messages that PeopleSoft delivers. In both of these cases, remember that PeopleSoft reserves all message set numbers up to 20,000. If you add a message set or edit a message set with a number that is less than 20,000, it may be overwritten in future upgrades:

To add a message set:

1. Select Utilities, Administration, Message Catalog, and on the search page click Add New Value.

2. Enter the value of the new Message Set Number and click OK.

3. Enter a description and short description of the type of messages that this message set contains.

   Try to group the messages logically. For instance, create one message set for the new budgeting application and a different one for the customized billing pages.

4. Add messages.

5. Save your work.

To add a message

1. Open the desired message set.

2. In the Message Catalog page, click the plus sign button to add a new row.

   The Message Number value is automatically set to the next unassigned number in the message set.

3. Select a Severity level, enter message text and a detailed explanation.

4. Save your work.

Spell Check System Dictionary

PeopleSoft PeopleTools provides personal and system-level dictionaries. End users and system administrators can add words to the dictionary for use with the spell check feature. Typically, system administrators add words to the system-level dictionary that are used company-wide; end users add additional role-specific terminology to their personal dictionaries.

Select PeopleTools, Utilities, Administration, System Dictionary to access the system-level dictionary.

Select the All Languages page to enter words that are valid across all languages. Select the Language Specific page for those words that are valid to a specific language:

To add words to the system dictionary by language:

1. Select Spell Check System Dictionary, Language Specific.

2. Select the desired language from the Spell Check Language drop-down list box.

3. Select Session to add a word to the current session's spell check dictionary. After saving this word, the language field refreshes to the current spell check language.

4. Enter the word (maximum 40 characters) that is to be added in the Spell Check Word field.

5. Save your changes.

Case Sensitivity for Spell Check

The words that you add to your personal dictionary are case-sensitive and are validated by the following rules:

1. If the added word is all lower case, such as worklist, then the following are considered valid:

   • Exact match, all lower case (worklist).

   • All uppercase (WORKLIST).

   • Initial capitals (Worklist), regardless of its position in the sentence. Mixed case (WorkList) is considered incorrect.

2. If the added word is all uppercase, such as CRM (customer relationship management), then only an exact match is valid.

3. If the added word is in initial capitals, such as California, then only an exact match and all upper case (CALIFORNIA) are considered valid.

4. If the added word contains an embedded capital letter, such as PeopleSoft, then only an exact match is valid. Therefore, if case is not relevant to the validity of the word, use all lower case.

Table Structure for Word Storage

System and personal words are stored in the database in the PSSCWORDDEFN table with the following fields:

• SCOPRID indicates whether a word is a system word or a user's personal word.

• SCLANG stores the dictionary language for which the word is considered valid. If the system administrator chooses to store the word for all languages, this field is left blank.

• SCWORD stores the actual word, with a maximum length of 40 characters.

Translate Values

You use the Translate Values interface to maintain the values in the translate table. If it's allowed by site security administrators, power users can now learn to add their own pick lists (translate values) to an application:

Select PeopleTools, Utilities, Administration, Translate Values to access the Maintain Translate Values page.

Value	Enter the value for the translate selection.
Effective Date	Specify a date for the value to become active.
Status	Specify whether the value is active or not.
Long Name	Enter a long description for identification. There is a 30-character limit.
Short Name	Enter a shorter description for identification. There is a 10-character limit.

See Also

Using the Translate Table

Load Application Server Cache

The Load Application Server Cache page enables you to invoke an Application Engine program, called LOADCACHE, which preloads the cache for the application server. You need to run this program only if you intend to implement shared caching on the application server, which you configure by setting the ServerCacheMode parameter in the application server configuration file.

Load Cache and Application Server Caching

Each PeopleTools server process has two types of cache: memory cache and file cache. Memory cache is always enabled for all processes, but file cache can be configured by an administrator. This section describes populating and using a shared file cache.

The LOADCACHE program caches all of the PeopleTools object metadata into the cache directory that you configure. This is the equivalent of having a user access every page in the system once so that all the metadata is stored in cache. The shared cache also contains metadata for other application objects, such as application messages and Application Engine programs

Using the cache options, the application server is recommended for optimal performance, but the underlying benefit of preloading the cache and using shared cache on the application server is predictable performance. For instance, by preloading the cache, users don't have to wait for the system to cache an object if it's the first time that the system accesses the object. Because the cache is preloaded with all the database objects, the system retrieves all of the required objects from the cache. This provides a significant improvement in first-time transactions and large transactions.

If you elect to implement the shared cache option on the application server, consider the following items:

• You need to run the LOADCACHE program at least once. As the PeopleTools metadata objects change, items that are in the shared cache are marked invalid but are not rewritten. This includes design time changes, upgrades, patches, and so on.

• The first time that you run the LOADCACHE program, it can take from 2 to 30 hours to complete. The time of the program run depends on the number of active languages that are set in the PSLANGUAGES table, the size of the database, and the performance of the machine. Subsequent program runs complete in less time if there is already valid cache data in the target cache directory, as the program is designed only to update the changed objects after the staging directory is already loaded.

• If you update PSSTATUS.LASTREFRESHDTTM, the system marks all items in the shared cache as invalid and you need to rerun LOADCACHE from scratch.

Note. The output is not portable to different operating systems. For instance, if you generate the cached metadata onto a Windows machine, you can't copy the cache files to a UNIX machine.

The following example graphically depicts the shared cache and the nonshared cache architecture:

Shared Cache vs. Nonshared Cache

Note. Shared cache can be used without running the LOADCACHE program, however you still need to load the cache through some other mechanism. If you do not preload the cache, then shared cache is equivalent to having no file cache at all. Using the LOADCACHE program to load the file cache is the best option.

Running the LOADCACHE Program

This page enables you to run the Application Engine LOADCACHE program.

Select PeopleTools, Utilities, Administration, Load Application Server Cache to access the Load Application Server Cache page.

To create and deploy a shared cache:

1. Make sure that the database that the application server runs against produces a clean SYSAUDIT report.

   If SYSAUDIT is not clean, the LOADCACHE program might fail.

2. Ensure that server file caching for all types is enabled.

   In the PSAPPSRV.CFG (application server configuration) file, the EnableServerCaching parameter should be set to 2 (the default) or commented out.

   The LOADCACHE program reads this setting and caches metadata according to the value specified.

   Note. Leave the ServerCacheMode parameter set to its default value of 0.

3. Access the Load Application Server Cache page with an appropriate Run Control ID.

4. In the Output Directory field, enter the value of PS_HOME (the location of your PeopleSoft root directory); for example, C:\psft846.

5. Click Run.

   The Process Scheduler Request page appears.

6. Specify the name of the server that you want to run the process, and click OK to launch the LOADCACHE program.

   The first time that you run the program, the process may take four to five hours. The LOADCACHE program creates the cache files in the following directory:

   PS_HOME\appserv\prcs\ProcessScheduler_domain\cache\cache\stage\stage

   Where ProcessScheduler_domain is the Process Scheduler domain in which you ran this program. After you invoke the program, you can use the Report Manager and Process Monitor links to monitor the progress of the program that is run.

7. Shut down the application server domain.

8. Enable shared caching with the ServerCacheMode parameter (ServerCacheMode=1), and reconfigure the domain so that the changes are reflected.

   Note. When you enable share cache but the SHARE directory is not set up properly, a warning message is generated in the application server log file to alert you that there are no cache files in the cache directory.

9. Copy the contents of the output directory into the \cache\share directory for the appropriate application server domain.

10. Reboot the application server domain.

Tablespace Utilities

Select PeopleTools, Utilities, Administration, Tablespace Utilities to access the Tablespace Utilities page.

To comply with requirements for DB2 UDB for z/OS, the Tablespace Utility now includes both tablespace name and database names when you define a tablespace using the Tablespace Management page. Use the Add/Delete/Rename Tablespaces page to change the list of tablespace and database names.

Add SQL Space

Delete SQL Space

Rename SQL Space

Tablespace Management

Select PeopleTools, Utilities, Administration, Tablespace Management to access the Tablespace Management component (PSTBLSPCCOMP).

These pages enable you to modify the tablespace definition.

Tablespace Defn Page

This page shows the identification values for the tablespace.

Tablespace List Page

This page is where you add records to a particular tablespace. Use the plus and minus buttons to add and delete rows from the list.

Tablespace DDL Page

This page enables you to view and override DDL parameters if needed. View the default DDL in the Default Tablespace DDL list. You override specific parameters, if needed, in the Override Tablespace DDL list. Enter the parameter that you want to override in the Parameter Name column, and enter the override value in the Override column.

DDL Model Defaults

Select PeopleTools, Utilities, Administration, DDL Model Defaults to access the DDL Model Defaults page.

This page is used to view and edit the DDL for creating tablespaces, indexes and tables. Any changes that you make here are global.

Platform ID	Identify the type of platform that you are running on.
Sizing Set	Specify multiple Sizing Sets if needed. Sizing Sets are a way to maintain multiple versions of the DDL Model statements for a particular database platform. For example, you could have one sizing set to be used during a development phase, when tables only have test data, and you could have separate sizing set to be used during production, when tables have much more data.
Copy	Copies information from one sizing set to another.
Statement Type	Indicates the type of statement that's entered in the Model SQL edit box. Values for this field can be Table, Index, and Tablespace.
Model SQL	This field displays the model SQL statements, which you can edit. Valid statements are CREATE TABLE, CREATE INDEX, CREATE TABLESPACE, and a platform-specific statement for updating statistics. Some platforms have all the statements, some do not. For example, DB2 UDB has all four statements. SQL Server has only CREATE TABLE and CREATE INDEX.
Parameter Count	The Parameter Count is calculated based on how many nonblank DDL parm rows that you define.
DDL Parm	The DDL Parm value is a value that the user can change.
DDL Parameter Value	The DDL Parameter value is a value that the user can change. Here you can override the DDL parameter default values with your own for the selected statement type. The statement type that you want to change must be open and have the focus in the PeopleSoft Application Designer. For example, if you want to change the DDL Parm Values for Indexes, set the statement type to Index, then open the record where the index is located in Application Designer, and then change the DDL Parm Value for the index in the chosen record.

Using the DDL Model Defaults page, you can maintain DDL model statements and default parameters for Data Mover. The options that you select on this page also apply to the build function in PeopleSoft Application Designer.

Using this utility, you can:

• Scroll through all the statement types and platforms that are defined in the PSDDLMODEL table.

• Change DDL model statements.

• Add, delete, or change DDL parameters and values.

The Platform IDs are as follows:

Note. There is no validation performed on the Model SQL statement, the DDL Parm syntax, or the relationship between the statement and the parameters.

Strings Table

Select PeopleTools, Utilities, Administration, Strings Table to access the Strings Table page.

The Strings Table page enables you to customize the column headings in the Structured Query Reports (SQRs):

String Source	Options are: RFT Long: Select if you want the long description of the field to be displayed in the column heading as set in PeopleSoft Application Designer. RFT Short: Select if you want the short description of the field as set in the Application Designer to be displayed in the column heading. Text: Select to enter a custom column heading for the report.
String ID	Use the browse button to select the string ID that is to be used for the column heading in the SQR report.
Default Label	The default label is enabled if you select the RFT Long or RFT Short string source, otherwise, the check box is disabled. Remember that fields can have multiple labels. Select the Default Label option to ensure that the default label is used. If you do not use the field's default label, you must select which of the field's labels to use using the label properties button.
String Text	Enter the text for the custom column heading, This is the text that is displayed if you set the string source to Text.
Width	The default value is the current width of the string that you enter or select. Be sure to update the width based on the actual space that is available on the report layout to avoid limiting a translator to an artificially short length, which is likely to degrade the quality of the translation.

XML Link Function Registry

The XML Link Function Registry is used exclusively in conjunction with the XML Link technology. This utility is documented in the PeopleSoft Business Interlinks PeopleBook.

Merchant Integration Utilities

There are two utilities that are related to the Merchant Integration technology that are provided for upgrade support only: Merchant Categories and Merchant Profile.

Refer to PeopleSoft documentation from previous releases for information regarding these utilities. These utilities are not intended for any new development purposes.

TableSet IDs

Select PeopleTools, Utilities, Administration, TableSet IDs to access the Tableset Control page.

Use this utility to create Set IDs. Before doing this:

• Add the SETID field (as a key field) to the record definition for that table.

• Define a Set Control Field as the field controlling the assignment of table sets.

SetID	Enter the setID as defined in the record definition.
Description/Comments	Add any descriptions and comments that are necessary for identification and internal documentation.

Record Group

Select PeopleTools, Utilities, Administration, Record Group to access the Record Group page.

Used to group record definitions for the tables that you want to share, as well as any dependent record definitions:

Description	The Record Group ID description should provide enough information to encompass a category of related tables, not just the table that you are specifically sharing.
Short Description	Enter a short description.
Force Use of Default SetID	This overrides alternate setIDs that are entered so that the default is used.
Record (Table) Name	This prompt list comes from a SQL view of record definitions that are defined with that Set Control Field that aren't already associated with a record group.
Record Description	Automatically populated when the Record (Table) Name is selected.

TableSet Control

The following pages are used to control table sets.

Record Group Page

Select PeopleTools, Utilities, Administration, TableSet Control to access the Record Group page.

Used to define which record groups use which table set:

Default SetID	This is the setID that the system uses as you add additional record definition groups to be shared within this tableset.
SetID	Although this database is set up to share only one accounting-related record group, you may have multiple record groups to which you assign default unique Set IDs.

Tree Page

Select PeopleTools, Utilities, Administration, TableSet Control, Tree to access the Tree page.

Used to share Trees as well as tables and views:

Default SetID	The Default setID that you assign to this field value automatically appears. If you create another tableset for sharing trees, you can change this value.
Tree Name	Use the browse button to select from a list of only the tree definitions that are defined with the same Set Control Field.
SetID	Use the browse button to select the appropriate SetID.

Convert Panels to Pages

The following pages are used to convert panels that are used in previous PeopleSoft Windows applications to pages that are used for browser access.

Scope Page

Select PeopleTools, Utilities, Administration, Convert Panels to Pages to access the Scope page.

This utility helps you update panels that you develop for previous PeopleSoft releases to reflect the pages that are used for the internet architecture.

Project List	Insert projects, containing panels that you want to convert, into this scroll. In addition, if you use the Apply Panel Group Defaults option, any panel group that is contained in projects in this scroll are processed. Note that exceptions may be defined see the task titled, Project Exceptions.
Page List	Insert panels that you want to convert to pages into this scroll.
Project Exceptions	If you want to ensure that a group of panels or panel groups is never processed for conversion, you can insert them into an application upgrade project and insert the project name in this scroll.
Page Exceptions	Panels that are inserted into this scroll are not be processed.

See PeopleSoft ugrade documentation.

documentation for more information.

Options Page

Select PeopleTools, Utilities, Administration, Convert Panels to Pages, Options to access the Options page.

Specify the options for the conversion process:

Convert Scrolls to Scroll Areas	If you select this option, scroll-to-scroll area conversions take place for panels with scroll bars. If this is unchecked, no scroll-to-scroll area conversion takes place.
Convert Scroll Action Buttons to Scroll Areas	Some scroll bars may exist with scroll action buttons that are already defined. This option determines whether these scrolls should be converted or ignored. If they are converted, the scroll action buttons are removed before the scroll bar is converted to a scroll area. If you select this option, scrolls with scroll action buttons are converted. If this options is not checked, scrolls with scroll action buttons are ignored.
Panels with Level 1 Scrolls	If you select this option, panels with level 1 scrolls are processed for scroll conversion.
Panels with Level 2 Scrolls	If you select this option, panels with level 2 scrolls are processed for scroll conversion.
Panels with Level 3 Scrolls	If you select this option, panels with level 3 scrolls are processed for scroll conversion.
Convert Level 1 Scrolls	If you select this option, level 1 scrolls are converted to scroll areas.
Convert Level 2 Scrolls	If you select this option, level 2 scrolls are converted to scroll areas.
Convert Level 3 Scrolls	If you select this option, level 3 scrolls are converted to scroll areas.
Max # Scrolls	This parameter is a general scroll count limit for scroll conversion processing. For example, if this is set to 5, any panel with more than five scrolls that are not invisible is ignored. This is a simple way of eliminating complex panels from automatic scroll conversion.
Apply Specific Page Size	This option is used to define whether a specific size should be assigned to a panel. If you select this option, the panel size that is defined in the drop-down list box is applied to the panel. If this is unchecked, no changes are made to the panel size.   Note. Note. When you select a specific panel size, the panel size is applied to standard panels only (secondary panels and subpanels are not sized automatically).
Apply Default Style Sheet	If you select this option, the style sheet that is associated with a panel is updated with a blank value, so that the panel's style sheet appears by default from PSOPTIONS.STYLESHEETNAME ('PSSTYLEDEF').
Apply Frame/Horz/GrpBox Styles	If you select this option, the conversion process looks for frames, group boxes, and horizontal rules that have no styles associated with them, and that appear to be associated with a specific scroll area by virtue of their position within a scroll area. It then assigns level-specific styles, based on the occurs level of the scroll area.
Convert Frames to Horizontal	Horizontal lines are a new page object for PeopleSoft 8. If you select this option, the conversion process looks for frames on the panel with upper and lower coordinates less than 9 grid units apart. These frames are then converted to horizonal lines.
Delete All Frames	If you select this option, the process removes all frames on the converted panel. Note. If Convert Frames to Horizontal and Delete All Frames are both checked, the conversion from frame to horizontal takes place first, then any remaining frames are deleted.
Turn On Grid 'Odd/Even Style'	This applies to grids that are on a panel being converted. If you select this option, the conversion process determines if grids on the panel have their 'Odd/Even Style' turned on. If it is not turned on, the conversion process turns on this option.
Turn On 'Show Prompt Button'	This option applies to edit box fields that are not invisible and are not display-only. If you select this option, the conversion process turns on the Show Prompt Button option for edit box fields that have it turned off.
Apply Component Defaults	Used to apply standard defaults to component definitions. The defaults that are set are dependent on the Use characteristics of the component. See Application Designer, Component Properties/Use and Component Properties/Internet tabs.
Turn Off 'Show Grid Lines'	Turns off the Show Grid Lines option for grids that have it checked on.
Language Code	Enables you to convert panels whose language code differs from that in PSOPTIONS. Select a language code from the drop-down list box.

Update Utilities

The Update utilities enable you to keep track of the PeopleSoft updates that you apply to the database.

Updates By Release Label

The release label refers to the official release name, such as PeopleTools 8.40.00

Updates By Update ID

The update ID refers to the patch or project name that you apply to the system. The update ID is typically the report ID for a TPRD incident.

Remote Database Connection

Use the Remote Database Connection page to set up remote databases for use with the Remote Data Access (RDA) feature. Select PeopleTools, Utilities, Administration, Remote Database Connection to access the Remote Database Access Management page.

Name	Enter the name of the remote database connection.
Database Type	Available types are Microsoft, DB2 (z/OS), DB2/UNIX, Sybase, Informix, Oracle, and Sybase.
Description	Enter a description of the remote database.
Server	Enter the server name where the remote database resides.
Database	Enter the remote database name.
Local Connect	One connection must defined as the Local Connect for the current PeopleSoft instance (the local database). Check this to specify which database is the local.
DB Server Port	This value is automatically populated with a default value that is based on the database type. You may need to change this value depending upon the database server configuration.
User ID	Enter the user ID that is needed to connect to the remote database.
Password	Enter the password that is associated with the user ID.
Test Connection	Select this to test the remote database connection.
Connection Type	For Oracle database type only. TNS Names or Specific. TNS Names represent a preconfigured file (tnsnames.ora) that consists of previously defined database connection information. Enter Specific if you want to set up a database that does not already have a TNS entry defined.
TNS Entry	For Oracle database type only.
Inf Svr Name	For Informix database type only.

Security in Remote Databases

To ensure security and limit the risk of unauthorized access to databases, follow these recommendations:

• The remote system's database administrator should create a user with read-only access to the tables that may be accessed by other systems using PeopleSoft's RDA.

  Use this restricted user ID and password in configuring a source RDA node.

• The local system's database administrator should create a user with insert/update access to the RDA destination tables only.

  Use this restricted user ID and password in configuring the target RDA node.

URL Maintenance

Select PeopleTools, Utilities, Administration, URLs to access the URL Maintenance page.

Use the URL Table to store URL addresses and to simplify specifying and updating URLs. URLs that are saved here can be referenced from page controls such as a push button/link. The associated URL can be either an internet or intranet link.

Description	Users can search for URLs by description.
URL	Enter the entire URL.
Comments	This field can be used to make notations and comments and is not displayed elsewhere.

To add a new URL entry in the URL table:

1. Click the Add a New Value link.

   A new page appears, prompting you to enter the URL Identifier. Enter the name that you want to use to identify the new URL address.

2. Select Add.

3. Enter the Description, URL, and Comment, if any.

4. Select Save.

   You must save the page before you can add another URL, or update or display existing URL addresses.

5. Select Add to add another URL.

To update or display the URL table:

1. From the URL Maintenance search page, click Search.

2. Select the URL Identifier link that you want to update from the Search Results table.

3. Make changes to the page and save.

Copy File Attachments

Select PeopleTools, Utilities, Administration, Copy File Attachments to access the Copy File Archive page.

Enables you to manage the file attachments that are stored in the database.

Transfer File Attachments

Remove Orphan File Attachments from Database

The accumulation of file attachments can consume a significant chunk of disk space. On a regular basis, you should make sure that lingering, or orphaned, file attachments are deleted from the database. Click the Delete Orphan File Attachments button to complete this task. This button invokes the CleanAttachments PeopleCode function.

Query Monitor

The Query Monitor is used to track the queries that users execute in the system. It enables you perform such tasks as identify queries that need to have logging turned off or need to be tuned.

See Also

Query Administration

Sync ID Utilities

The Sync ID Utilities are used exclusively with PeopleSoft Mobile Applications technology.

See Also

Data Synchronization

Gather Utility

The Gather utility facilitates communications between PeopleSoft and the customer on technical questions or issues. The Global Support Center (GSC) directs the customer to the Gather Utilty when problems arise. Customers can also use a self-service website to run this utility and send in relevant information about their problems or issues.

Using a simple command line interface, the Gather utility is a small Java application that can run on any platform to collect various files from the following environments:

• Application Server.

• Web Server.

• Any additional files that the user chooses (SQL Trace files, PeopleCode Trace Files, etc).

  The collected files are placed in a single jar file with psft.jar as the default name, in the temp directory. Subsequently, these files are sent to PeopleSoft.

Note. For this utility to work, Java must be installed on the target machine. Specifically, JRE 1.4.x and above must be used to take advantage of the Jar Utility Class.

Getting Started

The following files reside in the starting directory:

• Gather.class: The main Java class file

• Helper.class: This class file is called by Gather.class

• Runnit.bat: A MS-DOS batch file that is used by Windows users.

  UNIX users have to run the Gather utility manually.

• Vars.sh: a UNIX shell script.

  Gather calls this automatically if the UNIX operating system is detected.

Windows Users

The following steps are used for Windows (98/98SE/ME/NT/2K):

1. Make sure that you have the PS_HOME environment variable set.

   This saves the user from having to type it in.

2. Go to PS_HOME\utility.

3. Type runnit.

4. Follow the directions that are on the screen.

UNIX Users

Use the following steps for UNIX:

1. At a command prompt, run the following command where PeopleSoft is installed:

   ../psconfig.sh

2. Go to the PS_HOME/utility directory.

3. Change permissions for all files:

   chmod 777 *.*

4. Enter the following to start the utility:

   java -cp .:$CLASSPATH Gather

   Note. UNIX is case-sensitive – Gather is spelled with a capital G.

5. Follow the instructions that are on the screen.

Environmental Data

On Windows, both the set and netstat commands are invoked with the results copied to a file that is collected. On UNIX, the same thing is done with the env command.

Application Server Data

The following files are collected from the Application Server:

• PSAPPSRV.CFG

• PSAPPSRV.UBB

• LOGS/*.*—this usually includes all app serv/tuxedo logs, dump, and replay files.

  This includes all subdirectories under LOGS (8.18).

Web Server Data

The following files are collected from the Web Server:

Additional Files

There is always a need to include files that are not on the above list. These can include PeopleCode Trace files, SQL Trace files, SQL output, and so forth. The command line interface allows you to specify any file that you want to be included in the jar file.

Using Audit Utilities

This section covers the utilities that are used for auditing the system's integrity.

This section discusses how to:

• Use the Record Cross Reference component.

• Perform a system audit.

• Perform database level auditing.

Using the Record Cross Reference Component

Select PeopleTools, Utilities, Audit, Record Cross Reference.

You use the Record Cross Reference component (XREF_PANEL_01) to view where a record is used throughout the application. There are two pages in this page group:

• Pages, Views, Search Records.

• Prompts, Defaults, PeopleCode.

Pages, Views, Search Records

This is a read-only page that shows which Projects, Menus, Pages, and Objects reference a particular record:

Prompts, Defaults, PeopleCode

On the Prompts, Defaults, PeopleCode page, the group boxes list the components that refer to the record.

Used as an Edit Table on	Lists pages that use the record for those purposes.
Used as a Default Table in	Lists pages that use the record for those purposes.
PeopleCode with Fields from this Record	Shows where fields from this record are used in PeopleCode.
PeopleCode referring to this	Shows all PeopleCode that references this record.

Performing a System Audit

The System Audit (SYSAUDIT) utility is extensively documented in the Data Management PeopleBook.

See Also

Running SYSAUDIT

Performing Database Level Auditing

This utility is used to support database level auditing features, and is extensively documented in the Data Management PeopleBook.

See Also

Employing Database Level Auditing

Using Debug Utilities

This section discusses how to:

• Use the PeopleTools Test Utilities page.

• Use the Trace PeopleCode utility.

• Use the Trace SQL utility.

Note. The Trace page is no longer actively used or maintained.

Using the PeopleTools Test Utilities Page

Select PeopleTools, Utilities, Debug, PeopleTools Test Utilities to access the PeopleTools Test Utilities page:

Remote Call Test	You use the Remote Call Test button to test the Remote Call configuration.
Delivered Class File	The Delivered Class File button tests Java PeopleCode integration. It tests to see that Java is being executed correctly through PeopleCode. The Delivered Class File button tests a Java class that is shipped with PeopleSoft 8.
External Class File	The External Class File button tests Java PeopleCode integration. The External Class File button tests a Java class that is created similar to that, which a customer may wish to create.
FTP Site	Enter the full path and password for the test file. For example: FTP://YourFTPUser:YourFTPPassword@YourComputerName/YourDirectory/Path
Attached File	Click this button to attach the file whose path you indicate in the FTP Site.

Using the Trace PeopleCode Utility

The Trace PeopleCode utility is discussed elsewhere in this PeopleBook.

See Also

Setting Up the PeopleCode Debugger

Configuring PeopleCode Trace

Using the Trace SQL Utility

The Trace SQL utility is discussed elsewhere in this PeopleBook.

See Also

Configuring SQL Trace

Using International Utilities

The following sections cover the utilities that you use in globalization efforts.

This section discusses how to:

• Set international preferences.

• Set process field size.

• Administer time zones.

• Manage languages.

Setting International Preferences

Select PeopleTools, Utilities, International, Preferences.

Used to override the language that you select when you sign in to the database.

Language Preference

Use the International Preferences page to temporarily change the session's language preference that was specified during signon. This change lasts until you exit the PeopleSoft session or change the language preference again. Only languages that are enabled on the Languages page are available for selection.

Setting Process Field Size

Select PeopleTools, Utilities, International, Process Field Size.

If you process currency values that require large numbers, such as Italian lira, that require fields longer than those that are included in the standard application, you can use the International Field Size page to expand amount fields throughout the application.

After you create or select a run control ID, set the appropriate lengths for a list of fields, then click the Run button to launch the batch program that performs the field size changes.

Administering Time Zones

This utility is extensively documented in thePeopleTools Global Technology PeopleBook.

See Also

Setting and Maintaining Time Zones

Managing Languages

Select PeopleTools, Utilities, International, Languages to access the Manage Installed Languages page.

Use this page as a central utility to manage language information for the currently enabled languages.

Using Optimization Utilities

The Optimization utilities are documented extensively in the Optimization Framework PeopleBook.

See Also

Designing Analytic Type Definitions

Using PeopleSoft Ping

The PeopleSoft Ping feature collects timestamps by sending a specific page to different tiers of the PeopleSoft system, starting at the browser, then going to the web server, the application server, the database and back. The timestamps that are collected are total time elapsed for the round trip, and arrival and departure time at each of the tiers.

To use the PeopleSoft Ping feature, select PeopleTools, Utilities, PeopleSoft Ping. Enter a new or existing Test Case Identifier to show the following page:

After you specify a test case identifier, enter a value for Repeat Time Interval.To avoid creating unnecessary traffic and overhead to the PeopleSoft system, set the Repeat Time Interval to a relatively high value, such as 600 to 1800 seconds, during normal operations. You may need to increase the Session Timeout value accordingly.

To delete a ping page test case, select PeopleSoft Ping Delete. Select the appropriate check box:

The Delete page lists the test case identifiers. Select the check box that is next to the desired test case identifiers to delete a test case.

PeopleSoft Ping Chart

PeopleSoft Ping includes a charting utility to zoom in to a specific time interval from the ping test. To view a graphic chart of the ping data, select PeopleSoft Ping Chart:

You can change the displayed time interval to a subset of the full ping test period. Edit the start time and end time values, and click Redraw to refresh the chart display with the new time interval.

Click Query Viewer to query the database for the ping data. A new browser window opens, displaying the ping data for the full test period in a table.