1/111

Contents

List of Tables

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

What's New

• New Features in Release 11.1.2.0.0

Part I Learning the Basics

1 Introduction to Oracle Secure Enterprise Search

• Special-Use Licensing
• Overview of Oracle Secure Enterprise Search
• Source Types
• Oracle Secure Enterprise Search Components
  • Oracle Secure Enterprise Search Administration GUI
  • Oracle Secure Enterprise Search Crawler
  • Oracle Secure Enterprise Search APIs
• Oracle Secure Enterprise Search Features
  • Secure Search
  • Federated Search
  • Extensible Crawler Plug-in Framework

2 Getting Started with the Oracle SES Administration GUI

• Getting Started Basics for the Oracle SES Administration GUI
• Understanding the Oracle SES Administration GUI
  • Home Tab
  • Search Tab
  • Global Settings Tab

3 Understanding the Oracle SES Search User Interface

• Overview of Searching in Oracle Secure Enterprise Search
  • Basic Search
    • Keywords in Context
    • Stemming Expansion
    • Alternate Words Expansion
    • Linked Results
    • Syntax Rules
    • Browse Source Groups
    • Searching on Date Attributes
  • Submit URL
  • Configuring the Display Options on the Search Page
  • Attribute Filters
    • Using the Attributes Filter Table
  • Advanced Search
    • Search Documents in a Specific Language
    • Search in Specific Source Groups
    • Search by Attribute
    • Search Using Oracle Text Query Syntax
  • Thesaurus-Based Search
    • Including Related Terms from a Thesaurus
  • Alternate Words
    • Suggesting Alternate Words
  • Restricted Search and the Browse Popup
• Providing Oracle SES Search in a Secure Portlet
  • Choosing a Portlet Type
  • Configuring Oracle SES for a Secure Portlet
    • About the Portlet Configuration File
    • Customizing the Portlet Configuration File
    • Supporting Result List Customizations
    • Supporting Multiple Instances of a Portlet Type
    • Restarting the Oracle SES Middle Tier
  • Configuring an OracleAS Portal for a Secure Portlet
    • Registering a Secure Portlet in OracleAS Portal Tasks
    • Using the Portal User Interface to Change Preferences

4 Understanding Crawling

• Overview of the Oracle Secure Enterprise Search Crawler
  • Crawler URL Queue
  • Understanding Access URLs and Display URLs
  • Modifying the Crawler Parameters
• Overview of Crawler Settings
  • Crawling Mode
  • URL Boundary Rules
    • Inclusion Rules
    • Exclusion Rules
    • Example Using a Regular Expression
  • Document Types
  • Crawling Depth
  • Robots Exclusion
  • Index Dynamic Pages
  • URL Rewriter API
  • Title Fallback
  • Character Set Detection
    • Special Considerations with Automatic Character Set Detection
    • Language Detection
  • Cache Directory
  • Deleting the Secure Cache
• Overview of XML Connector Framework
  • Example Using the XML Connector
  • XML Configuration File
• Configuring Support for Image Metadata
  • Identifying the Search Attributes for Image Metadata
    • Supporting XMP Metadata
    • Supporting DICOM Metatags
    • Example: Adding an Attribute to the Default attr-config.xml File
  • Creating an Image Document Service Connector
  • Using the Image Document Service Connector
    • Searching Image Metadata
  • Troubleshooting the Image Document Service Connector
• Overview of Attributes
  • Attributes For Different Source Types
  • Using Lists of Values for Search Attributes
  • System-Defined Search Attributes
• Understanding the Crawling Process
  • The Initial Crawl
    • Queuing and Caching Documents
    • Indexing Documents
    • Oracle SES Stoplist
  • Maintenance Crawls
  • Automatic Forced Recrawls
• Monitoring the Crawling Process
  • Crawler Statistics
  • Crawler Log File
  • Crawler Configuration File
    • Crawling Zip Files Containing Non-UTF8 File Names
    • Setting the Logging Level
• Parallel Query Indexing
  • Document Partition Model and Storage Areas

5 Customizing the Search Results

• Adding Suggested Content in Search Results
  • Suggested Content Providers
  • Security Options
  • Example Configuring Google OneBox for Suggested Content
• Customizing the Appearance of Search Results
  • XML Result Schema
• Configuring Clustering in Search Results
  • Topic Clustering
  • Metadata Clustering
  • Using Clustering
  • Configuring Clustering in the Web Services API
  • Java Classes for Clustering
  • Cluster Result XML Schema
  • Cluster Result JSON Format
• Configuring Top-N Documents and Group/Sort Attributes
  • Top-N Documents
  • Group By and Sort By Lists
• Customizing the Relevancy of Search Results
  • Customizing Relevancy in the Query Web Services API
  • Filter Element
  • Ranking Element
  • Global-Settings Element
  • Default-Factor Element
  • Custom-Factor Element
  • Applying Ranking Factors

Part II Creating Data Sources

6 Configuring Access to Built-in Sources

• Setting Up Web Sources
  • Boundary Rules for Web Sources
  • Web Document Attributes
• Setting Up Table Sources
  • Choosing Between Table and Database Sources
  • Table Search Attributes
• Setting Up File Sources
  • File Document Attributes
  • Tips for Using File Sources
    • Crawling File Sources with Non-ASCII Character Sets
    • Crawling File Sources with Symbolic Links
    • Crawling File URLs
    • Crawling File Sources from a Network Drive
• Setting Up E-Mail Sources
  • E-Mail Attributes
• Setting Up Mailing List Sources
  • Mailing List Attributes
• Setting Up OracleAS Portal Sources
  • Crawling a Folder or Page
    • Omitting the Portal Pages for OracleAS Portal Sources
    • Smart Incremental Crawl for OracleAS Portal Sources
    • OracleAS Portal Search Attributes
    • Tips for Using OracleAS Portal Sources
• Setting Up Federated Sources
  • Federation Trusted Entities
  • Example Creating a Federated Source
  • Customizing Federated Sources
    • Route Queries to the Federated Source
    • Set Search Restrictions
    • Retrieve Attributes
    • Map Attributes
  • Tips for Using Federated Sources
    • Federated Search Characteristics
    • Federated Search Limitations

7 Configuring Access to Content Management Sources

• Setting Up EMC Documentum Content Server Sources
  • Important Notes for EMC Documentum Content Server Sources
    • Required Software
    • Required Tasks
    • Known Issues
    • Configuration for Documentum Content Server 6.5
  • Setting Up Identity Management for EMC Documentum Content Server
    • Activating the Documentum Identity Plug-in
    • Activating the OID Identity Plug-In
    • Activating the AD Identity Plug-In
    • Activating SunOne Identity Plug-In
  • Creating an EMC Documentum Content Server Source
• Setting Up FileNet Content Engine Sources
  • Important Notes for FileNet Content Engine Sources
    • Required Software
    • Required Tasks
    • Known Issues
  • Setting Up Identity Management with Filenet Content Engine
  • Creating a FileNet Content Engine Source
• Setting Up FileNet Image Services Sources
  • Important Notes for FileNet Image Services Sources
    • Required Software
    • Required Tasks
    • Known Issues
  • Setting Up Identity Management for FileNet Image Services
  • Creating a FileNet Image Services Source
• Setting Up Hummingbird Document Management Server Sources
  • Important Notes for Hummingbird DM Server Sources
    • Required Software
    • Required Tasks
    • Known Issues
  • Setting Up Identity Management for Hummingbird
  • Creating a Hummingbird Source
  • Deploying the Web Service on the Hummingbird DM Server
• Setting Up IBM DB2 Content Manager Sources
  • Important Notes for IBM DB2 Content Manager Sources
    • Required Software
    • Required Tasks on the Server
    • Required Tasks on the Client Side
    • Known Issues
  • Setting Up Identity Management for DB2 Content Manager
  • Creating an IBM DB2 Content Manager Source
