Skip to Main Content
Return to Navigation

Administering Content References

This section discusses how to:

Defining Content References

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:

URL Information

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

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.

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

Setting Content Reference Permissions

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.

Reviewing Content Reference Permissions

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.

Testing Content References

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.

Setting Content Reference Link Permissions

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.