Return to Navigation

Administering Content References

This section discusses how to:

Access the Content Ref Administration page (select PeopleTools, then select Portal, then select Structure and Content. Navigate the portal registry hierarchy until you are in the parent folder for the content reference; then click the Add Content Reference link.)

Image: Content Ref Administration page

The following screenshot illustrates how to define content reference on the Content Ref Administration page.

sm_contentrefadminPage

Note: Many of the fields described in this section appear only when you enter certain field values.

Many of these fields are similar to fields on the Folder Administration page.

When you save a content reference that points to a PeopleSoft component or script on the default local node, the security settings for the content reference are inherited automatically from the menu or script security settings. Any permission lists or roles that you enter on the Content Reference Security page before saving the content reference are deleted and replaced by those of the component or script. These new security settings are also propagated up the folder hierarchy. This ensures that the content reference is visible and all folders are viewable, enabling users to navigate to the component.

Warning! Do not add internal component-based PeopleSoft content references using the Content Ref Administration page. Use the registration wizard instead so that information is consistent between PeopleSoft Application Designer and the portal. Any changes made to the menu definition in PeopleSoft Application Designer and not made to the portal content reference definition break the content reference. The portal navigation system uses the portal registry, not the internal location of menu definitions in PeopleSoft Application Designer.

See Understanding the Registration Wizard.

This table describes the fields that appear on the Content Ref Administration page:

Field or Control

Definition

Usage Type

Select from these usage types:

  • Frame template.

  • Homepage tab.

  • HTML template.

  • Inline frame template.

  • Pagelet.

    Important! The portal recognizes pagelets that are registered as portal objects in the Pagelets folder only. This restriction is not enforced by the portal registry; you can create a pagelet that is not recognized.

    The name that you specify for a new pagelet can consist of letters, digits, and underscores ( _ ). It cannot contain any spaces and cannot begin with a digit.

  • Target.

    This is the default value.

Based on the value that you select, the application shows, hides, disables, and enables the other fields on the page so that only the fields that are relevant to the usage type are available. For example, if you select a usage type of Pagelet, then Pagelet Attributes group box appears in which you can specify the default column, the refresh time, and other properties that apply specifically to pagelets.

For a typical PeopleSoft application page, set the usage type to Target (the default value) and the URL type to PeopleSoft Component. With a usage type of target, the content will populate the target area on the page.

Storage Type

This field is enabled when you selected a usage type of Frame template or HTML template.

Select Local (in HTML Catalog) or the default value, Remote by URL.

HTML Area

This text area is enabled when you select a usage type of HTML template or Frame Template and Local (in HTML Catalog) as the storage type.

An HTML template uses the HTML that is entered into the HTML area of a content reference that is located in the Templates folder, which you find within the Portal Objects folder. Bind variables cannot be used within the HTML area. The HTML area includes any HTML that is required for the template itself, plus tags that specify the URLs for template pagelets.

Template Name

Select the template for this page. If you leave this field blank, the portal servlet automatically uses the default template of the node at runtime. The node default template is set up on the General Settings page. If a node default template has not been specified, it uses the portal default template.

WSRP Producible

This option appears only for usage types of Target and Pagelet. Select this option for PeopleSoft content that you intend to expose for remote WSRP portals to consume.

No Template

Select to have the target content (your application page) not wrapped with a portal template at runtime; by viewing your page, the user is effectively taken outside of the portal environment (this is not usually desirable). When this check box is selected, the Template Name field is hidden.

Create Content Reference Link

Click to create or edit a content reference link.

Add Content Reference

Click to add a content reference.

Test Content Reference

Click to test a content reference.

See Creating Related Links.

Hide from portal navigation

Select to hide the content reference from menu navigation.

Hide from MSF Navigation

MSF is not currently supported.

IWC Message Events

Click to access the Interwindow Communications page.

See Publishing and Subscribing to IWC Messages.

URL Information

The fields that appear in this group box are based on the selection that you make in the URL Type field.

Field or Control

Definition

Node Name

Select the node for this page. Select Always use local to associate the page with the default local node. The default local node is designated on the Portal Definitions page.

URL Type

