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

createAll

Creates all of the administrative objects of a specified type in an XML description.

See Also

create

SOAP Message

<createAll xmlns="http://search.oracle.com/Admin">
   <creatableType xmlns="">
   <objectXML xmlns="">
   <decryptionKey xmlns="">
   <credentials xmlns="">
      <password>
      <userName>
   <controls xmlns="">
      <controlName>
      <controlValue>
   <locale xmlns="">

Element Descriptions 

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

Describes creation of one or more administrative objects. It contains these elements:

<creatableType>
<objectXML>
<decryptionKey>
<credentials>
<attachments>
<controls>
<locale>
<creatableType xmlns="">

Contains a creatable type:

altWord
clusterTree
identityPlugin
proxyLogin
schedule
searchAttr
source
sourceGroup
sourceType
storageArea
suggLink
<objectXML xmlns="">

Contains an XML document that describes the objects. 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 these object types:

identityPlugin
proxyLogin
source
<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.

<controls xmlns="">

Specifies an operation control. It contains these elements:

<controlName>
<controlValue>
<controlName>

One of these controls:

  • DUPE_METHOD: Controls the action to take when an object already exists. For all creatable types.

  • IGNORE_INVALID_STATE: Controls whether processing continues when an object cannot be overwritten because it is in an invalid state. This control is used only when DUPE_METHOD is set to overwrite. For clusterTree, identityPlugin, and schedule only.

<controlValue>

For DUPE_METHOD:

  • error: The operation fails with an error. (Default)

  • ignore: The existing object description is kept.

  • overwrite: The new description replaces the existing object description

For IGNORE_INVALID_STATE:

  • true: Continue processing with the next object.

  • false: Stop processing with an error and roll back all changes. (Default)

<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 creates all of the alternate word pairs defined in the object XML (omitted):

<createAll xmlns="http://search.oracle.com/Admin">
  <creatableType xmlns="">altWord</creatableType>
  <objectXML xmlns="">
          
     <!-- XML object descriptions appear here-->
          
  </objectXML>
  <controls xmlns="">
     <controlName>DUPE_METHOD</controlName>
     <controlValue>overwrite</controlValue>
  </controls>
  <credentials xmlns="">
     <password>password</password>
     <userName>eqsys</userName>
  </credentials> 
</createAll>  

The response shows that three alternate word pairs were created successfully.

<ns2:createAllResponse xmlns:ns2="http://search.oracle.com/Admin">
  <statusList>
    <objectKey>
      <adminKeyPairs>
        <keyName>keyword</keyName>
        <keyValue>oses</keyValue>
      </adminKeyPairs>
      <adminKeyPairs>
        <keyName>altKeyword</keyName>
        <keyValue>Oracle Secure Enterprise Search</keyValue>
      </adminKeyPairs>
    </objectKey>
    <objectType>altWord</objectType>
    <statusCode>CREATE_SUCCEEDED</statusCode>
  </statusList>
  <statusList>
   <objectKey>
     <adminKeyPairs>
       <keyName>keyword</keyName>
        <keyValue>text</keyValue>
      </adminKeyPairs>
      <adminKeyPairs>
        <keyName>altKeyword</keyName>
        <keyValue>Oracle Text</keyValue>
     </adminKeyPairs>
    </objectKey>
    <objectType>altWord</objectType>
    <statusCode>CREATE_SUCCEEDED</statusCode>
  </statusList>
  <statusList>
   <objectKey>
      <adminKeyPairs>
        <keyName>keyword</keyName>
        <keyValue>rac</keyValue>
      </adminKeyPairs>
      <adminKeyPairs>
        <keyName>altKeyword</keyName>
        <keyValue>Real Application Clusters</keyValue>
      </adminKeyPairs>
    </objectKey>
    <objectType>altWord</objectType>
    <statusCode>CREATE_SUCCEEDED</statusCode>
  </statusList>
</ns2:createAllResponse>