Oracle9i Application Server Wireless Edition Developer's Guide Release 1.1 Part Number A86700-01 |
Library | Service | Contents | Index

# 4
Rebranding the Personalization Portal

This document explains the Personalization Portal architecture. Each section of this document presents a different topic. These sections include:

- Section 4.1, "Overview"

- Section 4.2, "Page Naming Conventions"

- Section 4.3, "JavaServer Pages Structure"

- Section 4.4, "Customization Levels"

- Section 4.5, "Setting the Multi-Byte Encoding for the Personalization Portal"

## 4.1 Overview

The Wireless Edition Personalization Portal is both a framework for the personalization interface and a sample implementation of that framework. The framework consists of JavaServer Pages (JSP) files, JavaBean modules, JavaScript, and such static elements as images, XSL stylesheets, and HTML files. Another element of the framework is the logical sequence in which the elements execute. You can rebrand the Personalization Portal based on the existing framework or restructure the framework itself by altering the logic in the JSP files and JavaBeans.

The following sections describe the elements that generate the Personalization Portal and their order of execution, as well as the file naming conventions and the directory structure used.

## 4.2 Page Naming Conventions

Some Personalization Portal pages display information, while others allow you to customize user information or repository object characteristics. The JSP files execute the tasks that are associated with user customization.

Each JSP file consists of an action applied to an object. One part of the JSP file name represents the action (usually Ed or Do, as in EdFolder.jsp and DoFolder.jsp). A second part of the file name represents the object (or the target) of the action, such as, Folder, Service, Alert, or Bookmark.

For example, to customize a user from the Service Subscription page Myservice.jsp, click the User link to invoke EdFolder.jsp, which displays the editable characteristics of that folder. In this example, the action is editing; it is represented by the prefix Ed in the file name. The object of the action is folder; it is represented by Folder in the file name. To apply the changes that you have made, the DoFolder.jsp file processes the input.

In this case, the actions are Ed and Do; the object is Folder.

- Edit JSP files, which begin with "Ed", generate the page, retrieve object characteristics, display the result, and accept user inputs.

- Action JSP files, which begin with "Do", process user inputs, perform the action, and display the result.

There are also similar JSP files at the administrator level.

- Admin JSP files, which begin with "Ad" operate like Edit JSP files, but are only available to accounts with Administrator privileges.

- Admin action JSP files, which begin with "AdDo" process inputs, perform actions and display results in the same manner as regular action files.

There are action/object combinations for all Personalization Portal objects. For example:

- EdFolder.jsp and DoFolder.jsp

- EdService.jsp, DoService.jsp, and MyService.jsp

- EdBookmark.jsp and DoBookmark.jsp

## 4.3 JavaServer Pages Structure

Each Personalization Portal JSP is composed of a series of JavaBeans assembled to generate the page when they are rendered. Each JavaBean is a reusable element and can be rendered individually or as part of the JSP.

#### Figure 4-1 Sample Page JavaBean Structure

Text description of the illustration beanstlk.gif

#### Figure 4-2 JavaBean Location on Sample Page

Text description of the illustration jsp_pag.gif

Table 4-1 JavaBean Function

JavaBean | Description
--- | ---
Root | Encompasses the JSP and allows it to be rendered as a whole.
1. Page Layout | Establishes the Header and Footer and reserves the remainder of the page for other content. This component contains the Navigation Trace, Form, and Message Box elements.
2. Navigation Trace | Displays navigation cue and display name elements.
3. Form | The main section of the page. This defines and contains the Row Layout.
4. Row Layout | Contains Tree, Cell, and Button elements.
5. Tree | Linked hierarchical lists.
6. Message Box | Displays text elements.
Button | Used to approve or cancel page actions. This is part of a row layout.

Pages can be modified in one of two ways.

- You can paste a partial page into the current layout. For example, you can remove a message box by deleting that JavaBean, or replace it with a Text Box.

- You can reuse an existing JavaBean to introduce a new element on a custom page. For example, using the Tree JavaBean to place a Tree on a new page.

### 4.3.1 Directory Structure

To rebrand the Personalization Portal, you modify the JSP files that generate the Personalization Portal. After installing the Wireless Edition, these files are located in the Oracle_Home/panama/portal directory which has the following structure:

Table 4-2 Portal Directory Contents

Directory | Contents
--- | ---
portal | Container JSP files. Container files are accessed directly by browsers. They invoke JavaBeans and other JSP files. This directory also contains JavaScript files.
portal/_pages/_portal | The folder where the compiled pages are saved.
portal/images | Images used throughout the Personalization Portal.
portal/Web-inf/jsp | Module JSP files. These files are included by either container JSP files or other module JSP files.
portal/cabo | JavaBean stylesheet, image, and JavaScript.
portal/cabo/images | JavaBean static images.
portal/cabo/images/cache | JavaBean generated images.
portal/cabo/Libs | Javascript.
portal/cabo/styles | Stylesheets.
portal/cabo/styles/cache | Generated stylesheets.
portal/oracle/panama/webui | UI beans and LocalStrings.properties file

## 4.4 Customization Levels

Personalization Portal pages can be customized in several different ways. You can easily alter the appearance of logos, banners, and icons. Alternatively, you may want to create your own JSP to achieve the desired look and feel.

### 4.4.1 Appearance Customization

This method requires replacing static strings in the HookFunc.jsp file located in the Oracle_Home/panama/portal/WEB-INF/jsp directory. By changing the file names called in by these static strings, you can alter the banner art, logo art, and tool tip text.

Table 4-3 HookFunc.jsp String Usage

String | Page Element
--- | ---
logoImage | Page logo image
logoDesc | Page logo tool tip text
advImage | Optional advertising banner image
advDescrip | Optional advertising banner image tool tip text
advDest | Optional advertising banner image destination

### 4.4.2 JSP Modification

The JSP file PageTemp.jsp generates the Personalization Portal page template. PageTemp.jsp is included in other JSP files which generate different contents in each page. The following illustrates the files that generate the Personalization Portal home page.

#### Figure 4-3 JSP Placement in Page Structure

Text description of the illustration pag_file.gif

PageTemp.jsp generates the logo and Sign Out button at the top of the page. MyService.jsp presents a tree view of the services available to the user.

### 4.4.3 Customization Components

The edit and action JSP files execute the tasks associated with user customization:

- The edit JSP files, which begin with "Ed", generate the forms for accepting user inputs.

- The action JSP files, which begin with "Do", process user inputs, perform the action, and display the result.

For example, to rename a folder, Wireless Edition first invokes EdFolder.jsp, then DoFolder.jsp.

Users can customize or configure the following:

- Services

- Folders

- Alerts (alert users when preset conditions are met)

- Profile Information

- Bookmarks

- Alert Addresses

- Locationmarks

### 4.4.4 Flow Example - Customizing a Services

The MyService.jsp file displays the Service Subscription page, which allows the user to customize or copy a service. Depending on the option selected by the user, an input form is displayed by an EdService.jsp file. When the user clicks a button on the input form, the flow moves to a DoService.jsp file. The DoService.jsp file posts and processes input values, and, depending on the validity of the input values, returns to the MyService.jsp or displays an error message. The following figure displays the flow of control when a user edits a service.

#### Figure 4-4 Service Customization Flow

Text description of the illustration edserv.gif

Note: The action pages, DoService.jsp and DoFolder.jsp have no display component, they perform their function, update the database, and then return the user to an input page, such as EdFolder.jsp or MyService.jsp.

### 4.4.5 Creating New JSP

To create a new JSP, you implement the Personalization Portal API. The classes in this API enable you to customize a version of the Personalization Portal by providing a set of interfaces for portal customization. For detailed information on the interfaces in this API, see Chapter 5, "Using the Personalization Portal API".

## 4.5 Setting the Multi-Byte Encoding for the Personalization Portal

The Personalization Portal gets the encoding for the text of the site from the setting in the PAPZ logical device, which is in the repository. The default encoding is JTF-8, which can handle Western European languages as well as some Asian languages. The portal sets the content for each page with the encoding specified by the logical device. To change the default encoding, click PAPZ under Logical Devices in the Service Designer and change the encoding according to the IANA standards for your particular language.

| Copyright © 2001 Oracle Corporation. All Rights Reserved. |
Library | Service | Contents | Index