Developing and Configuring Related Content Services

This chapter provides an overview of the PeopleSoft Related Content Framework and discusses how to:

• Define related content services.

• Assign and manage related content services.

• Configure related content service layout.

Understanding the PeopleSoft Related Content Framework

This section discusses:

• Framework flexibility.

• The related content development process.

• Delivered related content services for PeopleSoft Application Portal.

• Delivered related content services for Oracle WebCenter.

The PeopleSoft Related Content Framework enables developers and subject matter experts to link application pages with contextually relevant collaborative content.

The primary goal of related content services is to create opportunities for the user to view or quickly access information that supports, extends, and augments any PeopleSoft transaction. 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, and any relevant non-PeopleSoft data into a single tool—PeopleSoft application pages.

Related content services can be any collaborative, analytical, or informational content that is useful for completing business tasks. Related content services include any content such as related discussion forums, wiki pages, or links; PeopleSoft content references; or pagelets that are offered as services to be consumed by the applications. Related content services can be configured within the same database, among multiple PeopleSoft databases, and between a PeopleSoft database and external sources.

Prerequisites

This table lists the necessary and optional prerequisites to defining and configuring related content services:

**Indicates the prerequisite is required.

Common Elements Used in This Chapter

Framework Flexibility

The PeopleSoft Related Content Framework is designed to be flexible. You can assign, configure, and maintain related content services without access to developer tools such as PeopleSoft Application Designer. The related content service pages provide a variety of configuration options, which enable you to define related content services, associate them with components and pages, and grant access to these services based on your business rules.

PeopleSoft applications divide related content services into two major categories—related content and related actions—based on where the content appears when the user accesses the service.

• Related content only appears in one of two Related Content frames, which appear at the bottom or to the right of the primary transaction page.

• Related actions appear outside of the Related Content frames. Target locations include modal windows, in new browser windows, or in the existing browser window replacing the current transaction page.

The Bottom Related Content Frame

Note these points about the bottom Related Content frame:

• The frame extends across the width of the transaction page.

• The visible area increases and decreases when you drag the handle on the upper edge of the frame in a vertical direction.

• The frame appears and disappears when you click the Expand/Collapse button on the left side of the frame header.

• The frame reloads when you click the Refresh button in the frame header .

• The frame loads the current active service in a new window when you click the Zoom icon.

• The frame closes when you click the Close button.

• Open the active service in another window by clicking the zoom button in the frame header.

Note these points about the services that appear in the bottom frame:

• Only one service can be active and have focus at a time.

• Multiple services appear as tabs across the top of the frame.

• Users click the tab to bring the service into focus.

This is a sample transaction page showing related content in the bottom Related Content frame:

The Right Related Content Frame

Note these points about the right Related Content frame:

• The frame extends down the length of the transaction page.

• The visible area increases and decreases when you drag the left edge of the frame in a horizontal direction.

• The frame appears and disappears when you click the Maximize and Minimize buttons on the left border of the frame.

• The frame divides the visible area equally among all open pagelets.

• The bottom of the frame displays a More menu, which you use to access minimized pagelets.

Note these points about the services that appear in the right Related Content frame:

• Each service exists as a self-contained pagelet inside the Related Content frame.

• Any number of services can open be active and in the expanded state simultaneously.

• All maximized service pagelets divide the available space equally and always share the same vertical and horizontal dimensions. As users maximize and minimize other service pagelets in the frame, any service pagelets that remain open resize automatically so that the space appears equally divided.

  Note. Users cannot resize individual service pagelets.

• Each pagelet header can contain:

  • A Zoom button that users click to display the service in a new window.

  • A Refresh button that users click to reload the service.

  • A Maximize/Minimize button that users click to toggle the service between the expanded and collapsed states.

    Note. The state of each pagelet persists based on the state from the user's last session.

• Scroll bars appear on the right and bottom of a service pagelet if it is too small to fully display the content.

This is a sample transaction page showing related content in the right Related Content frame:

Related Content Service Menus

Menus provide access to related content services. Three types of menus exist:

• The Related Content menu, which appears in the page bar at the top of the transaction page.

• Related actions menus, which can appear:

  • As Actions folders in drop-down SmartNavigation menus,

    

    Related actions in a sample drop-down SmartNavigation menu

  • As Actions links on chart nodes of SmartNavigation pages

    

    Related actions on a sample SmartNavigation page

  • As Related Actions links in the search results of a Keyword search.

    

    Related actions on a sample Keyword Search Results page

• Page field contextual menus, which appear when the user right-clicks the red page-field glyph.

The Related Content Development Process

This table lists the steps in the process flow, the roles involved during each step, and provides cross-references to supporting PeopleBooks documentation:

Delivered Related Content Services for PeopleSoft Application Portal

PeopleTools provides the service definitions for three related content services for PeopleSoft Application Portal:

• Related Discussion service

• Related Links service

• Related Tags service

These related content services provide features of Oracle’s PeopleSoft Application Portal that can be added to PeopleSoft application pages through the PeopleTools Related Content Framework. While the service definitions are provided in PeopleTools, an active PeopleSoft Application Portal database is required to provide the services and to store the related data.

Setup procedures for these services is covered in the PeopleSoft Application Portal PeopleBooks.

See PeopleSoft Application Portal 9.1 PeopleBook: Using Portal Features, “Setting Up Related Content Services.”

Related Discussion Service

Using the Related Discussion related content service, you can collaborate to share relevant information about a transaction or a transaction instance. Discussion forums in the Related Discussion service provide a platform that groups can use to discuss topics of interest in a manner similar to standalone forums in PeopleSoft Application Portal. Discussion forums enable multiple relevant individuals to contribute to the review and resolution of a question. Your can post discussion topics, such as issues, suggestions, or questions, and receive replies and feedback.

