Contents


About This Guide

Who Should Read This Book
What You Need to Know
How This Book Is Organized
Document Conventions Used in This Guide

Monospaced Font
Bold Monospaced Font
Italicized Font
Square or Straight Brackets
Command-Line Prompts

Where to Find Related Information
Where to Find This Guide Online

Chapter 1 Introduction to Customizing the Desktop

Types of Desktop Customizations

End User Customizations
Developer Customizations
Administrator Customizations

Using the Display Profile

Display Profile Document Structure

DisplayProfile root Object
Channel Object
Container Object
Provider Object

Modifying the Display Profile
Where to Go for More Information

Using JavaServer Pages and Template Files

The Desktop and JavaServer Pages
The Desktop and Template Files
To Change the Desktop Type
Using the Desktop Tag Library

What Is the Sample Portal?
Creating a New Desktop

Developing the Container
Editing the Display Profile
Developing JSP or Template Files
Deploying JSP or Template Files

JSP and Template Files Lookup Scenario

Loading the Display Profile at the Appropriate LDAP Nodes
(Optional) Creating a Resource Bundle
Accessing the Desktop

Creating and Extending a Provider Class
Deploying Providers and Channels

Chapter 2 Display Profile Provider Definitions

Overview of Display Profile Provider Definitions

Properties Files

Display Profile Definitions for Leaf Building-Block Providers

URLScraperProvider
XMLProvider

Rich Site Summary (RSS) Channel

JSPProvider

Display Profile Definitions for Container Building-Block Providers

JSPTableContainerProvider
JSPTabContainerProvider
JSPSingleContainerProvider
TemplateTableContainerProvider
TemplateTabContainerProvider

Display Profile Definitions for Internally Used Container Providers

JSPTabCustomTableContainerProvider
JSPFrameCustomTableContainerProvider
TemplateEditContainerProvider
TemplateTabCustomTableContainerProvider

Display Profile Definition for SearchProvider

SearchProvider

Display Profile Definitions for Content Providers

BookmarkProvider
NotesProvider
AppProvider
UserInfoProvider
MailCheckProvider
LoginProvider
SimpleWebServiceProvider
SimpleWebServiceConfigurableProvider

Chapter 3 Display Profile Channel Definitions

Display Profile Definitions for Existing Channels

Bookmark Channel
Notes Channel
Applications List Channel
User Information Channel
Mail Check Channel
URL Scraper Channel
RSS Channel
XML Channel
JSP Channel
Search Channel
Simple Web Service Channel
Simple Web Service Configurable Channel
Login Channel

Chapter 4 Display Profile Properties

Overview of Display Profile Properties
Display Profile Global Properties
Display Profile Provider Required Properties

isEditable Property Tag

Display Profile Container Provider Properties

Container Required Properties
Other Required Container Properties
Properties for JSP-based Table, Tab, and Frame Tab Containers
Required Properties for Tab Containers

TabProperties Collection Property Example
defaultChannelList Collection Property
propertiesToCopy Collection Property
Other Required Properties

Display Profile Provider General Properties

Chapter 5 Understanding the Sample Portal

Overview of the Sample Portal

Guidelines for Using the Sample Portal
Sample Portal Installation Directories
Desktop Theme Link

JSP-based Tab Container (JSPTabContainer)

JSPTabContainer Architecture
JSPTabContainer Actions

Banner Links
Links Specific to the Contained Container
Content and Layout Links

JSPTabContainer Edit Pages
JSPTabContainerProvider Display Profile
JSPTabContainer Channel Display Profile
Contained Containers' Display Profile
JSP Files Used by JSPTabContainer

JSP-based Table Container (JSPTableContainer)

JSPTableContainer Architecture
JSPTableContainer Actions

Banner Links
Links Specific to the Contained Container
Content and Layout Links

JSPTableContainerProvider Display Profile
JSPTableContainer Channel Display Profile
Container's Display Profile
JSP Files Used by JSPTableContainer

Frame-based Container (FrameTabContainer)

FrameTabContainer Architecture
FrameTabContainer Actions

Banner Links
Links Specific to the Contained Container
Content and Layout Links

FrameTabContainer Edit Pages
JSPTabContainerProvider Display Profile
FrameTabContainer Channel Display Profile
Contained Containers' Display Profile
JSP Files Used by FrameTabContainer

Template-based Containers (TemplateTabContainer and TemplateTableContainer)

Chapter 6 Customizing the Desktop Interface

Desktop Customization Overview

What Are the Areas for Customizing the Desktop?
JavaServer Page Caching Information
Desktop and JSP Debug Information
Channel Refresh Times and Container Caching
Contained Containers
Guidelines for Using the dpadmin Command

Adding Containers and Channels to the Desktop
Customizing Container Tabs

To Add a Tab to JSPTabContainer
Creating a Tab Within a Tab
To Stretch a Tab Across an Entire Container
To Change the Look of Tabs for JSP-based Tab Containers
To Make a Tab the Start Tab
Setting a Role Tab
To Add a Role-based Tab
Adding a Channel to a User-defined Tab

