PeopleTools 8.

62: Usage Monitor

April 2025
PeopleTools 8.62: Usage Monitor
Copyright © 1988, 2025, Oracle and/or its affiliates.

This software and related documentation are provided under a license agreement containing restrictions on use and
disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement
or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute,
exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or
decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you
find any errors, please report them to us in writing.

If this is software, software documentation, data (as defined in the Federal Acquisition Regulation), or related
documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government,
then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software,
any programs embedded, installed, or activated on delivered hardware, and modifications of such programs) and
Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end users
are "commercial computer software," "commercial computer software documentation," or "limited rights data"
pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such,
the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works,
and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programs
embedded, installed, or activated on delivered hardware, and modifications of such programs), ii) Oracle computer
documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the license contained
in the applicable contract. The terms governing the U.S. Government's use of Oracle cloud services are defined by
the applicable contract for such services. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is
not developed or intended for use in any inherently dangerous applications, including applications that may create a
risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible
to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation
and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous
applications.

Oracle®, Java, MySQL, and NetSuite are registered trademarks of Oracle and/or its affiliates. Other names may be
trademarks of their respective owners.

Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used
under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc, and the AMD
logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The
Open Group.

This software or hardware and documentation may provide access to or information about content, products, and
services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all
warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an
applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any
loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as
set forth in an applicable agreement between you and Oracle.

Documentation Accessibility
For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program
website at https://docs.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers that have purchased support have access to electronic support through My Oracle
Support. For information, visit https://docs.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit https://
docs.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.
Contents
Preface: Preface............................................................................................................................................v
Understanding the PeopleSoft Online Help and PeopleBooks...............................................................v
Hosted PeopleSoft Online Help....................................................................................................... v
Locally Installed PeopleSoft Online Help....................................................................................... v
Downloadable PeopleBook PDF Files.............................................................................................v
Common Help Documentation.........................................................................................................v
Field and Control Definitions......................................................................................................... vi
Typographical Conventions.............................................................................................................vi
ISO Country and Currency Codes................................................................................................. vii
Region and Industry Identifiers..................................................................................................... vii
Translations and Embedded Help................................................................................................. viii
Using and Managing the PeopleSoft Online Help..............................................................................viii
PeopleTools Related Links.................................................................................................................. viii
Contact Us........................................................................................................................................... viii
Follow Us...............................................................................................................................................ix
Chapter 1: Getting Started with Usage Monitor....................................................................................11
Usage Monitor Overview......................................................................................................................11
Enabling Usage Monitor.......................................................................................................................11
Associating Test Names and Test Cases.............................................................................................. 17
Integrating Usage Monitor Data with PeopleSoft Test Framework..................................................... 19
Integrating Usage Monitor Data with LCM Insights........................................................................... 19

Copyright © 1988, 2025, Oracle and/or its affiliates. iii

Contents

iv Copyright © 1988, 2025, Oracle and/or its affiliates.

Preface

Understanding the PeopleSoft Online Help and PeopleBooks

The PeopleSoft Online Help is a website that enables you to view all help content for PeopleSoft
applications and PeopleTools. The help provides standard navigation and full-text searching, as well as
context-sensitive online help for PeopleSoft users.

Hosted PeopleSoft Online Help

You can access the hosted PeopleSoft Online Help on the Oracle Help Center. The hosted PeopleSoft
Online Help is updated on a regular schedule, ensuring that you have access to the most current
documentation. This reduces the need to view separate documentation posts for application maintenance
on My Oracle Support. The hosted PeopleSoft Online Help is available in English only.

To configure the context-sensitive help for your PeopleSoft applications to use the Oracle Help Center,
see Configuring Context-Sensitive Help Using the Hosted Online Help Website.

Locally Installed PeopleSoft Online Help

If you’re setting up an on-premises PeopleSoft environment, and your organization has firewall
restrictions that prevent you from using the hosted PeopleSoft Online Help, you can install the online help
locally. Installable PeopleSoft Online Help is made available with selected PeopleSoft Update Images and
with PeopleTools releases for on-premises installations, through the Oracle Software Delivery Cloud.

Your installation documentation includes a chapter with instructions for how to install the online help
for your business environment, and the documentation zip file may contain a README.txt file with
additional installation instructions. See PeopleSoft 9.2 Application Installation for your database platform,
“Installing PeopleSoft Online Help.”

To configure the context-sensitive help for your PeopleSoft applications to use a locally installed online
help website, see Configuring Context-Sensitive Help Using a Locally Installed Online Help Website.

