Skip Headers
Oracle® Secure Enterprise Search Administration API Guide
11g Release 1 (11.1.2.0.0)

E14133-02
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

activate

Activates an administrative object. Objects that control the periodic execution of an activity must also be started: indexOptimizer, schedule, and task.

See Also

start

SOAP Message

<activate xmlns="http://search.oracle.com/Admin">
   <objectType xmlns="">
   <objectKey xmlns="">
      <adminKeyPairs>
         <keyName>
         <keyValue>
   <objectXML xmlns="">
   <decryptionKey xmlns="">
   <credentials xmlns="">
      <password>
      <userName>
   <locale xmlns="">

Element Descriptions 

<activate xmlns="http://search.oracle.com/Admin">

Describes activation of an administrative object. It contains these elements:

<objectType>
<objectKey>
<objectXML>
<decryptionKey>
<credentials>
<locale>
<objectType xmlns="">

Contains one of these object types:

clustering
clusterTree
identityPlugin
indexOptimizer
resultList
schedule
skinBundle
spaceCalculator
<objectKey xmlns="">

Describes the object key for a creatable object type:

clusterTree
identityPlugin
schedule

This element contains one or more <adminKeyPairs> elements.

<adminKeyPairs>

Contains these elements:

<keyName>
<keyValue>
<keyName>

Contains the case-sensitive key name of the object type, such as name.

<keyValue>

Contains the value that uniquely describes the object, such as Website Schedule.

<objectXML xmlns="">

Contains an XML document that describes the object. See Chapter 2, "Administration Object Types."

Use escape codes for these symbols in the embedded XML:

Symbol Escape Code
< &lt;
> &gt;
" &quot;

<decryptionKey xmlns="">

Contains a decryption key for identityPlugin objects.

<credentials xmlns="">

Provides the credentials for the Oracle SES administrator. Credentials are required only when the session is stateless. See "Providing Credentials".

This element contains these child elements:

<password>
<userName>
<password>

Contains the password for <userName>.

<userName>

Contains the user name of the Oracle SES administrator.

<locale xmlns="">

Sets the language for error messages. See Table 2-2, "Product Languages" for a list of valid codes.

If you omit this element or enter an invalid code, then Oracle SES uses the default locale of the system where it is running.

SOAP Faults

AdminAPIRuntimeFault
CreatableAdminObjectFault
DependentObjectFault
InvalidInputFault
InvalidStateFault

Example

This example activates clustering:

<activate xmlns="http://search.oracle.com/Admin">
   <objectType xmlns="">clustering</objectType>
</activate>  

This is the service response for a successful operation:

<ns2:activateResponse xmlns:ns2="http://search.oracle.com/Admin" />