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
Common User Interface Verbs

Where to Find Related Information
Where to Find This Guide Online

Chapter 1 Introduction to Administering the Sun™ ONE Portal Server

Architecture Overview
Portal Access Overview
Service Configuration Overview

iPlanet Directory Server Access Management Edition Services
Sun ONE Portal Server Services

Desktop
Rewriter
Search Engine
NetMail

Configuration Mechanisms for Sun ONE Portal Server Services

Administration Overview

Using the iPlanet Directory Server Access Management Edition Console
Using Command-Line Utilities

Chapter 2 Administering Authentication, Users, and Services

Overview of iPlanet Directory Server Access Management Edition

Summary of iPlanet Directory Server Access Management Edition Features
Comparison: Portal Server 3.0 and Portal Server 6.0
iPlanet Directory Server Access Management Edition Constraints
iPlanet Directory Server Access Management Edition Interfaces

iPlanet Directory Server Access Management Edition Admin Console
iPlanet Directory Server Access Management Edition Command-Line

Logging In to the iPlanet Directory Server Access Management Edition Admin Console

Configuring Log in to the Admin Console Using an IP Address

Viewing Basic Information
Starting and Stopping Sun ONE Portal Server
Managing iPlanet Directory Server Access Management Edition Services

Installation and Sun ONE Web Server Packaging
User Management
Single Sign-On/Authentication
Service Management

Managing Sun ONE Portal Server Users

Planning Organizations, Suborganizations, and Roles

Organizations and Suborganizations
Roles
Users
Scenario 1: Hierarchical Structure with Suborganizations and Roles
Scenario 2: Flat Tree Structure

Creating New Organizations and Suborganizations
To Create a New Organization or Suborganization
To Register a Service
To Create a Template for a Service
To Add a New User
To Create a New Role
To Assign a Role to a User
Enabling Existing Users to Access the Sun ONE Portal Server
To Enable Users in the Default Organization
To Enable Users in a Non-Default Organization
Creating a New Portal Organization

Configuring Authentication

To Configure the Authentication Menu
To Configure LDAP Authentication to an External Directory
Configuring Anonymous Authentication

To Configure Anonymous Authentication (Anonymous User Session Method)
To Configure Anonymous Authentication (Authentication-less User ID Method)

To Configure UNIX Authentication

Overview of How Sun ONE Portal Server Uses Policy Management

To Create a Desktop Policy
To Create a NetMail Policy
To Assign a Policy to an Organization

Logging In to the Sun ONE Portal Server Desktop

To Log In to the Sample Desktop
To Log In to a Suborganization
To Log On Using Anonymous Authentication

Managing Logging

Chapter 3 Configuring Delegated Administration

Overview of Delegated Administration

Delegated Administration Roles

Developing a Delegated Administration Model
Configuring Delegated Administration

Defining the ACI Settings for Role Administrator Roles

To Define an ACI Using the Command Line
To Define an ACI Using the Admin Console

To Create a New Admin Role for the Delegation Model
To Assign a Role Administrator Role
To Configure Additional Restrictions on a Role Administrator Role

Chapter 4 Administering the Desktop Service

Overview of the Desktop

Desktop Glossary
Desktop Architecture and Container Hierarchy
Desktop Providers
Desktop Service
Sample Desktops
Desktop Customization

Overview of Hot Deployment of Channels
Overview of Provider Archives
Administering the Desktop Service

To Register the Desktop Service
To Create the Default Desktop Service Template
To Create and Assign a Desktop Policy to Users
To Redirect Successful Login User to the Desktop URL
To Redirect Successful Login User to the Desktop URL (Global)
To Modify the Values of Desktop Service Attributes
To Modify the Values of Desktop Service Attributes (Global)
To Log On to the Sample Desktop
To Examine the Desktop Logs

Administering par Files

To Create a New par File
To Modify an Existing par File
To Deploy par Files

Chapter 5 Administering the Display Profile

Overview of Display Profile

Display Profile and the Admin Console
Display Profile Document Structure

DisplayProfile root Object
Provider Object
Channel Object
Container Object

Putting Together Display Profile Objects
Display Profile Object Lookup
Display Profile Properties

Display Profile Property Types
Document Type Definition Element Attributes
Specifying Display Profile Properties

Property Nesting
Unnamed Properties
Display Profile Property Propagation

Display Profile Merge Semantics

