PeopleSoft Talent Management 9.1 to PeopleSoft HCM Integration

PeopleSoft Integration Reference Guide 

Implementing Portal Navigation Aggregation for Peoplesoft Campus 

Solutions 9.0 and Human Capital Management 9.0/9.1 

November 2010 

Including: 

• Overview of cross instance business processes 

• Step by step guide to setting up navigation links 

• Exploring the use of Related Content Services

Peoplesoft Campus Solutions 

Copyright 2010 Oracle, Inc. All rights reserved. 

Printed on Recycled Paper. Printed in the United States of America. 

Restricted Rights 

The information contained in this document is proprietary and confidential to 

PeopleSoft, Inc. 

Comments on this document can be submitted to Global Support Center. We 

encourage you provide feedback on this Integration Reference Guide and will ensure 

that it is updated based on feedback received. When you send information to Oracle, 

you grant Oracle a non-exclusive right to use or distribute the information in any way it 

believes appropriate without incurring any obligation to you. 

No part of this document may be reproduced or transmitted in any form or by any 

means, electronic or mechanical, including photocopying and recording, for any 

purpose without the express written permission of Oracle. 

This document is subject to change without notice, and Oracle does not warrant that 

the material contained in this document is error-free. If you find any problems with this 

document, please report them to PeopleSoft in writing. 

This material has not been submitted to any formal Oracle test and is published AS IS. 

It has not been the subject of rigorous review. Oracle assumes no responsibility for its 

accuracy or completeness. The use of this information or the implementation of any of 

these techniques is a customer responsibility and depends on the customer's ability to 

evaluate and integrate them into the customer's operational environment. While each 

item may have been reviewed by Oracle for accuracy in a specific situation, there is no 

guarantee that the same or similar results will be obtained elsewhere. Customers 

attempting to adapt these techniques to their own environments do so at their own risk 

Information in this book was developed in conjunction with use of the product 

specified, and is limited in application to those specific hardware and software 

products and levels. 

Oracles may have patents or pending patent applications covering subject matter in 

this document. The furnishing of this document does not give you any license to these 

patents 

Any pointers in this publication to external Web sites are provided for convenience only 

and do not in any manner serve as an endorsement of these Web sites. 

PeopleSoft, PeopleTools, PS/nVision, PeopleCode, PeopleBooks, PeopleTalk, and 

Vantive are registered trademarks, and Pure Internet Architecture, Intelligent Context 

Manager, and The Real-Time Enterprise are trademarks of Oracle. All other company 

and product names may be trademarks of their respective owners. The information 

contained herein is subject to change without notice.

TABLE OF CONTENTS 

Table of Contents 3 

Chapter 1 - Introduction 4 

Structure of this Integration Reference Guide ............................................................................................................................ 4 

Related Materials ....................................................................................................................................................................... 4 

Chapter 2 - Overview 5 

Introduction ................................................................................................................................................................................ 5 

Who Should Read This Guide? .................................................................................................................................................. 5 

Before You Begin ...................................................................................................................................................................... 6 

Common Terms .......................................................................................................................................................................... 6 

Chapter 3: Aggregating Navigational Links Across Instances 7 

Understanding Cross Instance Business Processes .................................................................................................................... 7 

Setting Up Integration Broker for Cross Instance Navigation .................................................................................................. 10 

Copying Users and Permission Lists ........................................................................................................................................ 17 

Adding External Content References ....................................................................................................................................... 17 

Chapter 4: Related Content 20 

Understanding Related Content Services ................................................................................................................................. 20 

Setting Up Related Content Services ....................................................................................................................................... 21 

Customizing the User Experience Using Related Content Services ......................................................................................... 24 

APPENDIX A – COPYING PORTAL OBJECTS .................................................................................................................. 28 

APPENDIX B – CHANGING PORTAL STRUCTURE NODE NAME EN MASSE ......................................................... 30 

APPENDIX C – COPYING PERMISSION LISTS ................................................................................................................ 31 

APPENDIX D – COPYING ROLES ........................................................................................................................................ 32 

APPENDIX E – VALIDATION AND FEEDBACK ............................................................................................................... 34 

Customer Validation 34 

Field Validation 34 

APPENDIX F – REVISION HISTORY ................................................................................................................................... 35 

Authors ..................................................................................................................................................................................... 35 

Revision History ....................................................................................................................................................................... 35 

© Copyright Oracle USA 2010. All rights reserved. Page 3 of 35

Implementing Portal Navigation Aggregation for PeopleSoft Campus Solutions 9.0 and Human Capital Management 9.0/9.1 

CHAPTER 1 - INTRODUCTION 

This Integration Reference Guide explores the use of capabilities within the standard Peoplesoft Application Portal to provide a 

more unified experience for users of Peoplesoft Campus Solutions and Human Capital Management operating in a separated 

instance. It is intended as a starting point for business analysts, system administrators, technical users and programmers to 

understand the ways in which existing delivered tools can be put to use to assist in the transition from a single CS/HCM 

instance to separated instances. 

This Integration Reference Guide is intended to be used in conjunction with delivered PeopleBooks documentation as well as 

the CS-HCM Integration White Paper and CS-HCM Integration implementation guides. 

Structure of this Integration Reference Guide 

This Integration Reference Guide provides guidance for the use of Application Portal technologies in integrating separate 

instances of Campus Solutions and Human Capital Management. 

Keep in mind that Oracle updates this document as needed so that it reflects the most current feedback we receive from the 

field. Therefore, the structure, headings, content, and length of this document is likely to vary with each posted version. To see 