Downloadable PeopleBook PDF Files

You can access downloadable PDF versions of the help content in the traditional PeopleBook format on
the Oracle Help Center. The content in the PeopleBook PDFs is the same as the content in the PeopleSoft
Online Help, but it has a different structure and it does not include the interactive navigation features that
are available in the online help.

Common Help Documentation

Common help documentation contains information that applies to multiple applications. The two main
types of common help are:

• Application Fundamentals

Copyright © 1988, 2025, Oracle and/or its affiliates. v

Preface

• Using PeopleSoft Applications

Most product families provide a set of application fundamentals help topics that discuss essential
information about the setup and design of your system. This information applies to many or all
applications in the PeopleSoft product family. Whether you are implementing a single application, some
combination of applications within the product family, or the entire product family, you should be familiar
with the contents of the appropriate application fundamentals help. They provide the starting points for
fundamental implementation tasks.

In addition, the PeopleTools: Applications User's Guide introduces you to the various elements of the
PeopleSoft Pure Internet Architecture. It also explains how to use the navigational hierarchy, components,
and pages to perform basic functions as you navigate through the system. While your application or
implementation may differ, the topics in this user’s guide provide general information about using
PeopleSoft applications.

Field and Control Definitions

PeopleSoft documentation includes definitions for most fields and controls that appear on application
pages. These definitions describe how to use a field or control, where populated values come from, the
effects of selecting certain values, and so on. If a field or control is not defined, then it either requires
no additional explanation or is documented in a common elements section earlier in the documentation.
For example, the Date field rarely requires additional explanation and may not be defined in the
documentation for some pages.

Typographical Conventions
The following table describes the typographical conventions that are used in the online help.

Typographical Convention Description

Key+Key Indicates a key combination action. For example, a plus sign

(+) between keys means that you must hold down the first key
while you press the second key. For Alt+W, hold down the Alt
key while you press the W key.

. . . (ellipses) Indicate that the preceding item or series can be repeated any
number of times in PeopleCode syntax.

{ } (curly braces) Indicate a choice between two options in PeopleCode syntax.

Options are separated by a pipe ( | ).

[ ] (square brackets) Indicate optional items in PeopleCode syntax.

& (ampersand) When placed before a parameter in PeopleCode syntax,

an ampersand indicates that the parameter is an already
instantiated object.

Ampersands also precede all PeopleCode variables.

vi Copyright © 1988, 2025, Oracle and/or its affiliates.

 Preface

Typographical Convention Description

⇒ This continuation character has been inserted at the end of a

line of code that has been wrapped at the page margin. The
code should be viewed or entered as a single, continuous line
of code without the continuation character.

ISO Country and Currency Codes

PeopleSoft Online Help topics use International Organization for Standardization (ISO) country and
currency codes to identify country-specific information and monetary amounts.

ISO country codes may appear as country identifiers, and ISO currency codes may appear as currency
identifiers in your PeopleSoft documentation. Reference to an ISO country code in your documentation
does not imply that your application includes every ISO country code. The following example is a
country-specific heading: "(FRA) Hiring an Employee."

The PeopleSoft Currency Code table (CURRENCY_CD_TBL) contains sample currency code data. The
Currency Code table is based on ISO Standard 4217, "Codes for the representation of currencies," and
also relies on ISO country codes in the Country table (COUNTRY_TBL). The navigation to the pages
where you maintain currency code and country information depends on which PeopleSoft applications
you are using. To access the pages for maintaining the Currency Code and Country tables, consult the
online help for your applications for more information.

Region and Industry Identifiers

Information that applies only to a specific region or industry is preceded by a standard identifier in
parentheses. This identifier typically appears at the beginning of a section heading, but it may also appear
at the beginning of a note or other text.

Example of a region-specific heading: "(Latin America) Setting Up Depreciation"

Region Identifiers
Regions are identified by the region name. The following region identifiers may appear in the PeopleSoft
Online Help:

• Asia Pacific

• Europe

• Latin America

• North America

Industry Identifiers
Industries are identified by the industry name or by an abbreviation for that industry. The following
industry identifiers may appear in the PeopleSoft Online Help:

• USF (U.S. Federal)

Copyright © 1988, 2025, Oracle and/or its affiliates. vii

Preface

• E&G (Education and Government)

Translations and Embedded Help