How the Merge Process Works
Display Profile Merge Types
Remove Example: Using remove Merge to Modify Container's Selected Channel List
Replace Example: Using replace Merge to Remove Channel from All Users' Display
Fuse Example: Using fuse Merge to Create Role-based Channel List
Merge Locking
Merge Locking Example: Using lock Merge to Force Property Value for All Users
Merge Locking Example: Using lock Merge to Force-remove Channel from All Users' Display
Display Profile Document Priorities
Document Priority Example 1
Document Priority Example 2
Display Profile Document Priority Summary

Display Profile and iPlanet Directory Server Access Management Edition
Administering the Display Profile

Default Display Profile Documents
Loading the Display Profile

To Load the Display Profile (Admin Console)
To Load the Display Profile (Command Line)
To Download and Upload a Display Profile

To View the Entire Display Profile
To Remove a Display Profile
Using the Channel and Container Management Link to Administer Channels
Channel and Container Management Default Providers

Add Channels
Add Container Channels
About the Notes Channel
Using Cookies with the URLScraper Channel *
This setting is on a channel-by-channel basis. See the Sun ONE Portal Server 6.0 Developer's Guide and Sun ONE Portal Server 6.0 Desktop Customization Guide for more information.

To Add a Channel or Container Channel
To Modify a Channel or Container Channel Property
To Remove a Channel or Container Channel
Administering Containers
Using the dpadmin Command
Guidelines for Using the dpadmin Command
Modifying the Display Profile
Understanding Display Profile Error Messages
To View a Display Profile Object
To Replace a Channel in a Container
To Replace a Property in a Channel
To Add a Channel to a Container
To Add a Property to a Collection
To Add a Collection Property
To Remove a Property from a Channel or Container
To Remove a Provider
To Remove a Channel from a Container
To Change a Display Profile Document Priority
To Make a Channel Available for a Container
To Make a Channel Unavailable for a Container
To Select a Channel from a Container's Available Channel List
To Unselect a Channel from a Containers Available Channel List
Using the Display Profile Text Window
To Access the Display Profile Text Window

Chapter 6 Administering the NetMail Service

Overview of the NetMail Service
Administering the NetMail Service

To Register the NetMail Service
To Create the Default NetMail Service Template
To Create and Assign a NetMail Policy to Users
To Modify Netmail Service Attributes (Specific Organization)
To Modify Netmail Service Attributes (All Organizations)
To Configure NetMail Lite to Open a New Window
Using the Remote Address Book (LDAP)

Chapter 7 Administering the Rewriter Service

Overview of the Rewriter Service

Expanding Relative URLs to Absolute URLs

URLScraperProvider Limitations

Prefixing the Gateway URL to an Existing URL

Supported URLs
Defining Rewriter Rules and Rulesets

Rules for HTML Content

Attribute Rules for HTML Content
JavaScript Token Rules for HTML Content
Form Rules for HTML Content
Applet Rules for HTML Content

Rules for JavaScript Content

JavaScript Variables
JavaScript Function Parameters

Rules for XML Content

Tag Text in XML
Attributes in XML

Administering the Rewriter Service

To Configure the Rewriter URLScraperProvider for SSL
To Create a New Ruleset from the Default Template
To Edit an Existing Ruleset
To Download a Ruleset
To Upload a Ruleset
To Delete an Existing Ruleset
To Restore the Default Ruleset

Chapter 8 Administering the Search Engine Service

Overview of the Search Engine Service

Search Database
Search Robots
Database Taxonomy Categories

Configuring the Search Channel

To Initially Configure the Search Server
To Define the Search URL

Administering the Search Engine

Viewing, Managing, and Monitoring Search Engine Operations
To View or Manage the Basic Settings
To View or Manage the Advanced Settings
To Monitor Search Engine Activity

Administering the Robot

Starting and Stopping the Robot
To Start and Stop the Robot
Defining Sites
To Define Sites for the Robot to Index
Controlling Robot Crawling
To Control Robot Crawling
Filtering Robot Data
To Create a New Filter Definition
To Modify an Existing Filter Definition
To Enable or Disable a Filter
Defining the Indexing Attributes
To Define the Indexing Attributes:
Using the Robot Utilities
To Run the Site Probe Utility
To Run the Simulator
Scheduling the Robot
To Schedule the Robot

Administering the Database

Importing to the Database
To Create an Import Agent
To Edit an Existing Import Agent
To Run an Import Agent Immediately
To Schedule an Import Agent for Processing
Editing RDs
To Edit the RDs
Editing the Database Schema
To Edit the Database Schema
Defining Schema Aliases
To Define Schema Aliases
Viewing Database Analysis
To View Database Analysis Information
Reindexing the Database
To Reindex the Database
Expiring the Database
To Expire the Database:
Purging the Database
To Purge Expired RDs from a Server:
Partitioning the Database
Optimizing the Database