Details for using the Related Discussion service are provided in the PeopleSoft Application Portal PeopleBooks.

See PeopleSoft Application Portal 9.1 PeopleBook: Using Portal Features, “Working With the Related Discussion Service.”

Related Links Service

The Related Links related content service enables you to create links to relevant content for the current transaction instance or for all instances in a transaction. You can link to content residing in PeopleSoft Application Portal—specifically, blogs, discussions, or collaborative workspaces—or external URLs. In addition, the Related Links service enables you to create a new workspace and to link that workspace to the transaction.

Details for using the Related Links service are provided in the PeopleSoft Application Portal PeopleBooks.

See PeopleSoft Application Portal 9.1 PeopleBook: Using Portal Features, “Working With the Related Links Service.”

Related Tags Service

The Related Tags related content service enables you to create user-specified tags for the current transaction instance. You can characterize and bookmark these transactional or business objects with terminology of your choosing, providing ease of access as well as collaborative classification of the transaction.

Details for using the Related Tags service are provided in the PeopleSoft Application Portal PeopleBooks.

See PeopleSoft Application Portal 9.1 PeopleBook: Using Portal Features, “Working With the Related Tags Service.”

Delivered Related Content Services for Oracle WebCenter

PeopleTools provides these service definitions for use with Oracle WebCenter:

• WebCenter Blogs service

• WebCenter Discussions service

• WebCenter Documents service

• WebCenter Links service

• WebCenter Wikis service

These related content services provide features of Oracle WebCenter that can be added to PeopleSoft application pages through the PeopleTools Related Content Framework. While the service definitions are provided in PeopleTools, an active Oracle WebCenter database is required to provide the services and to store the related data.

See Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter, http://download.oracle.com/docs/cd/E21764_01/webcenter.1111/e12405/wcadm_getstarted_app.htm

Note. Oracle recommends that you have a WebCenter that you dedicate solely to your PeopleSoft applications integration.

WebCenter Blogs Service

Blogs provide a useful tool for discussing or evangelizing any type of idea, strategy, or point of view. Blogs may be projected out to a select group of people or to a wider audience. Typically, blogs invite readers to comment on the overall concepts.

The Blogs service enables users to create instance specific or shared WebCenter blogs, which appear for all transaction instances of the transaction page.

See Oracle WebCenter Blogs Service.

WebCenter Discussion Service

The Discussions service lets you expose discussion forums on your application pages, so users can create forums, post questions, and search for answers. For example, customers can share product reviews, or a customer service department can answer questions online. Discussion forums additionally provide the means to preserve and revisit discussions.

The Discussion service enables users to create instance specific or shared WebCenter discussions, which appears for all transaction instances of the transaction page.

See Oracle WebCenter Discussion Service.

WebCenter Documents Service

The Documents service provides features for accessing, adding, and managing folders and files; configuring file and folder properties; and searching file and folder content in the connected content repositories. When you set up a content repository connection to integrate the Documents service, you can add content to the transaction pages of the PeopleSoft application.

The Documents service enables users to create instance specific or shared WebCenter documents, which appears for all transaction instances of the transaction page.

See Oracle WebCenter Documents Service.

WebCenter Links Service

The Links service provides a way to view, access, and associate related information. For example, in a list of project assignments, you can link to the specifications relevant to each assignment. In a discussion thread about a problem with a particular task, you can link to a document that provides a detailed description of how to perform that task.

The Links service enables users to create instance specific links or shared links, which appears for all transaction instances of the transaction page. When the transaction page or instance also uses other WebCenter related content services, related links to the other WebCenter group spaces appear by default and cannot be removed.

Unlike other WebCenter related content services, the Links service is a PeopleSoft component-based page. When you click the links in the service, the target opens in a new browser window.

See Oracle WebCenter Links Service.

WebCenter Wiki Service

A wiki is a collection of useful content or information that users can browse, update, and remove, sometimes without the need for registration. This ease of interaction and the variety of operations make wiki an effective tool for collaborative authoring, where multiple people create written content together.

The wiki service enables users to create instance specific wiki pages or shared WebCenter wiki pages, which appears for all transaction instances of the transaction page.

See Oracle WebCenter Wiki Service.

See Also

Understanding the Oracle WebCenter Integration

Defining Related Content Services

This section provides overviews of service types, service URL parameters, service security, and discusses how to:

• Define application class-related content services.

• Define non-PeopleSoft-related content services.

• Define PeopleSoft component related content services.

• Define Embeddable Pagelet related content services.

• Define OBIEE Pagelet related content services.

• Define PeopleSoft Query related content services.

• Define PeopleSoft Script related content services.

• Test related content service definitions.

• Write help text for related content service definitions.

• Copy related content service definitions.

Understanding Service Types

The PeopleSoft Related Content Framework supports seven explicitly definable service types. Each type is defined by its URL construction and each type requires different information to form the complete URL that locates and requests the contextual data.

When you select a service URL type, various service parameters appear for you to configure. The service parameters differ based on the URL type that you select. For example, when you select Embeddable Pagelet, the Node and Pagelet Name fields appear as service parameters because the framework must know the name of the node where the pagelet resides and the name of the pagelet to construct the URL and retrieve the pagelet and its data.

In addition to system-defined service parameters, you can enter user-defined parameters, which offers maximum flexibility in configuring the service to meet business requirements.

Definable Service Types

You can explicitly define the following related content service types:

The information that the system uses to construct the seven URL types differs for each type and is described in the following sections.

Anonymous Service Types

Services that you do not have to define explicitly are called anonymous services. Two service types exist that you do not have to explicitly define:

• Content references.

• Pagelets.

When you configure an anonymous related content service, the system automatically defines the service and the service parameters. No explicit service definition configuration is required.

Understanding Service URL Parameters

A service might need additional parameters to obtain the context for the data that the service provides. You define these parameters in the Service URL parameter grid.

