Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Structure
• Related Documentation
• Conventions

What's New in Oracle Ultra Search

• New Features in Release 11g
• Oracle Ultra Search Release Information

1 Introduction to Oracle Ultra Search

• Overview of Oracle Ultra Search
• Oracle Ultra Search Components
  • Oracle Ultra Search Crawler
  • Oracle Ultra Search Backend
  • Oracle Ultra Search Middle Tier
    • Oracle Ultra Search Administration Tool
    • Oracle Ultra Search APIs and Query Applications
    • Web Application Concepts
• Oracle Ultra Search Features
  • Oracle Ultra Search Instance
  • Document and Search Attributes
  • Metadata Loader
  • Internationalization in Oracle Ultra Search
  • Oracle Ultra Search Crawler Features
    • Robots
    • Data Harvesting
    • URL Rewrite
  • Query API
  • Secure Search
    • Dependency on Oracle XML DB
  • Document Relevancy Boosting
  • Query Syntax Expansion
  • Display URL Support
  • Federated Search
  • Single Sign-On Authentication
  • Integration with Oracle Internet Directory
    • Oracle Ultra Search Administration Groups in Oracle Internet Directory
    • Authorization of the Administration Privileges
  • Query Applications
  • Integration with Oracle Application Server
• Oracle Ultra Search System Configuration

2 Getting Started with Oracle Ultra Search

• Overview
• Installation
  • Using the Oracle Universal Installer
  • Accessing the Oracle Ultra Search Administration Application
• Setting up the Query Application

3 Using Oracle Ultra Search with Oracle Application Server

• Oracle Ultra Search Backend with Oracle Application Server
  • Changing the Character Set of Oracle Metadata Repository
• Oracle Ultra Search Middle Tier with Oracle Application Server
  • Installing the Middle Tier with Oracle Application Server
• Configuring Oracle Ultra Search in a Hosted Environment (Optional)
  • Oracle Ultra Search Administrator Privilege Model in the Hosted Environment
    • Administration Privilege Model

4 Installing Oracle Ultra Search

• Oracle Ultra Search Requirements
  • Hardware Requirements for Oracle Ultra Search
  • Software Requirements for Oracle Ultra Search
• Installing the Oracle Ultra Search Backend
• Installing the Oracle Ultra Search Middle Tier
  • Installing the Middle Tier with the Oracle Database
• Postinstallation Tasks
  • Unlock WKSYS and WK_TEST
  • Enable the Oracle Ultra Search Query Applications
  • Start the Oracle Ultra Search Middle Tier
  • Restart the Oracle Ultra Search Middle Tier
  • Reconfigure the Oracle Ultra Search Backend for the Database Character Set
• Checking Your Oracle Ultra Search Installation
  • Testing the Oracle Ultra Search Administration Tool
  • Testing the Oracle Ultra Search Query Applications
• Troubleshooting Oracle Ultra Search
  • Turning the Debug Mode On
• Installing the Backend on Remote Crawler Hosts
  • Installing the Backend on Remote Crawler Hosts
  • Configuring the Remote Crawler
  • Unregistering a Remote Crawler
• Upgrading Oracle Ultra Search Shipped with Oracle Database

5 Oracle Ultra Search Postinstallation Information

• Changing Oracle Ultra Search Schema Passwords
• Configuring the Oracle Server for Oracle Ultra Search
  • Step 1: Tune the Oracle Database
  • Step 2: Create and Assign the Temporary Tablespace to the CTXSYS User
  • Step 3: Create a Large Tablespace for Each Oracle Ultra Search Instance User
  • Step 4: Create and Configure New Users for Oracle Ultra Search Instances
  • Step 5: Alter the Index Preferences
• Configuring Oracle Ultra Search for SSL
• Managing Stoplists
  • Default Oracle Ultra Search Stoplist
  • Modifying Instance Stoplists
    • Modifying Instance Stoplists Before Initial Crawling
    • Modifying Instance Stoplists After Initial Crawling
• Configuring the Query Application

6 Security in Oracle Ultra Search

• About Oracle Ultra Search Security
  • Oracle Ultra Search Security Model
  • Oracle Ultra Search with Secure Socket Layer and HTTPS
  • Classes of Users and Their Privileges
    • Oracle Ultra Search Default Users
  • Resources Protected by Oracle Ultra Search
  • Authorization and Access Enforcement
  • How Oracle Ultra Search Leverages Security Services
  • How Oracle Ultra Search Leverages the Oracle Identity Management Infrastructure
  • Oracle Ultra Search Extensibility and Security
