PeopleSoft Enterprise Portal 9.1 PeopleBook: Branding

Setting Up PeopleSoft Enterprise Portal Branding

This chapter discusses Oracle's PeopleSoft Enterprise Portal branding set up and describes how to:

Enable PeopleSoft Enterprise Portal branding.
Manage system elements.
Create and enable HTML layouts.

Enabling PeopleSoft Enterprise Portal Branding

This section discusses how to enable PeopleSoft Enterprise Portal branding.

Pages Used to Enable PeopleSoft Enterprise Portal Branding

Page Name	Definition Name	Navigation	Usage
Installation Options	EO_PE_OPTIONS1	Portal Administration, System Data, Installation Options	Enable or disable PeopleSoft Enterprise Portal branding.

Enabling Branding

Access the Installation Options page (Portal Administration, System Data, Installation Options).

Note. By default, the PeopleSoft Enterprise Portal is delivered with branding enabled.

There are special application classes for PeopleSoft Enterprise Portal branding and another set for when basic PeopleTools branding applies. When you enable PeopleSoft Enterprise Portal branding, the application package and application class information for PeopleSoft Enterprise Portal is populated in the PeopleTools Options page.

Note. When PeopleSoft Enterprise Portal branding is enabled, My Links functionality is also enabled as is the display of the Add to My Links link on the portal header.

To enable or disable PeopleSoft Enterprise Portal branding:

Access the Installation Options page.
Locate the Branding section.
Select the Enable Branding Themes check box to enable branding.

Clear this check box to disable this feature.
Select the Enable Adding Image Objects check box to enable uploading of images to the image catalog.
Select the Enable Adding HTML Objects check box to enable adding and updating HTML objects from branding page.
Save your changes.

Managing Branding System Elements

This section discusses how to manage branding system elements.

Pages Used to Manage Branding System Elements

Page Name	Definition Name	Navigation	Usage
System Elements	EPPBR_ELEMENT	Portal Administration, Branding, Define Elements, View System Elements	View all branding elements noting which are configurable and which are not. Specify which elements are overridable when used by sites.

Managing System Elements

Access the System Elements page (Portal Administration, Branding, Define Elements, View System Elements).

The System Elements page enables you to view all the system elements. Use the page to specify the elements that are overridable when used by sites.

	Click to remove section tabs and show all columns of information.
Element ID	Unique numeric identifier for the element. These elements are hard coded and serve as the foundation for PeopleSoft Enterprise Portal branding.
Layout Type	Indicates the type of layout where the specific element can be used. The valid options are: Header (homepage and target page). Footer (homepage only).
Type	Element type. The valid options are: My Links. Search. Homepage Help. Bar (table row, link bar). Homepage Tab. HTML Area/Text. Image. Image URL. Scoped Search.

Description	Description of the element type including its bind variable. This becomes the default description for the elements listed on the HTML Layouts and Element Selection page.
Configurable	This is a read-only field. Elements marked configurable are available to accept various values to create different branding designs. Set these values using the Define Header and Define Footer pages. Elements that are not configurable drive the basic functionality of PeopleSoft Enterprise Portal branding.
Can be Overriden by Sites	Select the check box to indicate that sites can override the element with site-specific configuration values. If grayed out, you cannot specify if the element is overridable. In these instances, the existing setting is required to drive PeopleSoft Enterprise Portal branding.
Comments	Displays when the Additional Comments tab is selected or when all columns are displayed. Add notes and descriptive information about the element.

See Enterprise PeopleTools 8.50 PeopleBook: PeopleSoft Application Designer Developer's Guide, “Creating Image Definitions.”

See Enterprise PeopleTools 8.50 PeopleBook: PeopleSoft Application Designer Developer's Guide, “Creating HTML Definitions.”

Creating and Enabling HTML Layouts

This section provides an overview and discusses how to create and enable HTML layouts.

Understanding Creating and Enabling HTML Layouts

When you create an HTML layout, you define a layout that will support header and footer custom configurations. To incorporate an HTML design to function within PeopleSoft Enterprise Portal branding, you must enable the branding elements in the layout definition that match functionality in the underlying matching HTML object code.