When you access the service from the transaction page, contextual values from fields in the buffer, system variables, or even fixed values that you map to the parameters pass as arguments to the service.

Content Reference Attributes as Service URL Parameters

When you assign a content reference as an anonymous service, the system automatically defines service parameters for the components that provide either a valid search record or contextual record. For other types of content references, such as iScripts, PSQuery, and so on, the system checks for the RCF_SERVICE_PARAMETER attribute, which you must define manually on the Content Reference Administration page. If this attribute exists, the system automatically uses the attribute values as the service parameters for the content reference.

Note these points about the RCF_SERVICE_PARAMETER attribute.

• The attribute overrides the default behavior of component-based URLs. The system will not retrieve the service parameters from a valid search record or contextual record, rather the system supplants any search record parameters with the parameters included in the Attribute Value field.

• The attribute value format should follow this pattern:

  NAME,Label;NAME,Label for example, EMPLID,Employee ID;EXPENSEID,Expense ID.

• The NAME attribute value should not include spaces.

This is a sample content reference that uses the RCF_SERVICE_PARAMETER attribute:

See Also

Content Reference Attributes

Understanding Service Security

PeopleSoft Related Content Framework uses the basic PeopleTools security model, which secures local and remote PeopleSoft transaction pages and the application data that underlies these pages based on the user's assigned permission lists and roles.

For services that provide access to non-PeopleSoft content, the framework enables you to use the security model of the content provider. You should consult the content provider and your security administrator to determine the best course of action.

PeopleSoft Security Authorization Web Service

The security authorization web service runs on PeopleSoft and certain third party systems such as Oracle WebCenter. The service examines the basic PeopleTools security on the providing system and can respond to a web service call from another PeopleSoft system.

PeopleSoft Related Content Framework uses the authorization service in these two ways

• To show and hide related content links that access PeopleSoft content.

• To grant access to third party systems, such as Oracle WebCenter that contain PeopleSoft content.

The authorization service can check for basic PeopleTools security at the definition level and at the data, or row, level.

At the definition level, the authorization service response determines whether related content or related actions links to PeopleSoft content appear for the user. This level of authorization is automatically engaged for any PeopleSoft content. Beyond basic PeopleTools security setup, no other configuration is required.

If the user has the appropriate permissions to view the content, then the authorization service determines whether data, or row-level security has been configured. If any such configurations exist, then the appropriate data is returned when the user clicks the related content or related action link to access the data.

Important! Row-level, or data permission, security is not automatic. Use the Authorization Configuration component to configure the authorization service to implement data-level security on remote systems. Setup procedures for Authorization service configuration is covered in another PeopleBook.

See Understanding Developing and Invoking the Security Authorization Service.

Service Definition Security Options

You specify the security options for a service definition at design time. The selection of a security options does not enforce security, rather the selection indicates to the consumer where to look for the security associated with the service definition. The security options that appear on the service definition are not mutually exclusive. You can select one or more options to make available to the person who assigns the service to a content reference. During the service configuration process, he or she selects the security option that the service implements. Before you select a security option for a service, you should understand its security model. If you select a security option for a service definition that isn't applicable to the service definition type, unexpected results can occur.

Important! The security authorization web service is called for all PeopleSoft content regardless of the option that you select; however, the service is not called for nonPeopleSoft content.

PeopleTools offers three security options.

• Public access.

• Related content provider security.

• Related content consumer security.

Public Access

The Public Access security option provides access to the service based on the permissions of the public user that you specify in the web profile. The Public Access option is intended for use with services that require few parameters, such as a generic help policy or an internet search engine.

Components that use basic PeopleTools security, which provides authorization and access through permission lists and roles, are not public. If you select the Public Access option for a PeopleSoft Component service definition, users must have access to any PeopleSoft component associated with the service.

See Public Users.

See Setting Page Permissions.

Related Content Provider Security

Some content providers offer complex and industry-specific security models and mechanisms that are native to the service. The Related Content Provider Security option is intended for use with services that implement security that is specific to their data model or the content that they provide.

As an example, consider the Employee component in an HCM environment as the consumer and the Compensation Details component in Payroll as the producer. If you select Related Content Provider Security, then the provider system (Employee/HCM) must provide the security.

Related Content Consumer Security

PeopleSoft applications use basic PeopleTools security, which provides authorization and access to the many elements of your PeopleSoft application through the assignment of permission lists and roles to users. The Related Content Consumer Security option is intended for use with services that rely on the basic PeopleTools security or row-level security for authorizing access to the service content, for example:

• PeopleSoft Component, Embeddable Pagelet, OBIEE Pagelet, PeopleSoft Query, and PeopleSoft iScript services that access remote PeopleSoft nodes.

• Application Portal services that create related discussions, tags, and links workspaces

• Oracle WebCenter services that create group spaces linked to PeopleSoft transaction pages. The WebCenter maintains the group space security, but authorization and access are based on the permissions of the PeopleSoft transaction page.

For example, consider the Employee component in HCM as the consumer and the Compensation Details component in Payroll as the producer. If you select Related Content Consumer Security, then the consumer system (Employee/HCM) must provide the security. Therefore, the provider system (Compensation/Payroll) creates an authorization request to the consumer (Employee/HCM), which responds with the authorization details for that user.

See Also

Setting Up Permission Lists

Setting Up Roles

Administering User Profiles

Understanding Security Synchronization

Understanding Developing and Invoking the Security Authorization Service

Common Elements Used in This Section

This section describes the common elements used in defining related content services. The elements appear in the lists in the order that they appear on the respective pages

Related Content Service

This table describes the fields on the Define Related Content Service page that are common to all service URL types. .

URL Information

This table describes URL information fields. These fields are common to several or all service URL types.

Service URL Parameters

This table describes service URL parameter fields. These fields are common to all service URL types.