Customizing Channels

To Customize Window Preference
To Remove a Button From All Channels in a Container
To Remove a Button From a Single Channel

Creating Customized Organization JSP and Template Files

To Create Customized Organization JSP and Template Files

Customizing the Anonymous Desktop

Configuring Anonymous Authentication
To Enable Anonymous Log In
To Disable Anonymous Log In
To Enable Authentication-less (authlessanoymous) Log In
To Disable Authentication-less (authlessanoymous) Log In
To Access the Anonymous Desktop Through the Portal Server Host Name (obj.conf File)
To Access the Anonymous Desktop Through the Portal Server Host Name (index.html File)
To Disable the Initial iPlanet Directory Server Access Management Edition Login Page and Always Use Anonymous Log In
To Modify the Anonymous Banner and Menu Bar
Adding the Login Channel to the Anonymous Desktop of a Newly Created Organization

Customizing Authentication

To Use Unix Authentication with LoginProvider
To Modify the Default Desktop (Container) for authlessanonymous User

Modifying the Desktop Layout

Deriving More Desktop Layouts
To Derive More Desktop Layouts
Changing Content Layout to Support Categorizing the Available and Selected Lists
Adding New Layouts
To Change the Desktop Column Layout (Command Line)
To Change the Desktop Column Layout (iPlanet Directory Server Access Management Edition Admin Console)
To Change the Channel Layout for a Table Container
To Remove the Title Bar from a Channel
To Change the Channel Border Width
To Customize the Channel Border
To Modify Column Widths Directly (Using Scriptlets)

Branding the Desktop

To Change the HTML Title (Title That Appears in the Browser)
To Change the Logo (Image) in the Banner Header
To Change the Product Name in the Footer
To Change the Header and Footer of the Theme, Content, and Layout Pages

Changing Desktop Colors

To Change Desktop Colors
To Change the Default Color Scheme for an Organization

Adding and Customizing Global Themes

To Customize the Current Themes
To Add a Theme to the Sample Portal
To Change the Sample Anonymous Desktop Theme

Miscellaneous JSP Information

Performing Redirects
JSP vs. Theme Color
Recompiling JSPs

Chapter 7 Customizing the Search Provider

Overview of Customizing the Search Provider

Search Provider Design
Search JavaServer Pages and Tag Libraries

Tips for Customizing the Search Provider

Debugging the Search Provider
Location of Search JavaServer Pages
Modifying Search JavaServer Pages
Accessing Search Channel Directly

Customizing the Search Provider

To Modify the Default Search Server
To Add Search Box to Desktop and Display Search Results in a Separate Page
To Add last-modified to the Search Result Display
To Remove content-length from Search Results
To Display the Total Documents in the Search Result Status Message
To Remove author from the Advanced Search Interface
To Add a New Field to Advanced Search

Chapter 8 Customizing the Desktop End-User Online Help

Overview of the Desktop End-User Online Help
Location of the Desktop End-User Online Help HTML files
Modifying the Desktop End-User Online Help HTML files

To Edit An Existing Help File
To Create a New Help File

Appendix A Desktop Template and Tag Reference

Overview of Desktop Templates and Tags

How the Desktop Template Tags Work

Desktop Templates and Tag Reference

Appendix B JavaServer Pages Tag Library Reference

Tag Library Overview

Desktop Tag Library Hierarchy

Using Tags in JSPs

Using the Desktop Tag Library in Your Application
Example Tab Page with Selected Channels

Tag Reference

Attributes and Return Values
Tag Library Exceptions

Tag Overview

Context Setup Tags
Validator Tags
Normal Tags
Search Tags

Search Exceptions
Example of a Search JSP

Appendix C JavaServer Pages Reference

Anonymous FrameTabContainer Desktop JSPs
Anonymous JSPTabContainer Desktop JSPs
Anonymous JSPTableContainer Desktop JSPs
FrameTabContainer JSPs
JSPContentContainer JSPs
JSPCustomThemeContainer JSPs
JSPEditContainer JSPs
JSPFrameCustomTableContainerProvider JSPs
JSPLayoutContainer JSPs
JSPPopupContainer JSPs
JSPPresetThemeContainer JSPs
JSPProvider JSPs
JSPSingleContainer JSPs
JSPSingleContainerProvider JSPs
JSPTabContainer JSPs
JSPTabContainerProvider JSPs
JSPTabCustomTableContainerProvider JSPs
JSPTableContainerProvider JSPs
Miscellaneous JSPs
SampleJSP JSPs
SampleSimpleWebService JSPs
SampleSimpleWebServiceConfigurable JSPs
SimpleWebServiceConfigurableProvider JSPs
SimpleWebServiceProvider JSPs
Search JSPs
SearchProvider JSPs
TabJSPEditContainer JSPs

Index