Select from these URL types:

  • Non-PeopleSoft URL: Enter the URL in the Portal URL field that appears.

    This usage type can also be used in conjunction with a defined node. The result is the concatenation of the selected node's URI text and the portal URL that you entered.

  • PeopleSoft Component: The Component Parameters region appears. Select the menu name, market, and component name to use for this content reference.

  • PeopleSoft Generic URL: Enter the URL in the Portal URL field that appears.

    This usage type can also be used in conjunction with a defined node. The result is the concatenation of the selected node's URI text and the portal URL that you entered.

  • PeopleSoft Homepage Tab: In the Homepage tab attributes group box you can, designate a homepage as a dashboard page, add help functionality to a homepage tab, hide the pagelet action bar, and grant users the privilege to rename the homepage.

  • PeopleSoft Script: The iScript Parameters group box appears. Select the record (table) and field names, PeopleCode event name, and PeopleCode function name that specifies the iScript to use.

  • PeopleSoft Worklist URL: Enter the URL in the Portal URL field. Use the following format:

    w/WORKLIST?ICAction=ICViewWorklist&Menu=Worklist&Market=GBL&PanelGroupName=WORKLIST
  • Remote Portlet: Select the producer and the portlet that you want to register manually. Only producers that have been registered are available for selection. Values for the fields Label and Long Description are supplied by default to the portlet's title and description. You can change these values. Click Producer Details to display the Display Producers page and view remote producers that have been defined in the system.

    See Using the WSRP Consumption Wizard (Consumer).

Note: The availability of these options depends on the selected usage type.

Additional Parameters

Enter query string parameters to be appended onto a PeopleSoft component or PeopleSoft script. For example, enter emplid=8001.

Pagelet Attributes

The Pagelet Attributes group box enables you to manage pagelet behavior and appearance.

See Using Attributes to Enhance Pagelets.

Content Reference Attributes

Content reference attributes provide a framework to specify and store free-form information about a content reference. For example, you can use content reference attributes to specify and store keywords, help information, related content properties, and related links for content references.

In addition, portal-aware applications can use content reference attribute information for application-specific processing. Portal-aware applications are those that:

  • Know about the portal registry and API.

  • Know how to get information from a content reference.

  • Contain code that can access the properties of content references and do something meaningful with the information.

Field or Control

Definition

Name

Enter an object name to identify the attribute programmatically. This name is not displayed to the user.

Note: The name can consist of letters, digits, and underscores ( _ ) only. It cannot contain any spaces and cannot begin with a digit.

Translate

Select to specify that the label and attribute values are translated.

Attribute Information

Click to create related links. You can create related links only after entering RELLINK in the Name field.

Label

Enter a descriptive name for the attribute to display to the user. The label is required only if Translate is selected.

Attribute value

Enter information about the attribute that the portal uses to apply the attribute to the content reference.

Links

This grid appears only if content reference links that connect to this content reference exist. Click Link Definition to view the definition of each listed content reference link.

Available Content Reference Attributes

This table describes the content reference attributes that your PeopleTools portal recognizes:

Content Reference Attribute Name

Description

BCUPDATELABEL

Use this attribute to override the default label in the breadcrumbs.

See Overriding Default Breadcrumbs.

BCUPDATETYPE

Use this attribute to override the default breadcrumb update behavior.

See Overriding Default Breadcrumbs.

KEYWORD

KEYWORD_LNG

Use these attributes to specify a keyword or phrase that you want to associate with this content reference. Specific portal features, such as the Pagelet Search page, make use of these keywords when searching for definitions.

Note: However, while the KEYWORD attribute is also included in Verity-based search indexes, it is not included in indexes generated by the PeopleSoft Search Framework.

KEYWORDS

Use this attribute to specify keywords that you want to associate with this content reference for searching on the Manage Related Content for Content References page.

See Managing Related Content.

Name of a default homepage object or image

Use this attribute to override a default HTML object or image used for homepage components, such as tabs and pagelets, by providing the name of an alternative HTML object or image.

Note: You can override only a specified set of homepage objects and images.

IMAGE_BIND_12 to IMAGE_BIND_26

Use these attributes (numbered from 12 to 26) to insert additional custom images on a homepage tab.

NAVNEWWIN

Use this attribute to specify that the component or page always opens in a new browser window.