Display Options

This table describes display option fields. Display options apply only when you configure the to appear in the related content frame. These fields are common to all service URL types.

Note. Any browser setting that enables the browser to determine whether to open pages in a new window or a tab can affect the expected functionality of the New Window property. Configure the BNEWWIN navigation personalization option to override any user-specific browser settings so that the browser never uses tabbed browsing for PeopleSoft applications.

See Understanding Navigation Personalizations.

Pages Used to Define Related Content Services

Creating and Maintaining Application Class Related Content Service Definitions

Access the Define Related Content Service page. (Select PeopleTools, Portal, Related Content Service, Define Related Content Service) Select the Application Class URL URL type.

Application Class Parameters

These fields are validated when you save the definition; the application does not allow you to save the service if you enter an invalid application class.

Service URL Parameters

Application class service definitions do not require service URL parameters except when you want to map field-level data to the service and display the service in a field-level contextual menu.

Application class URLs cannot be formed by clicking the Show Formed URL link because the URL is dynamically generated by PeopleCode using data in the buffer. For the same reason, application class URLs cannot be tested by clicking the Test Related Content Service link.

Application Class PeopleCode Example

This is an example of application class PeopleCode that could be used to create an application class service for use as a related action on a SmartNavigation page:

import PT_RCF:ServiceInterface;


class res_det implements PT_RCF:ServiceInterface
   method execute();
end-class;

Global number &PRL_Schedule_Current_Row;

method execute
	/* Extends/implements PT_RCF:ServiceInterface.execute */
   
	Evaluate %Component
		When = Component.PGM_RESOURCE_LIST

/*******************************************************************
  Transfer to the Resource detail page.
*******************************************************************/
			If (%Page = Page.PC_PRL) Then
				GetPage(Page.PC_PRL_SCHED).Visible = True;
				&PRL_Schedule_Current_Row = CurrentRowNumber();
  
 			/*AN: Hide the grids if the resource is not a resource class */
				If (GetRow().PROJECT_TEAM.TEAM_MEMBER_CLASS.Value <> "L") Then
					GetRow().GetRowset(Scroll.PROJ_TEAM_SCHED).HideAllRows();
					GetRow().GetRowset(Scroll.PC_TEAM_IP_SCHD).HideAllRows();
				Else
					Local Rowset &ipRowSet = GetRow().GetRowset(Scroll.PC_TEAM_IP_SCHD);
					If (&ipRowSet.ActiveRowCount > 1 Or
						(&ipRowSet.ActiveRowCount = 1 And 
							All(&ipRowSet(1).PC_TEAM_IP_SCHD.START_DT.Value))) Then
						GetRow().GetRowset(Scroll.PC_TEAM_IP_SCHD).ShowAllRows();
					Else
						GetRow().GetRowset(Scroll.PC_TEAM_IP_SCHD).HideAllRows();
					End-If;
				End-If;
         
				Local Rowset &arlResDtlVw = GetRow().GetRowset(Scroll.PC_ARL_RESDTLVW);
				&arlResDtlVw.Flush();
				&arlResDtlVw.Select(Record.PC_ARL_RESDTLVW, "where BUSINESS_UNIT ⇒
= :1 AND PROJECT_ID = :2 AND TEAM_MEMBER = :3 and TEAM_MEMBER_CLASS ⇒
= :4 and TEAM_MEMBER_IND = :5 ", PROJECT.BUSINESS_UNIT, PROJECT.PROJECT_ID, ⇒
GetRow().PROJECT_TEAM.TEAM_MEMBER.Value, ⇒
GetRow().PROJECT_TEAM.TEAM_MEMBER_CLASS.Value, ⇒
GetRow().PROJECT_TEAM.TEAM_MEMBER_IND.Value);
 
				TransferPage(Page.PC_PRL_SCHED);
 
			End-If;
      
				/*AN: Hide the grids if the resource is not a resource class */

			If (&teamRow.PROJECT_TEAM.TEAM_MEMBER_CLASS.Value <> "L") Then
				&teamRow.GetRowset(Scroll.PROJ_TEAM_SCHED).HideAllRows();
				&teamRow.GetRowset(Scroll.PC_TEAM_IP_SCHD).HideAllRows();
			Else
				Local Rowset &ipSet = &teamRow.GetRowset(Scroll.PC_TEAM_IP_SCHD);
				If (&ipSet.ActiveRowCount > 1 Or
					(&ipSet.ActiveRowCount = 1 And
						All(&ipSet(1).PC_TEAM_IP_SCHD.START_DT.Value))) Then
						&teamRow.GetRowset(Scroll.PC_TEAM_IP_SCHD).ShowAllRows();
				Else
					&teamRow.GetRowset(Scroll.PC_TEAM_IP_SCHD).HideAllRows();
				End-If;
			End-If;
 
				TransferPage(Page.PC_PRL_SCHED);
	
			End-If;

	End-Evaluate;

end-method;

Creating and Maintaining Non-PeopleSoft Related Content Service Definitions

Access the Define Related Content Service page. (Select PeopleTools, Portal, Related Content Service, Define Related Content Service.) Select the Non-PeopleSoft URL URL type.

URL Information

Service URL Parameters

Enter any parameters that the external service requires.

Non-PeopleSoft URL Example

This is an example of a fully formed non-PeopleSoft URL:

http://finance.google.com/finance?q=ORCL

Creating and Maintaining PeopleSoft Component Related Content Service Definitions

Access the Define Related Content Service page. (Select PeopleTools, Portal, Related Content Service, Define Related Content) Select the PeopleSoft Component URL URL type.

Note. PeopleSoft components service definitions can be anonymous. You define this type of service explicitly when you need to include a service parameter that does not appear with the anonymous service.

Component Parameters

Component URL Example

This is an example of a fully formed component URL:

