Administering Portal Homepages and Pagelets

This chapter provides an overview of portal homepage and pagelet administration and discusses how to:

See Also

Working With Browser-Based Applications

Personalizing Your Homepage

Click to jump to parent topicUnderstanding Portal Homepage and Pagelet Administration

Available homepage functionality differs based on the products that you have licensed. Each users' homepage data is stored in a separate set of tables named PSPRUHDEFN (which is updated when a user personalizes the homepage), PSPRUHTAB, and PSPRUHTABPGLT. Based on the data in these tables, a personalized HTML homepage is generated.

As a portal administrator, you can create multiple homepages that users can view as a series of tabs across the top of the homepage. To accomplish this, you create additional homepage tabs with content specific to target community audiences.

Pagelet Loading

Portal homepages load each pagelet individually when you sign on. The pagelet appears as you see in this example, indicating that it's currently loading its data.

Click to jump to parent topicManaging Tabbed Homepages

This section discusses how to:

Click to jump to top of pageClick to jump to parent topicPages Used to Manage Tabbed Homepages

Page Name

Definition Name

Navigation

Usage

Structure and Content

PORTAL_FLDR_ADM

PeopleTools, Portal, Structure and Content, Portal Objects, Homepage, Tabs.

Add and delete homepage tabs or change tab order.

Content Ref Administration

PORTAL_CREF_ADM

Click Add Content Reference on the Structure and Content page.

Create homepage tabs.

Tab Content

PORTAL_TAB_CON_ADM

PeopleTools, Portal, Structure and Content, Portal Objects, Homepage, Tabs, Content Ref Administration, Tab Content.

Define the content for the homepage tab.

Tab Layout

PORTAL_TAB_LAY_ADM

PeopleTools, Portal, Structure and Content, Portal Objects, Homepage, Tabs, Content Ref Administration, Tab Layout.

Define the layout for the homepage tab.

Click to jump to top of pageClick to jump to parent topicAdding Homepage Tabs

To add a new homepage tab:

  1. Select PeopleTools, Portal, Structure and Content.

  2. Click the Portal Objects link.

  3. Click the Homepage link.

  4. Click the Tabs link.

  5. Click the Add Content Reference link.

Click to jump to top of pageClick to jump to parent topicConfiguring Homepage Tabs

Access the Content Ref Administration - General page. (Select PeopleTools, Portal, Structure and Content. Click the Portal Objects link. Click the Hompage link. Click the Tabs link).

Name

Enter a unique name for the tab.

The value you specify in the Name field can consist of up to 50 letters, digits, and underscores ( _ ). It cannot contain any spaces and cannot begin with a digit.

Label

Enter the label to display on the tab.

Usage Type

Select Homepage tab to create a tabbed homepage or an operational dashboard.

When you select Homepage tab, two additional pages appear in the component: the Tab Content and Tab Layout pages.

Valid from date

Enter the date that the tab becomes visible to the end user. You can enter a date to remove the tab from display.

Allow rename

Select this check box to enable users to rename the tab label of the homepage tab using the Personalize Content page.

Homepage Tab Attributes

Use the Homepage tab attributes group box of the Content Ref Administration page to enable users to rename the homepage tab label, as well as associate a help topic with the homepage tab, hide the pagelet action bar, and specify a homepage as an operational dashboard.

Allow rename

Select to enable the application user to change the homepage tab label.

Help ID

Enter the help ID for the pagelet. When users click the Help button on the pagelet, the system displays help information specific to the pagelet.

This feature works only if you specify a help URL on the Web Profile Configuration - General page, and the pagelet documentation is part of the HTML PeopleBooks identified by the help URL.

You must also ensure that the documentation HTML includes a properly formatted anchor element that uses the value you specify in this field. For example, if you specify a help ID of MY_PAGELET_CONTENT, the pagelet documentation in the PeopleBook must contain the following element:

<a NAME="F1ID_MY_PAGELET_CONTENT"></a>

Hide pagelet action bar

Select this check box to hide the pagelet action bar on all pagelets on the homepage tab. This option overrides all properties for pagelets used on this tab.

