Contents

List of Tables

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Conventions

What's New

• New Features in Release 10.1.8.2
• New Features in Release 10.1.8.1
• New Features in Release 10.1.8

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 Crawler
  • Oracle Secure Enterprise Search Administration Tool
  • Oracle Secure Enterprise Search APIs
• Oracle Secure Enterprise Search Features
  • Secure Search
  • Federated Search
  • Extensible Crawler Plug-in Framework

2 Getting Started with Oracle Secure Enterprise Search

• Getting Started Basics with Oracle Secure Enterprise Search
• Understanding the Administration Tool
  • Home Tab
  • Search Tab
  • Global Settings Tab

3 Understanding Crawling and Searching

• Overview of the Oracle Secure Enterprise Search Crawler
  • Crawler URL Queue
  • Understanding Access URLs and Display URLs
  • Using Crawler Plug-ins
• Overview of Crawler Settings
  • Crawling Mode
  • URL Boundary Rules
    • Inclusion Rules
    • Exclusion Rules
    • Example Using Regular Expression
    • Boundary Rules for Web Sources
  • Document Types
  • Crawling Depth
  • Robots Exclusion
  • Index Dynamic Pages
  • URL Rewriter API
  • Title Fallback
    • Special Considerations with Title Fallback
  • Character Set Detection
    • Special Considerations with Automatic Character Set Detection
    • Language Detection
  • Cache Directory
• Overview of XML Connector Framework
  • Example Using the XML Connector
  • XML Configuration File
• Overview of Attributes
  • Example of Attribute LOV Collection
• Understanding the Crawling Process
  • The Initial Crawl
    • Queuing and Caching Documents
    • Indexing Documents
  • Maintenance Crawls
• Monitoring the Crawling Process
  • Crawler Statistics
  • Crawler Log File
    • Crawler Configuration File
• Overview of Searching in Oracle Secure Enterprise Search
  • Basic Search
    • Browse Source Groups
    • Searching on Date Attributes
  • Submit URL
  • Advanced Search
    • Search Documents in a Specific Language
    • Search in Specific Source Groups
    • Search by Attribute
    • Oracle SES and Oracle Text
    • Internationalization Support
  • Thesaurus-Based Search
    • Uploading a Thesaurus
    • Exporting the Loaded Thesaurus
    • Removing a Loaded Thesaurus
  • Alternate Words
    • Uploading a List of Alternate Words
    • Export the Alternate Words List
    • Removing Alternate Words
    • Adding Alternate Word Pairs
  • Restricted Search and the Browse Popup

4 Security in Oracle Secure Enterprise Search

• Overview of Oracle Secure Enterprise Search Security
  • Oracle Secure Enterprise Search Security Model
  • Passwords
    • Temporary Passwords
  • Authorization and Authentication
    • Overview of Oracle SES Authorization and Authentication
    • Restrictions on Changing the ACL Policy
    • Activating an Identity Plug-in
    • Re-registering Preinstalled 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
  • Secure Search Options
    • Admin-based Authorization
    • Custom Crawler Plug-in
    • Identity-Based Secure Search
    • Query-time Authorization
    • Self Service Authorization
• Configuring Secure Search with OracleAS Single Sign-On
  • Using mod_oc4j to Front Oracle Secure Enterprise Search with an Oracle HTTP Server
• 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
    • Enabling SSL in Oracle HTTP Server's mod_oc4j Module
• Security in a Federated Search Environment

5 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
  • Setting Up Identity Management for EMC Documentum Content Server
  • 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
    • Deploy 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 Side
    • 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 for Microsoft SharePoint Sources
  • Creating a Microsoft SharePoint Source
    • Deploy the Web Service on the SharePoint Portal Server
• 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
    • Known Issues
  • Setting Up Identity Management for Oracle Content Database Sources
  • Creating an Oracle Content Database Source
    • Required Tasks for Oracle Content Database Release 10.1.3
• Setting Up Oracle Content Server Sources
  • Important Notes for Oracle Content Server Sources
    • Required Software
    • Known Limitations
    • Oracle Content Server Security Model
  • Setting Up Identity Management for Oracle Content Server
  • Creating an Oracle Content Server Source

6 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
• 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
• Setting Up NTFS Sources for Windows
  • Important Notes for NTFS Sources
    • Required Software
    • Required Tasks
  • Setting Up Identity Management with NTFS Sources
  • Creating an NTFS Source
• Setting Up NTFS Sources for UNIX
  • Important Notes for NTFS Sources
    • Required Software
    • Required Tasks
  • Setting Up Identity Management with NTFS Sources
  • Creating an NTFS Source
• Setting Up Oracle Calendar Sources
  • Setting Up Identity Management for Oracle Calendar
  • Creating an Oracle Calendar Source
• Setting Up IMAP Connector for OCS Email Server Sources
  • Important Notes for IMAP Connector for OCS Email Server Sources
    • Required Tasks
  • Setting Up Identity Management for IMAP Connector for OCS Email Server Sources
  • Creating IMAP Connector for OCS Email Server Sources

7 Configuring Access to Applications Sources

• Setting Up Database Sources
  • Important Notes for Database Sources
    • Required Tasks
  • Creating Public Database Sources
    • XSD for the Query File
  • Creating Secure Database Sources
  • Example of Creating a Secure Database Source
