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

You enable and disable the System Information page using the Show Connection Information check box on the Debugging page of the current web profile.

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.

Signon Event Message

Select PeopleTools, Utilities, Administration, SignOn Event Message to access the Event Messages page.

Use this page to define messages to display to end users when they sign on to the PeopleSoft system. As long as the signon message is active, each time a user signs on to PeopleSoft, the event message will appear after the user clicks Sign In on the signon page.

View/Edit	Click to view or modify a signon message.
Delete Expired Messages	Click to delete messages that have an End Time and End Date value earlier than current time. Note. To delete individual messages at any time, use the Delete row (-) button.

Note. Only users with the role of PeopleSoft System Administrator will have access to the pages used to view and define signon event messages.

Adding Signon Event Messages

To add a new signon event message:

1. Select PeopleTools, Utilities, Administration, SignOn Event Message.

2. Add a new row to the Event Messages grid.

Defining Signon Event Messages

Use the Message Definition dialog box to define signon event messages.

Click View/Edit in the Event Messages grid to display the Message Definition page.

Event Message

Compose the signon message in this edit box. The system will display to the user all text entered into this edit box. When creating messages, consider: Message size limit is 32 KB. Only plain text is supported (not HTML, XML, Rich Text, or text including links, bold, underline, and so on). Translation of the message is the responsibility of the system administrator creating the message. The system does not translate the message depending on the language of the user. For example, in Quebec, Canada, you might consider displaying an English and French version of the message. The message will be seen by all users signing on to the database through a browser, regardless of role, department, time zone, and so on. As such, care should be taken to ensure the message has broad relevance. Note. The message will not be displayed to Windows Development Environment users.

Message Active

Specify the duration for which the message will be active by setting a start time and date and an end time and date. The system only displays messages where the current time is after the start time and date and before the end time and date. Note. The Time Zone is read-only, and displays the time zone in which the database runs. It does not necessarily reflect the time zone that would be applicable to the text in the message. If there are any specifics related to the time zone that users need to be aware of, that should be communicated in the event message text.

Working With Signon Event Messages

The Event Messages grid can contain multiple signon event message definitions. However, only those messages that are currently active will be displayed to the user.

Multiple signon event messages are displayed to the user by start time and date, with the earliest appearing first.

After reading the message, the user clicks OK, and accesses the application as usual.

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

http://helpwebserver:port/productline/f1search.htm?⇒
ContextID=%CONTEXT_ID%&LangCD=%LANG_CD%

http://myhelpwebserver:8080/htmldoc/f1search.htm?⇒
ContextID=%CONTEXT_ID%&LangCD=%LANG_CD%

WSRP Display Mode

This option determines how WSRP-enabled content appears for users of remote WSRP portals that consume PeopleSoft WSRP content.

See Setting WSRP Display Mode.

Database Encryption Algorithm

(Applies to Oracle databases only.) Enables you to select the encryption algorithm the system uses to encrypt database fields to additional security.

See Implementing Oracle Transparent Data Encryption.

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 below 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. 32,767 is the maximum Message Set and Message Number.

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.

• SCNEGWORDFLG is a flag used to determine if a word is negative (incorrect) or not. Values can be 'N' or 'Y'. PeopleSoft does not currently use this feature, so the value should always be set to 'N'.

To load values in bulk into PSSCWORDDEFN:

1. Using the method of your choice (as in a SQL script), issue SQL similar to the following:

   insert into PSSCWORDDEFN (SCOPRID, SCLANG, SCWORD, SCNEGWORDFLG)
   values ('SYSTEM', 'SC00', 'nnn', 'N')

   Note. For each word you want to add to the library, you need a separate insert command, and the value 'nnn' will be changed in each of those insert statements to be the next value in the list of words you want to add.

2. Add a value (any value) to the Language Specific tab and click Save.

   This alerts the runtime system to update the cached version of the PSSCWORDDEFN table.

Note. In the current release, the maximum number of rows in the PSSCWORDDEFN table should not exceed 2,850.

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. Note. If you are adding a second row for the same translate value, you must enter a unique effective date.
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 run Application Engine programs that loads the shared file cache or the database cache for application server domains.

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

You need to run a cache loading program described in this section only if you intend to implement shared file caching on the application server or database caching.

To load non-shared file cache or database cache with specific cache projects, you use a separate process, which is documented elsewhere in this guide.

