Using Predefined Homepage HTML Definitions

This section discusses how to:

  • Construct homepages.

  • Construct headers.

  • Construct pagelets.

  • Adapt homepage and pagelet definitions.

Image: Graphical representation of the HTML definitions that comprise a homepage

This example shows the layout that is used for displaying a homepage with a header and pagelets. The PORTAL_HP_USER_TEMPLATE object serves as a container for the other HTML definitions found on the homepage.

Graphical representation of the HTML definitions that compose a homepage

Image: PeopleSoft homepage showing the composite HTML definitions

This example shows an actual PeopleSoft homepage with numbers specifying these HTML definitions:

  1. PORTAL_HP_USER_TEMPLATE

  2. PORTAL_UNI_HEADER_NEW

  3. PT_HNAV

  4. PORTAL_HP_2COL_LAYOUT or PORTAL_HP_3COL_LAYOUT

  5. PORTAL_HP_COMPONENT

PeopleSoft homepage showing the composite HTML definitions

This table describes the HTML definitions that the system uses to construct homepages:

HTML Definition

Description

PORTAL_HP_USER_TEMPLATE

This is the HTML definition for the homepage tab. This definition contains the iScript reference to the universal header, a bind variable for the two-column or three-column layout HTML, and binds for the Oracle image.

PORTAL_UNI_HEADER_NEW

This HTML definition contains all the HTML for the header portion of a homepage tab. The HTML definition is set up in WEBLIB_PORTAL.PORTAL_HEADER.FieldFormula.GetUniHeaderHTML.

PT_IFRAME_HDR

This HTML definition contains all of the HTML for the iframe header.

PT_HNAV

This HTML definition contains the HTML for the drop-down navigation header.

PORTAL_HP_2COL_LAYOUT

This HTML definition contains all the pagelet HTML for the two-column layout (columns 1 and 2).

PORTAL_HP_2COL_LAYOUT_ACCESS

This HTML definition contains all the pagelet HTML for the two-column layout (columns 1 and 2) when the homepage is viewed in screen reader mode.

PORTAL_HP_3COL_LAYOUT

This HTML definition contains all the pagelet HTML for the three-column layout (columns 1, 2 , and 3).

PORTAL_HP_3COL_LAYOUT_ACCESS

