Skip Headers

Oracle® Ultra Search User's Guide
10g Release 1 (10.1)

Part Number B10731-02
Go to Documentation Home
Go to Book List
Book List
Go to Index
Go to Master Index
Master Index
Go to Feedback page

Go to next page
View PDF


List of Examples

List of Figures

List of Tables

Title and Copyright Information

Send Us Your Comments


Documentation Accessibility
Related Documentation

What's New in Oracle Ultra Search?

Ultra Search Release Information

1 Introduction to Oracle Ultra Search

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

2 Getting Started with Oracle Ultra Search

Using the Oracle Universal Installer
Accessing the Ultra Search Administration Application
Setting up the Sample Query 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

3 Installing and Configuring Ultra Search

Ultra Search Requirements
Hardware Requirements
Software Requirements
Installing the Ultra Search Backend
Database Release
Oracle Application Server Release
Installing As Part of Oracle Application Server Metadata Repository Creation
Installing Into an Existing Database
Post-Installation Tasks for the Ultra Search Backend
Enabling Ultra Search to Process Binary Files
Configure the Oracle Database for Ultra Search
Configure a Secure Ultra Search Installation
Backend Reconfiguration After a Database Character Set Change
Configuring the Default Ultra Search Instance
Installing the Ultra Search Middle Tier on Web Server Hosts
Web Applications Concepts
Browser Requirements
Installing the Middle Tier with the Oracle Database Release
Installing the Middle Tier with the Oracle Application Server Release
Configuring the Middle Tier with Oracle HTTP Server and OC4J
Configuring the Administration Tool with Single Sign-On Server
Deploying the Ultra Search EAR File on a Third Party Middle Tier
Editing the data-sources.xml File
Editing the File
Starting the Web Server
Testing the Ultra Search Administration Tool
Testing the Ultra Search Sample Query Applications
Installing the Backend on Remote Crawler Hosts
Installing the Backend on Remote Crawler Hosts
Configuring the Remote Crawler
Unregistering a Remote Crawler
Configuring Ultra Search in a Hosted Environment
Preconfiguration Tasks for a Hosted Environment
Configuring Ultra Search in the Subscriber Context

4 Post-Installation Information

Changing Ultra Search Schema Passwords
Configuring the Oracle Server for 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 Ultra Search Instance User
Step 4: Create and Configure New Users for Ultra Search Instances
Step 5: Alter the Index Preferences
Configuring Ultra Search for SSL
Managing Stoplists
Default Ultra Search Stoplist
Modifying Instance Stoplists
Modifying Instance Stoplists Before Initial Crawling
Modifying Instance Stoplists After Initial Crawling
Upgrading Ultra Search
Pre-Upgrade Steps
Upgrading Ultra Search Shipped with Oracle Database
Upgrading Ultra Search Shipped with Oracle Application Server
Upgrading Ultra Search Shipped with Oracle Collaboration Suite
Upgrading Ultra Search to Oracle Collaboration Suite Release 1
Upgrade from Ultra Search 1.0.3 to 9.0.3
Upgrade from Ultra Search 9.0.2 to 9.0.3
Upgrade from Ultra Search 9.2 to 9.0.3
Post-Upgrade Configuration Steps
Post-Upgrade Example in Non-RAC Environment
Post-Upgrade Example in RAC Environment
Configuring the Query Application
Step 1: Edit the data-sources.xml File
Step 2: Deploy Multiple Query Applications Against Multiple Instances

5 Security in Oracle Ultra Search

About Ultra Search Security
Ultra Search Security Model
Ultra Search with Secure Socket Layer and HTTPS
Classes of Users and Their Privileges
Ultra Search Default Users
Ultra Search Admin Privilege Model in the Hosted Environment
Admin Privilege Model
Resources Protected by Ultra Search
Authorization and Access Enforcement
How Ultra Search Leverages Security Services
How Ultra Search Leverages the Identity Management Infrastructure
Ultra Search Extensibility and Security
Configuring a Security Framework for Ultra Search
Configuring Security Framework Options for Ultra Search
Configuring Oracle Identity Management Options for Ultra Search
Configuring Ultra Search Security

6 Understanding the Oracle Ultra Search Crawler and Data Sources

Overview of the 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
Ultra Search Remote Crawler
Ultra Search Crawler Status Codes

7 Understanding the Ultra Search Administration Tool

Ultra Search Administration Tool
Setting Crawler Parameters
Setting Query Options
Data Groups
Online Help in Different Languages
Logging On to Ultra Search
Logging On and Managing Instances as SSO Users
Logging On to Ultra Search
Granting Privileges to SSO 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
HTTP Authentication
HTML Forms
Attributes Page
Search Attributes
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
Email Sources
Creating Email 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
Users Page
Globalization Page
Search Attribute Name
LOV Display Name
Data Group Name

8 Ultra Search Developer's Guide and API Reference

Overview of Ultra Search APIs
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
Ultra Search Query Tag Library
Query Tag Descriptions
<instance> Tag: Connecting to the 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
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
Ultra Search Java Email API
JavaMail Implementation
Java Email API
Sample Mailing List Browser Application Files
Setting up the Sample Mailing List Browser Application
Ultra Search URL Rewriter API
URL Link Filtering
URL Link Rewriting
Creating and Using a URL Rewriter
Ultra Search Document Service API
APIs and Classes
Interface DocumentService
Agent Registration Client Interface
Example of Setting Up the Sample Document Service Agent
Ultra Search Sample Query Applications
Sample Query Applications
JavaServer Page Concepts

9 Tuning and Performance

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
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
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

10 Administration PL/SQL APIs

Instance-Related APIs
Schedule-Related APIs
Crawler Configuration APIs

A Loading Metadata into 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 Ultra Search Server Host
Altering the Crawler Java Classpath on a Remote Crawler Host

C Ultra Search Views


D URL Crawler Status Codes