PeopleSoft 9.2 software applications include translated embedded help. With the 9.2 release, PeopleSoft
aligns with the other Oracle applications by focusing our translation efforts on embedded help. We
are not planning to translate our traditional online help and PeopleBooks documentation. Instead we
offer very direct translated help at crucial spots within our application through our embedded help
widgets. Additionally, we have a one-to-one mapping of application and help translations, meaning that
the software and embedded help translation footprint is identical—something we were never able to
accomplish in the past.

Using and Managing the PeopleSoft Online Help

Select About This Help in the left navigation panel on any page in the PeopleSoft Online Help to see
information on the following topics:

• Using the PeopleSoft Online Help.

• Managing hosted Online Help.

• Managing locally installed PeopleSoft Online Help.

PeopleTools Related Links

PeopleTools 8.62 Home Page

PeopleSoft Search and Insights Home Page

“PeopleTools Product/Feature PeopleBook Index” (Getting Started with PeopleTools)

PeopleSoft Online Help

PeopleSoft Information Portal

PeopleSoft Spotlight Series

PeopleSoft Training and Certification | Oracle University

My Oracle Support

Oracle Help Center

Contact Us
Send your suggestions to psoft-infodev_us@oracle.com.

Please include the applications update image or PeopleTools release that you’re using.

viii Copyright © 1988, 2025, Oracle and/or its affiliates.

 Preface

Follow Us

Icon Link

Watch PeopleSoft on YouTube

Follow @PeopleSoft_Info on X.

Read PeopleSoft Blogs

Connect with PeopleSoft on LinkedIn

Copyright © 1988, 2025, Oracle and/or its affiliates. ix

Chapter 1

Getting Started with Usage Monitor

Usage Monitor Overview

The Usage Monitor monitors Managed Object (MO) data and Application Data Set (ADS) instance data
accessed by users through the PeopleSoft Internet Architecture (PIA).

From PeopleTools 8.62, the usage monitoring of data is extended to the Process Scheduler and
Application Engine servers.

The data collected by the Usage Monitor for managed objects such as pages, components, and
PeopleCode enables administrators to more accurately understand what definitions in the database are
used in their environment. This information can assist with impact analysis when applying updates or
change packages. Usage Monitor information for managed objects can also be used in conjunction with
the PeopleSoft Test Framework and (or) the LCM Insights feature.

The data collected by the Usage Monitor for ADS objects enables users to understand what ADS
instances are most used in their environment and can assist in impact analysis of how the change package
may modify any used ADS instance in their environment.

See “Application Data Set Overview” (Lifecycle Management Guide) and Enabling Usage Monitor

You can enable usage data collection on the Usage Monitoring Options page. See Enabling Usage
Monitor.

Enabling Usage Monitor

To enable Usage Monitor, select the Enable Usage Monitoring option on the Usage Monitoring Options
page.

Navigation:

PeopleTools > Lifecycle Tools > Usage Monitoring > Usage Monitoring Options.

By default, this option is not selected. After selecting this option, ensure to restart the application server.

Copyright © 1988, 2025, Oracle and/or its affiliates. 11

Getting Started with Usage Monitor Chapter 1

This example illustrates the fields and controls on the Usage Monitoring Options page.You can find
definitions for the fields and controls later on this page.

12 Copyright © 1988, 2025, Oracle and/or its affiliates.

Chapter 1 Getting Started with Usage Monitor

Field or Control Description

Data Collection Method Set the data collection method with:

• Anonymous- All usage by all users is collected and stored

with the User ID value of ANONYMOUS.

• By UserId- All usage by all users is collected and stored

with the UserID value of the user who accessed the
object.

Selecting By UserId option significantly increases the amount

of data collected.

For example, if you have ten users who use the same ten
objects, then:

• The Anonymous option collects 1 anonymous user * 10

objects = 10 rows of data.

• The By UserId option collects 10 users * 10 objects = 100

rows of data.

You can select an option based on your environment:

• Production environment: The Anonymous option should

be used in all cases when collecting usage data in this
environment.

• Test and Development environments- The Anonymous

option should be used when collecting usage data in these
environments for the following use cases:

• Collecting usage data for use with the LCM Insights

feature.

• General usage data collection for custom

applications.

• Using Usage Monitor for the first time or initial

rollout to estimate the potential data volumes to be
collected.

The By UserId option should be used only when collecting

usage data in the Test and Development environments for use
cases that require this level of detail including the following:

• Collecting usage data in conjunction with the PeopleSoft

Test Framework (PTF) tool.

• Usage data collection for custom applications that

requires user level data.

Enable Managed Object Usage Monitoring