• Setting Up Oracle E-Business Suite 11i Sources
  • Important Notes for Oracle E-Business Suite 11i Sources
  • Setting Up Identity Management for Oracle E-Business Suite 11i
  • Creating an Oracle E-Business Suite 11i Source
• Setting Up Oracle E-Business Suite 12 Sources
  • Setting Up Identity Management for Oracle E-Business Suite 12
  • Creating an Oracle E-Business Suite 12 Source
• Setting up Siebel 7.8 Sources
  • Important Notes for Siebel 7.8 Sources
    • Required Tasks
  • Setting Up Identity Management for Siebel 7.8
  • Creating a Secure Siebel 7.8 Source
  • Creating a Public Siebel 7.8 Source
  • Queries to Crawl Siebel 7.8 Business Components
    • Service Request Attachments Query
    • Accounts Query
    • Products Query
    • Literature Query
    • Solution Query
    • Service Request Query
    • Contacts Query
• Setting Up Siebel 8 Sources
  • Setting Up Identity Management for Siebel 8
  • Creating a Siebel 8 Source

8 Oracle Secure Enterprise Search Advanced Information

• 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
  • Limitations Federating Release 10.1.8.2 and Prior Releases
• Adding Suggested Content in Search Results
  • 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
• Customizing the Relevancy of Search Results
  • Customizing Relevancy in the Query Web Services API
    • Filter Element
    • Ranking Element
    • Apply Ranking Factors
• Using Backup and Recovery
  • Performing a Cold Backup
• Understanding Attributes
  • Web Source Attributes
  • File Source Attributes
  • E-mail and Mailing List Attributes
  • OracleAS Portal Source Attributes
  • Microsoft Exchange Source Attributes
  • NTFS Source Attributes
  • Oracle Calendar Attributes
  • Oracle Content Database Source Attributes
  • System-Defined Search Attributes
• Troubleshooting Sources
  • Tips for Using Table and Database Sources
    • Understanding Table Sources Versus Database Sources
    • Crawling Tables with Quoted Identifiers
  • Tips for Using File Sources
    • Crawling File Sources with Non-ASCII
    • Crawling File Sources with Symbolic Links
    • Crawling File URLs
    • Crawling File Sources from a Network Drive
  • Tips for Using Mailing List Sources
  • Tips for Using OracleAS Portal Sources
  • Tips for Using User-Defined Sources
  • Tips for Using Federated Sources
    • Federated Search Characteristics
    • Federated Search Limitations
• Tuning Crawl Performance
  • Understanding the Crawler Schedule
  • Registering a Proxy
  • Checking Boundary Rules
    • Notes for File Sources
  • Checking Dynamic Pages
  • Checking Crawler Depth
  • Checking Robots.txt Rule
  • Checking Duplicate Documents
  • Checking Redirected Pages
  • Checking URL Looping
  • Increasing the Oracle Redo Log File Size
  • Adding Datafiles
  • What to do Next
• Tuning Search Performance
  • Adding Suggested Links
  • Optimizing the Index
  • Adjusting the Indexing Parameters
    • Indexing Batch Size
    • Indexing Memory Size
  • Checking the Search Statistics
    • Relevancy Boosting
  • Increasing the JVM Heap Size
  • Increasing the Oracle Undo Space
• Oracle SES Command Line Tools
  • Restarting Oracle Secure Enterprise Search After Rebooting
• Turning On Debug Mode
• Monitoring Oracle Secure Enterprise Search
• Integrating with Google Desktop for Enterprise
• Accessing Application Server Control Console on Oracle SES

9 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
    • Admin 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 Search
    • Word Separator
    • Filter Conditions (Advanced Conditions)
    • Special Search Terms
  • Query Web Services Example
  • Client-Side Query Java Proxy Library
  • Internally Used Query Web Services Messages
  • Admin Web Services Operations
  • Client-Side Admin Java Proxy Library
  • Admin Web Services SOAP Fault Error Codes
• Oracle Secure Enterprise Search Java SDK
  • Crawler Plug-in API
    • Crawler Plug-in Overview
    • Crawler Plug-in Functionality
  • Document Service API
    • Creating and Using a Document Service Plug-in
  • URL Rewriter API
    • URL Link Filtering
    • URL Link Rewriting
    • Creating and Using a URL Rewriter
  • 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 Oracle Secure Enterprise Search Secure Portlet

• Oracle SES Tasks to Register a Secure Portlet
• OracleAS Portal Tasks to Register a Secure Portlet

B XML Connector Examples and Schemas

• Configuration File XSD
• Control Feed Example
• Control Feed XSD
• Data Feed Example
• Data Feed XSD

C Upgrading Oracle Secure Enterprise Search

• Upgrading Oracle Secure Enterprise Search to 10.1.8.2
  • Checking Memory Requirements
• Upgrading OracleAS Portal Sources
• Upgrading File Sources
• Upgrading Oracle Calendar Sources
• Using Secure Federated Search Between 10.1.8 and 10.1.6

D URL Crawler Status Codes

E Error Messages

F Third Party Licenses

• Apache Software
• Egothor Software
• Plug-in Software
• Snowball Software
• Yahoo! Inc.

Glossary

Index