Note: This attribute applies to links on navigation collection template pagelets that appear in the pagelet area of a WorkCenter page.

NAVTOPWIN

Use this attribute to specify that the component or page opens in the current browser window and replaces the current page completely.

Note: This option affects only the link behavior when it is rendered in a navigation collection template pagelet inside the pagelet area of a WorkCenter page.

PSCACHECONTROL

Use this attribute to implement caching for individual pagelets and targets based on user, role, or application.

PORTAL_BANNER_PGLT

Use this attribute to create a banner pagelet, which can appear at the top of a homepage or dashboard page and spans the width of the page.

Note: To use a pagelet as a banner pagelet, it has to be added to a homepage tab or dashboard page as a required-fixed pagelet in the first column.

See Maintaining Pagelet Branding Attributes.

PORTAL_ENCODING_OVERRIDE

Use this attribute to override the character set encoding that is used by the content reference.

PORTAL_HP_COMPONENT

Use this attribute to hide pagelet attributes such as the title bar, the borders, or both.

See Maintaining Pagelet Branding Attributes.

PSTIMEOUT

Use this attribute to specify how long the portal should wait for a pagelet to load before it considers the pagelet unavailable.

PT_PORTAL_PGLT_HDR_IMG

Use this attribute to add an icon to the header of the pagelet.

The attribute value should be the name of the image definition that is stored in the image catalog using PeopleSoft Application Designer.

PTPPB_PAGELET_HELP_LINK

Use this attribute to specify a URL that you want to associate with the help link for a pagelet.

Note: This attribute takes priority over a PeopleSoft Help ID if both properties are set.

RCF_SERVICE_PARAMETER

Use this attribute to provide related content service parameters in name/label pairs for the content reference. The presence of this attribute changes the default behavior of component-based URLs and supplants all parameters with those that you enter in the Value field.

See Defining Related Content Services.

RELLINK

Use this attribute to create related links for the content reference.

Content Reference Type Parameters

This table summarizes the valid combinations of usage type, storage type, and URL type or key HTML content supported for content references:

Usage Type

Storage Type

URL Type or Key HTML Content

Frame template

Remote by URL

PeopleSoft Script

Frame template

Remote by URL

Non-PeopleSoft URL

Frame template

Local (in HTML Catalog)

Target or IClientComponent element

Target

Remote by URL

PeopleSoft Component

HTML template

Local (in HTML Catalog)

Target, Pagelet, or Source element

HTML template

Remote by URL

PeopleSoft Script

HTML template

Remote by URL

Non-PeopleSoft URL

Homepage tab

Local (in HTML Catalog)

PeopleSoft Homepage tab

Inline Frame template

Local (in HTML Catalog)

Target or Pagelet component

Inline Frame template

Remote by URL

PeopleSoft Script

Inline Frame template

Remote by URL

Non-PeopleSoft URL

Pagelet

Remote by URL

Non-PeopleSoft URL

Pagelet

Remote by URL

PeopleSoft Component

Pagelet

Remote by URL

PeopleSoft Script

Pagelet

Remote by URL

PeopleSoft Generic URL

Pagelet

Remote by URL

PeopleSoft Worklist URL

Pagelet

Remote by URL

Remote Portlet

Target

Remote by URL

PeopleSoft Generic URL

Target

Remote by URL

PeopleSoft Script

Target

Remote by URL

PeopleSoft Worklist URL

Target

Remote by URL

Non-PeopleSoft URL

Target

Remote by URL

Remote Portlet

You can create related links for a portal page using the RELLINK content reference attribute. You can create related links to external sites, to internal sites, and to other portal pages.

Note: Related links can be implemented with your choice of template on the content reference. Using the PeopleTools Related Links template displays the related links for the content reference, but not the portal menu navigation.

To create related links:

  1. Define the RELLINK content reference attribute.

  2. Create related links groups.

  3. Create related links for each group.

  4. Test the related links.

Image: Related links for a content reference

In this sample page screenshot, you see the results of using the related links template and adding the RELLINK attribute on a given content reference:

sm_RELLINKAttributeResultsOnContentReference7ec5_tprt3507

This table describes the page elements shown in the sample page:

Page Element

Description

Related Links

RELLINK content reference attribute with the label Related Links.