if the document has been updated since you last downloaded it, compare the date of your version to the date of the version 

posted on My Oracle Support. 

Related Materials 

We highly recommend that before you read this technical guide, you read the Campus Solutions-HCM Integration White 

Paper. It provides an overall summary of the project objectives and the various approaches to supporting separate CS and 

HCM instances. 

Additional technical implementation guides are available to assist you in understanding and implementing your CS – HCM 

integrations. These documents and the Campus Solutions-HCM Integration White Paper are posted to My Oracle Support, 

associated with Feature Pack 4 Documentation ( ID 1259484.1 ). 

 

 

 

 

Implementing Setup Data Integration between CS and HCM 

Implementing External Search/Match between CS and HCM 

Implementing CS Integration with the Higher Education Constituent Hub (Note that this document will not be 

released until late 2010 or early 2011) 

Implementing Portal Navigation aggregation for CS and HCM Integration 

This document is not a general introduction to Integration Broker and we assume that our readers have a good understanding of 

PeopleSoft‟s Internet Architecture. To take full advantage of the information covered in this document, we recommend that 

you have a basic understanding of system administration, basic Internet architecture, integration technologies, relational 

database concepts/SQL, and how to use PeopleSoft applications. 

This document is not intended to replace the documentation delivered with the PeopleTools 8.4x or 8.5x PeopleBooks. We 

recommend that before you read this document you read the PIA related information in the PeopleTools PeopleBooks to ensure 

that you have a well-rounded understanding of our PIA technology. Note: Much of the information in this document 

eventually gets incorporated into subsequent versions of the PeopleBooks. 

Many of the fundamental concepts related to PIA are discussed in the following PeopleSoft PeopleBooks: 

PeopleSoft Internet Architecture Administration (PeopleTools|Administration Tools|PeopleSoft Internet 

Architecture Administration) 

Application Designer (Development Tools|Application Designer) 

Application Messaging (Integration Tools|Application Messaging) 

PeopleCode (Development Tools|PeopleCode Reference) 

PeopleSoft Installation and Administration 

PeopleSoft Hardware and Software Requirements 



CHAPTER 2 - OVERVIEW 

This chapter includes the following topics: 

 

 

 

 

Introduction 

Who Should Read This Guide? 

Before You Begin 

Common Terms 

Introduction 

Oracle‟s PeopleSoft Enterprise Campus Solutions (CS) has historically been released in the same database with 

PeopleSoft Enterprise Human Capital Management (HCM). The current release of the shared instance of HCM and CS 

is Release 9.0. With the recent adoption by Campus Solutions of the Continuous Delivery Model, ensuring that the CS 

application can operate independently of an HCM instance is fundamental to the future of CS and to the new model. 

This separation permits customers and Oracle‟s CS team to develop, deploy, and upgrade the two applications 

independently. 

Enabling this independence requires providing a supported integration solution for Higher Education customers to run 

separate production instances for CS and HCM. This capability is critically important with the release of HCM 9.1. The 

Continuous Delivery Model allows Campus Solutions to provide new features via Feature Packs without a major 

upgrade. There is no Campus Solutions 9.1 release. 

CS 9.0 Instance 

HCM 9.0/9.1 Instance 

Reference 

Data 

Transaction 

Data 

Figure 1 CS - HCM Integrations 

In order to reduce impact on existing business processes, Oracle is recommending that customers evaluate the use of the 

Application Portal to enable cross-instance navigation and minimize end user exposure to multiple underlying databases. 

Additional PeopleTools 8.5 and greater release functionalities, such as Related Content Services, provide further options to 

design a coherent and contextualized user experience. 

Who Should Read This Guide? 

For PeopleSoft Campus Solutions, administration refers to the process of implementing and setting up an application for a 

company and its employees and using the administrative features of that application. 

Typically, administrative users configure and administer the application. An administrative user can be either an Oracle 

Consulting Services representative or the designated members of your implementation team who are familiar with the 

Application Portal, Integration Broker and your organization‟s business process requirements. 

Functional users with a good understanding of core CS Campus Community and Human Resources functionality will be an 

essential part of your implementation. 

This guide assumes at least that level of knowledge and describes possible scenarios for configuring navigation in the Portal. 



Before You Begin 

Before you can setup, administer, or use the Application Portal to aggregate navigational elements of CS and HCM, you must 

install the CS and HCM environments and then configure Integration Broker between the two applications for your 

organization. 

Some examples of the configuration tasks that you must perform for your CS – HCM Integrations include: 

 

 

 

 

Configuring the PeopleSoft CS and HCM installation and PeopleTools options tables. 

Setting up the integration gateway and integration nodes within the Integration Broker system. 

Activating services, service operations, and routings within the Integration Broker system. 

Defining roles and permissions for your user profiles 

Common Terms 

This table provides definitions for some of the common terms that are used in this guide. 

Term 

Definition 

External CREF 

PIA 

Related Content Services 

User Profiles 

External Content References are links to external content sources defined in the 

Portal Structure setup 

PeopleSoft Internet Architecture 

PeopleSoft Related Content Services is the framework within which subject 

matter experts or administrators can contextually link application pages with 

collaborative content. 

User profiles define individual PeopleSoft users. You define user profiles and then 

link them to one or more roles. Typically, a user profile must be linked to at least 

one role to be a usable profile. The majority of the permissions that make up a 

user profile are inherited from the linked roles. 



CHAPTER 3: AGGREGATING NAVIGATIONAL LINKS ACROSS INSTANCES 

This chapter discusses the cross-instance business processes between CS and HCM and how to define Content References that 

