Developing and Configuring Related Content

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.

• Create security handlers.

Understanding the PeopleSoft Related Content Framework

This section provides an overview of the PeopleSoft Related Content Framework and discusses:

• Configuration flexibility

• Related content development process flow

• Delivered related content services

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 provide immediate access to relevant, contextual information for any PeopleSoft transaction 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 completing business tasks. A related content service is any content, such as a discussion forum, wiki page, or PeopleSoft content reference, 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 database and non-PeopleSoft data.

Note. The terms related content and related content service are synonymous in this chapter.

The terms related content service definition and service definition are synonymous in this chapter.

Configuration Flexibility

The Related Content Framework is designed so that you can assign, configure, and maintain existing related content services without access to developer tools such as PeopleSoft Application Designer. The related content pages provide a variety of configuration options, which enable you to associate related content services to transactions pages based on your business rules.

Contextual Menus

You can configure related content services so that users can access them by using contextual menus. You can configure three types of contextual menus:

• The related content menu, which appears as the Related Information menu at the top of the page.

• The field-level pop-up menu, which appears when you right-click the red related content glyph associated with a field.

• The drop-down menu, which appears as the Actions list that you use with SmartNavigation pages.

The Related Content menu in the pagebar accesses related content has been assigned to the Resources by Activity page.

The pop-up menu on the Project field accesses related content has been assigned to the field.

The Actions drop-down menu indicates that related content has been assigned to this SmartNavigation page.

Target Areas

You can configure related content services to display content in these locations:

• In the related content frame that appears directly beneath the primary page.

• In the current page target content frame, replacing the current transaction page.

• In a new window.

The related content frame enables simultaneous viewing of both the transaction page and the related content. The related content frame is configurable and easy to use. When working with the related content frame, you can set configuration options so that users can:

• Refresh the frame contents by clicking the refresh button in the frame header .

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

• Collapse the frame by clicking the collapse button to the left of the Related Information frame header.

• Close the frame by clicking the close button.

Related Actions

Related actions are a specific type of related content that you associate uniquely with SmartNavigation pages. SmartNavigation pages are dynamically generated navigation pages that combine the portal Main Menu structure, your own hierarchical application data from trees and rowsets, and PeopleSoft charting metadata to form a new, intuitive way to access transaction data in components.

Related actions appear as links in an Actions drop-down menu, which you find on the nodes on SmartNavigation pages. This example shows two nodes from a SmartNavigation page, the Actions menu, and a related action link:

The advantages of using related actions on SmartNavigation pages include:

• The application user saves time because with the search key details embedded in the nodes and leaves, the system passes the detail values directly to the search process and populates the page—eliminating the need to use a search page.

• You increase productivity by providing one-stop access for many related components because PeopleSoft components that share a similar search key structure can be configured and grouped as actions at the node level to support your business rules.

• Application users do not have to remember complex navigation paths to components because the link appears with the data.

Note. Related actions also appear in Action folders that you see in SmartNavigation folders in the Main Menu drop-down menu structure. Unlike other links, the links in Actions folders are not active.

Related Content Development Process Flow

The following diagram illustrates the Related Content Framework development process flow along with the role involved in each step.

Development process flow for related content development and implementation

This table lists the steps in the process flow, the role, and provides cross-references to supporting PeopleBooks documentation:

Delivered Related Content Services

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

• Related Discussion service

• Related Links service

• Related Tags service

These related content services provide features of Oracle’s PeopleSoft Enterprise 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 Enterprise Portal database is required to provide the services and to store the related data.

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

See PeopleSoft Enterprise 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 Enterprise 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 Enterprise Portal PeopleBooks.

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

Related Links Service

The Related Links related content service allows 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 Enterprise Portal—specifically, blogs, discussions, or collaborative workspaces—or external URLs. In addition, the Related Links service allows 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 Enterprise Portal PeopleBooks.

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

Related Tags Service

The Related Tags related content service allows 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 Enterprise Portal PeopleBooks.

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

Prerequisites

You must perform the following configuration tasks before defining and configuring related content services:

Common Elements Used in This Chapter

This section describes the common elements used in defining related content services.

Related Content Service

This table describes the common fields on the Define Related Content Service page. These fields 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 Parameter

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.

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

Display Options

This table describes display options 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.

See Also

Understanding Related Content Services Security

Defining Related Content Services

This section provides an overview of service URL types and 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 Related Content Framework supports seven 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 you select. For example, when you select PeopleSoft 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.

You can create the following related content service types:

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

Understanding Related Content Services Security

