Creating and Managing Related Content Service Definitions

Definable Service Types

You can explicitly define the following related content service types:

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

Related Content Services as Action Items

Action items in activity guides can be explicitly defined as related content services. When creating the service definition for an action item, you can ignore the display options and the security options. The basic PeopleTools transaction security model (user-role-permission list) is used to provide user access to the service. The following service types can be used as action items:

• Application class

• Non-PeopleSoft URL

• PeopleSoft component

• PeopleSoft query

• PeopleSoft script

See Creating and Maintaining Action Items.

Service URL Parameter Grid

Image: Service URL parameters

This example illustrates the fields and controls related to the Service URL Parameter grid. You can find definitions for the fields and controls later on this page.

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. You can manually define the RCF_SERVICE_PARAMETER attribute on the Content Ref Administration page for any content reference, such as for pagelets, iScripts, or for other content references that do not have a valid search record. If this RCF_SERVICE_PARAMETER 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 RCF_SERVICE_PARAMETER 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 overrides any search record parameters with the parameters included in the Attribute Value field.

• The attribute value format should follow this pattern:

  NAME1,Label1;NAME2,Label2 with NAME identifying the service parameter and Label identifying the label for the service parameter. For example, EMPLID,Employee ID;EXPENSEID,Expense ID.

• The NAME attribute value must not include spaces.

Image: Content Reference Administration page showing the RCF_SERVICE_PARAMETER attribute

The following example shows content reference definition that uses the RCF_SERVICE_PARAMETER attribute:

PeopleSoft Security Authorization Web Service

The PeopleSoft security authorization web service runs on PeopleSoft systems and certain service consumer 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.

The 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, and no other configuration is required beyond basic PeopleTools security setup.

However, row-level, or data permission, security is not automatic. Use the Authorization Configuration component to configure the authorization service to implement row-level security on remote systems. When 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 actions link to access the data. Procedures for configuration of the security authorization service are covered elsewhere.

See Understanding Developing and Invoking the Security Authorization Service.

Service Definition Security Options

At design time, you select which security options will be available when the service is assigned and configured for an application page. You can select one or more options to make available to the subject matter expert who assigns the service to a content reference. During the service configuration process, he or she selects the security option to be in effect when the service is accessed from a specific application page; therefore, a different security could be selected for use with a different application page. Before you allow a security option for a service, you should understand the service’s security model.

The framework offers four security options.

• Public access.

• Related content provider security.

• Related content consumer security.

• App class required.

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 the PeopleSoft component associated with the service.

See “Public Users” in Configuring Portal Security.

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 Compensation Details component in Payroll as the producer and the Employee component in an HCM environment as the consumer. If you select Related Content Provider Security, then the provider system (Compensation Details/Payroll) must provide the security.

As another example, the Related Discussion service of PeopleSoft Interaction Hub implements both provider security and consumer security. When provider security is selected, then the security model of the PeopleSoft Interaction Hub discussion forums is used, which means that the forum moderator is responsible for adding members and privileges for access to the forum.

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

• 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 Compensation Details component in Payroll as the producer and the Employee component in HCM as the consumer. 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.

App Class Required

When selected, this option indicates that a service filter is required when this service is assigned to an application page.

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.

Display Options

This table describes display option fields. Display options apply only when the subject matter expert configures the service to appear in the Related Content frame. These fields are common to all service URL types.

Select Security Options

This table describes security options.

Before you allow a security option for a service, you should understand the service’s security model.

See Understanding Service Security

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

An application class that will be used to define a related content service must import and extend the PT_RCF:ServiceInterface class. In addition, it must define a single method named execute.

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

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;

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.

See Step 3: Specifying Pagelet Data Source Parameters.

Embeddable Pagelet URL Example

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

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

URL Information

Service URL Parameter

Enter the names of all parameters that the component, iScript, or other PeopleSoft definition must have to render the service in the related content service frame.

PeopleSoft Generic URL Example

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

http://myserver.example.com/psc/ps/EMPLOYEE/PT_LOCAL/c/NUI_FRAMEWORK.PT_AGSTARTPAGE_NUI.GBL?CONTEXTIDPARAMS=TEMPLATE_ID:NAVCOLL_COMP&scname=PTGP_NAV_COLL

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://myserver.example.com/psc/ps/EMPLOYEE/PT_LOCAL/s/WEBLIB_PTEMBED.ISCRIPT1.FieldFormula.IScript_EmbeddedPageletBuilder?PAGELETID=OBIEE_REPORT&1) Markets.Region=EASTERN REGION

URL Information

Service URL Parameters

Enter any parameters that the external service requires. For example: q

Non-PeopleSoft URL Example

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

http://search.oracle.com/search/search?q=PeopleTools

Component Parameters

PeopleSoft Component URL Example

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

http://myserver.example.com/psp/ps/EMPLOYEE/PT_LOCAL/c/MAINTAIN_SECURITY.USERMAINT.GBL?OPRID=PTPORTAL

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://myserver.example.com/psc/ps_newwin/EMPLOYEE/PT_LOCAL/q/?ICAction=ICQryNameURL=PUBLIC.MESSAGES_FOR_MSGSET&MESSAGE_SET_NBR=240

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://myserver.example.com/psc/ps/EMPLOYEE/PT_LOCAL/s/WEBLIB_STOCK.ISCRIPT1.FieldFormula.IScript_StockQuote?stockquote=ORCL

URL Information

PeopleSoft Tile URL Example

The fully formed URL is not available for a PeopleSoft tile.

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 using the specified parameter values.

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

Component-Level Related Actions

At the component level, you can associate a bulk action with a service. The Look Up Service ID page and the Configure Service page reflect the selection of a bulk action.

Page-Level Related Actions

At the page level, a bulk action is available for a service that is linked to the related action widget. A bulk action is not available for a glyph. The Related Action Look Up page and the Configure Service page reflect the selection of bulk action.

Limitations

Bulk action functionality is not supported:

• In the Related Content frame.

• For the following service types:

  • Embeddable pagelet

  • Generic PeopleSoft URL

  • Non-PeopleSoft URL

  • OBIEE pagelet

  • PeopleSoft query

  • PeopleSoft tile

Bulk Action Availability for Authorized/Unauthorized Rows

The bulk action functionality is available or not available in the following scenarios: