Skip Headers
Oracle® Ultra Search User's Guide
10
g
Release 1 (10.1)
Part Number B10731-01
Home
Book List
Index
Master Index
Feedback
Next
View PDF
Contents
List of Examples
List of Figures
List of Tables
Title and Copyright Information
Send Us Your Comments
Preface
Audience
Organization
Related Documentation
Conventions
Documentation Accessibility
What's New in Oracle Ultra Search?
Oracle Ultra Search Release Information
1
Introduction to Oracle Ultra Search
1.1
Overview of Oracle Ultra Search
1.2
Oracle Ultra Search Components
1.2.1
Oracle Ultra Search Crawler
1.2.2
Oracle Ultra Search Backend
1.2.3
Oracle Ultra Search Administration Tool
1.2.4
Oracle Ultra Search APIs and Sample Applications
1.3
Oracle Ultra Search Features
1.3.1
Integration with Oracle Application Server
1.3.2
Extensible Crawler and Crawler Agents
1.3.3
Federated Search
1.3.4
Secure Search
1.3.4.1
Dependency on Oracle XML DB
1.3.5
Sample Query Applications
1.3.6
Sample Search Portlet
1.3.7
Query API
1.3.8
URL Rewrite
1.3.9
Robots Exclusions
1.3.10
Display URL Support
1.3.11
Document and Search Attributes
1.3.12
Metadata Loader
1.3.13
Document Relevancy Boosting
1.3.14
Data Harvesting Mode
1.3.15
Instance Snapshot Support
1.3.16
Integration with Oracle Internet Directory
1.3.16.1
Oracle Ultra Search Administration Groups in Oracle Internet Directory
1.3.16.2
Authorization of the Administration Privileges
1.3.17
Single Sign-On Authentication
1.3.18
Query Syntax Expansion
1.4
Oracle Ultra Search System Configuration
2
Getting Started with Oracle Ultra Search
2.1
Overview
2.2
Installation
2.2.1
Using the Oracle Universal Installer
2.2.2
Accessing the Ultra Search Administration Application
2.3
Setting up the Sample Query Application
2.4
Setting up the Ultra Appliance Demo
2.5
Crawl and Index Ultra Appliance's Intranet Documents
2.6
Crawl and Index Ultra Appliance's Database Documents
2.7
Issuing a Query
3
Installing and Configuring Oracle Ultra Search
3.1
Oracle Ultra Search Requirements
3.1.1
Hardware Requirements
3.1.2
Software Requirements
3.2
Installing the Oracle Ultra Search Backend
3.2.1
Database Release
3.2.2
Oracle Application Server Release
3.2.2.1
Installing As Part of Oracle Application Server Metadata Repository Creation
3.2.2.2
Installing Into an Existing Database
3.2.3
Post-Installation Tasks for the Oracle Ultra Search Backend
3.2.3.1
Enabling Oracle Ultra Search to Process Binary Files
3.2.3.2
Configure the Oracle Database for Oracle Ultra Search
3.2.3.3
Configure a Secure Oracle Ultra Search Installation
3.2.3.4
Backend Reconfiguration After a Database Character Set Change
3.3
Configuring the Default Oracle Ultra Search Instance
3.4
Installing the Oracle Ultra Search Middle Tier on Web Server Hosts
3.4.1
Web Applications Concepts
3.4.2
Browser Requirements
3.4.3
Installing the Middle Tier with the Oracle Database Release
3.4.4
Installing the Middle Tier with the Oracle Application Server Release
3.4.4.1
Configuring the Middle Tier with Oracle HTTP Server and OC4J
3.4.4.2
Configuring the Administration Tool with Single Sign-On Server
3.4.4.3
Deploying the Oracle Ultra Search EAR File on a Third Party Middle Tier
3.4.4.4
Editing the data-sources.xml File
3.4.4.5
Editing the ultrasearch.properties File
3.4.4.6
Starting the Web Server
3.4.4.7
Testing the Oracle Ultra Search Administration Tool
3.4.4.8
Testing the Oracle Ultra Search Sample Query Applications
3.5
Installing the Backend on Remote Crawler Hosts
3.5.1
Installing the Backend on Remote Crawler Hosts
3.5.2
Configuring the Remote Crawler
3.5.3
Unregistering a Remote Crawler
3.6
Configuring Oracle Ultra Search in a Hosted Environment
3.6.1
Preconfiguration Tasks for a Hosted Environment
3.6.2
Configuring Oracle Ultra Search in the Subscriber Context
4
Post-Installation Information
4.1
Changing Oracle Ultra Search Schema Passwords
4.2
Configuring the Oracle Server for Oracle Ultra Search
4.2.1
Step 1: Tune the Oracle Database
4.2.2
Step 2: Create and Assign the Temporary Tablespace to the CTXSYS User
4.2.3
Step 3: Create a Large Tablespace for Each Oracle Ultra Search Instance User
4.2.4
Step 4: Create and Configure New Users for Oracle Ultra Search Instances
4.2.5
Step 5: Alter the Index Preferences
4.3
Managing Stoplists
4.3.1
Default Oracle Ultra Search Stoplist
4.3.2
Modifying Instance Stoplists
4.3.2.1
Modifying Instance Stoplists Before Initial Crawling
4.3.2.2
Modifying Instance Stoplists After Initial Crawling
4.4
Upgrading Oracle Ultra Search
4.4.1
Pre-Upgrade Steps
4.4.2
Upgrading Oracle Ultra Search Shipped with Oracle Database
4.4.3
Upgrading Oracle Ultra Search Shipped with Oracle Application Server
4.4.4
Upgrading Oracle Ultra Search Shipped with Oracle Collaboration Suite
4.4.5
Upgrading Oracle Ultra Search to Oracle Collaboration Suite Release 1
4.4.5.1
Upgrade from Oracle Ultra Search 1.0.3 to 9.0.3
4.4.5.2
Upgrade from Oracle Ultra Search 9.0.2 to 9.0.3
4.4.5.3
Upgrade from Oracle Ultra Search 9.2 to 9.0.3
4.5
Configuring the Query Application
4.5.1
Step 1: Edit the data-sources.xml File
4.5.2
Step 2: Deploy Multiple Query Applications Against Multiple Instances
5
Tuning and Performance
5.1
Tuning the Web Crawling Process
5.1.1
Web Crawling Strategy
5.1.2
Monitoring the Crawling Process
5.1.3
URL Looping
5.2
Tuning Query Performance
5.3
Using the Remote Crawler
5.3.1
Understanding the Launcher
5.3.2
RMI-Based Remote Crawling
5.3.3
JDBC-Based Remote Crawling
5.3.4
Security With Remote Crawlers
5.3.5
Scalability and Load Balancing
5.3.6
Installation and Configuration Sequence
5.4
Oracle Ultra Search on Real Application Clusters
5.4.1
Configuring Storage Access
5.4.1.1
Remote Crawler File Cache
5.4.2
Logging on to the Oracle Instance
5.4.2.1
Query Search Application for Read Application Clusters
5.4.2.2
Java Crawler
5.4.2.3
Choosing a JDBC Driver
5.5
Table Data Source Synchronization
5.5.1
Synchronizing Crawling of Oracle Databases
5.5.1.1
Create Log Table
5.5.1.2
Create Log Triggers
5.5.2
Synchronizing Crawling of Non-Oracle Databases
6
Security in Oracle Ultra Search
6.1
About Oracle Ultra Search Security
6.1.1
Oracle Ultra Search Security Model
6.1.2
Classes of Users and Their Privileges
6.1.2.1
Oracle Ultra Search Default Users
6.1.3
Oracle Ultra Search Admin Privilege Model in the Hosted Environment
6.1.3.1
Admin Privilege Model
6.1.4
Resources Protected by Oracle Ultra Search
6.1.5
Authorization and Access Enforcement
6.1.6
How Oracle Ultra Search Leverages Security Services
6.1.7
How Oracle Ultra Search Leverages the Identity Management Infrastructure
6.1.8
Oracle Ultra Search Extensibility and Security
6.2
Configuring a Security Framework for Oracle Ultra Search
6.2.1
Configuring Security Framework Options for Oracle Ultra Search
6.2.2
Configuring Oracle Identity Management Options for Oracle Ultra Search
6.3
Configuring Oracle Ultra Search Security
7
Understanding the Oracle Ultra Search Crawler and Data Sources
7.1
Overview of the Oracle Ultra Search Crawler
7.2
Crawler Settings
7.3
Crawler Data Sources
7.3.1
Using Crawler Agents
7.3.2
Synchronizing Data Sources
7.3.3
Display URL and Access URL
7.4
Document Attributes
7.5
Crawling Process for the Schedule
7.5.1
Queuing and Caching Documents
7.5.2
Indexing Documents
7.6
Data Synchronization
7.7
Web Crawling Boundary Control
7.7.1
URL Boundary Rule
7.7.2
robots.txt Protocol and robots META Tag
7.7.3
Crawling Depth
7.7.4
URL Rewriter
7.7.5
URL Redirection and Boundary Rule Enforcement
7.8
Oracle Ultra Search Remote Crawler
7.9
Oracle Ultra Search Crawler Status Codes
8
Understanding the Oracle Ultra Search Administration Tool
8.1
Oracle Ultra Search Administration Tool
8.1.1
Setting Crawler Parameters
8.1.2
Setting Query Options
8.1.2.1
Attributes
8.1.2.2
Data Groups
8.1.3
Online Help in Different Languages
8.2
Logging On to Oracle Ultra Search
8.3
Logging On and Managing Instances as SSO Users
8.3.1
Logging On to Oracle Ultra Search
8.3.2
Granting Privileges to SSO Users
8.4
Instances Page
8.4.1
Creating an Instance
8.4.1.1
Creating a Regular Instance
8.4.1.2
Creating a Snapshot Instance
8.4.2
Selecting an Instance
8.4.3
Deleting an Instance
8.4.4
Editing an Instance
8.4.4.1
Instance Mode
8.4.4.2
Schema Password
8.5
Crawler Page
8.5.1
Configure the Settings
8.5.2
Remote Crawler Profiles
8.5.3
Crawler Statistics
8.5.3.1
Summary of Crawler Activity
8.5.3.2
Detailed Crawler Statistics
8.5.3.3
Crawler Progress
8.5.3.4
Problematic URLs
8.6
Web Access Page
8.6.1
Proxies
8.6.2
Authentication
8.6.2.1
HTTP Authentication
8.6.2.2
HTML Forms
8.7
Attributes Page
8.7.1
Search Attributes
8.7.2
Mappings
8.8
Sources Page
8.8.1
Web Sources
8.8.1.1
Creating Web Sources
8.8.2
Table Sources
8.8.2.1
Creating Table Sources
8.8.2.2
Editing Table Sources
8.8.2.3
Table Sources Comprised of More Than One Table
8.8.2.4
Limitations With Database Links
8.8.3
Email Sources
8.8.3.1
Creating Email Sources
8.8.4
File Sources
8.8.4.1
Creating File Sources
8.8.5
Oracle Sources
8.8.5.1
Oracle Portal Sources
8.8.5.2
Federated Sources
8.8.6
User-Defined Sources
8.8.6.1
Creating User-Defined Data Source Types
8.8.6.2
Creating User-Defined Sources
8.9
Schedules Page
8.9.1
Data Synchronization
8.9.1.1
Creating Synchronization Schedules
8.9.1.2
Updating Schedules
8.9.1.3
Editing Synchronization Schedules
8.9.1.4
Launching Synchronization Schedules
8.9.1.5
Synchronization Status and Crawler Progress
8.9.2
Index Optimization
8.10
Queries Page
8.10.1
Data Groups
8.10.2
URL Submission
8.10.3
Relevancy Boosting
8.10.4
Query Statistics
8.10.5
Configuration
8.11
Users Page
8.11.1
Preferences
8.11.2
Super-Users
8.11.3
Privileges
8.12
Globalization Page
8.12.1
Search Attribute Name
8.12.2
LOV Display Name
8.12.3
Data Group Name
9
Oracle Ultra Search Developer's Guide and API Reference
9.1
Overview of Oracle Ultra Search APIs
9.2
Oracle Ultra Search Query API
9.3
Customizing the Query Syntax Expansion
9.3.1
Default Query Syntax Expansion Implementation
9.3.1.1
End User Query Syntax
9.3.1.2
Scoring Classes
9.3.1.3
Expansion Rules
9.3.1.4
Examples of Applying the Rules
9.3.2
Customizing the Rules
9.4
Oracle Ultra Search Query Tag Library
9.4.1
Query Tag Descriptions
9.4.1.1
<instance> Tag: Connecting to the Oracle Ultra Search Instance
9.4.1.2
<iterAttributes> Tag: Show All Search Attributes
9.4.1.3
<iterGroups> Tag: Show All Search Groups
9.4.1.4
<iterLanguages> Tag: Show All Search Languages
9.4.1.5
<iterLOV> Tag: Show All Values Defined for a Search Attribute
9.4.1.6
Formulating the Query
9.4.1.7
<getResult> Tag: Perform Search
9.4.1.8
<fetchAttribute> Tag: Metadata Selection
9.4.1.9
<showHitCount> Tag: Show Estimated Hit Count
9.4.1.10
<iterResult> Tag: Render the Results
9.4.1.11
<showAttributeValue> Tag: Render a Document Attribute
9.5
Oracle Ultra Search Crawler Agent API
9.5.1
Crawler Agent Overview
9.5.1.1
Standard Agent
9.5.1.2
Smart Agent
9.5.1.3
Document Attributes and Properties
9.5.2
Crawler Agent Functionality
9.5.2.1
Data Source Type Registration
9.5.2.2
Data Source Registration
9.5.2.3
Data Source Attribute Registration
9.5.2.4
User-Implemented Crawler Agent
9.5.2.5
Interaction Between the Crawler and the Crawler Agent
9.5.2.6
Crawler Agent APIs and Classes
9.5.3
Sample Agent Files
9.5.4
Setting up the Sample Crawler Agent
9.5.4.1
Compiling and Building the Agent Jar File
9.5.4.2
Creating a Data Source Type
9.5.4.3
Defining Data Source Parameters
9.5.4.4
Defining a Data Source of this Type
9.6
Oracle Ultra Search Java Email API
9.6.1
JavaMail Implementation
9.6.2
Java Email API
9.6.3
Sample Mailing List Browser Application Files
9.6.4
Setting up the Sample Mailing List Browser Application
9.7
Oracle Ultra Search URL Rewriter API
9.7.1
URL Link Filtering
9.7.2
URL Link Rewriting
9.7.3
Creating and Using a URL Rewriter
9.8
Oracle Ultra Search Sample Query Applications
9.8.1
Sample Query Applications
9.8.2
JavaServer Page Concepts
10
Administration PL/SQL APIs
Instance-Related APIs
CREATE_INSTANCE
DROP_INSTANCE
GRANT_ADMIN
REVOKE_ADMIN
SET_INSTANCE
Schedule-Related APIs
CREATE_SCHEDULE
DROP_SCHEDULE
INTERVAL
SET_SCHEDULE
UPDATE_SCHEDULE
Crawler Configuration APIs
IS_ADMIN_READONLY
SET_ADMIN_READONLY
UPDATE_CRAWLER_CONFIG
A
Loading Metadata into Oracle Ultra Search
A.1
Launching the Loading Tool
A.2
Loading Documents and Relevance Scores
A.2.1
The Input XML File
A.2.1.1
Example of the Document Relevance Boosting XML File
A.3
Loading Search Attribute LOVs and LOV Display Names
A.3.1
The LOV XML File
A.3.1.1
Example of the LOV XML File
A.4
XML Schema for Document Relevance Boosting
A.5
XML Schema for LOVs and LOV Display Names
B
Altering the Crawler Java Classpath
B.1
Reasons for Altering the Crawler Java Classpath
B.2
Difference Between the Crawler Classpath and the Remote Crawler Classpath
B.3
Altering the Crawler Java Classpath on the Oracle Ultra Search Server Host
B.4
Altering the Crawler Java Classpath on a Remote Crawler Host
C
Oracle Ultra Search Views
C.1
OUS_INSTANCES
C.2
OUS_SCHEDULES
C.3
OUS_DEFAULT_CRAWLER_SETTINGS
C.4
OUS_CRAWLER_SETTINGS
Index