point to instances external to the Application Portal of the hosting instance. 

 

 

 

Setting Up Integration Broker for Cross Instance Navigation 

Copying Users and Permission Lists 

Adding External Content References 

Understanding Cross Instance Business Processes 

In a single database instance, the ability to undertake Person-related business processes in either application was 

straightforward. Person data resided in the PERSONAL_DATA and related records, and those records were accessed directly 

by either Campus Solutions or Human Capital Management as required. For example, an employee of an institution who 

enrolled to take a class did not have to be re-keyed, and any updates that were made a Person record in one application were 

immediately available to the other application because, after all, the data was writing to the same record. 

There are a number of different integration configurations supported by tools and functionality delivered to support CS-HCM 

integrations. Some of those configurations have a greater impact on the user experience of existing business processes, 

requiring users to access both database instances. The discussion in this paper will focus on the Owner/Subscriber 

configuration. 

Note: The use of the PeopleSoft Enterprise Portal is not required. This document primarily describes techniques which make 

use of features delivered with the native Application Portal that comes as part of your CS and HCM systems. 

Owner/Subscriber Configuration 

In an Owner/Subscriber integration model, the institution defines one system as the system of record and the other system as a 

subscribing recipient of that same information. The core Person data is replicated in the subscribing system and kept 

synchronized via published updates from the Owner/system of record. The Owner/Subscriber approach results in exact data 

sets in both CS and HCM database instances. 

For the Owner/Subscriber configuration, Oracle is supporting an implementation model in which Campus Solutions is the 

defined system of record for Person data and HCM is the subscriber of that data. For example, when adding a new person to 

the system, an administrator might navigate to the Campus Solutions Add/Update a Person component and elect to add a new 

person – for example, Bob Jones. The administrator adds Bob Jones‟s name, an address, email and phone number, and saves 

the record. This information, including the created EMPLID, is published to HCM 9.1 and Bob Jones now exists in both the CS 

and HCM instance. Later, Bob needs to change his phone number – the administrator would again navigate to the Campus 

Solutions Add/Update a Person component, make the appropriate change to the phone number, and click Save. The updated 

phone number is published to the HCM instance, and the data is kept synchronized between the two systems. 

When deployed in a single instance, the administrative user in a scenario in which an employee needed to be added and 

updated would simply navigate to the appropriate menu navigation links in the combined CS/HCM Application Portal and 

make the appropriate changes. Using separated instances, some of those navigations would no longer be valid; for example, in 

the above scenario, if the administrator when updating Bob‟s phone number, navigated to the Workforce 

Administration>Personal Information>Update a Person component in the HCM 9.1 instance to update, that updated phone 

number would not make its way back to the owner/system of record, Campus Solutions. 

Using External Content References in the Application Portal 

The impact to user data entry in a business processes can be ameliorated through the use of some of the inherent capabilities of 

your CS and HCM native application portal. The concept of “navigation aggregation” simply means that the navigation 

defined in your application portal in the left-hand or drop-down menu can include links to components in both your CS and 

HCM instance. This is true of the standard application portal in which PeopleSoft products are deployed, as well as the 

PeopleSoft Enterprise Portal. 

For example, if you have defined a business process in which administrators create and maintain Person data in the CS 

Add/Update a Person component, but you don‟t wish to require your administrators to log in separately to your CS instance, 



you can deploy a navigational link in your HCM 9.1 application portal structure that links users directly to the CS component. 

The end user may never realize that they are navigating to pages being provided from a separate database. 

Figure 2 below shows an example of the Campus Community Add/Update a Person link added to an HCM 9.1 portal structure. 

Figure 2 Example of HCM 9.1 Navigation with External CREF 

The user, after logging into their HCM 9.1 instance, would first click on the Add/Update a Person link to enter or update the 

bio-demo data for the person. They would then click the next link in the navigation, or in their favorites collection, to choose 

the next step in the business process. 

Depending on what specific policies and processes you may need to support for your CS – HCM integrations, you may 

consider deploying external content references in two different ways. 

Single Portal Experience 

Generally, the goal of an enterprise portal is to create for the user a unified experience (visual as well as navigational) access 

across any number of content provider sources. An institutional portal might have pagelets, portlets or links to the campus HR 

department, enrollment, sports schedules, self service functions, calendars, maps, etc. 



In thinking about the use of the Application Portal to unify the separate CS and HCM business processes, you could choose to 

select the PIA portal of one of the applications to aggregate all of the navigational links from both systems into a single menu 

navigation collection. Under those circumstances, you would see a menu structure more or less identical to that which you see 

in today‟s single instance. Figure 3 below shows an example of a superuser view of a current CS/HCM 9.0 instance. 

Figure 3 Sample Application Portal Navigation for combined CSHCM 9.0 database 

Cross Instance Processes Only 

In a typical Owner/Subscriber configuration, a number of business processes include tasks that require a user to access both CS 

and HCM instances. These business processes primarily include those where Person data is added or updated. You would not 

expect an HCM administrative user to need access or unified navigation to components that enroll students or manage grades. 

A Registrar in CS is not going to need to access Benefits or Time and Labor. 

For institutions that wish to create a unified navigational experience for those cross instance processes, a limited number of 

external content references could be added to the HCM Application Portal in order to allow HCM administrators easy access 

and minimally modified navigation to the Person add/update components they might need to access in Campus Solutions in 

order to add new Persons to the integrated system or update the core bio-demo data of existing Persons. 

As an example, the HCM user adding a new employee selects an external content reference in the HCM 9.1 navigation that 

displays the Add/Update a Person pages from the Campus Solutions instance. The HCM user simply clicks on the link to 