Administering the Database Taxonomy

Configuring Categories
To Create a Child Category
To Create a Sibling Category
To Update a Category
To Delete a Category
Defining Classification Rules
To Define a Classification Rule
Reindexing the Category Tree
To Reindex the Category Tree:

Chapter 9 Administering the Search Engine Robot

Search Engine Robot Overview

How the Robot Works
Robot Configuration Files

Setting Robot Process Parameters
The Filtering Process

Stages in the Filter Process
Filter Syntax
Filter Directives
Writing or Modifying a Filter

User-Modifiable Parameters
Sample robot.conf File

Chapter 10 The Pre-defined Robot Application Functions

Sources and Destinations

Sources Available at the Setup Stage
Sources Available at the MetaData Filtering Stage
Sources Available at the Data Stage
Sources Available at the Enumeration, Generation, and Shutdown Stages
Enable Parameter

Setup Functions

filterrules-setup
setup-regex-cache
setup-type-by-extension

Filtering Functions

filter-by-exact
filter-by-max
filter-by-md5
filter-by-prefix
filter-by-regex
filterrules-process

Filtering Support Functions

assign-source
assign-type-by-extension
clear-source
convert-to-html
copy-attribute
generate-by-exact
generate-by-prefix
generate-by-regex
generate-md5
generate-rd-expires
generate-rd-last-modified
rename-attribute

Enumeration Functions

enumerate-urls
enumerate-urls-from-text

Generation Functions

extract-full-text
extract-html-meta
extract-html-text
extract-html-toc
extract-source
harvest-summarizer

Shutdown Functions

filterrules-shutdown

Chapter 11 Managing the Sun ONE Portal Server System

Configuring Secure Sockets Layer (SSL)

To Configure SSL with Sun ONE Portal Server
To Modify an Existing Sun ONE Portal Server Installation to Use SSL
To Configure a Sun ONE Portal Server Instance to Use SSL

Backing Up and Restoring Sun ONE Portal Server Configuration

To Back Up a Sun ONE Portal Server Configuration
To Restore a Sun ONE Portal Server Configuration

Changing Sun ONE Portal Server Network Settings
Managing a Multiple UI Node Installation

To Add Additional Portal Servers to the Server List

Configuring a Sun ONE Portal Server Instance to Use an HTTP Proxy
Managing Sun ONE Portal Server Logs

To Configure Logging to a File
To Configure Logging to a Database

Debugging Sun ONE Portal Server

To Set the Debug Level for iPlanet Directory Server Access Management Edition

Chapter 12 Command-Line Utilities

dpadmin

Description
Syntax

Short-Named Format
Long-Named Format

Subcommands

list
modify
add
remove
batch

Options

par

Description
Syntax

Short-Named Format
Long-Named Format

Subcommands

containers
describe
export
import

Options
Arguments
Export Files
Operations
Par Files

Par File Contents

rwadmin

Description
Syntax

Short Named Format
Long Named Format

Subcommands

list
store
get
remove

Options

rdmgr

Description
Syntax
Subcommands

Resource Description Subcommands
Database Maintenance Subcommands
Usage Message and Version Subcommands

Return Codes

sendrdm

Description
Syntax
Options
Example

StartRobot

Syntax
Options

Appendix A Configuration Files

Overview of Sun™ ONE Portal Server Configuration Files
Desktop Configuration Properties
Search Configuration Properties

Appendix B XML Reference

Sun ONE Portal Server Desktop Service Definition
Sun ONE Portal Server NetMail Service Definition
Sun ONE Portal Server Rewriter Service Definition
Sun ONE Portal Server Search Service Definition
Display Profile DTD
Rewriter Ruleset DTD
Default Ruleset

Appendix C Desktop Attributes

Desktop Global Attributes
Desktop Dynamic Attributes

Appendix D NetMail Attributes

NetMail Dynamic Attributes

Appendix E Rewriter Attributes

Appendix F Search Attributes

Server

Settings
Advanced

Robot

Control
Sites
Crawling
Indexing
Simulator
Site Probe
Schedule

Database

Import
Edit
Schema
Reindex
Purge
Expire
Analysis
Schedule

Categories

Category Editor
Classification Rules Editor
Reindex

Reports

Starting Points
Excluded URLs
Robot Advanced Reports
View Log Files
Popular Searches

Appendix G Schema Reference

Sun ONE Portal Server Desktop Schema
Sun ONE Portal Server NetMail Schema
Sun ONE Portal Server Search Schema