See Configuring an Application Server Domain to Preload Cache.

See ServerCacheMode.

Understanding Application Server Caching

Each server process running within a domain has these caching features:

With file caching, you have the option of implementing shared or non-shared file caching.

Oracle provides cache loading programs designed specifically to load cache prior to users accessing the system, which you run from the Load Application Server Cache page. The cache loading programs retrieve all of the PeopleTools definition metadata from the database and builds either file cache that you can deploy locally on an application server or it populates the database cache tables, depending on what type of cache you are implementing.

Running a cache loading program is the equivalent of having a user access every page in the system once so that all the metadata associated with each page is retrieved from the database and stored in the local cache. With all the metadata already stored in cache, the end users experience more predictable performance.

With cache already loaded, end users don't have to wait for the system to retrieve a definition from the database and cache it, each time a definition is accessed for the first time. The system retrieves all of the required objects from the cache as opposed to querying the database for each request. This provides significant performance benefits for first-time and large transactions.

If you elect to run a cache loading program, consider the following items:

• You need to run one of the cache loading programs at least once. Once the cache is loaded, the cache loading programs download only new or changed metadata to the cache.

  Note. Items that are outdated in the cache are marked invalid but are not deleted. This includes design time changes, upgrades, patches, and so on. However, the system uses only the most current cache definitions.

• The first time that you run a cache loading program, it can take a significant amount of time to complete, for example 2 to 30 hours. The duration of the program run depends on a number of factors, including the number of active languages selected, the size of the database, and the power of the server machine. Subsequent program runs complete in less time if there is already valid cache data in the target cache directory or the database cache tables. The programs are designed to update only the changed objects.

• You can copy the output of a cache loading program to other machines (for shared file caching).

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

Warning! If for any reason you update PSSTATUS.LASTREFRESHDTTM, the system marks all items in the shared cache as invalid, and you will need to rerun one of the cache loading programs again.

Oracle provides these options for loading your cache:

Loading Shared File Cache or Database Cache

To load shared file cache or database cache:

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

   If SYSAUDIT is not clean, the cache loading programs can fail.

2. Access the Load Application Server Cache page, entering an appropriate Run Control ID.

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

3. (For shared file cache) In the Output Directory field, enter a valid location.

   Note. In almost all situations, the system ignores any custom value entered in the Output Directory and generates output into the default directory: PS_CFG_HOME\appserv\prcs\ProcessScheduler_domain\cache\stage\stage. However, if a cache loading program runs through a PSNT Process Scheduler server definition running on a remote drive, and the application server cache directory and Process Scheduler cache directory are located on the local drive, then the value entered in the Output Directory field supersedes the default output directory.

4. (For database caching) Select the Database Cache check box.

   This disables the output directory field, and indicates for the cache loading program that cache should be written to the database.

5. Select the languages to load.

   If not all possible languages are required to be loaded for a domain, you can improve performance of the program run by only selecting those languages that are required.

6. Click Run.

   The Process Scheduler Request page appears.

7. From the Server Name dropdown list, select the name of the server that you want to run the process.

8. From the Process List, select Serial LoadCache to run the single LOADCACHE Application Engine program, or select Parallel LoadCache to run the PLCACHE PSJob to run multiple Application Engine jobs in parallel.

9. If running Parallel LoadCache, ensure that the Process Scheduler server definition is set to run the LOADCACHE process category and that the Max Concurrent value is set appropriately.

   Parallel LoadCache is assigned to the LOADCACHE process category. It will run only on servers that are configured to run the LOADCACHE process category.

   For the LOADCACHE process category, set the Max Concurrent value greater than 0. The recommended value is 2.

   If you modify the server definition, restart the server for your changes to take effect.

   Note. When running the cache loading programs, only one server at a time should have the MaxConcurrent value set greater than 0. Otherwise there is no guarantee that the processes running within the Parallel LoadCache job will run on the same server. This could result in each server having an incomplete set of generated cache files.

   See Setting Server Definitions.

10. Click OK to launch the cache loading program.

    After you invoke the process, you can use the Report Manager and Process Monitor links to monitor the progress.

    The first time that you run the program, the process may take numerous hours to complete (less time for the Parallel LoadCache option).