Operational Dashboard

Select to hide the tab from the homepage and create a content reference link to the tab so that you can access the homepage from the root level of the menu.

See Creating WorkCenter Operational Dashboard Pages.

Creating Homepage Tabs

To create homepage tabs:

  1. Click the Add Content Reference link.

  2. Enter a name and label for the new tab.

    Note. The label value appears as the homepage tab name.

  3. In the Usage Type field, select Homepage tab.

    After selecting Homepage tab, the page refreshes to display two additional pages, the Tab Content and Tab Layout pages.

  4. In the Valid from date field, enter the date that you want the tab to first appear for your users. Optionally, enter a valid to date to remove the tab from use.

  5. Select the homepage tab attributes.

  6. Define the tab content and tab layout.

    See Selecting the Tab Content.

    See Arranging the Tab Layout.

  7. Click the Save button.

  8. To view the newly defined tab, click Home to return to your homepage.

See Also

Setting Content Reference Security

Creating WorkCenter Operational Dashboard Pages

Click to jump to top of pageClick to jump to parent topicSelecting the Tab Content

Access the Tab Content page (click the Tab Content tab).

To select pagelets for the homepage:

  1. Select the check box for the pagelet to appear on the homepage tab.

    Select the Include All? check box to select all pagelets in the category.

    Note. The user must have security access to the pagelet component for the pagelet to be properly displayed on the homepage.

  2. Use the drop-down list to select the pagelet behavior.

    Optional

    The pagelet does not appear automatically on the homepage. However, it is available for users when personalizing the homepage.

    Opt-Dflt (option-default)

    The pagelet appears on all user homepages, if the users have access to the pagelet. The pagelet can be removed when users personalize the homepage.

    Req-Fix (required-fixed)

    The pagelet appears on all user homepages, if users have access to the pagelet. The placement of the pagelet can not be changed, and it also cannot be removed.

    Required

    The pagelet appears on all user homepages if users have access to the pagelet. The placement of the pagelet can be changed, but it cannot be removed.

  3. Click the Save button.

Note. Content outside of PeopleSoft applications is available only with PeopleSoft Enterprise Portal.

Important! When selecting content for inclusion on any PeopleSoft homepage, only one pagelet or portlet should use the calendar prompt. If more than one pagelet or portlet per homepage uses the calendar prompt, unexpected results might occur.

Click to jump to top of pageClick to jump to parent topicArranging the Tab Layout

Access the Tab Layout page (click the Tab Layout tab).

Label

Displays the label information from the Content Ref Administration page.

Basic Layout

Select to display the pagelets in either two or three columns on the homepage.

To specify the three-column layout, be sure that at least one pagelet does not have the Req-Fix behavior option selected on the Tab Content page.

Columns

Displays the pagelets selected on the Tab Content page in the column sections.

If the basic layout is two columns, the pagelets are divided into left and right columns. If the basic layout is three columns, the pagelets are divided into left, center, and right columns.

