---

docServiceInstance

A document service instance is a Java class that implements the document service API. It accepts input from documents and performs an operation on it. For example, you could create a document service for auditing or to show custom metatags.

Object Type

Creatable

Object Key

NAME

Object Key Command Syntax

--NAME=object_name

-n object_name

State Properties

None

Supported Operations

create
createAll
delete
deleteAll
deleteList
export
exportAll
exportList
getAllObjectKeys
update
updateAll

Administration GUI Page

Global Settings - Document Services - Create or Edit Document Service Instance

XML Description

The <search:docServiceInstances> element describes the document service instances:

<search:docServiceInstances> 
   <search:docServiceInstance> 
      <search:name> 
      <search:instanceManagerName> 
      <search:parameters>  
         <search:parameter> 
            <search:value> 
            <search:description>

Element Descriptions 

<search:docServiceInstances>

Describes all document service instances. It contains one or more <search:docServiceInstance> elements, each defining a document service instance.

<search:docServiceInstance>

Describes a document service instance. It contains these elements:

<search:name> 
<search:instanceManagerName> 
<search:parameters> 

<search:name>

Contains the name of the document service instance.

<search:instanceManagerName>

Contains the name of the manager for the document service instance. (Read only)

<search:parameters>

Contains one or more <search:parameter> elements, each describing a parameter of the document service instance.

<search:parameter>

Describes a parameter. It contains these elements:

<search:value> 
<search:description> 

Attribute	Value
name	Name of the parameter. (Read only)

<search:value>

Contains the value of the parameter.

Attribute	Value
encrypted	Indicates whether the value of <search:value> is encrypted. Set to true if the value is encrypted, or set to false if it is plain text.

<search:description>

Contains a description of the parameter. (Read only)

Example

This XML document describes the default image service:

<?xml version="1.0" encoding="UTF-8"?>
<search:config productVersion="11.2.1.0.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:docServiceInstances>
      <search:docServiceInstance>
         <search:name>Default image service instance</search:name>
         <search:instanceManagerName>
            Secure Enterprise Search Image Document Service
         </search:instanceManagerName>
         <search:parameters>
            <search:parameter name="attributes configuration file">
               <search:value>attr-config.xml</search:value>
              <search:description>EQG-12011:en-US:</search:description>
            </search:parameter>
         </search:parameters>
      </search:docServiceInstance>
   </search:docServiceInstances>
</search:config>