11. When the cache loading program completes, verify the existence of the cache contents.

    The cache loading program creates the shared file cache in the following directory:

    PS_CFG_HOME\appserv\prcs\ProcessScheduler_domain\cache\stage\stage

    Where ProcessScheduler_domain is the Process Scheduler domain in which you ran the process.

    If database caching is enabled, the program loads the cache into the database.

12. Once you've determined that the cache has been successfully loaded, shut down the application server domain(s), and modify the domain configuration.

    For shared file caching, edit the PSAPPSRV.CFG file, and enable shared caching, by uncommenting and setting ServerCacheMode=1 for all appropriate domains.

    For database caching, edit the PSAPPSRV.CFG file, and enable database caching, by uncommenting and settting EnableDBCache=Y for all appropriate domains.

13. (For shared file cache ) Copy the contents of the output directory into the PS_CFG_HOME\appserv\domain\cache\share directory for the appropriate application server domain(s).

14. Boot the application server domain(s).

Working with Database Cache

Database caching provides another implementation option. Determining which caching option works best for your site requires analysis and testing. For many cases, file caching will continue to be the preferred method.

The benefits of database caching include:

• Cache loading only needs to be run once for all domains connecting to a database as they will all share the same database cache.

• New domains can immediately take advantage of the database cache once EnableDBCache is set in the domain configuration. That is, no additional cache loading programs need to be run or additional output that needs to be copied.

• Eliminates administrative overhead of managing disk space and cache files on the file system.

Note. The database cache stores the cached metadata as a BLOB in a single table for the most efficient retrieval.

Note. The database cache is generated specific to the system's byte-order (little-endian or big-endian). The database cache is shared by all systems that have the same byte-order.

See Also

Configuring an Application Server Domain to Preload Cache

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.

Tablespace Name	Enter the name of the Tablespace that you want to add.
Database Name	Enter the database name into which you want to add the space.
Type	Select the type of Tablespace.

Use the plus/minus buttons to add and delete tablespaces.

Tablespace Management

Select PeopleTools, Utilities, Administration, Tablespace Management to access the Tablespace Management component

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 of the current database type.
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.
Parameter Count	The Parameter Count is calculated based on how many nonblank DDL Parm rows that you define.
DDL Parm	Enter the DDL Parm (parameter) to which you want to assign a default.
DDL Parameter Value	The DDL Parameter Value field is where you override a DDL parameter's default value with your own for the selected statement type.

Using the DDL Model Defaults page, you can maintain DDL model statements and default parameters for Data Mover and Application Designer when DDL (PSBUILD.SQL, for example) is generated during the build process.

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.

BOE Integration Administration

This page enables you to manage your BusinessObjects Enterprise installation.

See Getting Started with Crystal Reports for PeopleSoft.

Strings Table

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

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

Lookup Exclusion

Enter the record name for the tables you want to exclude from the auto lookup feature. A prompt or lookup button opens a lookup page in the user's browser populated with up to 300 available values for that field. The user can then either select the desired value or refine their search further. For extremely large tables, the system administrator has the option of excluding that table from auto prompting by adding the table to this list.

See Also

Prompt Fields

XML Link Function Registry

The XML Link Function Registry is used exclusively in conjunction with the XML Link technology, which is associated with PeopleSoft Business Interlinks.

Note. PeopleSoft Business Interlinks is a deprecated product. This option currently exists for upgrade compatibility and transition.

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

Record Group

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

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

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.

Tree Page

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

Used to share Trees as well as tables and views.

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 from PeopleTools 7.5x versions to reflect the pages that are used for the PeopleSoft Internet Architecture.

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:

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

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. Note. For the file attachment functionality, in specifying the URL for the FTP server, the FTP server's machine name can be more than 30 characters, but the length of the full URL is limited to 120 characters. The URL format for file attachments stored in the database is record://recordname, as in record://ABSENCE_HIST_DB.
Comments	This field can be used to make notations and comments and is not displayed elsewhere.

Adding New URLs

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.

Viewing and Updating the URL Table

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.

3. Make changes to the page and save.

Specifying URL Properties

You access the URL Properties page by clicking the URL Properties link on the URL maintenance page.

You create the URLID using the URL Maintenance page, but you assign various properties to the URLID for the following protocol types using the URL Properties page.

• FTP

• FTPS

• SFTP

• HTTP

• HTTPS

The properties you assign depend on the protocol and the type of security you are implementing.