Note. A pound sign (#) indicates a pagelet with the Req-Fix behavior option selected on the Tab Content page. An asterisk (*) indicates a pagelet with the Required behavior option selected on the Tab Content page.

For example, #Signon indicates that the Signon pagelet cannot be moved to a different location on the homepage.

Use to position the pagelets. Highlight a pagelet, and then click the directional arrow buttons to move the selected pagelet above a pagelet, below a pagelet, to the next column to the right, or the next column tothe left.

Delete Pagelet

Highlight a pagelet and then click to delete it from the homepage.

To arrange the tab layout:

  1. Select a basic layout option.

  2. Select the pagelet name.

  3. Click the directional arrow buttons to position the pagelets.

  4. Click the Save button.

Note. The portal administrator determines the flexibility of the layout of the pagelets based on the settings that you select on both the Tab Content and Tab Layout pages. Grant the end user as much or as little flexibility as your organization demands.

Click to jump to top of pageClick to jump to parent topicRearranging the Tab Order

The sequence number determines the homepage tab order. The tabs appear with the lowest sequence number first. If any numbers are identical, then the order is alphanumeric. If no sequence numbers exist, the default is considered to be zero. For example, if no sequence numbers are entered, the default is zero, and the order is alphanumeric.

To rearrange the tab order:

  1. Select PeopleTools, Portal, Structure and Content.

  2. Click the Portal Objects link.

  3. Click the Homepage link.

  4. Click the Tabs link.

  5. Click the Edit link for each tab that you want to reorder.

  6. Enter a number in the Sequence field.

If caching is turned on for the portal, the tab order change does not take effect until the caching recycles or the web server is restarted.

Click to jump to top of pageClick to jump to parent topicTroubleshooting Homepages

Under most circumstances, PeopleTools portal technology assembles homepages by simultaneously retrieving content for all the pagelets referenced on the homepage. As a result, the portal renders the homepage as soon as the user signs in and immediately begins loading individual pagelets. Under certain circumstances, pagelets do not load simultaneously, but load sequentially.

Sequential Pagelet Retrieval

When document.write or document.writeln scripts are detected inside a pagelet, the homepage loads all pagelets sequentially. This is required to properly assemble that pagelet's content. For example, consider a homepage with the following pagelets, each of which loads in the time indicated:

Note. These pagelets can all have relatively quick average load times, but any pagelet might be excessively slow on occasion.

The total time required to retrieve all the pagelets is 37.5 seconds, which is disproportionately skewed by pagelet C. Some reasons for this could be that pagelet C's URL is incorrect or has changed, the domain name server can't resolve the URL, the content server is down or unreachable, the content server is behind a firewall, or the content server is temporarily unavailable. As a result of such high retrieval times, the total time to render the homepage is unacceptable to the user, and for practical purposes the pagelet is unavailable.

You can respond to unavailable pagelets by specifying a time-out period during which each pagelet must load. This improves portal homepage performance by enabling the system to present the homepage quickly in spite of an individual pagelet's unavailability. You specify a pagelet time-out as a content reference attribute on the pagelet's Content Ref Administration page.

See Configuring Pagelet Time-outs.

Click to jump to parent topicManaging Pagelet Attributes

This section discusses how to:

Click to jump to top of pageClick to jump to parent topicPage Used to Manage Pagelet Attributes

Page Name

Definition Name

Navigation

Usage

Content Ref Administration

PORTAL_CREF_ADM

PeopleTools, Portal, Structure and Content, Portal Objects, Homepage, Tabs.

Click Add Content Reference.

Create or edit homepage tabs.

Click to jump to top of pageClick to jump to parent topicManaging Pagelet Attributes

Access the Content Ref Administration page (PeopleTools, Portal, Structure and Content. Click the Edit link for the appropriate content reference).

Select Pagelet in the Usage Type drop-down list box.

Use the Pagelet Attributes group box to select the default column for a pagelet, associate a help topic with the pagelet, set refresh time, and hide certain buttons from users.

This table describes the pagelet attribute fields:

Default Column

Select the number of columns for the pagelet.

Help ID

Enter the help ID for the pagelet. When users click the Help button on the pagelet, the system displays help information specific to the pagelet.

This feature works only if you specified a help URL on the Web Profile Configuration - General page, and the pagelet documentation is part of the HTML PeopleBooks identified by the help URL.

You must also ensure that the documentation HTML includes a properly formatted anchor element that uses the value you specify in this field. For example, if you specify a help ID of MY_PAGELET_CONTENT, the pagelet documentation in the PeopleBook must contain the following element:

<a NAME="F1ID_MY_PAGELET_CONTENT"></a>

Refresh Time (sec)

Enter the number of seconds after which the system auto-refreshes the pagelet. To activate the refresh timer, enter a value of 1 or greater.

The timer refreshes the pagelet as soon as the user enters the homepage and then automatically refresh the pagelet every n number of seconds.

Note. Only homepages use automatic refresh.

Hide minimize image

Select to hide the minimize button that normally appears in the pagelet header, so that users are prevented from minimizing the pagelet.

Hide refresh image

Select to hide the refresh button to prevent users refreshing the pagelet.

If you implemented pagelet caching for this pagelet, a refresh button automatically appears in the pagelet header.

Force Pagelet Refresh

Some components can render themselves differently based on the column width. When a homepage has a 2 column layout, and the user moves a PIA based component pagelet to a different sized column by using the drag and drop method then this pagelet needs to be refreshed so that the content displays correctly.

The drag and drop iScript that persists the pagelet changes forces a homepage refresh only when all of the following conditions are met:

  • A pagelet changes columns.

  • The homepage layout is 2-column.

  • The pagelet is a PIA component

  • You select the Force page refresh property for the pagelet

Note. When document.write or document.writeln scripts are detected inside a pagelet, the whole homepage will be refreshed instead of just that pagelet. This is required to properly assemble that pagelet's content.

See Implementing Pagelet Caching.

Edit URL Information

Use the Node Name and URL Type fields to specify a page to be used for personalizing this pagelet, and to make the personalization button appear in the pagelet header.

Node Name

Select the node name for the edit URL of the pagelet. This node name can be different than the pagelet node name.

URL Type

Select the type of the edit URL. The specific URL entry fields appear based on the setting of this field. Options are:

Non-PeopleSoft URL: The Edit URL field appears. Enter the URL of the personalization page to use.

PeopleSoft Component: The Component Parameters group box appears, containing the same fields as the Component Parameters group box for the content reference. Use these fields to identify the personalization page to use.

PeopleSoft Script: The iScript Parameters group box appears, containing the same fields as the iScript Parameters group box for the content reference. Use these fields to identify the personalization page to use.

See Also

Administering Content References

Click to jump to top of pageClick to jump to parent topicConfiguring Pagelet Help Links

To specify pagelet help:

  1. Select PeopleTools, Portal, Structure and Content, Portal Objects, and navigate to the Content Ref Administration (content reference administration) page for the pagelet.

    You define the pagelet help in the Content Reference Attributes region of the page.

  2. Enter PTPPB_PAGELET_HELP_LINK in the Name field.

  3. Leave the Label field blank.

  4. Clear the Translate check box.

    Note. You must clear the Translate check box or unexpected results might occur.

  5. In the Attribute Value field, enter the URL of the location of your help document, for example http://www.mycompany.com/help_doc1.html

  6. Save the content reference.

Note. The pagelet Help URL takes precedence over the Help ID, when both attributes are set for a pagelet.

Note. The help button appears only when the pagelet is on the homepage inside the PeopleSoft Portal; it will not appear when the pagelet is displayed as a WSRP portlet.

See Also

Administering Content References

Click to jump to top of pageClick to jump to parent topicConfiguring Pagelet Time-outs

To specify a pagelet time-out:

  1. Select PeopleTools, Portal, Structure and Content, Portal Objects, and navigate to the Content Ref Administration (content reference administration) page for the pagelet.

    You define the pagelet time-out in the Content Reference Attributes region of the page.

  2. Enter PSTIMEOUT in the Name field.

  3. Enter PSTimeout in the Label field.

  4. In the Attribute Value field, enter number of seconds before the pagelet is considered unavailable. This can be any positive integer.

    Note. The portal ignores this attribute if you specify 0 or a negative value, or if the content reference isn't a pagelet.

  5. Save the content reference.

When your specified time-out expires, the portal stops attempting to load the pagelet and generates an error message.

See Also

Administering Content References

Configuring Look and Feel

Click to jump to top of pageClick to jump to parent topicConfiguring Automatic Pagelet Refresh Attributes

To specify a pagelet refresh time in seconds:

  1. Select PeopleTools, Portal, Structure and Content, Portal Objects, and navigate to the Content Ref Administration (content reference administration) page for the pagelet.

    You define the pagelet time-out in the Content Reference Attributes region of the page.

  2. Enter the number of seconds for automatic refresh in the Refresh Time (sec) field.

  3. (Optional) Check the Hide refresh image check box to prevent manual pagelet refresh by the user.

  4. Save the content reference.

Note. Pagelets with document.write or document.writeln should not have the refresh timer set (to automatically refresh every x number of seconds) because this requires that the whole homepage be refreshed every x number of seconds.