Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

1 Using the Administration API

• Introduction to the Administration API
• Command Interface
  • Opening an Interactive Session
  • Issuing Individual Commands
  • Issuing Commands to Remote Oracle SES Instances
  • Using the Help Command
  • Command Syntax
• Web Services Interface
  • Connecting to the Web Services Endpoint
  • Providing Credentials
  • Using the Web Services Java Client
    • Java Libraries
    • Creating a Stateful Web Services Client
    • Creating a Stateless Web Services Client
    • Creating an Administrative Object
• Object Types
  • Universal Objects
  • Creatable Types
• Object Properties
  • XML Documents
    • Sample XML Document of an Administration Object
    • Editing XML Files
  • State Properties
• Operations
  • Command Syntax
  • Using the Message Logs
    • Log Files
    • Configuration File
  • Managing Universal Objects
  • Managing Creatable Objects
  • Managing Object State
  • Status Codes for Bulk Operations

2 Administration Object Types

• Alphabetic List of Administration Object Types
• Document Support
• Globalization Support
  • Product Languages
  • Crawlable Documents
  • Providing Translations of Object Names
• Encryption
• XML Description of State Properties
• Partitioning for Parallel Query
• Disk Space Management: Quotas and Alerts
• Search Interface Customization: Skin Bundles
  • Support Bundles
  • FreeMarker Templates
  • Asset Files
  • JavaScript Libraries
  • Template Library
  • Configuration Settings
  • Assembling the Skin Bundle Files
  • Creating a skinBundle Object
  • Using a Skin Bundle to Render the Search Application User Interface
  • Skin Bundle Example
    • Changes to the Example Results Page
    • Changes to the Example Footer
    • Creating the Example Directory Structure
    • Customizing results.ftl
    • Customizing inc_logo_querybox.ftl
    • Customizing inc_footer.ftl
    • Creating the Example Skin Bundle File List
    • Creating an XML Description of the Example Skin Bundle
    • Creating the Example skinBundle Object
    • Using the Example Skin Bundle to Render the Search Application
• alert
• altWord
• clustering
• clusterTree
• crawlerSettings
• identityPlugin
• index
• indexOptimizer
• partitionConfig
• proxyLogin
• queryConfig
• resultList
• schedule
• searchAttr
• skinBundle
• source
• sourceGroup
• sourceType
• spaceCalculator
• storageArea
• suggLink
• task
• thesaurus

3 searchadmin Commands

• Alphabetic List of searchadmin Commands
• Entering Special Characters
• activate clustering
• activate clusterTree
• activate identityPlugin
• activate indexOptimizer
• activate resultList
• activate schedule
• activate skinBundle
• activate spaceCalculator
• create altWord
• create clusterTree
• create identityPlugin
• create proxyLogin
• create schedule
• create searchAttr
• create skinBundle
• create source
• create sourceGroup
• create sourceType
• create storageArea
• create suggLink
• create thesaurus
• createAll altWord
• createAll clusterTree
• createAll identityPlugin
• createAll proxyLogin
• createAll schedule
• createAll searchAttr
• createAll source
• createAll sourceGroup
• createAll sourceType
• createAll storageArea
• createAll suggLink
• deactivate clustering
• deactivate clusterTree
• deactivate identityPlugin
• deactivate indexOptimizer
• deactivate resultList
• deactivate schedule
• deactivate skinBundle
• deactivate spaceCalculator
• delete creatable_type
• deleteAll creatable_type
• deleteList creatable_type
• export creatable_type
• export universal_type
• exportAll creatable_type
• exportList creatable_type
• getAllObjectKeys
• getAPIVersion
• getAllStates clusterTree
• getAllStates identityPlugin
• getAllStates schedule
• getAllStates skinBundle
• getState clustering
• getState clusterTree
• getState identityPlugin
• getState index
• getState indexOptimizer
• getState resultList
• getState schedule
• getState skinBundle
• getState spaceCalculator
• getState task
• getStateList clusterTree
• getStateList identityPlugin
• getStateList schedule
• getStateList skinBundle
• start indexOptimizer
• start schedule
• start spaceCalculator
• start task
• stop schedule
• update alert
• update altWord
• update clustering
• update clusterTree
• update crawlerSettings
• update index
• update indexOptimizer
• update partitionConfig
• update proxyLogin
• update queryConfig
• update resultList
• update schedule
• update searchAttr
• update skinBundle
• update source
• update sourceGroup
• update sourceType
• update spaceCalculator
• update storageArea
• update suggLink
• update thesaurus
• updateAll alert
• updateAll altWord
• updateAll clusterTree
• updateAll proxyLogin
• updateAll schedule
• updateAll searchAttr
• updateAll source
• updateAll sourceGroup
• updateAll sourceType
• updateAll storageArea
• updateAll suggLink

4 Web Service Operations

• Alphabetic List of Web Service Operations
• activate
• create
• createAll
• deactivate
• delete
• deleteAll
• deleteList
• export
• exportAll
• exportList
• getAllObjectKeys
• getAPIVersion
• getAllStates
• getState
• getStateList
• login
• logout
• start
• stop
• update
• updateAll

A Java Example

• Java Source Code Example
• Shell Script Example

B Error Messages

• Invalid Input Errors
• Creatable Administration Object Errors
• Invalid State Errors
• Administration API Run-Time Errors
• Dependent Object Errors