access the Add/Update a Person component and enters Person data, saves the component, and then navigates to subsequent 

navigation links to complete the remaining business process steps. 



Setting Up Integration Broker for Cross Instance Navigation 

In order to provide as much detail to the defined steps as possible, placeholders for actual implementation level data values 

have been used throughout this section. Make the following substitutions throughout this document: 

APPSRVRNAME 

APPSRVRPORT 

PORTALPRJ 

DFLTPW 

DFLTUID 

EXTDBNAME 

.mycompany.com 

PIASRVRNAME 

PORTALDBNAME 

PS_HOME 

WEBSRVRNAME 

Setting the Cookie Domain 

The machine name of your application server 

The jolt port number you are using on your application server 

The project name used for copying portal objects 

The password associated with DFLTUID 

The default userid associated with connecting to this node 

The name of your external content reference node 

Your internet domain name 

The machine name of your PIA (web) server; note that this machine name may 

be followed by the web server port, if it is not the default value of 80 

The name of your portal database 

The disk location of PS_HOME on your application server 

The domain name you specified for your web server 

If single signon capability is to be used, user tokens will be passed between the portal domain website and the external content 

domain website. For this to occur, the cookie domain must be set properly. 

1. Make sure that the cookie domain is set to your company internet domain name; e.g. 'mycompany.com'. 

2. The cookie domain should match that of the web server's machine name. This is accomplished during PIA install. At 

one point, it prompts for the 'Authentication Token Domain', which is optional. For our purposes, it is required. 

To determine its value for a Weblogic web server: 

a) Open file PS_HOME\webserv\PORTALDBNAME\applications\peoplesoft\PORTAL\WEB-INF\weblogic.xml 

b) Under you should find . 

c) Under that, you should find a with a value of 'CookieDomain'. 

d) After that should be a tag, followed by its value. That value is the name of your cookie domain. It 

should match your internet domain name. e.g. '.mycompany.com' (without the quotes). Note: the leading period 

„.‟ is important. 

Service Configuration 

Because the Portal uses some integration broker node features to implement some of its functionality, administrators should 

ensure that the Service has been properly configured. 

1. Navigate: PeopleTools > Integration Broker > Configuration > Service Configuration. 

2. Set Service Namespace = 'http://xmlns.oracle.com/Enterprise/HCM/services'. 

3. Set Schema Namespace = 'http://xmlns.oracle.com/Enterprise/Tools/schemas'. 

4. Set Target Location = 'http://PIASRVRNAME/PSIGW/PeopleSoftServiceListeningConnector'. 

5. Set System Service Status = 'Production'. 



Figure 4 Service Configuration 

Gateway Configuration 

The portal uses certain Integration Broker node features to implement aspects of its functionality. Administrators should 

confirm that the IB Gateway has been properly configured. These steps should be performed on both databases, and both 

databases should use the same Gateway. 

Note: If your databases are at different PeopleTools versions, use the Gateway of the database at the greater PeopleTools 

version. All Node definitions should also be associated with this Gateway. For example, if your CS database is at PeopleTools 

8.49.x, and your HCM 9.1 database is at PeopleTools 8.5x, you would configure to use the HCM 9.1 instance Gateway. 

1. Navigate: PeopleTools > Integration Broker > Configuration > Gateways. 

2. Open the 'LOCAL' gateway. 

3. Set url = http://PIASRVRNAME/PSIGW/PeopleSoftListeningConnector 



Figure 5 Gateway 

4. Click the 'Gateway Setup Properties' link. 

5. Enter the administrator id and password. 

6. In the 'Gateway Default App. Server' frame 

7. Set 'App Server URL' = '//APPSRVRNAME:APPSRVRPORT' 

8. Set User ID = 

9. Set Password = 

10. Set Tools Release = '8.5x'; (Note the actual tools release can be determined by hitting CTL+J); 

11. In the 'PeopleSoft Nodes' grid, add the node names of the two databases. 

12. Click the 'Ping' button for each node. It should be successful. 

Click the 'Save' button. 

13. Click the 'Advanced Properties Page' link. 

14. Scroll down to secureFileKeystorePath. Uncomment it and point to the correct path, e.g. 

d:/hr91asps/webserv/SPLTHP91/keystore/pskey (note the forward slashes). This may have already been set and 

uncommented. 

15. You should encrypt the password using the password encryption utility. 

Node Settings 

Confirm that the nodes been properly configured. 

1. Navigate: PeopleTools > Integration Broker > Integration Set Up > Nodes. 

2. Open the default local node. 

3. Set Authentication Option = 'Password'. 



4. Set the node password for this node. It should be the same value you choose for this node in all databases. When you 

tab out of this field, it should unhide and take you to a new field to verify the password. 

5. Set Default User ID = . 

Figure 6 Node Definitions 

6. On the Connectors tab, ensure that you are pointing to the common gateway, and that the Connector ID = 

'PSFTTARGET'. 



Figure 7 Connectors 

7. On the Portal tab, enter PIA content server for this database. 

Figure 8 Portal 

8. On the portal database, open the 'ANONYMOUS' node. 

9. Set Default User ID = 'DFLTUID'. 

10. Click the 'Save' button. 

11. On the portal database, open the ' WSDL_NODE' node. 

12. Set Default Userid = 'DFLTUID'. 



13. Set External Userid = 'DFLTUID'. 

14. Set External Password = 'DFLTPW'. 

15. Go to the WS Security tab. 

16. Authentication Token Type = 'Username Token'. 

17. Encrypted is enabled. 

18. Encryption Level = 'All' 