http://mymachine.peoplesoft.com/psp/ps/EMPLOYEE/PT_LOCAL/c/MAINTAIN_SECURITY.USERMAINT.GBL?OPRID=PTPORTAL&OPRDEFNDESC=Portal Administrator

Creating and Maintaining Embeddable Pagelet Related Content Service Definitions

Access the Define Related Content Service page. (Select PeopleTools, Portal, Related Content Service, Define Related Content) Select the Embeddable Pagelet URL type.

URL Information

Service URL Parameters

Click the Populate parameters button to populate the Service URL Parameter grid with parameters that you defined as Context Sensitive in step three of the pagelet construction in Pagelet Wizard.

If the pagelet resides in the same system, as soon as you select the node, a lookup appears next to the pagelet ID field. When clicked, the lookup lists all of the available embeddable pagelets in the system.

The Populate parameters button supplies the parameters only for the locally available pagelets. If a pagelet resides in a remote PeopleSoft system, you must manually enter the pagelet ID and pagelet parameters.

See Step 3: Specifying Pagelet Data Source Parameters.

Embeddable Pagelet URL Example

This is an example of a fully formed embeddable pagelet URL:

http://mymachine.peoplesoft.com/psc/ps/EMPLOYEE/PT_LOCAL/s/WEBLIB_PTEMBED.ISCRIPT1.FieldFormula.IScript_EmbeddedPageletBuilder?PAGELETID=USER_ROLES&OPRID=PTDMO&.MAXROWS=10

Creating and Maintaining OBIEE Pagelet Related Content Service Definitions

Access the Define Related Content Service page. (Select PeopleTools, Portal, Related Content Service, Define Related Content) Select the PeopleSoft OBIEE Pagelet URL type.

URL Information

Service URL Parameters

Click the Populate parameters button to populate the Service URL Parameter grid with parameters that you defined as Context Sensitive in step three of the pagelet construction in Pagelet Wizard.

If the pagelet resides in the same system, then as soon as you select the node, a lookup appears next to the pagelet ID field. When clicked, the lookup lists all of the available OBIEE pagelets in the system.

The Populate parameters button supplies the parameters only for the locally available pagelets. If a pagelet resides in a remote PeopleSoft system, you must manually enter the pagelet ID and pagelet parameters.

See Step 3: Specifying Pagelet Data Source Parameters.

OBIEE Pagelet URL Example

This is an example of a fully formed OBIEE pagelet URL:

http://mymachine.peoplesoft.com/psc/ps/EMPLOYEE/PT_LOCAL/s/WEBLIB_PTEMBED.ISCRIPT1.FieldFormula.IScript_EmbeddedPageletBuilder?PAGELETID=OBIEE_REPORT&1) Markets.Region=EASTERN REGION

Creating and Maintaining PeopleSoft Query Related Content Service Definitions

Access the Define Related Content Service page. (Select PeopleTools, Portal, Related Content Service, Define Related Content.) Select the PeopleSoft Query URL type.

URL Information

Service URL Parameters

Click the Populate parameters button to populate the Service URL Parameter grid with fields that you defined as prompts when creating the query definition.

If the query resides in the same system, as soon as you select the node, a lookup appears next to the PS Query field. When clicked, the lookup lists all of the available queries in the system.

The Populate parameters button supplies the parameters only for the locally available queries. If a query resides in a remote PeopleSoft system, you must manually enter the query name and query parameters.

See Defining Prompts.

PeopleSoft Query URL Example

This is an example of a fully formed PeopleSoft Query URL:

http://mymachine.peoplesoft.com/psc/ps_newwin/EMPLOYEE/PT_LOCAL/q/?ICAction=ICQryNameURL=PUBLIC.MESSAGES_FOR_MSGSET&MESSAGE_SET_NBR=240

Creating and Maintaining PeopleSoft Script Related Content Service Definitions

Access the Define Related Content Service page. (Select PeopleTools, Portal, Related Content Service, Define Related Content.) Select the PeopleSoft Script URL type.

See Web Libraries.

iScript Parameters

Service URL Parameter

Enter the names of all parameters that the iScript must have to render the service in the related content service frame.

PeopleSoft Script URL Example

This is an example of a fully formed PeopleSoft script URL:

http://mymachine.peoplesoft.com/psc/ps/EMPLOYEE/PT_LOCAL/s/WEBLIB_STOCK.ISCRIPT1.FieldFormula.IScript_StockQuote?stockquote=ORCL

Testing Related Content Service Definitions

Access the Test Related Content Service page. (On the Define Related Content Service page, click the Test Related Content Service link.)

Parameter Name	Displays the parameters that you enter on the Define Related Content Service page. This field is display-only.
Parameter Value	Enter a test value for the parameter.
Test Related Content Service	Click to test the related content service with the parameter values that you enter.
Return	Click to return to the Define Related Content Service page after testing the service.

Testing Related Content Service Parameter Values

To test parameter values:

1. Enter the value in the Parameter Value field.

2. Click the Test Related Content Service link.

   The service appears in a separate browser window with the parameter value.

3. Click the Return button to return to the Define Related Content Service page.

Writing Help Text for Related Content Service Definitions

When you define related content services, you may want to document the service and how the service parameters should be mapped to transaction content, especially if your services use multiple, complex service parameters. The components and pages can include numerous fields, some of which are named similarly, which can make configuring the service parameter mapping difficult.

Use the Help text to clearly communicate the values that must be assigned to the service parameters for the service. The text that you enter is accessible to the subject matter expert when she clicks the Read help text link on the Related Content Service - Configure Service page.

Important! You must use explicit, concise, clear, understandable language in your instructions.

Access the Related Content Service Definition - Help information page. (On the Define Related Content Service page, click the Write help text button.)