• Setting Up Microsoft SharePoint Sources
  • Important Notes About SharePoint 2007 Sources
  • Known Limitations of the SharePoint 2007 Connector
  • Known Issues for SharePoint 2007 Connector
  • Supported Platforms
  • Creating a SharePoint 2007 Source
  • Deploying the Web Service on MOSS 2007
• Setting Up Open Text Livelink Sources
  • Important Notes for Open Text Livelink Sources
    • Required Tasks
    • Known Issues
  • Setting Up Identity Management for Open Text
  • Creating an Open Text Livelink Source
• Setting Up Oracle Content Database Sources
  • Important Notes for Oracle Content Database Sources
  • Setting Up Identity Management for Oracle Content Database Sources
  • Creating an Oracle Content Database JDBC Source
  • Creating an Oracle Content Database Source
    • Required Tasks for Oracle Content Database Release 10.1.3
  • Oracle Content Database Source Attributes
• Setting Up Oracle Content Server Sources
  • Oracle Content Server Security Model
    • Roles and Groups
    • Accounts
  • Setting Up Identity Management for Oracle Content Server
  • Creating an Oracle Content Server Source

8 Configuring Access to Collaboration Sources

• Setting Up EMC Documentum eRoom Sources
  • Documentum eRoom Web Services
  • Important Notes for Documentum eRoom Sources
    • Supported Platforms
    • Required Software
    • Required Tasks
    • Known Issues
  • Creating a Documentum eRoom Source
• Setting Up Lotus Notes Sources
  • Important Notes for Lotus Notes Sources
    • Required Software
    • Required Tasks
    • Known Issues
  • Setting Up Identity Management for Lotus Notes
  • Creating a Lotus Notes Source
  • Displaying the Parent URL in the Search Results
• Setting Up Microsoft Exchange Sources
  • Important Notes for Microsoft Exchange Sources
    • Required Software
    • Required Tasks
    • Known Issues
  • Setting Up Identity Management for Microsoft Exchange
  • Creating a Microsoft Exchange Source
  • Microsoft Exchange Source Attributes
• Setting Up NTFS Sources for Windows
  • Important Notes for NTFS Sources
    • Required Software
    • Required Tasks
  • Setting Up Identity Management for NTFS Sources
  • Creating an NTFS Source
  • NTFS Source Attributes
• Setting Up NTFS Sources for UNIX
  • Important Notes for NTFS Sources
    • Required Software
  • Setting Up Identity Management with NTFS Sources
  • Creating an NTFS Source
  • Installing and Configuring Windows Services
    • Required Software
    • Required Tasks
    • Installing Oracle Search File Change Detector
    • Modifying the File Change Detector Configuration File
    • Installing the NTFS Web Service
    • Configuring the NTFS Connector
    • Known Issues
• Setting Up Oracle Calendar Sources
  • Setting Up Identity Management for Oracle Calendar
  • Creating an Oracle Calendar Source
  • Oracle Calendar Attributes
• Setting Up Oracle Collaboration Suite E-Mail Sources
  • Important Notes for Oracle Collaboration Suite E-Mail Sources
    • Required Tasks
  • Setting Up Identity Management for Oracle Collaboration Suite E-Mail Sources
  • Creating an Oracle Collaboration Suite E-Mail Sources

9 Configuring Access to Applications Sources

• Setting Up Database Sources
  • Required Columns in Database Sources
  • Optional Columns in Database Sources
  • Configuring the JDBC Driver
  • Query File XML Schema Definition
  • Creating Public Database Sources
  • Defining User-Defined Security for Database Sources
  • Database Search Attributes
  • Example of Creating a Database Source With User-Defined Security