• Configuring a Security Framework for Oracle Ultra Search
  • Configuring Security Framework Options for Oracle Ultra Search
• Configuring Secure Search in Oracle Ultra Search
  • Pre-requirements of Enabling Secure Search in OracleAS 10g Release
  • Enabling Secure Search in OracleAS 10g Release
    • Configuring the Oracle Internet Directory- SSL Link
    • Creating the /sys/apps/ultrasearch Folder
    • Activating the Secure Search Functionality in Oracle Ultra Search
    • Activating Secure Search in the Query Application

7 Understanding the Oracle Ultra Search Crawler and Data Sources

• Overview of the Oracle Ultra Search Crawler
• Crawler Settings
• Crawler Data Sources
  • Using Crawler Agents
  • Synchronizing Data Sources
  • Display URL and Access URL
• Document Attributes
• Crawling Process for the Schedule
  • Queuing and Caching Documents
  • Indexing Documents
• Data Synchronization
• Web Crawling Boundary Control
  • URL Boundary Rule
  • robots.txt Protocol and robots Metatag
  • Crawling Depth
  • URL Rewriter
  • URL Redirection and Boundary Rule Enforcement
• Oracle Ultra Search Remote Crawler
• Oracle Ultra Search Crawler Status Codes

8 Understanding the Oracle Ultra Search Administration Tool

• Oracle Ultra Search Administration Tool
  • Setting Crawler Parameters
  • Setting Query Options
    • Attributes
    • Data Groups
  • Online Help in Different Languages
• Logging On to Oracle Ultra Search
• Logging On and Managing Instances as Single Sign-On Users
  • Logging On to Oracle Ultra Search
  • Granting Privileges to Single Sign-On Users
• Instances Page
  • Creating an Instance
    • Creating a Regular Instance
    • Creating a Snapshot Instance
  • Selecting an Instance
  • Deleting an Instance
  • Editing an Instance
    • Instance Mode
    • Schema Password
• Crawler Page
  • Configure the Settings
  • Remote Crawler Profiles
  • Crawler Statistics
    • Summary of Crawler Activity
    • Detailed Crawler Statistics
    • Crawler Progress
    • Problematic URLs
• Web Access Page
  • Proxies
  • Authentication
    • HTTP Authentication
    • HTML Form Authentication
  • HTML Forms in Oracle Ultra Search
  • Registering Forms
    • Wizard-Based HTML Form Registration
    • Manual HTML Form Registration
• Attributes Page
  • Search Attributes
  • Mappings
• Sources Page
  • Web Sources
    • Creating Web Sources
  • Table Sources
    • Creating Table Sources
    • Editing Table Sources
    • Table Sources Comprised of More Than One Table
    • Limitations With Database Links
  • E-mail Sources
    • Creating E-mail Sources
  • File Sources
    • Creating File Sources
  • Oracle Sources
    • Oracle Portal Sources
    • Federated Sources
  • User-Defined Sources
    • Creating User-Defined Data Source Types
    • Creating User-Defined Sources
• Schedules Page
  • Data Synchronization
    • Creating Synchronization Schedules
    • Updating Schedules
    • Editing Synchronization Schedules
    • Launching Synchronization Schedules
    • Synchronization Status and Crawler Progress
  • Index Optimization
• Queries Page
  • Data Groups
  • URL Submission
  • Relevancy Boosting
  • Query Statistics
  • Configuration
• Users Page
  • Preferences
  • Super-Users
  • Privileges
• Globalization Page
  • Search Attribute Name
  • LOV Display Name
  • Data Group Name

9 Implementing Ultra Search on an Application

• Setting up the Ultra Appliance Demo
• Crawl and Index Ultra Appliance's Intranet Documents
• Crawl and Index Ultra Appliance's Database Documents
• Issuing a Query

10 Oracle Ultra Search Developer's Guide and API Reference

• Overview of Oracle Ultra Search APIs
• Oracle Ultra Search Query API
• Customizing the Query Syntax Expansion
  • Default Query Syntax Expansion Implementation
    • End User Query Syntax
    • Scoring Classes
    • Expansion Rules
    • Examples of Applying the Rules
  • Customizing the Rules
• Oracle Ultra Search Query Tag Library
  • Query Tag Descriptions
    • <instance> Tag: Connecting to the Oracle Ultra Search Instance
    • <iterAttributes> Tag: Show All Search Attributes
    • <iterGroups> Tag: Show All Search Groups
    • <iterLanguages> Tag: Show All Search Languages
    • <iterLOV> Tag: Show All Values Defined for a Search Attribute
    • Formulating the Query
    • <getResult> Tag: Perform Search
    • <fetchAttribute> Tag: Metadata Selection
    • <showHitCount> Tag: Show Estimated Hit Count
    • <iterResult> Tag: Render the Results
    • <showAttributeValue> Tag: Render a Document Attribute