19. Digitally signed is enabled. 

20. Click the 'Save' button. 

Figure 9 WS Security 

Single Signon Settings 

If you choose to enable single signon capability, then a portal user will not be prompted for a user id and password when 

selecting an external content component. 

1. Navigation: PeopleTools > Security > Security Objects > Single Signon. 

2. Verify that both the database nodes are listed. 

3. Also, add the 'HRMS' node. This is the local portal node on the HR database that is referenced in all of the crefs. It is 

not necessary to rename all of the node references on the master CS database from 'HRMS', since the portal hosting is 

being done on the HR database. 



Figure 10 Single Signon Security Object 



Copying Users and Permission Lists 

In order to provide a seamless user experience, User Profiles that need to access both systems will need to exist in both 

systems. This can either be done by manually creating User Profiles in both systems, or by using the delivered 

USER_PROFILE service to automatically synchronize User Profiles between systems. Users that do not need access to cross 

instance processes do not require synchronization of User Profiles across systems. 

It will also be necessary for administrators to create corresponding Permission Lists between the systems; at a minimum you 

will the permissions lists that grant access to the components for which you will be adding external content references entered 

into the system serving as the aggregating portal. This can be done either using Application Designer to copy the permission 

lists from one instance to the other directly, or by using Application Designer “copy to file” capability and then copying the 

permissions lists from the file to the portal database. For further discussion see “Appendix C: Copying Permission Lists.” 

For more information about managing User Profiles and using the USER_PROFILE service, please see Enterprise PeopleTools 

PeopleBook: Security Administration. For more information about the use of Application Designer, please see Enterprise 

PeopleTools PeopleBook: PeopleSoft Application Designer Developer’s Guide. 

Adding External Content References 

Content references are the definitions within the Portal Structure and Content that allow navigational links to point to particular 

menu/components within an application. By adding external content references, you provide the ability to your users to select 

content (open components) from databases external to your portal database. 

To add an external content reference: 

1. Gather External Navigation Information. For example, if you are entering an external content reference to Campus 

Solutions Add/Update a Person in your HCM portal structure, you would need to know the 

a. In the external database, navigate: PeopleTools > Portal > Structure and Content. 

b. Open the content reference you want to copy. 

c. Make a note of the information, including security settings. The most important ones are the label and 

component parameters on the general tab and the security authorizations on the security tab. For example, if 

you are entering an external content reference to Campus Solutions Add/Update a Person in your HCM 

portal structure: 



Figure 11 CS 9.0 Add/Update a Person Content Reference 



Figure 12 CS 9.0 Add/Update a Person Content Reference Security 

2. Add the new external content reference. 

a. In the portal database, navigate: PeopleTools > Portal > Structure and Content. 

b. Enter the information the same way it appeared on the external database, except change the value of the Node 

Name to match your external database node name. 

c. Set the permission lists on the Security tab as well. 

d. Save the component. 

3. If you modified an existing content reference, it may be necessary for you to delete your web browser cache, your web 

server cache and your application server cache in order for the change to take effect. 

a. Deleting your browser cache is dependent on the particular version of browser that you are using. It is 

typically on the menu under Tools > Options. Then you clear history and temporary items. You will want to 

delete the cookies for your portal web server as well as cookies for your external content web server. 

b. To delete your web server cache depends on the particular version of your web server as well. For example, 

WebLogic's navigation cache is stored under your PS_HOME (or PS_CFG_HOME), then look under the 

'webserv' folder. Under that are your web domain folders. Select the one for your portal database. Under that 



is an 'applications' folder. Then look in the 'peoplesoft' folder therein. Go into the PORTAL folder (or 

PORTAL.war folder). Under there you will find the web server name that you chose for your portal. Finally, 

under that is the 'cache' folder. After shutting down your web server, delete the contents of its cache folder. 

c. After shutting down your application server, you can delete its cache by navigating to PS_HOME (or 

PS_CFG_HOME), then look under the appserv folder. Go into the folder with the database name of your 

portal database. Under that you will find a 'cache' folder. Delete the contents of this 'cache' folder before 

restarting your application server. 

CHAPTER 4: RELATED CONTENT 

Related Content is new functionality introduced into the portal toolset with the release of PeopleTools 8.5. Related Content 

provides the ability to not simply aggregate navigation, but to embed transactions within other transactions (e.g., components 

within components) to aggregate a business process into a unified user experience. 

This chapter discusses the new Related Content functionality, including: 

 

 

Creating Related Content Services 

Customizing the User Experience using Related Content Services 

Understanding Related Content Services 

From Peoplesoft Enterprise PeopleTools 8.50 PeopleBook: PeopleTools Portal Technology 

“PeopleSoft Related Content Services is the framework within which subject matter experts or administrators can contextually 

link application pages with collaborative content. 

The primary goal of related content services is to provide immediate access to relevant, contextual information for any activity 

without requiring any additional user effort. PeopleSoft Related Content Services Framework acts as an enterprise mashup, 

tying together all types of content such as Oracle Business Intelligence Enterprise Edition (OBIEE) analytics, queries, 

discussion threads, or any relevant non-PeopleSoft data into a single tool—PeopleSoft application pages. 

Related content can be any collaborative, analytical, or informational content that is useful for performing the business process. 

A related content service is content, such as, a discussion forum or wiki page which is offered as a service to be consumed by 

other applications. Related content can be configured within the same database, among multiple PeopleSoft databases, and 

between a PeopleSoft application page and non-PeopleSoft data. The terms related content and related content service are 

synonymous. 

When users access application pages that are configured with related data, the related content appears in the related content 