External Sites

A related link group defined with the label External Sites.

Site #1, Site #2, Site #3

Related links for the External Sites group.

PeopleSoft Sites

A related link group defined with the label PeopleSoft Sites.

Batch rules, Developers' site, and User maintenance

Related links for the PeopleSoft Sites group.

Defining the RELLINK Content Reference Attribute

To define a related link content reference attribute:

  1. Access the Content Ref Administration page (select PeopleTools, then select Portal, then select Structure and Content. Navigate to the appropriate content reference; then click the Edit link.)

  2. Enter RELATEDLINKS_TEMPLATE. in the Template Name field.

  3. In the Name field of the Content Reference Attributes region, enter RELLINK.

    After you enter this value and move out of the field, the Attribute Information link changes to Edit Related Links.

  4. Verify that the Translate check box is selected.

  5. Enter a label for the related links attribute.

Note: You do not need to enter any information in the Attribute Value field. After you create the related link group and the related links, the system populates this field with all defined attributes as a string.

Creating Related Link Groups

Access the Related Links Group (PORTAL_RLNK_ADM) page.

To create a related link group:

  1. In the Related Link Groups Label field, enter a name.

    This name is the heading under which you place related links.

  2. To create additional related link groups, click Add and repeat step 1.

Creating Related Links

To create a link:

  1. In the Related Links region on the Related Links Group (PORTAL_RLNK_ADM) page, enter a name in the Related Link URL Label field.

    This name appears as a link under the group name.

  2. If you're linking to an internal site, select a node name from the list.

    If you're linking to an external site, leave this field blank.

  3. In the Related Link URL field, enter URL information for the link.

    If the link is to an internal site, enter the URL or URI. The URL or URI can be to an internal site, to a portal, and so on. If you specified a value for the Portal URI Text field on the node definition, you can enter a specific document name as the target. The name is appended to the URI text for a full URL.

    If the link is to an external site, enter the URL.

  4. To define additional links for the group, click Add and repeat steps 2 and 3.

  5. Click OK to save the entry and return to the Content Ref Administration page.

    The Attribute Value field is populated with an XML-type formatted string. This string contains all the related link data and is stored in the PORTAL_ATTR_VAL field of the PSPRSMATTRVAL record for the content reference specified in the PORTAL_OBJNAME field. The following example shows a generated XML-type formatted string:

    <GRPLBL>Worklist Pages
    		<URLLBL>Worklist Details</URLLBL>
    		<CP>Portal</CP>		<URL>ICType=Panel&Menu=WORKLIST&Market=GBL&PanelGroupName=WORKLIST_DETAILS
    		</URL>
    		<URLLBL>Worklist Monitor</URLLBL>
    		<CP>Portal</CP>		<URL>ICType=Panel&Menu=WORKFLOW_ADMINISTRATOR&Market=GBL&PanelGroupName=WF_MONITOR_01
    		</URL>
    	</GRPLBL>
    
    	<GRPLBL>Tasks
    		<URLLBL>Task List Summary</URLLBL>
    		<CP>Portal</CP>
    		<URL>ICType=Panel&Menu=PORTAL_COMPONENTS&Market=GBL&PanelGroupName=EO_PE_TASK_LIST		</URL>
    </GRPLBL>

Testing Related Links

You should test related links to view how the page appears to users, ensure that the labels are correct, and verify that the links function properly. To test related links, click Test Content Reference on the Content Ref Administration page just above the URL Information region.

Note that:

  • If the portal cache is enabled on the web server, the related link template does not appear for a content reference page accessed from the menu until the cache expires.

  • Related link URLs are displayed only when a user has security access to the URLs.

    To grant security access to a related link URL, register the related link URL as a separate content reference and associate permission lists with it.

    If the related link is not separately registered, then it is treated as having public access.

    If a related link group contains no URLs to which the user has security access, the related link group is hidden. If the user does not have access to any of the related links associated with the target page, then the related links section of the template is hidden.