This HTML definition contains all the pagelet HTML for the three-column layout (columns 1, 2 , and 3 when the homepage is viewed in screen reader mode.

PORTAL_HP_COMPONENT

This is the HTML definition for pagelets.

This table describes the HTML definitions that the system uses to construct headers:

HTML Definition

Description

PORTAL_HP_TABS

This is the HTML definition for all tabs. Use this HTML definition when more than one system tab exists for a user. This HTML definition is set up in WEBLIB_PORTAL.PORTAL_HOMEPAGE.FieldFormula.GetHPTabHTML().

PORTAL_HP_INACTIVE_TAB

This is the HTML definition for the inactive tab. The inactive tab name is linked. This HTML definition is set up in WEBLIB_PORTAL.PORTAL_HOMEPAGE.FieldFormula.GetHPTabHTML().

PORTAL_HP_ACTIVE_TAB

This is the HTML definition for the active tab. Only one active tab can exist. The tab name is static text. This HTML definition is set up in WEBLIB_PORTAL.PORTAL_HOMEPAGE.FieldFormula.GetHPTabHTML().

PORTAL_HP_PERSONALIZE_LINKS_TD

This is the HTML definition for the Personalize Content and Personalize Layout links. This HTML definition is used only when more than one system tab exists for a user. This HTML definition is set up in WEBLIB_PORTAL.PORTAL_HOMEPAGE.FieldFormula.GetHPTabHTML().

PORTAL_HP_PERSONALIZE_LINKS

This is the HTML definition for the Personalize Content and Personalize Layout links. This HTML definition is used only when one system tab exists for a user. This HTML definition is set up in WEBLIB_PORTAL.PORTAL_HOMEPAGE.FieldFormula.GetHPTabHTML().

PORTAL_HEADER_ADDTOFAVORITES

This is the HTML definition for the Add To Favorites link. This HTML definition is set up in WEBLIB_PORTAL.PORTAL_HEADER.FieldFormula.GetUniHeaderHTML().

PORTAL_HEADER__ADDTOFAVSFORM

This is the HTML definition for the Add to Favorites form. This form contains the PortalActualURL and PortalContentURL hidden fields. The Add to Favorites page uses these hidden fields to construct the content reference to the page to which you are adding a favorite (PortalContentURL) and a link back to the actual page (PortalActualURL). This HTML definition is set up in WEBLIB_PORTAL.PORTAL_HEADER.FieldFormula.GetUniHeaderHTML().

PORTAL_HEADER_WL

This is the HTML definition for the View Worklist link. This HTML definition is set up in WEBLIB_PORTAL.PORTAL_HEADER.FieldFormula.GetUniHeaderHTML().

This table describes the HTML definitions that the system uses to construct pagelets:

HTML Definition

Description

PORTAL_HP_ACTIONBAR

This is the HTML definition for the pagelet action bar. For a personalized tab, the pagelet action bar always includes a Maximize image button. It may also contain up to three more image buttons (Remove, Edit, and Help). This HTML definition is not populated for a pagelet on a system tab.

PORTAL_HP_ACTIONBAR_EDIT

This is the HTML definition for the Edit image button on the pagelet action bar.

PORTAL_HP_ACTIONBAR_HELP

This is the HTML definition for the Help image button on the pagelet action bar.

PORTAL_HP_ACTIONBAR_REFRESH

This is the HTML definition for the Refresh image button on the pagelet action bar.

PORTAL_HP_ACTIONBAR_REMOVE

This is the HTML definition for the Remove image button on the pagelet action bar.

PORTAL_HP_COMPONENT

This is the HTML definition for pagelets.

PT_HP2_BANNER

This is the HTML definition for the banner pagelet.

PT_HP2_PGLTHNDL

This is the HTML definition for the pagelet label when the pagelet cannot be dragged.

PT_HP2_PGLTHNDL_DRAG

This is the HTML definition for the pagelet label when the pagelet can be dragged.

PT_HP2_PGLT_HDR_IMG

This is the HTML definition for the pagelet header image.

This section discusses how to:

  • Build portal homepage tabs by using fixed-name HTML and image definitions.

  • Add images to homepage tabs.

Building Portal Homepage Tabs by Using Fixed-Name HTML and Image Definitions

PeopleSoft applications use fixed-name HTML and image definitions to build portal homepage tabs. You can override default HTML definitions and images that are used for homepage elements, such as tabs and pagelets, by adding attributes on the Content Ref Administration page.

Access the Content Ref Administration page (Select PeopleTools > Portal > Structure and Content. Click the Portal Objects link.)

To work with homepages, click the Homepages link, then the Tabs link. Click a homepage tab label.

To work with pagelets, click the Pagelets link, then a pagelet group name link. Click a pagelet label.

Image: Content Reference Attributes group box of the Content Ref Administration page

The following screenshot illustrates building portal homepage tabs using fixed-name HTML and image definitions.

Content Reference Attributes region of the Content Ref Administration page

To override a default fixed-name HTML or image definition:

  1. In the Content Reference group box at the bottom of the page, click the Edit link for a content reference.

  2. Scroll to the Content Reference Attributes group box for a content reference.

  3. In the Name field, enter the name of the default definition that you want to change.

  4. Deselect the Translate check box.

    Note: You must deselect the Translate check box for the override to be successful.

  5. In the Attribute Value field, specify the new definition value.

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

  6. Click Save.

You can omit the Label field value.

As shown in the example, to replace the Powered by PeopleSoft image on the homepage tab, add a nontranslatable attribute named PT_PORTAL_POWEREDBY with a new image definition name in the database.

This table shows a list of default definitions that you can change for a tab:

HTML or Image Definition

Value

PT_PORTAL_POWEREDBY

Image name in database.

PT_PORTAL_IC_REFRESH

Image name in database.

PT_PORTAL_IC_EDIT

Image name in database.

PT_PORTAL_IC_CLOSE

Image name in database.

PT_PORTAL_IC_COLLAPSE

Image name in database.

PT_PORTAL_IC_EXPAND

Image name in database.

PT_PGLT_HELP

Image name in database.

PORTAL_HP_COMPONENT

HTML definition name in database.

PORTAL_HP_ACTIONBAR

HTML definition name in database.

PORTAL_HP_ACTIONBAR_REFRESH

HTML definition name in database.

PORTAL_HP_ACTIONBAR_REMOVE

HTML definition name in database.

PORTAL_HP_ACTIONBAR_EDIT

HTML definition name in database.

PORTAL_HP_ACTIONBAR_HELP

HTML definition name in database.

PORTAL_HP_2COL_LAYOUT

HTML definition name in database.

PORTAL_HP_3COL_LAYOUT

HTML definition name in database.

PORTAL_HP_USER_TEMPLATE

HTML definition name in database.

Adding Images to Homepage Tabs

You can specify up to 15 extra images for a homepage by using %BIND variables on PORTAL_HP_COMPONENT and PORTAL_HP_ACTIONBAR_xxx HTML definitions. Homepage generation logic replaces %BIND12 to %BIND26 on the homepage tab by the images that are specified as attributes.

Note: Bind variables for images and all HTML components (tab and pagelet) should be nontranslatable. To make an item nontranslatable, deselect the Translate check box.

The following %BIND variables can be replaced by the Homepage Generation service (specify bind variables in PeopleSoft Application Designer):

Bind Variable

Definition Replaced

%BIND(:1)

The PT_PORTAL_POWEREDBY image (Powered By PeopleSoft image).

%BIND(:2)

The result of a function call to %Request.Full URI.

%BIND(:3)

The result of a function call to %Request.GetHelpURL('PERSHOEPAGE').

%BIND(:4)

The result of a function call to refreshonExpire.

%BIND(:5)

The PT_PGLT_HELP image.

%BIND(:6)

The result of a function call to %Request.GetHelpURL(&Pglt.HelpID).

%BIND(:7)

The PT_PORTAL_IC_EDIT image (edit image for a pagelet).

%BIND(:8)

The result of a function call to SetRefreshPage.

%BIND(:9)

The PT_PORTAL_IC_CLOSE image.

%BIND(:10)

The PT_PORTAL_IC_COLLAPSE image.

%BIND(:11)

The PT_PORTAL_IC_EXPAND image.

%BIND(:12) to %BIND(:26)

The value of the tab attribute IMAGE_BIND_X, where X ranges from 12 to 26.

%BIND(:28)

The PT_PORTAL_IC_REFRESH image.

This code sample shows how to specify custom %BIND images to display custom images for the PORTAL_HP_COMPONENT HTML definition:

<!-- Begin Pagelet=%BIND(:5) -->
<!-- PageletState=MAX -->
<TABLE id="" CLASS="PTPAGELET" WIDTH="100%" CELLPADDING="0" CELLSPACING="0" BORDER="1">
<TR>
     <TD>
          <!--Image 12 will be displayed here.-->
          <IMG SRC="%BIND(:12)" NAME="anything you like">
          <!--Image 13 will be displayed here.-->
          <IMG SRC="%BIND(:13)" NAME="anything you like">
          <!--Image 14 will be displayed here.-->
          <IMG SRC="%BIND(:14)" NAME="anything you like">	
          <!--Image 26 will be displayed here.-->
          <IMG SRC="%BIND(:26)" NAME="anything you like">
     </TD>
</TR>
   <TR>
      <TD CLASS="PTPAGELETHEADER">
         %BIND(:1)
         %BIND(:2)</nobr>
      </TD>
   </TR>
   <TR>
      <TD CLASS="PTPAGELETBODY" WIDTH="100%">
         <Pagelet Name="%BIND(:2)">
            <Source Pagelet="%BIND(:4)" href="%BIND(:3)" />
         </Pagelet>
      </TD> 
   </TR>
</TABLE>
<BR>
<!-- End Pagelet=%BIND(:5) -->

The HTML definitions PORTAL_HP_2COL_LAYOUT and PORTAL_HP_3COL_LAYOUT HTML can be modified similarly to display extra images.

The Homepage Generation service replaces the image that is specified by the attribute IMAGE_BIND_12 in place of bind variable %BIND(:12), and so on.

Warning! Pagelet HTML is parsed by the portal servlet. Be sure that the HTML is properly formatted and that none of the matching tags are missing. Improperly formatted HTML and missing tags may result in unexpected web server behavior.