Copyright © 1988, 2025, Oracle and/or its affiliates. 13

Getting Started with Usage Monitor Chapter 1

Field or Control Description

Enable Managed Object Usage Monitoring Select to enable the Usage Monitor for managed objects
accessed through application server, Process Scheduler server,
and Application Engine server.

The use cases for Managed Object usage collection include

collecting usage data for use with the LCM Insights feature,
collecting usage data in conjunction with the PeopleSoft Test
Framework (PTF) tool, and general usage data collection for
custom applications.

Managed Object Buffer Size Set the buffer limit which determines how much data should
be collected in the buffer before storing the data in the
database. Depending on the pages that are accessed and your
testing needs, you can arrive at an optimum buffer size for
your usage pattern.

The Buffer Size value affects the performance of the system.

Each buffer row requires 1000 bytes of memory, such that a
Buffer size value of 200,000 will require 190 MB of available
memory.

While the buffer maintains a unique set of objects, the writes

to the buffer flush events to the database can result in duplicate
data that must subsequently be aggregated.

In order to minimize the number of database writes and

data aggregation actions, the Buffer value should be set to a
relatively large value that is ideally in line with the number of
expected number of unique rows.

Determining the optimal value for the buffer size will likely
take some adjustment once usage collection is up and running
and the volume of data being collected is better known.

Factors that impacts the expected number of unique rows

include:

• Data collection method (Anonymous or By UserID

options).

• Number of users when collecting data with the By UserID

option.

• Number of objects used in the system.

For example, HCM92 has nearly 700,000 unique

Managed Objects. However, it is likely that not all of
these are in use.

The buffer writes to the database when:

• the buffer is full.

• the Application server or Process Scheduler is shutdown.

If the Buffer Size value is set too high, the buffer may never
fill, causing the process to write collected data to the database
only during the server shutdown event.

14 Copyright © 1988, 2025, Oracle and/or its affiliates.

Chapter 1 Getting Started with Usage Monitor

Field or Control Description

Enable ADS Usage Monitoring

Enable ADS Usage Monitoring Select to enable the Usage Monitor for ADS instances
accessed through application server, Process Scheduler server,
and Application Engine server.

The use cases for ADS usage collection include General usage
data collection for custom applications.

The list of ADS instances that are monitored and recorded will
be those identified in the PSADSTRACKITEM PeopleTools
table.

ADS Buffer Size Set the buffer limit which determines how much data should
be collected in the buffer before storing the data in the
database. Depending on the ADS instances that are accessed,
you can arrive at an optimum buffer size for usage pattern.

The Buffer Size value affects the performance of the system.

Each buffer row requires 1000 bytes of memory, such that a
Buffer Size value of 200,000 will require 190 MB of available
memory. While the buffer maintains a unique set of objects,
the writes to the buffer flush events to the Database can result
in duplicate data that must subsequently be aggregated.

In order to minimize the number of database writes and

data aggregation actions the Buffer value should be set to a
relatively large value that is ideally in line with the number of
expected number of unique rows.

Determining the optimal value for the buffer size will likely
take some adjustment once usage collection is up and running
and the volume of data being collected is better known.

Factors that impacts the expected number of unique rows

include:

• Collection mode.

• Number of users when collecting in By UserID option.

• Number of objects used in the system.

The buffer will write to the database:

• When the buffer is full.

• the Application server or Process Scheduler is shutdown.

If the Buffer Size value is set too high, the buffer may never
fill, causing the process to write collected data to the database
only during the server shutdown event.

Process Scheduler Usage Monitoring Options

Copyright © 1988, 2025, Oracle and/or its affiliates. 15

Getting Started with Usage Monitor Chapter 1

Field or Control Description

Set Process Names and Process ID for Test Name and Test When you select this option, the process name and process
Case Name ID details get recorded for the usage data monitored by
Application Engine server and Process Scheduler server.

Note: This is not applicable for application server.

Purge Usage Monitor Data

After <N> days N specifies the retention period or the number of days
during which the Usage Monitor data remains in the
PSPTUMPMTAGR table.

Purge Managed Object Data Usage Monitor managed object data older than the retention
period gets deleted when you click the Purge Managed Object
Data button.

Purge ADS Data ADS instance data older than the retention period gets deleted
when you click the Purge ADS Data button.

To verify the Usage Monitor configuration:

1. On the Usage Monitoring Options page, set the Managed Object (MO) buffer size to 50.

Note: Until the Buffer Size value is reached, no Usage Monitor data will be written to the database.