If the target page does not display any related links, ensure that:

  • The application and portal databases are registered as content providers.

    Also check for data-entry errors.

  • The templates are registered in PeopleSoft Application Designer with the correct names.

    If the templates are registered, check for data-entry errors.

  • The correct related link template is specified for the target page.

    Also ensure that the value of the PORTAL_TEMPL_NAME field in the PSPRSMDEFN record displays a correct related link template

  • The RELLINK string was saved on the target page in the content registry.

    Check whether an XML string appears in the Attribute Value field on the Content Ref Administration page. If not, then delete and reenter the RELLINK attribute for all the related link information.

  • You assigned security in the registry to the user for the content references listed as related link URLs.

    If not, assign security using the Content Reference Security page for registered related link URLs.

Access the Content Reference Security page (Select select PeopleTools, then select Portal, then select Structure and Content.Click the Edit link for a content reference; then select the Security tab.)

Image: Content Reference Security page

The following screenshot illustrates how to set content reference permissions on the Content Reference Security page.

sm_ContentReferenceSecurityPage

This page is similar to the Folder Security page. You can specify the permission lists and roles that grant security access to the content reference.

Certain URL types inherit the security permission list and role authorizations from the referenced object. For these URL types, you can view, but not modify the security by using the Content Reference Security page. All fields except Public and Author Access are display-only. This is the list of URL types that inherit security authorization:

  • PeopleSoft Component.

  • Worklist.

  • PeopleSoft Script.

When you save a content reference that points to a PeopleSoft component or script on the default local node, the security settings for the content reference are inherited automatically from the menu or script security settings. Any permission lists or roles that you entered on the Content Reference Security page before saving the content reference are deleted and replaced by those of the component or script. These new security settings are also propagated up the folder hierarchy. This ensures that the content reference is visible and all folders are viewable, enabling users to navigate to the component.

Note: If you copy, move, or add a content reference to a folder, the security settings of the content reference are propagated up the folder hierarchy. This ensures that the content reference is visible and all folders are viewable, and it enables users to navigate to the content reference. If you remove the content reference from that folder, the security settings that were applied when it was added to the folder are also removed from the folder hierarchy, without disturbing any settings still required for other content references remaining in that folder.

Note: Content reference links do not inherit cascaded security from folders.

You can use automated queries to discover the content references to which a given user, permission list, or role has access. Each query provides a different degree of detail about the properties of the content references.

Reviewing Content Reference Security by User

Access the User ID Queries page (select PeopleTools, then select Security, then select User Profiles, then select User Profiles, then select User ID Queries).

This page contains several general-purpose security queries, along with the following links to content reference access queries for the selected user, which are described on the page:

  • User ID's Content Reference Access.

  • User ID's Content Reference (includes Portal) Access.

  • User ID's Content Reference (includes Menu, Component and Market) Access.

  • User ID's Content Reference (includes Portal, Menu, Component and Market) Access.

When you click one of the query links, a page appears in a new window, containing a grid with the information described for each content reference.

Reviewing Content Reference Security by Permission List

Access the Permission List Queries page (select PeopleTools, then select Security, then select Permissions & Roles, then select Permission Lists, then select Permission List Queries).

This page is similar to the User ID Queries page, with the following equivalent links to content reference access queries for the selected permission list:

  • Permission List's Content Reference Access.

  • Permission List's Content Reference (includes Portal) Access.

  • Permission List's Content Reference (includes Menu, Component and Market) Access.

  • Permission List's Content Reference (includes Portal, Menu, Component and Market) Access.

When you click one of the query links, a page appears in a new window, containing a grid with the information described for each content reference.

Reviewing Content Reference Security by Role

Access the Role Queries page (select PeopleTools, then select Security, then select Permissions & Roles, then select Roles, then select Role Queries).

This page is similar to the User ID Queries page, with the following equivalent links to content reference access queries for the selected role:

  • Role's Content Reference Access.

  • Role's Content Reference (includes Portal) Access.

  • Role's Content Reference (includes Menu, Component and Market) Access.

  • Role's Content Reference (includes Portal, Menu, Component and Market) Access.

When you click one of the query links, a page appears in a new window containing a grid with the information described for each content reference.

After creating or modifying a content reference and setting up permissions, test the content reference.

  1. Click Home in the portal navigation header

  2. Use the Menu pagelet or the Main Menu to navigate to the content reference.

  3. Click the content reference.

You can also click the Test Content Reference on the Content Ref Administration page.