Service Name	Displays the name of the related content service. This field is display-only.
OK	Click to save the text and return to the Related Content Service Definition page. Note. You must save the service definition to save the help text.
Cancel	Click to discard any changes and return to the Related Content Service Definition page.

To write Help text for a related content service definition:

1. Enter help information for the related content service definition in the editor window.

2. Click the OK button.

   This returns you to the Related Content Service Definition page.

3. Save the definition.

Copying Related Content Service Definitions

Access the Copy Related Content Service Definition page. (On the Define Related Content Service page, click the Copy Service Definition button.)

To copy a related content service definition:

1. Enter a new value in the Service ID field.

2. Enter a new value in the Service Name field.

3. Click the Save button.

   A message appears indicating a successful save.

4. Click the OK button to dismiss the message box.

5. Click the Go to Related Content Service Definition link that appears to access the new related content service definition or click the Cancel button to discard the related content definition that you copied.

   Note. Clicking the Cancel button does not cancel the save. The transaction is saved when you click the Save button.

PeopleSoft Application Designer Projects

You can use PeopleSoft Application Designer to create upgrade projects that contain related content definitions and related content services, which include related content configurations and menu layouts. You can save these projects to files or copy them directly to other PeopleSoft databases.

See Working With Projects.

Assigning and Managing Related Content Services

This section provides overviews of related content assignment, related actions assignment, and service configuration and discusses how to:

• Select a content reference.

• Assign component services to content references.

• Assign page level services to content references.

• Configure related content services.

Understanding Related Content Assignment

The Related Content Framework is designed so that subject matter experts or business analysts with an understanding of PeopleSoft applications and your business processes can assign related content services to components with little or no assistance from the developer after the service is defined. Almost every aspect of assigning and configuring related content services is done in the browser; no access to developer tools, such as PeopleSoft Application Designer, is necessary.

The Manage Related Content Configuration page is the starting point for creating and assigning related content services. The first time you access this page, you will see that no application pages have been assigned related content. After you assign related content services to application pages, a grid appears listing the related content assignments.

When you design and configure related information correctly, the application user is presented with seamless access to related information, which can increase productivity and improve job performance.

Assigning Related Content Process Flow

Related content assignment follows this basic process flow:

1. Select the content reference.

   Important! When you select a content reference, the services that you assign are unique to the menu and component combination. The same component, when it is placed on different menus, can take different services because components on different menus might have different business requirements.

2. Include hidden content references (Optional).

   Selecting this check box redraws the tree including hidden content references in the system. Deselecting it redraws the tree with only the visible content references in the system.

3. Assign component-level related content to the content reference.

4. Assign page-level related content to the content reference.

5. Configure the assigned services.

6. Save the configuration.

Managing Related Content

After you have defined related content services and assigned them to content references, the assignments appear in the Content References grid that is on the Manage Related Content Configuration page. Use the Edit Configuration buttons on the Manage Related Content page to modify existing related content assignments.

When you click the Edit Configuration button, the Assign Related Content page appears.

Understanding Related Actions Assignment

Related actions links can appear in an Actions drop-down menu, which you find on nodes that appear on SmartNavigation pages. SmartNavigation pages are dynamically generated navigation structures that combine your own hierarchical application data from trees and rowsets, along with PeopleSoft charting metadata to provide users with an alternative way to access transaction data in components.

See Defining Folders.

This example shows two nodes on a SmartNavigation page and the Actions drop-down menu.

Related action links can also appear in the search results list of a keyword search.

This example shows the Related Actions drop-down menu that appears in the results of a keyword search:

You configure related actions similarly to the way that you configure related content. However, the component to which you assign the related content service might not seem obvious. These next sections explain how to find the component to which you want to assign a related content service that you want to appear in the Actions drop-down menu on a SmartNavigation page.

Finding the Details Component for Tree-Based SmartNavigation Pages

Trees are hierarchical collections of data that you create and maintain by using PeopleSoft Tree Manager. Tree-based SmartNavigation folders use a specific type of tree called a detail tree as the data source. When you use PeopleSoft Tree Manager to configure a detail tree structure, you define the location of the component that you use to maintain the detail values in the tree. When you assign a related content service that you want to appear as a related action, you assign the service to the detail component, which underlies the nodes and leaves of the tree structure. To find this information, access the Details page on the Tree Structure component. (Select Main Menu, Tree Manger, Tree Structure and then select the Details tab.) Use the value in the Component Name field, which is the DEPARTMENT component in this example:

Note. Nodes and leaves can have different details components. The Nodes tab displays the tree node details component. When setting up related actions for a tree, you can configure services for either one or both.

See Defining Tree Details.

Finding the Details Component for Rowset-Based SmartNavigation Pages

Rowsets are collections of data that are associated with buffer data. Rowset-based SmartNavigation pages use PeopleCode to populate the component buffer, generate the chart, and retrieve related actions. When the developer writes the PeopleCode programs that populate the chart, she must define a detail component from which the data is retrieved. When you assign a related content service that you want to appear as a related action, you assign the service to the detail component indicated in the PeopleCode program.

To find this information you can consult the developer or you can follow these steps:

1. Select PeopleTools, Portal, Structure & Content.

2. Navigate to the SmartNavigation folder by clicking the folder labels until you reach the appropriate folder.

   When you find the folder, the label will be text, not a link.

3. Click the Edit link for that folder.

4. Use the PeopleCode Type and the iScript Parameters or Application Class Parameters fields to determine the name of the PeopleCode function or class that contains the information.

5. Open PeopleSoft Application Designer and access the record or class that you ascertained in the previous step.

6. Search for a line that sets the detail component. The exact code can vary depending on the naming conventions of the programmer, but it should set these elements:

   • MenuName

   • BarName

   • ItemName

   • Page

   • Action

   • Record

   • KeyFieldNumber

   • FieldName

   This is an example: "MenuName.QE_SAMPLE_APPS, BarName.USE, ItemName.QE_EMPLOYEE, Page.QE_EMPLOYEE, Action.U, Record.QE_EMPLOYEE, KeyFieldNumber.001, FieldName.EMPLID"

