Skip Headers
Oracle® Ultra Search User’s Guide
10
g
(9.0.4)
Part No. B10896-01
Home
Solution Area
Index
Contents
Title and Copyright Information
Send Us Your Comments
Preface
Audience
Organization
Related Documentation
Conventions
Documentation Accessibility
What’s New in Ultra Search?
Ultra Search Release Information
1
Introduction to Ultra Search
1.1
Overview of Ultra Search
1.2
Ultra Search Components
1.2.1
Ultra Search Crawler
1.2.2
Ultra Search Backend
1.2.3
Ultra Search Administration Tool
1.2.4
Ultra Search APIs and Sample Applications
1.3
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
Ultra Search Administration Groups in OID
1.3.16.2
Authorization of the Administration Privileges
1.3.17
Single Sign-On Authentication
1.3.18
Query Syntax Expansion
1.4
Ultra Search System Configuration
2
Installing and Configuring Ultra Search
2.1
Ultra Search Requirements
2.1.1
Ultra Search Conventions
2.1.2
Ultra Search System Requirements
2.1.2.1
Hardware Requirements
2.1.2.2
Software Requirements
2.2
Installing the Ultra Search Backend
2.2.1
Installing and Configuring the Ultra Search Backend
2.2.2
Configure a Secure Ultra Search Installation
2.3
Installing the Backend on an Existing Database or Metadata Repository
2.3.1
Database Requirements
2.3.2
Installing the Ultra Search Backend on an Existing Oracle9i Database with OPCA
2.4
Configuring the Default Ultra Search Instance
2.5
Installing the Ultra Search Middle Tier on Web Server Hosts
2.5.1
Web Applications Concepts
2.5.2
Browser Requirements
2.5.3
Installing the Middle Tier with the Oracle Database Release
2.5.4
Installing the Middle Tier with the Oracle Application Server Release
2.5.4.1
Configuring the Middle Tier with Oracle HTTP Server and OC4J
2.5.4.2
Configuring the Administration Tool with Single Sign-On Server
2.5.4.3
Deploying the Ultra Search EAR File on a Third Party Middle Tier
2.5.4.4
Editing the data-sources.xml File
2.5.4.5
Editing the ultrasearch.properties File
2.5.4.6
Starting the Web Server
2.5.4.7
Testing the Ultra Search Administration Tool
2.5.4.8
Testing the Ultra Search Sample Query Applications
2.6
Installing the Backend on Remote Crawler Hosts
2.6.1
Installing the Backend on Remote Crawler Hosts
2.6.2
Configuring the Backend on Remote Crawler Hosts
2.6.3
Unregistering a Remote Crawler
2.7
Configuring Ultra Search in a Hosted Environment
2.7.1
Preconfiguration Tasks for a Hosted Environment
2.7.2
Configuring Ultra Search in the Subscriber Context
3
Post-Installation Information
3.1
Changing Ultra Search Schema Passwords
3.2
Configuring the Oracle Server for Ultra Search
3.2.1
Step 1: Tune the Oracle Database
3.2.2
Step 2: Create and Assign the Temporary Tablespace to the CTXSYS User
3.2.3
Step 3: Create a Large Tablespace for Each Ultra Search Instance User
3.2.4
Step 4: Create and Configure New Database Users for Each Ultra Search Instance
3.2.5
Step 5: Alter the Index Preferences
3.3
Managing Stoplists
3.3.1
Default Ultra Search Stoplist
3.3.2
Modifying Instance Stoplists
3.3.2.1
Modifying Instance Stoplists Before Initial Crawling
3.3.2.2
Modifying Instance Stoplists After Initial Crawling
3.4
Upgrading Ultra Search
3.4.1
Pre-Upgrade Steps
3.4.2
Upgrading Ultra Search Shipped with Oracle Database
3.4.3
Upgrading Ultra Search Shipped with Oracle Application Server
3.4.4
Upgrading Ultra Search Shipped with Oracle Collaboration Suite
3.4.5
Upgrading Ultra Search to Oracle Collaboration Suite Release 1
3.4.5.1
Upgrade from Ultra Search 1.0.3 to 9.0.3
3.4.5.2
Upgrade from Ultra Search 9.0.2 to 9.0.3
3.4.5.3
Upgrade from Ultra Search 9.2 to 9.0.3
3.5
Configuring the Query Application
3.5.1
Step 1: Edit the data-sources.xml File
3.5.2
Step 2: Deploy Multiple Query Applications Against Multiple Instances
4
Tuning and Performance
4.1
Tuning the Web Crawling Process
4.1.1
Web Crawling Strategy
4.1.2
Monitoring the Crawling Process
4.1.3
URL Looping
4.2
Tuning Query Performance
4.3
Using the Remote Crawler
4.3.1
Scalability and Load Balancing
4.3.2
Installation and Configuration Sequence
4.4
Ultra Search on Real Application Clusters
4.4.1
Configuring Storage Access
4.4.1.1
Remote Crawler File Cache
4.4.2
Logging on to the Oracle Instance
4.4.2.1
Query Search Application for Read Application Clusters
4.4.2.2
Java Crawler
4.4.2.3
Choosing a JDBC Driver
4.5
Table Data Source Synchronization
4.5.1
Synchronizing Crawling of Oracle Databases
4.5.1.1
Create Log Table
4.5.1.2
Create Log Triggers
4.5.2
Synchronizing Crawling of Non-Oracle Databases
5
Security in Ultra Search
5.1
About Ultra Search Security
5.1.1
Ultra Search Security Model
5.1.2
Classes of Users and Their Privileges
5.1.2.1
Ultra Search Default Users
5.1.3
Ultra Search Admin Privilege Model in the Hosted Environment
5.1.3.1
Admin Privilege Model
5.1.4
Resources Protected by Ultra Search
5.1.5
Authorization and Access Enforcement
5.1.6
How Ultra Search Leverages Security Services
5.1.7
How Ultra Search Leverages the Identity Management Infrastructure
5.1.8
Ultra Search Extensibility and Security
5.2
Configuring a Security Framework for Ultra Search
5.2.1
Configuring Security Framework Options for Ultra Search
5.2.2
Configuring Oracle Identity Management Options for Ultra Search
5.3
Configuring Ultra Search Security
6
Understanding the Ultra Search Crawler and Data Sources
6.1
Overview of the Ultra Search Crawler
6.2
Crawler Settings
6.3
Crawler Data Sources
6.3.1
Using Crawler Agents
6.3.2
Synchronizing Data Sources
6.3.3
Display URL and Access URL
6.4
Document Attributes
6.5
Crawling Process for the Schedule
6.5.1
Queuing and Caching Documents
6.5.2
Indexing Documents
6.6
Data Synchronization
6.7
Ultra Search Remote Crawler
7
Understanding the Ultra Search Administration Tool
7.1
Ultra Search Administration Tool
7.1.1
Setting Crawler Parameters
7.1.2
Setting Query Options
7.1.2.1
Attributes
7.1.2.2
Data Groups
7.1.3
Online Help in Different Languages
7.2
Logging On to Ultra Search
7.3
Logging On and Managing Instances as SSO Users
7.3.1
Logging On to Ultra Search
7.3.2
Granting Privileges to SSO Users
7.4
Instances Page
7.4.1
Creating an Instance
7.4.1.1
Creating a Regular Instance
7.4.1.2
Creating a Snapshot Instance
7.4.2
Selecting an Instance
7.4.3
Deleting an Instance
7.4.4
Editing an Instance
7.4.4.1
Instance Mode
7.4.4.2
Schema Password
7.5
Crawler Page
7.5.1
Configure the Settings
7.5.2
Remote Crawler Profiles
7.5.3
Crawler Statistics
7.5.3.1
Summary of Crawler Activity
7.5.3.2
Detailed Crawler Statistics
7.5.3.3
Crawler Progress
7.5.3.4
Problematic URLs
7.6
Web Access Page
7.6.1
Proxies
7.6.2
Authentication
7.6.2.1
HTTP Authentication
7.6.2.2
HTML Forms
7.7
Attributes Page
7.7.1
Search Attributes
7.7.2
Mappings
7.8
Sources Page
7.8.1
Web Sources
7.8.1.1
Creating Web Sources
7.8.2
Table Sources
7.8.2.1
Creating Table Sources
7.8.2.2
Editing Table Sources
7.8.2.3
Table Sources Comprised of More Than One Table
7.8.2.4
Limitations With Database Links
7.8.3
Email Sources
7.8.3.1
Creating Email Sources
7.8.4
File Sources
7.8.4.1
Creating File Sources
7.8.5
Oracle Sources
7.8.5.1
Oracle Portal Sources
7.8.5.2
Federated Sources
7.8.6
User-Defined Sources
7.8.6.1
Creating User-Defined Data Source Types
7.8.6.2
Creating User-Defined Sources
7.9
Schedules Page
7.9.1
Data Synchronization
7.9.1.1
Creating Synchronization Schedules
7.9.1.2
Updating Schedules
7.9.1.3
Editing Synchronization Schedules
7.9.1.4
Launching Synchronization Schedules
7.9.1.5
Synchronization Status and Crawler Progress
7.9.2
Index Optimization
7.10
Queries Page
7.10.1
Data Groups
7.10.2
URL Submission
7.10.3
Relevancy Boosting
7.10.4
Query Statistics
7.10.5
Configuration
7.11
Users Page
7.11.1
Preferences
7.11.2
Super-Users
7.11.3
Privileges
7.12
Globalization Page
7.12.1
Search Attribute Name
7.12.2
LOV Display Name
7.12.3
Data Group Name
8
Ultra Search Developer’s Guide and API Reference
8.1
Overview of Ultra Search APIs
8.2
Ultra Search Query API
8.3
Customizing the Query Syntax Expansion
8.3.1
Default Query Syntax Expansion Implementation
8.3.1.1
End User Query Syntax
8.3.1.2
Scoring Classes
8.3.1.3
Expansion Rules
8.3.1.4
Examples of Applying the Rules
8.3.2
Customizing the Rules
8.4
Ultra Search Query Tag Library
8.4.1
Query Tag Descriptions
8.4.1.1
<instance> Tag: Connecting to the Ultra Search Instance
8.4.1.2
<iterAttributes> Tag: Show All Search Attributes
8.4.1.3
<iterGroups> Tag: Show All Search Groups
8.4.1.4
<iterLanguages> Tag: Show All Search Languages
8.4.1.5
<iterLOV> Tag: Show All Values Defined for a Search Attribute
8.4.1.6
Formulating the Query
8.4.1.7
<getResult> Tag: Perform Search
8.4.1.8
<fetchAttribute> Tag: Metadata Selection
8.4.1.9
<showHitCount> Tag: Show Estimated Hit Count
8.4.1.10
<iterResult> Tag: Render the Results
8.4.1.11
<showAttributeValue> Tag: Render a Document Attribute
8.5
Ultra Search Crawler Agent API
8.5.1
Crawler Agent Overview
8.5.1.1
Standard Agent
8.5.1.2
Smart Agent
8.5.1.3
Document Attributes and Properties
8.5.2
Crawler Agent Functionality
8.5.2.1
Data Source Type Registration
8.5.2.2
Data Source Registration
8.5.2.3
Data Source Attribute Registration
8.5.2.4
User-Implemented Crawler Agent
8.5.2.5
Interaction Between the Crawler and the Crawler Agent
8.5.2.6
Crawler Agent APIs and Classes
8.5.3
Sample Agent Files
8.5.4
Setting up the Sample Crawler Agent
8.5.4.1
Compiling and Building the Agent Jar File
8.5.4.2
Creating a Data Source Type
8.5.4.3
Defining Data Source Parameters
8.5.4.4
Defining a Data Source of this Type
8.6
Ultra Search Java Email API
8.6.1
JavaMail Implementation
8.6.2
Java Email API
8.6.3
Sample Mailing List Browser Application Files
8.6.4
Setting up the Sample Mailing List Browser Application
8.7
Ultra Search URL Rewriter API
8.7.1
URL Link Filtering
8.7.2
URL Link Rewriting
8.7.3
Creating and Using a URL Rewriter
8.8
Ultra Search Sample Query Applications
8.8.1
Sample Query Applications
8.8.2
JavaServer Page Concepts
A
Loading Metadata into 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 Ultra Search Server Host
B.4
Altering the Crawler Java Classpath on a Remote Crawler Host
C
Customizing the Query Syntax Expansion 9.0.1
C.1
Default Query Syntax Expansion Implementation
C.1.1
End User Query Syntax
C.1.1.1
Summary of Rules
C.1.1.2
Scoring
C.1.1.3
Expansion Rules
C.1.2
Customizing the Rules
C.1.2.1
The expand_main Function
C.1.2.2
The expand_attr Function
C.1.2.3
Example of Combining Values
Index
