Go to main content
1/10
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 Formats Supported
Globalization Support
Product Languages
Crawlable Documents
Providing Translations of Object Names
Encryption
XML Description of State Properties
Search Interface Customization: Skin Bundles
Support Bundles
FreeMarker Templates
Asset Files
JavaScript Libraries
Template Library
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
altWord
authorizedPrincipal
autoSuggestion
boostedUrl
classification
classificationMappings
clustering
clusterTree
crawlerSettings
docServiceInstance
docServiceManager
docServicePipeline
facetTree
globalBoundaryRules
globalDocumentTypes
identityPlugin
index
indexOptimizer
indexProfile
languageBasedTokenization
lexer
partitionConfig
proxy
proxyLogin
queryConfig
queryUIConfig
queryUIFacets
queryUISourceGroups
relevanceRanking
resultList
schedule
searchAttr
singleSignOnSetting
skinBundle
source
sourceGroup
sourceType
storageArea
suggContent
suggContentProvider
suggestion
suggLink
tagging
tag
thesaurus
3
searchadmin Commands
Alphabetic List of searchadmin Commands
activate clustering
activate clusterTree
activate identityPlugin
activate indexOptimizer
activate partitionConfig
activate queryUIFacets
activate resultList
activate schedule
activate singleSignOnSetting
activate skinBundle
activate suggContentProvider
activate tagging
create altWord
create boostedUrl
create classification
create clusterTree
create docServiceInstance
create docServiceManager
create docServicePipeline
create facetTree
create identityPlugin
create indexProfile
create lexer
create proxyLogin
create schedule
create searchAttr
create skinBundle
create source
create sourceGroup
create sourceType
create storageArea
create suggContentProvider
create suggestion
create suggLink
create tag
create thesaurus
createAll altWord
createAll boostedUrl
createAll authorizedPrincipal
createAll classification
createAll clusterTree
createAll docServiceInstance
createAll docServiceManager
createAll docServicePipeline
createAll facetTree
createAll identityPlugin
createAll indexProfile
createAll lexer
createAll proxyLogin
createAll schedule
createAll searchAttr
createAll source
createAll sourceGroup
createAll sourceType
createAll storageArea
createAll suggContentProvider
createAll suggestion
createAll suggLink
createAll tag
deactivate clustering
deactivate clusterTree
deactivate identityPlugin
deactivate indexOptimizer
deactivate queryUIFacets
deactivate resultList
deactivate schedule
deactivate singleSignOnSetting
deactivate skinBundle
deactivate suggContentProvider
deactivate tagging
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 singleSignOnSetting
getAllStates skinBundle
getAllStates suggContentProvider
getState autoSuggestion
getState clustering
getState clusterTree
getState identityPlugin
getState index
getState indexOptimizer
getState partitionConfig
getState queryUIFacets
getState resultList
getState schedule
getState singleSignOnSetting
getState skinBundle
getState suggContentProvider
getState tagging
getStateList clusterTree
getStateList identityPlugin
getStateList schedule
getStateList singleSignOnSetting
getStateList skinBundle
getStateList suggContentProvider
start autoSuggestion
start indexOptimizer
start schedule
stop indexOptimizer
stop schedule
update altWord
update autoSuggestion
update boostedUrl
update classification
update classificationMappings
update clustering
update clusterTree
update crawlerSettings
update docServiceInstance
update docServicePipeline
update facetTree
update globalBoundaryRules
update globalDocumentTypes
update index
update indexOptimizer
update indexProfile
update languageBasedTokenization
update lexer
update partitionConfig
update proxy
update proxyLogin
update queryConfig
update queryUIConfig
update queryUIFacets
update queryUISourceGroups
update relevanceRanking
update resultList
update schedule
update searchAttr
update singleSignOnSetting
update skinBundle
update source
update sourceGroup
update sourceType
update storageArea
update suggContent
update suggContentProvider
update suggestion
update suggLink
update tag
update tagging
update thesaurus
updateAll altWord
updateAll boostedUrl
updateAll classification
updateAll clusterTree
updateAll docServiceInstance
updateAll docServicePipeline
updateAll facetTree
updateAll indexProfile
updateAll lexer
updateAll proxyLogin
updateAll schedule
updateAll searchAttr
updateAll schedule
updateAll singleSignOnSetting
updateAll sourceGroup
updateAll sourceType
updateAll storageArea
updateAll suggContentProvider
updateAll suggestion
updateAll suggLink
updateAll tag
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
Index
Scripting on this page enhances content navigation, but does not change the content in any way.