If you are using any of the delivered layouts, you do not need to enable any branding elements. PeopleSoft delivers these layouts enabled. You must create and enable new HTML layouts only if you are using your own custom-designed HTML objects for header or footer layout designs.

Warning! If you start selecting and deselecting elements for any of the delivered layouts, the HTML layout definition may no longer match the code in the underlying HTML design object. You can enable them again by viewing the HTML text and selecting again the appropriate elements.

Elements that are required to drive the core aspects of PeopleSoft Enterprise Portal branding are automatically enabled and cannot be edited. These elements appear grayed out on the HTML Layouts and Element Selection page.

Pages Used to Create and Enable HTML Layouts

Page Name	Definition Name	Navigation	Usage
HTML Layouts and Element Selection	EPPBR_LAYOUT	Portal Administration, Branding, Define Elements, Enable HTML Layouts, HTML Layouts and Element Selection	Select the branding elements that are used in the HTML object code.

Creating and Enabling Layouts

Access the HTML Layouts and Element Selection page (Portal Administration, Branding, Define Elements, Enable HTML Layouts, HTML Layouts and Element Selection).

Note. When creating a new HTML object to be used in an HTML layout, make sure to include all the non-configurable system elements. These elements are essential for the system to function. Model your new HTML object after the delivered HTML objects, and keep all of the non-configurable system element binds in place.

To create and enable a new HTML layout:

Access the Enable HTML Layouts page.
Click the Add a New Value tab.
In the HTML Layout ID field, enter a name for the layout.
Click the Add button. The HTML Layouts and Element Selection page displays.
In the Description field, enter a descriptive name for the layout.
In the HTML Object Name field, enter the HTML object on which to base the layout, or use the Lookup button to select one. The HTML object must have been previously loaded into the PeopleSoft Enterprise Portal database using PeopleTools Application Designer to appear in the lookup. You can also add new HTML at this point.

To add new HTML to the system catalog, click the Add New HTML link.

The Add to HTML Catalog page appears enabling you to add and edit a new HTML object.
From the Layout Type dropdown list, select the type of layout.

All of the delivered branding elements relevant to the selected type display.

The valid options are:
- Header
- Footer
Select the Select check box for all elements that are in the HTML object code. Make sure the element functionality matches.
Select the Required check box to specify that an element must always be configured. If the element is not required, you don't have to define value(s) for it on the Define Header or Define Footer pages.
The Custom Label column should contain a description of how the element is used in the layout. The name you enter is used as the element name on the header or footer configuration pages. For example, you could change the description My Links %1 to My Links, Lower Right %1.
Save your changes.

Note. PeopleSoft 9.1 Enterprise Portal delivers the EPPBR_HDRHTML_BASE HTML HTML object as the base for creating any new header for use with branding.

See Example: Creating and Configuring Custom Branding Headers with Bind Variables.

Viewing the HTML Text

Access the View HTML Text page (click the View HTML Text link on the HTML Layouts and Element Selection page).

To aid in matching up elements between the HTML layout and the HTML object, click the View HTML Text link. The HTML object code displays in a new window.

Adding New HTML to the System Catalog

Access the Add to HTML Catalog page (click the Add New HTML link on the HTML Layouts and Element Selection page).

Enter a unique name and description for the HTML object. The system displays the prefix PAPP, as a default.

Use this page to paste HTML code that you've cut or copied from another source or type in the HTML that you want to add to the catalog.

Editing HTML Objects

Access the HTML Catalog page. (click the Browse HTML Catalog icon on the HTML Layouts and Element Selection page).

To add a new HTML object to the catalog, click the link toAdd New HTML.

To edit the HTML that you have previously added, click the Edit button. The Edit HTML Object page appears where you can alter the HTML.

HTML objects cannot be deleted online. Use Application Designer to delete any HTML or image objects.

Note. Only HTML objects that have been added using the Add New HTML page can be edited from these pages. Delivered HTML objects or ones added from Application Designer cannot be edited from this page.