Note: The Test Content Reference link appears on the Content Ref Administration page when the usage type of the content reference type is set to Target only.

Access the Select a Content Reference or Content Reference Link page (Select select PeopleTools, then select Portal, then select Structure and Content. Navigate the portal registry hierarchy into the parent folder in which you want the link to appear. Click the Add Content Reference Link link that appears after the Content References group box.)

Image: Select a Content Reference or Content Reference Link page

The following screenshot illustrates how to define content reference links on the Select a Content Reference or Content Reference Link page.

sm_selectCreforCrefLinkpage

Click the folder icons to navigate the tree structure until you find the target of the link. Click the link and the Content Reference Link Administration page appears.

Image: Content Reference Link Administration page

The following screenshot illustrates selecting content reference or content reference link page on the Content Reference Link Administration page.

sm_ContentRefLinkAdministrationPage

PeopleSoft portals store content references based on their URLs, so you can't register two different content references that specify the same URL. Content reference links overcome this limitation by enabling you to define more than one menu item that invokes a given URL. You define a content reference link like any other content reference, but instead of specifying a URL, you specify an existing content reference as its destination. At runtime, clicking the content reference link on the portal menu connects to the destination content reference by URL.

Note: To the user, a content reference link looks and works the same as a content reference on the portal menu.

A content reference link can point to:

  • A content reference of usage type Target.

  • Another content reference link.

You can define a content reference link in the same locations that you can define a content reference of usage type Target. Multiple content reference links can connect to a single destination content reference.

By connecting one content reference link to another content reference link, you can create a chain of redirection, which always ends in a content reference of usage type Target. You don’t need to know what the ultimate destination is when you define your new content reference link, and you can duplicate the property settings of the content reference link to which it connects rather than those of the ultimate destination. However, Oracle recommends that you limit your use of chains of content reference links because they impose processing overhead on your portal when selected.

Warning! If you delete a destination content reference or content reference link, all content reference links that connect to it are also deleted. This behavior propagates back through any content reference link chain.

Target Information

Field or Control

Definition

Name

Select the destination content reference to which you want this content reference link to connect.

Portal

Select the portal that contains the destination content reference to which you want this content reference link to connect. The Always use local value refers to the portal where the content reference link is defined, so moving or copying it to a different portal changes the resolution of this value.

Important! If you change this value, you must also select a new link content reference.

Link Information

Field or Control

Definition

Name

Enter a unique object name for this content reference link. This field is required.

Test Content Reference Link

Click to test this content reference link. Clicking this button should produce the same result as clicking the content reference link from the portal menu.

If you omit values in following fields, their values are inherited from the destination content reference:

  • Label.

  • Long Description.

  • Product.

  • Sequence number.

  • Object owner identifier.

  • No Template.

  • Template Name.

  • Valid from date.

  • Valid to date.

URL Information

These fields are display-only and reflect the URL information of the content reference that you are linking to.

See “URL Information” in Defining Content References.

Content Reference Attributes

If the destination content reference has defined content reference attributes, they appear in this grid. You can copy them from the grid to the Content Reference Link Attributes group box using the following page elements:

Field or Control

Definition

Select

Select to designate a content reference attribute for copying to the Content Reference Link Attributes group box.

Select All

Click to designate all content reference attributes for copying to the Content Reference Link Attributes group box.

Copy

Click to copy the selected content reference attributes to the Content Reference Link Attributes group box.

Content Reference Link Attributes

Content reference link attributes and content reference attributes share the same page fields.

You can define content reference link attributes directly in this group box, or you can copy an attribute from the destination content reference using the Content Reference Attributes grid, and modify it to suit your purposes.

At runtime, the content reference link attributes defined here are combined with the content reference attributes defined at the link destination, and they are applied together.

Important! If a content reference link attribute defined here has the same name as a content reference attribute defined at the link destination, but a different attribute value, the value defined here takes precedence and is applied at runtime.

Content reference link attributes are independent and separate from the content reference attributes at the link destination. Modifying one has no effect on the other.

Access the Content Reference Link Security page (Click the Security tab on the Content Reference Link Administration page.)

The fields on this page are disabled because content reference links inherit the security settings of the destination object. The inherited security settings propagate upward through the folder hierarchy from the content reference link.