The Oracle Secure Enterprise Search Administration API Guide documents two interfaces to the Administration API: a command-line interface and a Web services interface. It also introduces the Web services Java client. The Administration API supports the same features as the Oracle SES Administration GUI, and some new features that are currently not supported by the GUI.
This document is intended for anyone using the Oracle SES Administration API:
Administrators of Oracle Secure Enterprise Search may find a command-line interface to be easier for routine tasks than a graphical user interface. Administrators of large installations, who make the same changes across many instances of Oracle SES, will find the command-line interface to be particularly useful.
Java developers can create custom administrative tools using the Web services Java client.
Web designers can create custom skins for the default search interface using any of these interfaces.
Our goal is to make Oracle products, services, and supporting documentation accessible to all users, including users that are disabled. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Accessibility standards will continue to evolve over time, and Oracle is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For more information, visit the Oracle Accessibility Program Web site at
Screen readers may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, some screen readers may not always read a line of text that consists solely of a bracket or brace.
This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites.
To reach Oracle Support Services, use a telecommunications relay service (TRS) to call Oracle Support at 1.800.223.1711. An Oracle Support Services engineer will handle technical issues and provide customer support according to the Oracle service request process. Information about TRS is available at
http://www.fcc.gov/cgb/consumerfacts/trs.html, and a list of phone numbers is available at
For more information about Oracle Secure Enterprise Search, refer to the following resources:
Oracle Secure Enterprise Search Administrator's Guide
Explains how to administer Oracle Secure Enterprise Search instances, including how to set up a variety of information sources, crawl and index those sources, and customize the search results.
Oracle Secure Enterprise Search Release Notes
Provides version information and identifies known issues.
Oracle Secure Enterprise Search Installation Guides
Discuss installation requirements and tips, and provides information on how to get started using Oracle Secure Enterprise Search.
Oracle Secure Enterprise Search Java API Reference
Describes the classes and methods in the Oracle SES Java APIs.
Up-to-date Release Notes are posted on Oracle Technology Network (OTN). You must register online before using OTN. Registration is free and can be done at this location:
If you have a user name and password for OTN, then you can go directly to the documentation section of OTN at this location:
The following text conventions are used in this document:
|boldface||Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary.|
|italic||Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.|
||Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter.|
This reference presents syntax in a simple variant of Backus-Naur Form (BNF) that includes the following symbols and conventions.
|Symbol or Convention||Meaning|
||Brackets enclose optional items.|
||Braces enclose a choice of items of which only one is required.|
||A vertical bar separates alternatives.|
||Ellipses indicate that the preceding syntactic element can be repeated.|
||A slash separates levels of a directory path. On Windows, use a backslash (
|delimiters||Delimiters other than brackets, braces, vertical bars, and ellipses must be entered as shown.|
||Words appearing in italics are placeholders for which you must substitute a name or a value. Words that are not in italics are keywords and must be entered as shown.|
||ORACLE_BASE is the root of the directory structure, where Oracle SES software and its supporting infrastructure software are installed. This directory path typically is stored in an environment variable. On Linux and UNIX systems, you can reference the variable as
||ORACLE_HOME is the