services frame of the bottom of the application page. You can assign multiple services to entire components, individual pages 

in a component, or a combination of the two. If an application page has multiple services, each service appears as a tab in the 

related content frame. In addition to the related content frame at the bottom of the page, a Related Information drop-down list 

box appears in the navigation bar at the top of pages configured with related content services.” 

In the context of CS-HCM integration, related content services can move you one step closer to a more seamless and unified 

user experience of cross-instance business processes. In the section above, “External CREFS in the Application Portal,” we 

discussed a scenario in which an HCM administrative user would click on the “Add/Update a Person” link in the HCM portal 

menu, which would take them (via single signon and the registration of external content references) to the CS instance of the 

“Add/Update Person” component. When they had completed that transaction, they would navigate to the next component 

depending on the business process they are undertaking. 

Related Content Services removes the need to navigate between components for defined business processes. 

Let‟s look again at the Manage Hire scenario described in the Campus Solutions – HCM Integration White Paper. By creating 

a related content service, you can actually include the HCM Add Employment Instance and any other desired components as 

frames within the single Add a Person transaction. Rather than stepping through a series of menu navigations, the HR 

administrator simply navigates between frames within a component window, with data integrating and refreshing as defined by 

the related content service settings. 



Setting Up Related Content Services 

The creation of related content services is really comprised of two elements: defining related content services and managing 

related content services. 

In defining a related content service, you are creating the content that will appear both as a link and as an embedded frame 

within your hosting component. In managing related content services, you assign that content to the hosting component. 

For example, you might wish to embed the HCM Update Person component as related content within the CS Add a Person 

component in order to create the Person in CS with core bio-demo data, and then enrich that further with data elements specific 

to HCM in the HCM instance. To do so, you would follow these steps: 

1. Determine the content reference data for the component that will serve as the related content. 

a. Navigate to PeopleTools>Portal>Structure and Content, and drill down through the Portal structure to the 

Modify a Person link 

Figure 13 HCM Modify a Person Content Reference 

2. Navigate to PeopleTools>Portal>Related Content Service>Define Related Content Service 

3. Add a new Related Content Service 

4. Enter the CREF information from step 1, and the other information in the related content service definition, as 

appropriate. For example: 

a. Service Name is the text that will appear as the displayed link in your hosting component as well as on the 

tab in the related content frame 

b. Parameters in the Service URL Parameter will be passed to the related content component and so may 

include things such as record keys that allow for a contextual transference between components. 



Figure 14 Define Related Content Service 

5. Navigate to PeopleTools>Portal>Related Content Service>Manage Related Content Service 

6. Add the related content service created in the steps above to a component by clicking the Assign Related Content to 

Application Pages link 

Figure 15 Manage Related Content Configuration 

7. Add the related content service created above to the Related Content to Display grid, and add other values as 

appropriate. 



Figure 16 Assign Related Content 

8. Click Save. 

Figure 17 Related Content Service - Map Fields 