The Password Encryption box enables you to enter and confirm any password value you intend to assign to a PASSWORD property. Click Encrypt to encrypt the password, then copy the results into the edit box for PASSWORD.

Note. If you intend to implement secure FTP, SFTP, HTTP, or HTTPS, Oracle recommends you understand the details and behavior of the attachment PeopleCode constructs, such as AddAttachment.

See Working With File Attachments.

To assign properties to a URL:

1. On the URL Maintenance page, add a URL value containing ftp://, ftps://, sftp://, http://, or https:// in the URL field.

2. Click Save.

3. Click the URL Properties link.

4. Set the URL properties for the protocol and your security preference.

5. Click Save.

The available URL properties for each protocol appear in the following table:

Working with FTP/FTPS

FTP over SSL (FTPS) can be achieved in two ways: implicit and explicit. Implicit SSL uses ftps:// and explicit uses ftp://.

To use PASV only, set URL property EXTENDEDPASSIVEMODE to 0.

Working with SFTP

With SFTP, these authentication methods are supported:

• password

• public key

To set up password authentication create a URL identifier with an sftp URL value, such as sftp://10.145.641.122/, then set these URL properties:

• AUTHTYPE: 2 - PASSWORD

• USER: user ID

• PASSWORD: encrypted user password

For public key authentication copy the public key to <PS_SERVDIR>\sshkeys\public and the private key file to <PS_SERVDIR>\sshkeys\private. Alternatively, you can copy the files in to a different location and define an environment variable PS_SSHKEYPATH.

Note. PS_SSHKEYPATH can only replace PS_SERVDIR. The locations, ...\sshkeys\public and ...\sshkeys\private must be used.

Then set these URL properties appropriately:

• AUTHTYPE: (1 - PUBLIC KEY)

• USER

• PRIVATEKEY

• PUBLICKEY

• PASSWORDKEY

Working with HTTP/HTTPS

HTTP/S file transfer requires the http/https repository available (file storage location). The repository can either be on a PeopleSoft web server or non-PeopleSoft server. The PeopleSoft Internet Architecture provides a handler servlet (psfiletranfer) to handle the requests. If you use a non-PeopleSoft web server you need to create a handler for non-PeopelSoft servers/repositories.

Once the repository is created, the configuration.properties file for the appropriate PeopleSoft site needs to be modified to include the HttpRepository property. For example:

HttpRepositoryPath=D:\HttpRepository

To set up HTTP:

After creating a URL identifier with an http:// URL (as in, http://<PIA URL>/psfiletransfer/<sitename>/), select these URL properties:

• USEAUTHTOKEN: Y

• USER: user_ID

Set the Authentication Option field on the default local node to Password.

To set up HTTPS:

Setup the target web server for HTTPS, and add the Root CA and Client Certificate to Digital Certificate store.

Create an URL Identifier using https://, and add these URL properties:

• CERTALIAS: your certificate alias

• SSLUSAGELEVEL: 3-SSL Only

• VERIFYHOST: 2

• VERIFYPEER: Y

• USER: user ID

• USEAUTHTOKEN: Y

You can have the HTTP repository on a separate PeopleSoft web server too. For example, PIAsystem1 can have the URL identifier pointing to a URL on PIAsystem2. This requires following to be in place:

• The user specified in the URL properties must exist in both the systems with the proper permissions.

• The default local nodes on both systems should have Authentication Option set to Password and should be pinged successfully.

• The default local nodes of each system are added to single-signon list for each database.

Copy File Attachments

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

Enables you to administer your file attachments.

Transfer File Attachments

Removing Orphan File Attachments from the Database

The accumulation of file attachments can consume a significant amount of space in your database. Therefore, on a regular basis, it is recommended that you make sure that orphaned file attachments are deleted from the storage location, reclaiming disk space being used unnecessarily. Orphan file attachments are stored file attachments for which there is no longer a corresponding file reference in a valid file reference table.

Click the Delete Orphan File Attachments button to complete this task. This button invokes the CleanAttachments PeopleCode function.

Warning! There is no way to roll back changes made by the CleanAttachments function. Review the CleanAttachments documentation in the PeopleCode Language Reference PeopleBook describing the behavior of CleanAttachments in order to appropriately anticipate how it will behave. Oracle suggests that you perform a database backup before invoking this functionality.

See PeopleTools 8.51 PeopleBook: PeopleCode Language Reference, "PeopleCode Built-in Functions," CleanAttachments