Including Related Actions Links in Search Results

The appearance of related actions links in the search results list of a keyword search depends on several configuration options. Consult the PeopleSoft Search Technology documentation for detailed information.

See Working with Related Actions.

Assigning Related Actions Process Flow

Related content assignment follows this basic process flow:

1. Select the content reference.

   Important! When you select a content reference, the services that you assign are unique to the menu and component combination. The same component, when it is placed on different menus, can take different services because components on different menus might have different business requirements.

2. Include hidden content references (Optional).

   Selecting this check box redraws the tree including hidden content references in the system. Deselecting it redraws the tree with only the visible content references in the system.

3. Assign component level services to the content reference.

4. Assign page level services to the content reference.

5. Configure the assigned services.

6. Save the configuration.

Managing Related Actions

After you have defined related content services and assigned them to content references, the assignments appear in the Services assigned to Application Pages grid, which is on the Manage Related Content Configuration page. Use the Edit Configuration buttons on the Manage Related Content page to modify existing related actions assignments.

When you click the Edit Configuration button, the Assign Related Content page appears. Click the Related Actions tab to access the Assign Related Actions page.

See Also

Defining Tree Details

Accessing Definitions and Associated PeopleCode

Understanding Service Configuration

When you assign a related content service to a page or component, you must configure the service parameters. Configuration can include mapping the field data to the service parameters, specifying which type of menu the service link is listed in, adding filters to the service, and specifying security options. The service parameter list and other configuration options vary based the service type, the service definition, and the service target that you choose.

Related content service configuration establishes the relationships between the service and the transaction data so that the service appears in context with the current transaction. To establish contextually relevant relationships, service configuration includes working with:

• Service parameter mapping.

• Service filters.

• Security options.

Service Parameter Mapping

Many services include parameters that you must map to key fields or page fields, system variables, and fixed values. You map the parameters to these elements so that they can pass the data to the service and create the relevant context for the related content.

This table discusses the source of the parameters for each of the service types.

When you map parameters, usually you must first select the mapping type and then select the mapping data. Some services might already have the mapping defined.

This table discusses the mapping types.

After you select a mapping type, click the Select button to see the mapping type prompt page.

Note these points about the prompt pages:

• If the mapping type is Key Field, then the prompt page displays a list of search key fields from the component search record.

• If the mapping type is Page Field, then the prompt page constructs a grid and dynamically populates it with a row for each page field that is available to the service. For each page field row, the grid also includes a hidden field indicator, the occurs or scroll level, the record (table) name, the field definition name, and the page field ID number.

  Use the page field ID number to identify a specific occurrence of a page field when the field appears multiple times in the same occurs level on the page. Each instance of a page field has a unique ID number that you find on the Order tab of the page definition in PeopleSoft Application Designer.

• If the mapping type is System Variable, then the prompt page displays valid system variables.

  See System Variables.

  Important! Only %UserID, %EmployeeId, and %EmailAddress are supported for services to be displayed in the Related Actions menu of SmartNavigation pages.

If the mapping type is Fixed Value, then the Select button is hidden.

Note. To reduce mapping effort, the PeopleSoft Related Content Framework defines a set of reserved words and service parameters.

See Related Content Reserved Words and Service Parameters.

Service Filters

A service filter hides or displays a service link in a field-level menu or the Related Content menu based on the value in the field at runtime. The Application Package PeopleCode that you specify can access the component buffer, using field values to trigger data-specific logic that causes the related content service link to be visible or hidden based on the value of the field. The filter enables the context of the data to determine whether the service link appears.

Security Options

The service definition determines the choices of security options that appear.

See Understanding Service Security.

Prerequisites

This table discusses the prerequisites for assigning related content.

Common Elements Used in This Section

Pages Used to Assign and Manage Related Content Services

Selecting a Content Reference

Access the Manage Related Content Configuration page. (Select PeopleTools, Portal, Related Content Service, Manage Related Content Service.)

Access the Select a Content Reference page. (Click the Assign Related Content to Application Pages link.)

Select Include hidden Crefs to make hidden content references available for assignment.

Note. The tree shows both PeopleSoft component URLs and PeopleSoft component-based generic URLs.

Assigning Component-Level Services to Content References

At the component level, you can:

• Assign related content.

• Assign related actions.

Assigning Component-Level Related Content

Access the Assign Related Content page.

1. In the Component Level Related Content group box, select the service type.

2. Click the Select button.

   The lookup page that appears will depend on the service type you select. If you select Service or Pagelet as the service type, a lookup page appears.

   If you select Content Reference, this page appears:

   

   Lookup Content Reference page

   If you have multiple PeopleSoft applications that have been configured as remote nodes, you can change the node and the portal, and then select a remote content reference.

3. From the lookup page, select a service.

4. If necessary, modify the label in the Service Label field.

Assigning Component-Level Related Actions

Access the Assign Related Actions page.

1. In the Component Level Related Actions group box, select the service type.

2. Select the service type.

3. Click the Select button.

   The lookup page that appears will depend on the service type you select. If you select Service or Pagelet as the service type, a lookup page appears.

   If you select Content Reference, this page appears:

   

   Lookup Content Reference page

   If you have multiple PeopleSoft applications that have been configured as remote nodes, you can change the node and the portal, and then select a remote content reference.

4. From the lookup page, select a service.

5. If necessary, modify the label in the Service Label field.

6. Select a service target.

Assigning Page-Level Services to Content References

At the page level, you can:

• Assign related content.

• Assign related actions.

Assigning Page-Level Related Content

Access the Assign Related Content page.

