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

update

Sets the properties of an administrative object.

See Also

updateAll

SOAP Message

<update xmlns="http://search.oracle.com/Admin">
   <objectType xmlns="">
   <objectKey xmlns="">
      <adminKeyPairs>
         <keyName>
         <keyValue>
   <objectXML xmlns="">
   <decryptionKey xmlns="">
   <credentials xmlns="">
      <password>
      <userName>
   <attachments xmlns="">
      <resourceName>
      <resourcePath>
   <controls xmlns="">
      <controlName>
      <controlValue>
   <locale xmlns="">

Element Descriptions 

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

Describes the update of an administrative object. It contains these elements:

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

Contains one of these types:

alert
altWord
clustering
clusterTree
crawlerSettings
index
indexOptimizer
partitionConfig
proxyLogin
queryConfig
resultList
schedule
searchAttr
skinBundle
source
sourceGroup
sourceType
spaceCalculator
storageArea
suggLink
thesaurus
<objectKey xmlns="">

Describes the object key for a creatable object. 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 proxyLogin and source 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.

<attachments xmlns="">

Describes a set of files composing a skinBundle. It contains these elements:

<resourceName>
<resourcePath>
<resourceName>

Contains the relative path of the file within the skin bundle, such as assets/images/logo.gif

<resourcePath>

Contains the full local path to the attachment file, such as /home/user/skins/holiday/assets/images/logo.gif.

<controls xmlns="">

Specifies an operation control. It contains these elements:

<controlName>
<controlValue>
<controlName>

UPDATE_METHOD: Controls the method used to update the properties of an object. (Required)

<controlValue>

For UPDATE_METHOD:

  • overwrite: Replaces the existing property values with the new values.

  • add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted from the XML document. For clusterTree, resultList, schedule, searchAttr, source, sourceGroup, and sourceType.

  • remove: Removes existing properties. For clusterTree, resultList, schedule, searchAttr, source, sourceGroup, and sourceType.

<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

Notes

After updating a skin bundle, restart the middle tier:

ORACLE_HOME/bin/searchctl restart

Example

This example updates the crawler settings. The input XML document is omitted from the example.

<update xmlns="http://search.oracle.com/Admin">
  <objectType xmlns="">crawlerSettings</objectType>
  <objectXML xmlns="">
          
     <!-- XML object description appears here-->
          
  </objectXML>
  <controls xmlns="">
    <controlName>UPDATE_METHOD</controlName>
    <controlValue>overwrite</controlValue>
  </controls>
</update>

The following is the service response to a successful update:

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