Related content services implement security in a variety of ways. It is crucial that you understand the security model that is native to the service definition before you define the service definition. If you select a security option for a service definition that isn't applicable to the service definition type, unexpected results can occur.

Related Content Security Options

When you define a related content service, you can select security options to make available to the administrator who assigns the service to components.

The fields associated with security options do not enforce security. Security option fields are flags which indicate to the service where to look for the security associated with this service definition. This table describes the related content security options.

Contextual Menu Links

Related content security options enable you to control access to related content links in most scenarios. However, when you define related content services that are outside of the local node, the link appears in the contextual menu even if the application user does not have access to the page. The link appears because the local node has no awareness of non-local permission list security until the user attempts to access the non-local service. However, if the user attempts to access the service, the permissions of the target node are applied at that time and a warning dialog appears, requesting the user to contact the system administrator.

Pages Used to Define Related Content Services

Defining Application Class Related Content Services

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

Application Class Parameters

Application classes must instantiate the PT_RCF:ServiceInterfacebase class. The options, fields, and mapped parameters are retrievable through API calls of the base class. Application class-based services support transfer-based links only.

The application class fields are validated when you save the definition; the service does not allow you to save 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;

Defining Non-PeopleSoft Related Content Services

Access the Define Related Content Service page (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

Defining PeopleSoft Component Related Content Services

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

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

Defining Embeddable Pagelet Related Content Services

Access the Define Related Content Service page (PeopleTools, Portal, Related Content Service, Define Related Content). Select the PeopleSoft 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 populates 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

Defining PeopleSoft OBIEE Pagelet Related Content Services

Access the Define Related Content Service page (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, 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 populates 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

Defining PeopleSoft Query Related Content Services

Access the Define Related Content Service page (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 populates 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

Defining PeopleSoft Script Related Content Services

Access the Define Related Content Service page (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, it is advantageous 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 - Map fields page.

Important! It is imperative to 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 the user 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 Related Content Service Definition 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 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.

Assigning and Managing Related Content Services

This section provides an overview of related content and related actions configuration and discusses how to:

• Assign related content to components, pages, and fields.

• Configure related content service parameters.

• Configure contextual menus.

• Configure the related content frame.

• Manage related content configuration.

Understanding Related Content Configuration

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.

When you assign related content services to content references, you configure how the application user accesses the related content and where the related content appears. It is at this stage that you configure the contextual relationships between the transaction data and the related content by mapping service parameters to the fields on the transaction page.

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

Important! For all service types other than PeopleSoft components, service definitions must exist before you can perform any configuration tasks.

Understanding Related Actions Configuration

SmartNavigation pages are dynamically generated folder structures that combine your own hierarchical application data from trees and rowsets, and PeopleSoft charting metadata to form a new, intuitive way to access transaction data in components.

See Defining Standard Navigation Folders.

Related actions are a specific type of related content that appear as links in an Actions drop-down menu, which you only find on nodes that appears on SmartNavigation pages. This example shows two nodes on a SmartNavigation page and the Actions drop-down menu.

You configure related actions the same way that you configure other types related content services. 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, which 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 click 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 component. 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"

See Also

Defining Tree Details

Accessing Definitions and Associated PeopleCode

Pages Used to Assign and Manage Related Content Services

Assigning Related Content to Components, Pages, and Fields

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

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.

See Managing Related Content Configuration.

Click the Assign Related Content to Application Pages link to get started. This accesses the page where you select the content reference to which you are assigning the related content.

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

Select Include hidden Crefs to make hidden content references available for assignment. Selecting this check box redraws the tree including hidden content references in the system. Clearing it redraws the tree with only the visible content references in the system.

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 as components on different menus might have different business requirements.

These tables describe the fields that appear on the Assign Related Content page:

Service Level

Note. The same service cannot be assigned at both the component and page levels. If you decide to change the level at which the service appears, you must remove it from the existing level before assigning it at the new level.

Related Content to Display

The fields in this grid change depending on the service level that you select. This table describes all possible fields.

Configuring Related Content Service Parameters

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 in which type of menu the service link is listed, 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.

The following sections describe configuration options and default settings for the various service type and service target combinations.

Contextual Menu Options for Component Level Services

If the service target is the related content frame, you can configure the service to appear in contextual menus as indicated in this table:

If the service target is a new window or the target content frame, you can configure the service to appear in contextual menus as indicated in this table:

Note. The framework does not prevent you from configuring a service to appear in multiple contextual menus on the same page. Always have a valid business rule or business process that guides you in configuring menu options.

Related Content Menu Options for Page Level Services

This table describes menu availability options for page level services.

Note. The framework does not prevent you from configuring a service to appear in multiple contextual menus on the same page. Always have a valid business rule or business process that guides you in configuring menu options.

Service Configuration

Access the Related Content Service - Configure page, (on the Assign Related Content page, click the Configure link.

Page Name	Displays the name of the page if you are configuring page level services. This field is display-only.
Service Name	Displays the name of the service as defined on the Related Content Service Definition page. This field is display-only.
Read help text	Click to display the help text as defined on the Related Content Service Definition page. See Writing Help Text for Related Content Service Definitions.
OK	Click to return to the Assign Related Content page and save the configuration.

Map Parameters

The fields that appear in the Map Parameters grid vary depending on the service level type and the service type. This table describes all of the fields that can appear in the Map Parameters grid.

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

See Related Content Reserved Words and Service Parameters.

Select Menu Type

Not all options are available for every service. Availability is based on service type and service target.

Service Filter

A service filter hides or displays a service link in a field-level or related actions contextual menu based on the value in the field at runtime. The PeopleCode application class that you specify in these fields can access the component buffer, using field values to trigger data-specific logic that causes the related content service link to be visible or invisible based on the value of the field.

Service Security Options

This section appears only when the service target is the related content frame; additionally, only the security options specified in the related content service definition are available. This table describes the possible options:

Note. You must select a security option.

Note. You must click the OK button to return to the Assign Related Content page and save your service parameter settings.

Configuring Contextual Menus

After you assign related content services to specific menu types, you can configure the order that the services appear in the contextual menus and in the related content frame. This section describes how to configure the order of the links in field-level menus and the Related Content menu.

Access the Configure Menu Options page. (PeopleTools, Portal, Related Content Service, Manage Related Content Service. Click the Configure Menus tab.)

All fields on the Configure Menu Options page are display-only; the Configure link is active.

Menu Options

Access the Menu Options page. (On the Configure Menu Options page, click the Configure link associated with either the Related Actions Menu, the Related Content Menu, or a Field Menu row).

The display-only fields on this page provide details for the services that you access from the contextual menus. You can order the sequence in which the links appear in the menu by changing the value in the Sequence Number field.

Note. Click the OK button to return to the Configure Menu Options page and save your settings.

Configuring the Related Content Frame

You configure the order that services appear in the related content frame similarly to the way that you configure contextual menu options. You use the Menu options page; the page, however, offers more options that are specific to the related content frame.

Access the Menu options page where you by clicking the Configure link associated with the Related Content Frame display type.

The display-only fields on this page provide details for the services that appear in the related content frame. This table describes other fields in the Configure Related Content Frame grid.

Note. Click the OK button to return to the Configure Menus page, where you must save your settings.

Managing Related Content Configuration

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 this page to modify existing related content assignments.

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

Services Assigned to Application Pages

This table describes elements used to assign and manage related content services.

Creating Security Handlers

This section provides an overview of related content security handlers and describes how to define security handlers.

Page Used to Create Related Content Security Handlers

Understanding Security Handlers

Security handlers are PeopleCode application packages that define the way security is enforced when accessing related content outside of the local node. You associate a content reference in the remote system to security logic that you write into an application class.

Default Security Handler

Developers must create new security handlers and application classes or use the default security handler, PeopleToolsBasicSecurity (PTCS_SECURITY application class). The default security handler uses these three methods:

onAccessRequest(&MSG As Message) Returns Message; - determines whether the current user has access to the remote related content.

onSearchRequest(&MSG As Message) Returns Message; - determines whether the current user has access to search the information in the related content discussion.

onHelpInfoRequest(&MSG As Message) Returns Message; - determines whether the related content has associated Help information.

The default security handler includes no data-level security. If you want data or row-level security, you must write the logic into the application class of the security handler.

Defining Security Handlers

Access the Related Content - Security Handlers page (PeopleTools, Portal, Related Content Service, Security Handlers).

Handler Name	Enter a unique name for the handler.
Default Security	Select this check box to use the default delivered security.
Cref Name	Enter the name of the content reference to which you wish to apply the security logic.
Root Package ID	Enter the name of the application package that contains the security logic.
Qualified Package/Class Path	Enter the names—delimited by colons—of each subpackage in the hierarchy that drills down to the class that contains the method that defines the security logic.
Class ID	Enter the class name for the security logic.
Method	Enter the name of the method that invokes the security logic.
Description	Enter a short description of the handler.