1. In the Page Level Related Content group box, click the Page lookup button and then, select the page to which you want to assign the service.

2. Select the service type.

3. Click the Select button.

   The lookup page that appears will depend on the service type you select. If you select Service or Pagelet as the service type, a lookup page appears.

   If you select Content Reference, this page appears:

   

   Lookup Content Reference page

   If you have multiple PeopleSoft applications that have been configured as remote nodes, you can change the node and the portal, and then select a remote content reference.

4. From the lookup page, select a service.

5. If necessary, modify the label in the Service Label field.

Assigning Page-Level Related Actions

Access the Assign Related Actions page.

1. In the Page Level Related Actions group box, click the Page lookup button and select the page to which you want to assign the service.

2. Select the service type.

3. Click the Select button.

   The lookup page that appears will depend on the service type you select. If you select Service or Pagelet as the service type, a lookup page appears.

   If you select Content Reference, this page appears:

   

   Lookup Content Reference page

   If you have multiple PeopleSoft applications that have been configured as remote nodes, you can change the node and the portal, and then select a remote content reference.

4. From the lookup page, select a service.

5. If necessary, modify the label in the Service Label field.

6. Select a service target.

Configuring Service Parameters

Access the Configure Service page. (On the Assign Related Content page, click the Configure button.

1. For each service parameter, select the mapping type.

2. For each fixed value mapping type, enter the value in the Mapping Data field.

3. For each key field, page field, or system variable mapping type, click the Select button.

4. Click a link to select the field or variable on the prompt page.

5. For page-level services, select the Display in field menu check box for the field that provides access to the contextual pop-up menu.

6. (Optional) Enter the package, path, and class ID of the service filter .

7. Select the security option.

8. Click the OK button to accept the configuration and return to the assignment page.

Managing Related Content Configuration

Access the Manage Related Content Configuration page. (Select PeopleTools, Portal, Related Content Service, Manage Related Content Service.)

To manage related content services:

1. Click the Edit Configuration button to modify the assignment or the service configuration.

2. Click the Remove Configuration button to delete the assignment from the content reference.

Configuring Menu and Frame Layout

This section provides overviews of the related content menus configuration and the Related Content frames configuration and discusses how to:

• Configure the related actions menus.

• Configure the Related Content menu.

• Configure page field contextual menus.

• Configure the related content frames.

Understanding Menu Configuration

Menus provide access to related content services. Three menu layout options exist:

• Related Actions menus configuration can contain up to 3 levels of folders. Folders appear first in the menu followed by links.

• The Related Content menu configuration is a flat hierarchy and uses no folders.

• Page field contextual menus configuration can contain two sections: related actions and related content.

  Related actions appear first; this part of the menu can be hierarchical displaying folders and links.

  Related content appears last; this part of the menu is flat displaying links only.

Understanding the Configuration of Related Content Frames

PeopleSoft Related Content Framework enables you to configure related content to appear in two related content frames. The Related Content frames appear beneath and to the right of the transaction page so that users can view the transaction page and the related content simultaneously. When you assign related content to a content reference, you configure the services to appear either in the bottom frame or the right frame; the two frames cannot appear simultaneously.

Pages Used to Configure Related Content Service Layout

Configuring the Related Actions Menu

Access the Configure Layout page (Select PeopleTools, Portal, Related Content Service, Manage Related Content Service. Select the Configure Layout tab. Click the Configure Layout button in the Related Actions Menugroup box.)

1. Adjust any necessary folders within the hierarchy.

   See Working with Folders.

2. Move service links within the hierarchy.

   See Working with Services.

   See Selecting a Folder.

3. Click the OK button.

4. Click the Save button.

Working with Folders

When you select a folder, these options appear:

Note. Not all options appear for all folders.

Working with Services

When you select a service, these options appear:

Note. Not all option appear enabled for all services.

Selecting a Folder

Access the Select a folder page (Select a service link. Click the Move to Folder button.)

Select the new folder and click the OK button.

Configuring the Related Content Menu

Access the Configure Layout page (Select PeopleTools, Portal, Related Content Service, Manage Related Content Service. Select the Configure Layout tab. Click the Configure Layout button in the Related Content Menugroup box).

1. Select a service link.

2. Click the Move Up or Move Down button to move the service link.

3. Click the OK button.

4. Click the Save button.

Note. The system does not save the menu configuration until you click the Save button.

Working with Services

When you select a service, these options appear:

Configuring Page Field Contextual Menus

Access the Configure Layout page (Select PeopleTools, Portal, Related Content Service, Manage Related Content Service. Select the Configure Layout tab. Click the Configure Layout button in the Page Field Contextual Menugroup box).

1. Adjust any necessary folders within the Page Field Contextual Menu hierarchy.

   See Working with Folders.

2. Move service links within the hierarchy.

   Note. Links that appear beneath the Related Content menu can be moved up and down only, not into other folders.

   See Working with Services.

   See Selecting a Folder.

3. Click the OK button.

4. Click the Save button.

Working with Folders

When you select a folder, these options appear:

Note. Not all options appear for all folders.

Working with Services

When you select a service, these options appear:

Note. Not all option appear enabled for all services.

Selecting a Folder

Access the Select a folder page (Select a service link. Click the Move to Folder button.)

Select the new folder and click the OK button.

Configuring the Related Content Frames

Access the Configure Related Content Frame page (Select PeopleTools, Portal, Related Content Service, Manage Related Content Service. Select the Configure Layout tab. Click the Configure Layout button in the Related Content Frame group box).

1. Select the frame location. Choose either Bottom Frame or Right Frame.

   See Related Content Location.

2. Configure the order and initial state of the services that appear in the Related Content frame.

   See Related Content Frame Options.

3. Select the frame layout and appearance options.

   See Layout Options.

Related Content Location

Related Content Frame Options

Layout Options