• Setting Up Oracle E-Business Suite Sources
• Setting up Siebel 7.8 Sources
  • Requirements for Siebel 7.8 Sources
  • Installing the JDBC Driver for Microsoft SQL Server
  • Setting Up Identity Management for Siebel 7.8
  • Creating a Secured Siebel 7.8 Source
  • Creating a Public Siebel 7.8 Source
  • Queries to Crawl Siebel 7.8 Business Components
    • Service Request Attachments
    • Accounts
    • Products
    • Literature
    • Solution
    • Service Request
    • Contacts
    • Activity
• Setting Up Siebel 8 Sources
• Setting Up Oracle Fusion Sources
  • Setting up Identity Management System
  • Defining a Fusion Source
• Setting up Oracle WebCenter Sources
  • Defining a WebCenter Source

Part III Advanced Topics

10 Customizing the Search User Interface

• Overview of the Search GUI
  • User Interface Components
  • Editable Template Files
    • Template File for Additional Error Handling
  • Data Model for the Template Files
    • Data Model for the Main Search Pages
    • Data Model for the Supplemental Pages
    • Data Model for Output Format Pages
  • Handling Errors and Exceptions
    • Errors in Template Files
    • End User Query Syntax Errors
  • Configuration Files
    • Using the QueryPlan.xml File
  • Configuring the JavaScript Components
    • SearchView
    • Result Cluster Tree
    • ResultsView and ResultsModel
    • InlineAdvancedView
    • BrowseView and BrowseModel
    • SuggestedContentView and SuggestedContentModel
    • SESConnectionFactory and SESConnection
    • AnchoredOverlay
    • Template File for Initializing JavaScript Components
  • FreeMarker Macros
• Using Skin Bundles to Customize the Search GUI
  • Customizing the Skin Bundles
    • How Oracle SES Selects a Skin Bundle for Display
    • How Oracle SES Selects the Template Files
    • About the WebDAV Interface
    • Securing the Oracle SES-WebDAV Communication Channel

11 Security in Oracle Secure Enterprise Search

• Overview of Oracle Secure Enterprise Search Security
  • Oracle Secure Enterprise Search Security Model
  • Passwords
  • Authentication and Authorization
    • About Oracle SES Authentication
    • About Oracle SES User Authorization
    • Restrictions on Changing the ACL Policy
    • Activating an Identity Plug-in
    • Re-registering Pre-Installed Identity Plug-ins
    • Restrictions on Changing the Identity Plug-in
  • Authentication Methods
    • Oracle Secure Enterprise Search User Repository
    • Oracle Secure Enterprise Search Authentication Interface
• Enabling Secure Search
  • User Authorization Cache
  • Federated User Authorization Cache
    • Modifying the Remote Cache Configuration File
    • XML Schema Definition for Remote Cache Configuration Files
  • Administrator-Based Authorization
  • Custom Crawler Plug-in
  • Identity-Based Secure Search
  • Query-time Authorization
  • Self Service Authorization
• Configuring Secure Search with OracleAS Single Sign-On
  • Configuring Oracle HTTP Server
  • Configuring OracleAS and Oracle SES for Single Sign-on Security
    • Adding OSSO Identity Asserter
    • Adding OID Authenticator
• Configuring Secure Search with OAM Single Sign-On
  • Configuring OID
  • Configuring Oracle HTTP Server
  • Installing and Configuring WebGate
    • Creating a WebGate Instance
    • Installing WebGate
    • Updating the WebGate Web Server Configuration
  • Integrating OAM with Oracle SES
  • Configuring QueryPlan.xml in Oracle SES
• SSL and HTTPS Support in Oracle Secure Enterprise Search
  • Understanding SSL
  • Managing the Keystore
  • Oracle SES Acting as an SSL Client
  • Oracle SES Acting as an SSL Server
    • Configuring Oracle Secure Enterprise Search to Require SSL
    • Configuring Oracle HTTP Server to Require SSL
• Using Windows Native Authentication
  • Activating Windows Native Authentication
    • Configuring the Active Directory
    • Configuring the Active Directory Plug-In
    • Activating Windows Native Authentication on Oracle SES
    • Configuring Microsoft Internet Explorer to support WNA
    • Configuring Mozilla Firefox to Support WNA