When you navigate to Campus Solutions Add/Update a Person component (Campus Community>Personal 

Information>Add/Update a Person, you will see the related content link available in the drop down list at the top of the 

page. 



Figure 18 Example of CS 9.0 Add/Update a Person with Related Content Link 

Clicking on that link will display the HCM Modify a Person component as a frame at the bottom of the displayed page. 

Figure 19 Example of CS 9.0 Pages Displaying Related Content from HCM Database 

You can relate as many content services to an application page as you may need to comprise a complete business process. 

Additional related contents will show up as links in the drop down and, once selected, each related content service will display 

as a separate tab in the bottom frame. 

Customizing the User Experience Using Related Content Services 

In the example used above, enabling the Modify a Person pages as related content to the Add/Update a Person component, is a 

simple construction.. The keys are identical and easy to pass, and the Modify a Person component has a very straightforward an 



traditional search record which makes it easy for the passed key parameters to open the related component in a contextual 

fashion. 

But what about constructions that do not match up so well, or that have a complication? 

Related Content Services in coordination with Peoplecode constructs and manipulations can create a powerful ability to 

manage end to end business processes in your portal environment. 

For example, rather than embedding Modify a Person within CS Add/Update a Person, what if you wanted to create HCM Add 

Employment Instance as a related content service, so that an HR Administrator could add an incoming employee‟s Person data 

in the owner (CS) system and continue straightaway with the business process at hand by adding an Employment Instance to 

that Person, thereby creating them as an employee? 

Creating the related content service is simple enough, just as with Modify a Person: 

Figure 20 Define Related Content Service 

Then, adding the related content service to an application page: 



Figure 21 Assign Related Content 

Navigating out to CS Add/Update a Person, you add a new person and can see the related service content links that you‟ve 

created: 

Figure 22 Example of CS 9.0 Pages Displaying Related Content Links 

When you click on the Add Employment link, it takes you to the “search record” for the Add Employment Instance 

component, rather than passing the EMPLID key field for you and taking you straight into the component: 



Figure 23 Example of CS 9.0 Pages Displaying Related Content from HCM Database 

This is because the 'Add Employment Instance' page is not a regular component search record add new value page; it's actually 

a custom page that is made to look like a regular component search add new value page. 

Using Peoplecode structures in conjunction with the related content service capability, institutions can extend delivered 

capabilities to allow for business processes to continue under conditions like this. 

For example, at a minimum you can have the newly created EMPLID (which you have just created in the CS Add/Update 

Person component, and which data has, in the owner/subscriber configuration, published to the HCM instance via 

PERSON_BASIC_SYNC) autopopulate in the EMPLID field in the Add Employment Instance search record page, by adding 

Prebuild peoplecode to the JOB_DATA_EMP_SRCH component (Add Employment Instance component) to allow it to read in 

values being passed in the URL as part of the related content service, and execute the same validation code located in the 

EMPLID fieldchange event. 

As a sample: 

Declare Function GetNextEmplRcd PeopleCode FUNCLIB_HC_CORE.EMPL_RCD 

FieldFormula; 

Local Record &DERIVED_JOBSRCH = GetLevel0().GetRow(1).DERIVED_JOBSRCH; 

Local string &empl_id = %Request.GetParameter("EMPLID"); 

rem testhardcode &empl_id = "0003"; 

If All(&empl_id) Then 

&DERIVED_JOBSRCH.EMPLID.Value = &empl_id; 

GetNextEmplRcd(&DERIVED_JOBSRCH.EMPLID.Value, &EmpRcd); 

&DERIVED_JOBSRCH.EMPL_RCD.Value = &EmpRcd; 

End-If; 

To make the above sample code function correctly, you would also need to modify the access to the derived record at 

component level code to getlevel0() first. To ensure the code still functions properly if a user navigates to this page, you would 

add a check to make sure &empl_id is filled in first before trying to get the next emplrcd. 

With those pieces in place, selecting the Add Employment related content link would open the Add Employment Instance 

search record page in the bottom frame, with the EMPLID passed into the EMPLID field. The HR Administrator simply clicks 

the Add Relationship link and the business process continues. 



Related content services is an extremely powerful tool, and knowledgeable, sophisticated use of it can create a highly 

streamlined and unified user experience across your enterprise. For more information on the use of Related Content Services, 

please see Enterprise PeopleTools PeopleBook: PeopleTools Portal Technology. 

Appendix A – Copying Portal Objects 

These instructions describe how to copy portal objects from one database to another. 

Portal objects must be copied via Application Designer projects. 

1. Create a new empty project via Application Designer. 

2. Click on the 'Upgrade' tab. 

3. Select from the menu: 'Insert' > 'Definitions into project...'. 

4. Select Definition Type = 'Portal Registry Structures'. 

5. Select Portal Name = 'EMPLOYEE'. 

6. Click the 'Insert' button to search. 

7. Select at least one definition 

8. Click the 'Insert' button again. This adds the selected object into your project. 

9. Click the 'Close' button. 

10. Select from the menu: 'File > Save Project As...'. 

11. Enter a new project name, such as 'PORTALPRJ'. 

12. Optional: Run a query to populate your project. 

a. Close Application Designer. 

b. Open Data Mover. 

c. Run this datamover script changing 'PORTALPRJ' to your project name in quotes and possibly changing the 

where condition to match your desired criteria: 

DELETE FROM PSPROJECTITEM WHERE PROJECTNAME = 'PORTALPRJ' 

; 

INSERT INTO PSPROJECTITEM 

( 

PROJECTNAME 

,OBJECTTYPE 

,OBJECTID1 

,OBJECTVALUE1 

,OBJECTID2 

,OBJECTVALUE2 

,OBJECTID3 



,OBJECTVALUE3 

,OBJECTID4 

,OBJECTVALUE4 

,NODETYPE 

,SOURCESTATUS 

,TARGETSTATUS 

,UPGRADEACTION 

,TAKEACTION 

,COPYDONE 

) 

SELECT 

'PORTALPRJ' 

,55 

,99 

,PORTAL_NAME 

,100 

,PORTAL_REFTYPE 

,101 

,PORTAL_OBJNAME 

,0 

,' ' 

,0 

,0 

,0 

,0 

,1 

,0 

FROM PSPRSMDEFN 



WHERE OBJECTOWNERID LIKE 'S%' 

; 

13. Exit from Data Mover. 

14. Delete your Application Designer cache. Its location is stored within Configuration Manager in the Startup tab under 

'Cache File Directory'. 

15. Log back into Application Designer. 

16. Open your project again. It should now contain only the portal objects that you selected via Data Mover. 

17. Validate your project. 

a. Select from the menu: 'Tools' > 'Options...”. 

b. Select the 'Validate' tab. 

c. Enable the checkbox for 'Validate project integrity'. 

d. Disable the checkbox for 'Validate PeopleSoft Internet Architecture Execution'. 

e. Click the 'OK' button. 

f. Click 'Tools' > 'Validate Project'. 

g. When it prompts you 'Do you want to delete all invalid objects...', click Yes. It should not show any invalid 

objects. 

18. Copy your project to file. 

a. Select from the menu: 'Tools' > 'Copy Project' > 'To File...'. 

b. Make a note of or set your Export Directory. Click the 'Copy' button. This may take a few minutes. 

c. When it is done, close Application Designer. 

19. Navigate to your export directory and create a zip file from the folder that corresponds to your project name. The zip 

file should retain the child directory structures from the project name on down. 

20. Copy the zipped project to the export directory for your target database, which may or may not be on a different 

server. 

21. Unzip your project into the export directory for your target database, retaining your directory structures. 

22. Log onto Application Designer for your target database. 

23. Optional: you may want to compare your project from file first. 

24. Select from the menu: 'Tools' > 'Copy Project' > 'From File...'. 

25. Select your project. 

26. Click the 'Options...' button. 

27. On the 'General Options' tab, in the group box 'Portal Structures Permission List', enable the radio button for 'Set 

References From Source'. 

28. Click the 'OK' button. 

29. Click the 'Copy' button. 

30. Validate the newly imported project. If there are errors in the validation, you will have to resolve those by manually 

updating those portal objects in the database; login via PIA and navigate to PeopleTools > Portal > Structure and 

Content. 

31. Shut down your web server and your application server and purge their caches. 

32. Change the node for the newly copied portal content references. 

33. Set the permissions for the newly copied portal content references. See also Appendix C. 

Appendix B – Changing Portal Structure Node Name En Masse 



The portal content references that point to an external node may need to have their node name changed. This appendix 

describes how you can make this change en masse via Data Mover sql. 

1. Login to your portal database via Data Mover. 

2. Modify the following sql command to match your desired selection criteria; in this example, it changes the portal node 

for all content references that are in a specified Application Designer project: 

UPDATE PSPRSMDEFN 

SET PORTAL_CNTPRV_NAM = 'EXTDBNAME' 

WHERE EXISTS 

( 

SELECT 'X' FROM PSPROJECTITEM B 

WHERE B.PROJECTNAME = 'PORTALPRJ' 

AND B.OBJECTTYPE = 55 

AND B.OBJECTVALUE1 = PSPRSMDEFN.PORTAL_NAME 

AND B.OBJECTVALUE2 = PSPRSMDEFN.PORTAL_REFTYPE 

AND B.OBJECTVALUE3 = PSPRSMDEFN.PORTAL_OBJNAME 

) 

AND PSPRSMDEFN.PORTAL_REFTYPE = 'C' 

; 

3. Delete your application server cache and your web server cache. 

Appendix C – Copying Permission Lists 

Permission lists vary from customer to customer, and although there is no specific set of instructions for copying permission 

lists, this appendix is an example of how to copy a set of permission lists. 

1. Open Application Designer. 

2. From the menu, select 'File' > 'New'; select 'Project'. 

3. Click the 'Upgrade' tab. 

4. From the menu, select 'Insert' > 'Definitions Into Project...'. 

5. Select Definition Type of 'Permission Lists'. 

6. Search for your desired permission lists, for example, all permission lists that start with 'HCCPCSSA'. 

7. Select the permission lists in the 'Definitions matching criteria' box. 

8. Click the 'Insert' button to add them to your project. 

9. From the menu, select 'File' > 'Save Project As...'. 

10. Give the project a name, such as 'CS_ALL_PLISTS'. 



11. Copy the project to your target database. 

Appendix D – Copying Roles 

Similarly to permission lists, roles also vary from customer to customer, however, this appendix shows a way to copy a set of 

roles via Data Mover, given that you provide your own selection criteria. Only simple roles that only contain a list of 

permission lists can be copied this way. The remainder must be copied manually. 

1. Open Data Mover on your source database. 

2. Copy and paste these commands into Data Mover and modify them to meet your selection criteria for your 

installation. 

SET LOG CS_ROLE_COPY_EXPORT.LOG; 

SET OUTPUT CS_ROLE_COPY.DAT; 

EXPORT PSROLEDEFN 

WHERE ROLENAME LIKE 'CS%' OR ROLENAME LIKE 'SA%'; 

EXPORT PSROLEDEFNLANG 


EXPORT PSROLECLASS 

WHERE ( ROLENAME LIKE 'CS%' OR ROLENAME LIKE 'SA%' ) 

AND CLASSID LIKE 'HCCPCSSA%'; 

EXPORT PSROLEUSER 

WHERE ( ROLENAME LIKE 'CS%' OR ROLENAME LIKE 'SA%' ); 

3. Save the Data Mover script to match that of the log file, e.g. CS_ROLE_COPY_EXPORT.DMS. 

4. Run the script. 

5. Open Data Mover on your target database. 

6. Copy and paste these commands into Data Mover and modify them to meet your selection criteria for your 

installation. 

SET LOG CS_ROLE_COPY_IMPORT.LOG; 

SET INPUT D:\HC900\data\CS_ROLE_COPY.DAT; 



DELETE FROM PSROLEDEFN 


DELETE FROM PSROLEDEFNLANG 


DELETE FROM PSROLECLASS 

WHERE ( ROLENAME LIKE 'CS%' OR ROLENAME LIKE 'SA%' ) 

AND CLASSID LIKE 'HCCPCSSA%'; 

DELETE FROM PSROLEUSER 

WHERE ( ROLENAME LIKE 'CS%' OR ROLENAME LIKE 'SA%' ); 

IMPORT PSROLEDEFN; 

IMPORT PSROLEDEFNLANG; 

IMPORT PSROLECLASS; 

IMPORT PSROLEUSER; 

COMMIT; 

DELETE FROM PSROLEUSER 

WHERE 

( 

ROLENAME LIKE 'CS%' 

OR ROLENAME LIKE 'SA%' 

) 



AND NOT EXISTS 

( 

SELECT 'X' FROM PSOPRDEFN B 

WHERE B.OPRID = PSROLEUSER.ROLEUSER 

) 

; 

7. Save the Data Mover script to match that of the log file, e.g. CS_ROLE_COPY_IMPORT.DMS. 

8. Run the script. 

Appendix E – Validation and Feedback 

This section documents that real-world validation that this Integration Reference Guide has received. 

CUSTOMER VALIDATION 

PeopleSoft is working with PeopleSoft customers to get feedback and validation on this document. Lessons learned from these 

customer experiences will be posted here. 

FIELD VALIDATION 

Additional lessons learned from field experience will be posted here. 



Appendix F – Revision History 

Authors 

PeopleSoft Enterprise Campus Solutions Development Team 

Revision History 

November 2010 - Created document.

PeopleSoft Talent Management 9.1 to PeopleSoft HCM Integration

Create successful ePaper yourself

Delete template?

Save as template?