• Oracle Ultra Search Crawler Agent API
  • Crawler Agent Overview
    • Standard Agent
    • Smart Agent
    • Document Attributes and Properties
    • Library Path and Java Class Path
  • Crawler Agent Functionality
    • Data Source Type Registration
    • Data Source Registration
    • Data Source Attribute Registration
    • User-Implemented Crawler Agent
    • Interaction Between the Crawler and the Crawler Agent
    • Crawler Agent APIs and Classes
  • Sample Agent Files
  • Setting up the Sample Crawler Agent
    • Compiling and Building the Agent Jar File
    • Creating a Data Source Type
    • Defining Data Source Parameters
    • Defining a Data Source of this Type
• Oracle Ultra Search Java E-mail API
  • JavaMail Implementation
  • Java E-mail API
  • Mailing List Browser Application Files
  • Setting up the Mailing List Browser Application
• Oracle Ultra Search URL Rewriter API
  • URL Link Filtering
  • URL Link Rewriting
  • Creating and Using a URL Rewriter
• Oracle Ultra Search Document Service API
  • APIs and Classes
  • Interface DocumentService
  • Agent Registration Client Interface
  • Example of Setting Up the Document Service Agent
• Oracle Ultra Search Query Applications
  • Query Applications
  • JavaServer Page Concepts

11 Tuning and Performance in Oracle Ultra Search

• Tuning the Web Crawling Process
  • Web Crawling Strategy
  • Monitoring the Crawling Process
  • URL Looping
• Tuning Query Performance
• Using the Remote Crawler
  • Understanding the Launcher
  • RMI-Based Remote Crawling
  • JDBC-Based Remote Crawling
  • Security With Remote Crawlers
  • Scalability and Load Balancing
  • Installation and Configuration Sequence
• Oracle Ultra Search on Real Application Clusters
  • Configuring Storage Access
    • Remote Crawler File Cache
  • Logging on to the Oracle Instance
    • Query Search Application for Read Application Clusters
    • Java Crawler
    • Choosing a JDBC Driver
  • Oracle Ultra Search Failover in a RAC Environment
• Table Data Source Synchronization
  • Synchronizing Crawling of Oracle Databases
    • Create Log Table
    • Create Log Triggers
  • Synchronizing Crawling of Non-Oracle Databases

12 Oracle Ultra Search Administration PL/SQL APIs

• Instance-Related APIs
  • CREATE_INSTANCE
    • Syntax
    • Example
  • DROP_INSTANCE
    • Syntax
    • Example
  • GRANT_ADMIN
    • Syntax
    • Example
  • REVOKE_ADMIN
    • Syntax
    • Example
  • SET_INSTANCE
    • Syntax
    • Example
• Schedule-Related APIs
  • CREATE_SCHEDULE
    • Syntax
    • Example
  • DROP_SCHEDULE
    • Syntax
    • Example
  • INTERVAL
    • Syntax
    • Examples
  • SET_SCHEDULE
    • Syntax
    • Example
  • UPDATE_SCHEDULE
    • Syntax
    • Examples
• Crawler Configuration APIs
  • SET_ADMIN_READONLY
    • Syntax
    • Examples
  • IS_ADMIN_READONLY
    • Syntax
    • Example
  • UPDATE_CRAWLER_CONFIG
    • Syntax
    • Example

A Loading Metadata into Oracle Ultra Search

• Launching the Loading Tool
• Loading Documents and Relevance Scores
  • The Input XML File
    • Example of the Document Relevance Boosting XML File
• Loading Search Attribute LOVs and LOV Display Names
  • The LOV XML File
    • Example of the LOV XML File
• XML Schema for Document Relevance Boosting
• XML Schema for LOVs and LOV Display Names

B Altering the Crawler Java Classpath

• Reasons for Altering the Crawler Java Classpath
• Difference Between the Crawler Classpath and the Remote Crawler Classpath
• Altering the Crawler Java Classpath on the Oracle Ultra Search Server Host
• Altering the Crawler Java Classpath on a Remote Crawler Host

C Oracle Ultra Search Views

• OUS_INSTANCES
• OUS_SCHEDULES
• OUS_DEFAULT_CRAWLER_SETTINGS
• OUS_CRAWLER_SETTINGS

D URL Crawler Status Codes

E Error Messages

Index