12 Administering Oracle SES Instances

• Managing Disk Space Usage
• Using Backup and Recovery
• Tuning the Crawl Performance
  • Understanding the Crawler Schedule
  • Registering a Proxy
  • Checking Boundary Rules
    • Notes for File Sources
  • Checking Dynamic Pages
  • Checking Crawler Depth
  • Checking Robots Rule
  • Checking Duplicate Documents
  • Checking Redirected Pages
  • Checking URL Looping
  • Increasing the Oracle Redo Log File Size
    • What to Do Next
  • Automatically Adding Datafiles
• Tuning Search Performance
  • Adding Suggested Links
  • Parallel Querying and Index Partitioning
    • Storage Areas
    • Storage Area Schema
    • Configuring a Partition
    • partitionConfig Schema
  • Managing Index Fragmentation
  • Modifying the KEEP Pool Size
    • Determining if the KEEP Pool Size is Sufficient
    • Increasing the KEEP Pool Buffer Size
  • Optimizing the Index
  • Adjusting the Indexing Parameters
    • Indexing Batch Size
    • Indexing Memory Size
    • Parallel Indexing Degree
  • Checking the Search Statistics
    • Relevancy Boosting
  • Increasing the JVM Heap Size
  • Increasing the Oracle Undo Space
  • Optimizing Query Application Performance
• Oracle SES Command Line Tools
• Turning On Debug Mode
• Monitoring Oracle Secure Enterprise Search
• Integrating with Google Desktop
• Accessing Oracle WebLogic Server Administration Console on Oracle SES

13 Oracle Secure Enterprise Search APIs

• Overview of Oracle Secure Enterprise Search APIs
• Oracle Secure Enterprise Search Web Services APIs
  • Web Services APIs Installation
    • Query Web Services Location
    • Administration Web Services Location
  • Web Services Concepts
    • Web Services
    • Simple Object Access Protocol
    • Web Services Description Language
  • Web Services Architecture
    • Development Platforms
  • Query Web Services Common Data Types
    • Base Data Types
    • XML-to-Java Data Type Mappings
    • Complex Types
    • Array Types
  • Query Web Services Operations
    • Overview of Query Web Services Operations
    • Authentication Operations
    • Search Operations
    • Browse Operations
    • Metadata Operations
    • Search Hit Operations
    • User Feedback Operations
  • Query Web Services Query Syntax
    • Search Term
    • Phrase
    • Operators
    • Default Search: Implicit AND
    • Word Separator
    • Filter Conditions (Advanced Conditions)
    • Special Search Terms
  • Query Web Services Example
  • Client-Side Query Java Proxy Library
• Oracle Secure Enterprise Search Java SDK
  • Crawler Plug-in API
    • Crawler Plug-in Overview
    • Crawler Plug-in Functionality
  • Document Service API
  • URL Rewriter API
    • URL Link Filtering
    • URL Link Rewriting
  • Security APIs
    • Identity Plug-in API
    • Authorization Plug-in API
    • User-Defined Security Model
  • Query-time Authorization API
    • Overview of Query-time Authorization
    • Filtering Document Access
    • Filtering Folder Browsing
    • Pruning Access to an Entire Source
    • Determining the Authenticated User
    • Query-time Authorization Interfaces and Exceptions
    • Thread-Safety of the Filter Implementation
    • Compiling and Packaging the Query-Time Filter

A XML Connector Examples and Schemas

• Configuration File XML Schema Definition
• Control Feed Example
• Control Feed XML Schema Definition
• Data Feed Example
• Data Feed XML Schema Definition

B URL Crawler Status Codes

C Third Party Licenses

• Apache Software
• Eclipse Software
• Egothor Software
• Javascript Bubbling Library
• Plug-in Software
• Snowball Software
• Visigoth Software
• Yahoo! Inc.

D Error Messages

Glossary

Index