Query Administration

System administrators can use Query Administration to monitor query performance and usage. Some of the conditions that you can monitor include average runtime, number of times run, and the dates last run. Using a predefined search, you can also select queries to review and report on.

See Also

Query Administration

Sync ID Utilities

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

Important! PeopleSoft Mobile Agent is a deprecated product. These pages currently exist for backward compatibility only.

nVision Report Request Admin

See Securing and Sharing Report Requests in PIA.

Analytic Server Administration

See Administering Analytic Servers.

Upgrade Conversion

Defines upgrade drivers, providing details regarding Application Engine program, section, group, and calling sequence. If you need to specify any of these values, your upgrade documentation will provide the details.

See your upgrade documentation for more information.

Analytic Model Viewer

See Viewing Analytic Model Properties.

Analytic Instance Load/Unload

See Loading and Unloading Analytic Instances.

Analytic Instance Create/Del/Copy/

See Creating, Deleting, and Copying Analytic Instances.

Pre-Load Cache Utilities

See Configuring an Application Server Domain to Preload Cache.

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 Utility 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, and so on).

  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, the supported version of Java (JRE) must be installed on the target machine.

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:

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 application serv/tuxedo logs, dump, and replay files.

  This includes all subdirectories under LOGS .

Web Server Data

The gather utility collects numerous files (log files, configuration files, and so on) from each of the supported web servers. If an analyst only asks for a specific file, send that, but make sure to keep the other collected files in case they are needed.

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.

QAS Administration

See Using QAS Administration.

Oracle Resource Management

See Working With Oracle Consumer Groups.

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 as edit table.
Used as a Default Table in	Lists pages that use the record as a default table.
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 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 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 / Trace Panel 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.
Interlink Test	Used to test Business Interlinks. (Business Interlinks is a deprecated product).
PeopleCode/Java Test	The Derived Class File button tests Java-PeopleCode integration. It tests to see that Java is being executed correctly through PeopleCode. The External Class File button tests Java PeopleCode integration.
File Attachment Test	This enables you to test the file attachment PeopleCode functions with your file storage location. Enter the full path and password for the test file or the URL identifier (URL.URL_ID). For example: ftp://user01:password@ftpserver.oracle.com/myfiles Note. For the file attachment functionality, in specifying the URL for the FTP server, the FTP server's machine name can be more than 30 characters. The length of the full URL is limited to 120 characters. Click Attach to attach the file. Once the file is attached, you can View, Detach, and Delete the file. The file attachment PeopleCode functions and their usage within PeopleSoft applications is documented in detail in the PeopleCode Developer's Guide. Note. The File Attachment Test does not allow .JSP files to be uploaded or downloaded.

Example: File Attachment Test

The following shows an example of the buttons that appear once a file is uploaded.

See Also

Working With File Attachments

URL Maintenance

Replay Appserver Crash

See Configuring the Application Server to Handle Cache Files and Replay Files.

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.

See Also

Changing the Session Language While Signed In

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.

See Also

Resizing Currency Fields by Using the International Field Size Utility

Administering Time Zones

This utility is extensively documented in the PeopleTools 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.

See Also

Managing Languages in the PSLANGUAGES Table

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 utility 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 Test Case Identifier to uniquely group each set of metrics. For Repeat Time Interval , enter an increment for the ping to run. 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.

PeopleSoft Ping Chart

Select PeopleTools, Utilities, PeopleSoft Ping, PeopleSoft Ping Chart.

PeopleSoft Ping includes a charting utility to zoom in to a specific time interval from the ping test.

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.

PeopleSoft Ping Delete

To delete a ping page test case:

1. Select PeopleTools, Utilities, PeopleSoft Ping, PeopleSoft Ping Delete.

   The Delete page lists the current test case identifiers.

2. Select the check box next to the identifier(s) you want to delete.

3. Click Delete.

PeopleSoft Ping Options

Select PeopleTools, Utilities, PeopleSoft Ping, PeopleSoft Ping Options.

The PeopleSoft Ping Options page enables you to set targets for each tier as well as overall completion time. If the ping process exceeds your targets, this affects the color-coding on the PeopleSoft Ping interface, using green, yellow, and red. Green is any time under the yellow and red targets, yellow is any time over the yellow target yet under red, and red is anything exceeding the red target. The metrics you enter depend on the typical conditions and expectations at your site.