Important! This buffer value of 50 is only for verifying the Usage Monitor configuration, ensuring
that data will be quickly written to the Usage Monitor tables. When you are using the Usage Monitor,
you need to increase the Buffer Size value to a more appropriate "production" value. The default is
2500. Refer to the documentation of Managed Object Buffer Size given in the preceding table.

2. Shutdown and restart the application server domain and the PeopleSoft Internet Architecture.

3. Login to that application with your browser and navigate through a few pages and menus in the
application.

4. With your SQL query tool, submit the following query on the monitoring database for managed
objects:
SELECT * FROM PSPTUMPMTAGR

Note: The Usage Monitor managed object data is collected and stored in the PSPTUMPMTAGR
table.

With your SQL query tool, submit the following query on the monitoring database for ADS instances:
SELECT * FROM PS_PTUMADSAGR

Note: The Usage Monitor ADS instance data is collected and stored in the PS_PTUMADSAGR table.

16 Copyright © 1988, 2025, Oracle and/or its affiliates.

Chapter 1 Getting Started with Usage Monitor

5. Verify that data is present in the table and that the timestamps correspond to the time you verified the
Usage Monitor configuration.

6. Repeat the previous steps when setting the Buffer Size value to your production value.

Associating Test Names and Test Cases

When the Usage Monitor is enabled and collecting usage data, the information is stored associated with a
user ID or anonymously, depending on the options selected for the Usage Monitoring State parameter in
the application server domain configuration.

To associate a test name and test case with usage monitoring managed object data and ADS instance data,
use the Test Usage Monitoring page. This can help to sort the generated usage data, especially for usage
data for PeopleSoft Test Framework tests. As of now, this is only an option when data is collected using
the By UserID option.

Associating Test Names and Test Cases

Access the Test Usage Monitoring page by selecting

PeopleTools > LifeCycle Tools > Usage Monitoring > Test Usage Monitoring.

Copyright © 1988, 2025, Oracle and/or its affiliates. 17

Getting Started with Usage Monitor Chapter 1

This example illustrates the fields and controls on the Test Usage Monitoring page to test usage
monitoring for managed objects and ADS instances.

Enter a Test Name and Test Case value to associate specific usage data with individual tests and test
cases.

To begin a test, click Start Test.

To end a test, click Stop Test.

To view the data collected during the test, you can use the Test Name and Test Case value to retrieve
information specific to a particular test case.

To retrieve information about a managed object test case, for example:

SELECT * FROM PSPTUMPMTAGR
WHERE PTTST_NAME = 'GES_TEST'
AND PTTST_CASE_NAME = 'TC_1423';

To retrieve information about a ADS instance test case, for example:

SELECT * FROM PS_PTUMADSAGR
WHERE PTTST_NAME = 'GES_TEST'
AND PTTST_CASE_NAME = 'TC_1423';

Where PTTST_NAME is the Test Name value, and PTTST_CASE_NAME is the Test Case value.

18 Copyright © 1988, 2025, Oracle and/or its affiliates.

Chapter 1 Getting Started with Usage Monitor

Integrating Usage Monitor Data with PeopleSoft Test Framework

The Usage Monitor provides additional information for analysis when determining test coverage for
Managed Objects with the PeopleSoft Test Framework.

For this integration, we need to enable Managed Object usage monitoring and use the By UserID data
collection option.

In the PeopleSoft Test Framework (PTF), a test coverage report for managed objects correlates
PeopleTools project data with PTF test metadata to identify components, menus, pages, records and fields
that are referenced in PTF tests. When used in conjunction with Usage Monitor, test coverage correlations
can be extended to include information on all definitions (including PeopleCode, Application Engine
programs, and so on) from a usage perspective. A test coverage report identifies which managed objects
included in the change project are referenced by which PTF test. Definitions included in the change
project that are not referenced in the PTF test metadata or Usage Monitor data appears in the report
identified as a coverage gap.

Integrating Usage Monitor Data with LCM Insights

Use the usage data of managed objects to set up LCM Insights.

For this integration, we need to enable Managed Object usage monitoring and use the Anonymous data
collection option.

In LCM Insights, the usage data combines with the customization data to provide information such as the
percentage of customizations in the environment, details of which customizations are used and which are
not.

This information helps to identify the customized objects that are regularly impacted by application
maintenance.

Copyright © 1988, 2025, Oracle and/or its affiliates. 19

Getting Started with Usage Monitor Chapter 1

20 Copyright © 1988, 2025, Oracle and/or its affiliates.