3 searchadmin Commands

This chapter describes all the searchadmin commands of Oracle SES.

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 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

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 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 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 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 singleSignOnSetting
updateAll sourceGroup
updateAll sourceType
updateAll storageArea
updateAll suggContentProvider
updateAll suggestion
updateAll suggLink

activate clustering

Activates clustering.

Syntax

activate clustering

Example

This example activates clustering:

SES>activate clustering
 
The object "clustering" was successfully activated.

activate clusterTree

Activates a cluster tree.

A clusterTree object is active when it is created. You must activate a clusterTree only after deactivating it.

Syntax

activate clusterTree --NAME=object_name

activate clusterTree -n object_name]

Parameters

object_name: Content of a <search:name> element in the XML document.

Example

This example activates a cluster tree named Topic Tree, which was previously created and deactivated:

SES>activate clusterTree --NAME="Topic Tree"
 
The object "[name=Topic Tree]" was successfully activated.

activate identityPlugin

Activates an identity plug-in.

Only one identity plug-in can be active at a time. To change identity plug-ins, deactivate the current one before activating a different identity plug-in. Otherwise, an error results. An identity plug-in is inactive when it is created.

Syntax

activate identityPlugin --JAR_FILE=jar_filename --MANAGER_CLASS=class  [--INPUT_FILE=xml_filename --ENCRYPT_KEY=key]

activate identityPlugin --JAR_FILE=jar_filename --MANAGER_CLASS=class [-i xml_filename -e key]

Parameters

jar_filename

Content of a <search:jarFilePath> element in the XML document.

class

Content of a <search:managerClassName> element in the XML document.

xml_filename

Path to an XML document that contains parameter settings for the object. See "identityPlugin".

key

Decryption key for passwords in xml_filename. If the plug-in description has been exported from Oracle SES, use the same key.

The key must be at least eight ASCII characters long and include at least one letter and one number. Multibyte characters are invalid. If you omit this option, you are prompted for the key.

Example

This example activates an identity plug-in with the configuration settings in identity.xml:

SES>activate identityPlugin --JAR_FILE=OIDPlugins.jar --MANAGER_CLASS=oracle.search.plugin.security.identity.oid.OIDPluginManager --INPUT_FILE=identity.xml --ENCRYPT_KEY=key2decrypt
 
The object "[jarFilePath=OIDPlugins.jar, managerClassName=oracle.search.plugin.security.identity.oid.OIDPluginManager]" was successfully activated.

activate indexOptimizer

Activates the index optimizer schedule.

See Also

start indexOptimizer

Syntax

activate indexOptimizer

Example

This example activates the index optimizer:

SES>activate indexOptimizer
 
The object "indexOptimizer" was successfully activated.

activate partitionConfig

Activates partitionConfig.

Syntax

activate partitionConfig

Example

This example activates partitionConfig:

SES>activate partitionConfig
 
The object "partitionConfig" was successfully activated.

activate queryUIFacets

Activates queryUIFacets.

Syntax

activate queryUIFacets

Example

This example activates queryUIFacets:

SES>activate queryUIFacets
 
The object "queryUIFacets" was successfully activated.

activate resultList

Enables the global advanced result configuration option.

Syntax

activate resultList

Example

This example activates the result list:

SES>activate resultList
 
The object "resultList" was successfully activated.

activate schedule

Activates a schedule.

See Also

start schedule

Syntax

activate schedule --NAME=object_name [--INPUT_FILE=xml_filename]

activate schedule -n object_name [-i xml_filename]

Parameters

object_name: Content of a <search:name> element in the XML document.
xml_filename: Path to the XML document that describes the object. See "schedule".

Example

This example activates a schedule named Mailing List Schedule:

SES>activate schedule --NAME="Mailing List Schedule"
 
The object "[name=Mailing List Schedule]" was successfully activated.

activate singleSignOnSetting

Activates a Single Sign-On setting.

Syntax

activate singleSignOnSetting --NAME=object_name

activate singleSignOnSetting -n object_name]

Parameters

object_name: Content of a <search:name> element in the XML document.

Example

This example activates a Single Sign-On setting named OSSO:

SES>activate singleSignOnSetting --NAME="OSSO"
 
The object "[name=OSSO]" was successfully activated.

activate skinBundle

Activates a skin bundle.

Syntax

activate skinBundle --NAME=object_name [--INPUT_FILE=xml_filename] [--ATTACHMENT_LIST=list_filename]

activate skinBundle -n object_name [-i xml_filename] [-h list_filename]

Parameters

object_name: Content of a <search:name> element in the XML document.
xml_filename: Path to the XML document that describes the object. See "skinBundle".
list_filename: Path to the text file that lists the files in the skin bundle. See the Notes for "create skinBundle".

Example

This example activates a skin bundle named acme:

SES>activate skinBundle --NAME=acme
 
The object "[name=acme]" was successfully activated

activate suggContentProvider

Activates a suggested content provider.

Syntax

activate suggContentProvider --NAME=object_name

activate suggContentProvider -n object_name]

Parameters

object_name: Content of a <search:name> element in the XML document.

Example

This example activates a suggested content provider named Provider1:

SES>activate suggContentProvider --NAME="Provider1"
 
The object "[name=Provider1]" was successfully activated.

activate tagging

Activates tagging configuration.

Syntax

activate tagging

Example

This example activates tagging configuration:

SES>activate tagging
 
The object "tagging" was successfully activated.

create altWord

Creates an alternate word pair from an XML description.

See Also

createAll altWord

Syntax

create altWord --KEYWORD=keyword --ALT_KEYWORD=alt_keyword --INPUT_FILE=xml_filename

create altWord --KEYWORD=keyword --ALT_KEYWORD=alt_keyword -i xml_filename

Parameters

keyword: Content of a <search:keyword> element in the XML document.
alt_keyword: Content of a <search:altKeyword> element in the XML document.
xml_filename: Path to the XML document that defines the object. See "altWord".

Example

This example creates an alternate word for RAC. No other objects in the XML document are created.

SES>create altWord --KEYWORD=rac --ALT_KEYWORD="Real Application Clusters" --INPUT_FILE=altwords.xml
 
The object "[keyword=rac, altKeyword=Real Application Clusters]" was successfully created.

create boostedUrl

Creates a boostedUrl object from an XML description.

See Also

createAll authorizedPrincipal

Syntax

create boostedUrl --DOC_URL=url --QUERY=query_term

Parameters

url: The URL of a document being boosted.
query_term: The exact query term that returns the boosted URL.

Example

This example boosts a URL for queries matching the term "indexing":

SES>create boostedUrl --DOC_URL=http://example.com//doctools/b32440/xref_foot_in.htm --QUERY=indexing --INPUT_FILE=boost.xml

The object "[query=indexing, docUrl=http://example.com/doctools/b32440/xref_foot_in.htm]" was successfully created.

create classification

Creates classification from an XML description.

See Also

createAll classification

Syntax

create classification --NAME=object_name --INPUT_FILE=xml_filename

create classification -n object_name -i xml_filename

Parameters

object_name: Content of a <search:name> element in the XML document.
xml_filename: Path to the XML document that defines the object. See "classification".

Example

This example creates a classfication myClassification defined in classification.xml.

SES>create classification --NAME="myClassification" --INPUT_FILE=classification.xml
 
The object "[name=myClassification]" was successfully created.

create clusterTree

Creates a cluster tree from an XML description.

See Also

createAll clusterTree

Syntax

create clusterTree --NAME=object_name --INPUT_FILE=xml_filename

create clusterTree -n object_name -i xml_filename

Parameters

object_name: Content of a <search:name> element in the XML document.
xml_filename: Path to the XML document that defines the object. See "clusterTree".

Example

This example creates a metadata cluster tree defined in clustertree.xml. No other objects in the document are created.

SES>create clusterTree --NAME="Metadata Tree" --INPUT_FILE=clustertree.xml
 
The object "[name=Metadata Tree]" was successfully created.

create docServiceInstance

Creates a document service instance from an XML description.

See Also

createAll docServiceInstance

Syntax

create docServiceInstance --NAME=object_name --INPUT_FILE=xml_filename [--ENCRYPT_KEY=key]

create docServiceInstance -n object_name -i xml_filename [-e key]

Parameters

object_name: Content of a <search:name> element in the XML document.
xml_filename: Path to the XML document that defines the object. See "docServiceInstance".
key: Encryption key for passwords in xml_filename. The key must be at least eight ASCII characters long and include at least one letter and one number. Multibyte characters are invalid. If you omit this option, you are prompted for the key.

Example

This example creates a service instance from the description in docserviceinstance.xml:

SES>create docServiceInstance --NAME="Default summarizer service instance" --INPUT_FILE=docserviceinstance.xml --ENCRYPT_KEY=key2encrypt
 
The object "[name=Default summarizer service instance]" was successfully created.

create docServiceManager

Creates a document service manager from an XML description.

See Also

createAll docServiceManager

Syntax

create docServiceManager --NAME=object_name --INPUT_FILE=xml_filename]

create docServiceManager -n object_name -i xml_filename]

Parameters

object_name: Content of a <search:name> element in the XML document.
xml_filename: Path to the XML document that defines the object. See "docServiceManager".

Example

SES>create docServiceManager --JAR_FILE=extractor/extractor.jar --MANAGER_CLASS=oracle.search.plugin.doc.extractor.DocumentSummarizerManager --INPUT_FILE=docservicemanager.xml
 
The object "[jarFilePath=extractor/extractor.jar, managerClassName=oracle.search.plugin.doc.extractor.DocumentSummarizerManager]" was successfully created.

create docServicePipeline

Creates a document service pipeline from an XML description.

See Also

createAll docServicePipeline

Syntax

create docServicePipeline --NAME=object_name --INPUT_FILE=xml_filename

create docServicePipeline -n object_name -i xml_filename

Parameters

object_name: Content of a <search:name> element in the XML document.
xml_filename: Path to the XML document that defines the object. See "docServicePipeline".

Example

This example creates a document service pipeline:

SES>create docServicePipeline --NAME=Default pipeline --INPUT_FILE=docservicepipeline.xml
 
The object "[name=Default pipeline]" was successfully created.

create facetTree

Creates a facet tree from an XML description.

See Also

createAll facetTree

Syntax

create facetTree --NAME=object_name --INPUT_FILE=xml_filename

create facetTree -n object_name -i xml_filename

Parameters

object_name: Content of a <search:name> element in the XML document.
xml_filename: Path to the XML document that defines the object. See "facetTree".

Example

This example creates a facet tree named Country:

SES>create facetTree --FACETNAME=Country --INPUT_FILE=facettree.xml
 
The object "[facetName=Country]" was successfully created.

create identityPlugin

Creates an identity plug-in from an XML description.

See Also

createAll identityPlugin

Syntax

create identityPlugin --JAR_FILE=jar_filename --MANAGER_CLASS=class --INPUT_FILE=xml_filename]

create identityPlugin --JAR_FILE=jar_filename --MANAGER_CLASS=class -i xml_filename]

Parameters

jar_filename: Content of a <search:jarFilePath> element in the XML document.
class: Content of a <search:managerClassName> element in the XML document.
xml_filename: Path to the XML document that defines the object. See "identityPlugin".
key: Encryption key for passwords in xml_filename. The key must be at least eight ASCII characters long and include at least one letter and one number. Multibyte characters are invalid. If you omit this option, you are prompted for the key.

Example

This example creates an identity plug-in defined in identity.xml.

SES>create identityPlugin --JAR_FILE=OIDPlugins.jar --MANAGER_CLASS=oracle.search.plugin.security.identity.oid.OIDPluginManager --INPUT_FILE=identity.xml
 
The object "[jarFilePath=OIDPlugins.jar, managerClassName=oracle.search.plugin.security.identity.oid.OIDPluginManager]" was successfully created.

create indexProfile

Creates an index profile from an XML description.

See Also

createAll indexProfile

Syntax

create indexProfile --NAME=object_name --INPUT_FILE=xml_filename

create indexProfile -n object_name -i xml_filename

Parameters

object_name: Content of a <search:name> element in the XML document.
xml_filename: Path to the XML document that defines the object. See "indexProfile".

Example

This example creates an index profile named My Index Profile:

SES>create indexProfile --NAME="My IndexProfile" --INPUT_FILE=indexprofile.xml
 
The object "[name=My Index Profile]" was successfully created.

create lexer

Creates a lexer from an XML document.

See Also

createAll lexer

Syntax

create lexer --NAME=object_name --INPUT_FILE=xml_filename

create lexer -n object_name -i xml_filename

Parameters

object_name: Content of a <search:name> element in the XML document.
xml_filename: Path to the XML document that defines the object. See "lexer".

Example

This example creates a Swedish lexer:

SES>create lexer --NAME=SwedishLexer --INPUT_FILE=lexer.xml
 
The object "[name=SwedishLexer]" was successfully created.

create proxyLogin

Creates a proxy log-in (federation trusted entity) from an XML description.

See Also

createAll proxyLogin

Syntax

create proxyLogin --NAME=object_name --INPUT_FILE=xml_filename [--ENCRYPT_KEY=key]

create proxyLogin -n object_name -i xml_filename [-e key]

Parameters

object_name: Content of a <search:name> element in the XML document.
xml_filename: Path to the XML document that defines the object. See "proxyLogin".
key: Encryption key for passwords in xml_filename. The key must be at least eight ASCII characters long and include at least one letter and one number. Multibyte characters are invalid. If you omit this option, you are prompted for the key.

Example

This example creates this_proxy as defined in proxy.xml.

The user is prompted for a password after omitting the --ENCRYPT_KEY option.

SES>create proxyLogin --NAME=this_proxy --INPUT_FILE=proxy.xml
Enter encryption key:
 
The object "[name=this_proxy]" was successfully created.

create schedule

Creates a schedule from an XML description. You must create the source before creating the schedule. See create source.

See Also

createAll schedule

Syntax

create schedule --NAME=object_name --INPUT_FILE=xml_filename

create schedule -n object_name -i xml_filename

Parameters

object_name: Content of a <search:name> element in the XML document.
xml_filename: Path to the XML document that defines the object. See "schedule".

Example

This example creates the Doc Library schedule as defined in schedule.xml:

SES>create schedule --NAME="Doc Library" --INPUT_FILE=schedule.xml

The object "[name=Doc Library]" was successfully created.

create searchAttr

Creates a custom search attribute from an XML description.

See Also

createAll searchAttr

Syntax

create searchAttr --NAME=object_name --INPUT_FILE=xml_filename

create searchAttr -n object_name -i xml_filename

Parameters

object_name: Content of a <search:name> element in the XML document.
xml_filename: Path to the XML document that defines the object. See "searchAttr".

Example

This example creates the Copyright search attribute:

SES>create searchAttr --NAME=Copyright --INPUT_FILE=searchattrs.xml
 
The object "[name=Copyright]" was successfully created.

create skinBundle

Creates a skin bundle from an XML description and a structured directory of files.

Syntax

create skinBundle --NAME=object_name --INPUT_FILE=xml_filename --ATTACHMENT_LIST=list_filename

create searchAttr -n object_name -i xml_filename -h list_filename

Parameters

object_name: Content of a <search:name> element in the XML document.
xml_filename: Path to the XML document that defines the object. See "skinBundle".
list_filename: Path to the text file that lists the files in the skin bundle. See the Notes.

Notes

To identify the location of the files composing the skin bundle, create a text file with a line for each file in this format:

resource_name::local_file_path

Where:

resource_name identifies the location of the file in the skin bundle. Use this resource name in the XML description of the skin bundle.

local_file_path is the fully qualified name of the file.

For example:

templates/query.ftl::/scratch/skins/Holiday/templates/query.ftl
assets/images/logo.gif::/scratch/skins/Holiday/assets/images/logo.gif

Example

This example creates the acme skin bundle from the description in skins.xml and the files identified in skins/resources.lst:

SES>create skinBundle --NAME=acme --INPUT_FILE=skins.xml --ATTACHMENT_LIST=skins/resources.lst
 
The object "[name=acme]" was successfully created.

create source

Creates a source from an XML description.

See Also

createAll source

Syntax

create source --NAME=object_name --INPUT_FILE=xml_filename [--ENCRYPT_KEY=key]

create source -n object_name -i xml_filename [-e key]

Parameters

object_name: Content of a <search:name> element in the XML document.
xml_filename: Path to the XML document that defines the object. See "source".
key: Encryption key for passwords in xml_filename. The key must be at least eight ASCII characters long and include at least one letter and one number. Multibyte characters are invalid. If you omit this option, you are prompted for the key.

Example

This example creates the Doc Library source defined in sources.xml:

SES>create source --NAME="Doc Library" --INPUT_FILE=sources.xml --ENCRYPT_KEY=key2encrypt
 
The object "[name=Doc Library]" was successfully created.

create sourceGroup

Creates a source group from an XML description.

See Also

createAll sourceGroup

Syntax

create sourceGroup --NAME=object_name --INPUT_FILE=xml_filename

create sourceGroup -n object_name -i xml_filename

Parameters

object_name: Content of a <search:name> element in the XML document.
xml_filename: Path to the XML document that defines the object. See "sourceGroup".

Example

This example creates the Mail source group defined in sourcegroups.xml:

SES>create sourceGroup --NAME=Mail --INPUT_FILE=sourcegroups.xml
 
The object "[name=Mail]" was successfully created.

create sourceType

Creates a source type from an XML description.

See Also

createAll sourceType

Syntax

create sourceType --NAME=object_name --INPUT_FILE=xml_filename

create sourceType -n object_name -i xml_filename

Parameters

object_name: Content of a <search:name> element in the XML document.
xml_filename: Path to the XML document that defines the object. See "sourceType".

Example

This example creates the New Agent source type defined in sourcetype.xml.

SES>create sourceType --NAME="New Agent" --INPUT_FILE=sourcetype.xml
 
The object "[name=New Agent]" was successfully created.

create storageArea

Creates a storage area from an XML description. Note that this command does not create a new tablespace, but uses an existing tablespace for creating storageArea object.

See Also

createAll storageArea

Syntax

create storageArea --NAME=object_name --INPUT_FILE=xml_filename

create storageArea -n object_name -i xml_filename

Parameters

object_name: Content of a <search:name> element in the XML document.
xml_filename: Path to the XML document that defines the object. See "storageArea".

Example

This example creates a storage area named Prosperity:

SES>create storageArea --NAME=Prosperity --INPUT_FILE=storage.xml
 
The object "[name=Prosperity]" was successfully created.

create suggContentProvider

Creates a suggested content provider from an XML description.

See Also

createAll suggContentProvider

Syntax

create suggContentProvider --NAME=object_name --INPUT_FILE=xml_filename

create suggContentProvider -n object_name -i xml_filename

Parameters

object_name: Content of a <search:name> element in the XML document.
xml_filename: Path to the XML document that defines the object. See "suggContentProvider".

Example

This example creates a suggested content provider named Provider1:

SES>create suggContentProvider --NAME=Provider1 --INPUT_FILE=provider1.xml
 
The object "[name=Provider1]" was successfully created.

create suggestion

Creates a suggestion from an XML description.

See Also

createAll suggestion

Syntax

create suggestion --NAME=object_name --INPUT_FILE=xml_filename

create suggestion -n object_name -i xml_filename

Parameters

object_name: Content of a <search:name> element in the XML document.
xml_filename: Path to the XML document that defines the object. See "suggestion".

Example

This example creates a suggestion mySuggestion defined in suggestion.xml.

SES>create suggestion --NAME="mySuggestion" --INPUT_FILE=suggestion.xml
 
The object "[name=mySuggestion]" was successfully created.

create suggLink

Creates a suggested link from an XML description.

See Also

createAll suggLink

Syntax

create suggLink --KEYWORD=keyword --LINK_URL=url --INPUT_FILE=xml_filename

create suggLink --KEYWORD=keyword --LINK_URL=url -i xml_filename

Parameters

keyword: Content of the <search:keyword> element in the XML document.
url: Content of the <search:linkUrl> element in the XML document.
xml_filename: Path to the XML document that defines the suggested link. See "suggLink".

Example

This example creates a suggested link for the oracle keyword from the description in sugglinks.xml:

SES>create suggLink --KEYWORD=oracle --LINK_URL=http://www.oracle.com --INPUT_FILE=sugglinks.xml
 
The object "[keyword=oracle, linkUrl=http://www.oracle.com]" was successfully created.

create tag

Creates a tag from an XML description.

Syntax

create tag --NAME=object_name --INPUT_FILE=xml_filename

create tag -n object_name -i xml_filename

Parameters

object_name: Content of a <search:name> element in the XML document.
xml_filename: Path to the XML document that defines the object. See "tag".

Example

This example creates the OSES tag defined in tag.xml:

SES>create tag --NAME=OSES --INPUT_FILE=tag.xml
 
The object "[name=OSES]" was successfully created.

create thesaurus

Creates a thesaurus from an XML description.

Syntax

create thesaurus --NAME=object_name --INPUT_FILE=xml_filename

create thesaurus -n object_name -i xml_filename

Parameters

object_name: Content of a <search:name> element in the XML document.
xml_filename: Path to the XML document that defines the object. See "thesaurus".

Example

This example creates the DEFAULT thesaurus defined in thesaurus.xml:

SES>create thesaurus --NAME=DEFAULT --INPUT_FILE=thesaurus.xml
 
The object "[name=DEFAULT]" was successfully created.

createAll altWord

Creates all alternate words described in an XML file.

See Also

create altWord

Syntax

createAll altWord --INPUT_FILE=xml_filename [--DUPE_METHOD=action]

createAll altWord -i xml_filename [-d action]

Parameters

xml_filename

Path to the XML document that contains the object descriptions. See "altWord".

action

Action to take when an object already exists:

error: The createAll command fails with an error. (Default)
ignore: The existing object description is kept.
overwrite: The new description replaces the existing object description.

Example

This example creates the three altWord objects defined in altwords.xml.

SES>createAll altWord --INPUT_FILE=altwords.xml

createAll operation succeeded for type "altWord".
 
  3 object(s) with status CREATE_SUCCEEDED

The next example shows use of the --DUPE_METHOD option:

SES>createAll altWord --INPUT_FILE=altwords.xml

The object with key "[keyword=text, altKeyword=Oracle Text]" and type "altWord"already exists.
 
SES>createAll altWord --INPUT_FILE=altwords.xml --DUPE_METHOD=overwrite
 
createAll operation succeeded for type "altWord".
 
  2 object(s) with status CREATE_SUCCEEDED
  1 object(s) with status DUPLICATE_OVERWRITTEN

createAll boostedUrl

Creates all the boostedUrl objects described in an XML document.

See Also

create boostedUrl

Syntax

createAll boostedUrl --INPUT_FILE=xml_filename [--DUPE_METHOD=action]

createAll boostedUrl -i xml_filename [-d action]

Parameters

xml_filename

Path to the XML document that contains the object descriptions. See "boostedUrl".

action

Action to take when an object already exists:

error: The command fails with an error. (Default)
ignore: The existing object description is kept.
overwrite: The new description replaces the existing object description.

Example

This example creates one boostedUrl defined in boost.xml and ignores the existing object description.

SES>createAll boostedUrl --INPUT_FILE=boost.xml --DUPE_METHOD=ignore

createAll operation succeeded for type "boostedUrl".
 
  1 object(s) with status CREATE_SUCCEEDED
  1 object(s) with status DUPLICATE_IGNORED

createAll authorizedPrincipal

Creates all the authorizedPrincipal objects described in an XML document.

Syntax

createAll authorizedPrincipal --INPUT_FILE=xml_filename [--DUPE_METHOD=action]

createAll authorizedPrincipal -i xml_filename [-d action]

Parameters

xml_filename

Path to the XML document that contains the object descriptions. See "authorizedPrincipal".

action

Action to take when an object already exists:

error: The command fails with an error. (Default)
ignore: The existing object description is kept.
overwrite: The new description replaces the existing object description.

Example

This example creates one authorizedPrincipal defined in authorizedPrincipals.xml and ignores the existing object description.

SES>createAll authorizedPrincipal --INPUT_FILE=authorizedPrincipals.xml --DUPE_METHOD=ignore

createAll operation succeeded for type "authorizedPrincipal".
 
  1 object(s) with status CREATE_SUCCEEDED
  1 object(s) with status DUPLICATE_IGNORED

createAll classification

Creates all the classifications described in an XML file.

See Also

create classification

Syntax

createAll classification --INPUT_FILE=xml_filename [--DUPE_METHOD=action [--IGNORE_INVALID_STATE=state]]

createAll classification -i xml_filename [-d action [-s state]]

Parameters

xml_filename

Path to the XML document that contains the object descriptions. See "classification".

action

Action to take when an object already exists:

error: The createAll command fails with an error. (Default)
ignore: The existing object description is kept.
overwrite: The new description replaces the existing object description.

state

Controls whether processing continues when an object cannot be overwritten because it is in an invalid state. This option is used only when --DUPE_METHOD=overwrite.

true: Continue processing with the next object.
false: Stop processing with an error and roll back all changes. (Default)

Example

This command creates one of the two classifications described in classifications.xml. The second classification already exists.

SES>createAll classification --INPUT_FILE=classifications.xml --DUPE_METHOD=overwrite
 
createAll operation succeeded for type "classification".
 
  1 object(s) with status CREATE_SUCCEEDED
  1 object(s) with status DUPLICATE_OVERWRITTEN

createAll clusterTree

Creates all cluster trees described in an XML file.

See Also

create clusterTree

Syntax

createAll clusterTree --INPUT_FILE=xml_filename [--DUPE_METHOD=action [--IGNORE_INVALID_STATE=state]]

createAll clusterTree -i xml_filename [-d action [-s state]]

Parameters

xml_filename

Path to the XML document that contains the object descriptions. See "clusterTree".

action

Action to take when an object already exists:

error: The createAll command fails with an error. (Default)
ignore: The existing object description is kept.
overwrite: The new description replaces the existing object description.

state

Controls whether processing continues when an object cannot be overwritten because it is in an invalid state. This option is used only when --DUPE_METHOD=overwrite.

true: Continue processing with the next object.
false: Stop processing with an error and roll back all changes. (Default)

Example

This command creates one of the two cluster trees described in clustertree.xml. The second cluster tree already exists.

SES>createAll clusterTree --INPUT_FILE=clustertree.xml --DUPE_METHOD=overwrite
 
createAll operation succeeded for type "clusterTree".
 
  1 object(s) with status CREATE_SUCCEEDED
  1 object(s) with status DUPLICATE_OVERWRITTEN

createAll docServiceInstance

Creates all document service instances described in an XML file.

See Also

create docServiceInstance

Syntax

createAll docServiceInstance --INPUT_FILE=xml_filename [--DUPE_METHOD=action]

createAll docServiceInstance -i xml_filename [-d action]

Parameters

xml_filename

Path to the XML document that contains the object descriptions. See "docServiceInstance".

action

Action to take when an object already exists:

error: The createAll command fails with an error. (Default)
ignore: The existing object description is kept.
overwrite: The new description replaces the existing object description.

Example

This example creates one new document service instance and overwrites an exiting one:

SES>createAll docServiceInstance --INPUT_FILE=docserviceinstance.xml --DUPE_METHOD=overwrite --ENCRYPT_KEY=key2encrypt
 
createAll operation succeeded for type "docServiceInstance".
 
  1 object(s) with status CREATE_SUCCEEDED
  1 object(s) with status DUPLICATE_OVERWRITTEN

createAll docServiceManager

Creates all document service managers described in an XML file.

See Also

create docServiceManager

Syntax

createAll docServiceManager --INPUT_FILE=xml_filename [--DUPE_METHOD=action]

createAll docServiceManager -i xml_filename [-d action]

Parameters

xml_filename

Path to the XML document that contains the object descriptions. See "docServiceManager".

action

Action to take when an object already exists:

error: The createAll command fails with an error. (Default)
ignore: The existing object description is kept.

Example

The following example shows the resulting error when --DUPE_METHOD=error and an object described in the XML file already exists. No objects are created.

SES>createAll docServiceManager --INPUT_FILE=docservicemanager.xml --DUPE_METHOD=error

EQA-11001: The object with key "[jarFilePath=extractor/extractor.jar, managerClassName=oracle.search.plugin.doc.extractor.DocumentSummarizerManager]" and type "docServiceManager" already exists.

createAll docServicePipeline

Creates all document service pipelines described in an XML document.

See Also

create docServicePipeline

Syntax

createAll docServicePipeline --INPUT_FILE=xml_filename [--DUPE_METHOD=action]

createAll docServicePipeline -i xml_filename [-d action]

Parameters

xml_filename

Path to the XML document that contains the object descriptions. See "docServicePipeline".

action

Action to take when an object already exists:

error: The createAll command fails with an error. (Default)
ignore: The existing object description is kept.
overwrite: The new description replaces the existing object description.

Example

This example creates a new document service pipeline and replaces an existing one:

SES>createAll docServicePipeline --INPUT_FILE=docservicepipeline.xml --DUPE_METHOD=overwrite 
 
createAll operation succeeded for type "docServicePipeline".
 
  1 object(s) with status CREATE_SUCCEEDED
  1 object(s) with status DUPLICATE_OVERWRITTEN

createAll facetTree

Creates all facet trees described in an XML document.

See Also

create facetTree

Syntax

createAll facetTree --INPUT_FILE=xml_filename [--DUPE_METHOD=action]

createAll facetTree -i xml_filename [-d action]

Parameters

xml_filename

Path to the XML document that contains the object descriptions. See "facetTree".

action

Action to take when an object already exists:

error: The createAll command fails with an error. (Default)
ignore: The existing object description is kept.

Example

This example attempts to create two facet trees. One facet tree is created successfully, and the other attempt is ignored because the object already exists.

SES>createAll facetTree --INPUT_FILE=facettree.xml --DUPE_METHOD=ignore
 
createAll operation succeeded for type "facetTree".
 
  1 object(s) with status CREATE_SUCCEEDED
  1 object(s) with status DUPLICATE_IGNORED

createAll identityPlugin

Creates all identity plug-ins described in an XML file.

See Also

create identityPlugin

Syntax

createAll identityPlugin --INPUT_FILE=xml_filename [--DUPE_METHOD=action] [--ENCRYPT_KEY=key]

createAll identityPlugin -i xml_filename [-d action [-s state]] [-e key]

Parameters

xml_filename

Path to the XML document that contains the object descriptions. See "identityPlugin".

action

Action to take when an object already exists:

error: The createAll command fails with an error. (Default)
ignore: The existing object description is kept.

key

Encryption key for passwords in xml_filename. The key must be at least eight ASCII characters long and include at least one letter and one number. Multibyte characters are invalid. If you omit this option, you are prompted for the key.

Example

This example attempts to create the identity plug-ins described in identity.xml, but it already exists:

SES>createAll identityPlugin --INPUT_FILE=identity.xml --DUPE_METHOD=ignore --ENCRYPT_KEY=key2encrypt
 
createAll operation succeeded for type "identityPlugin".
 
  1 object(s) with status DUPLICATE_IGNORED

createAll indexProfile

Creates all index profiles described in an XML document

See Also

create indexProfile

Syntax

createAll indexProfile --INPUT_FILE=xml_filename [--DUPE_METHOD=action]

createAll indexProfile -i xml_filename [-d action]

Parameters

xml_filename

Path to the XML document that contains the object descriptions. See "indexProfile".

action

Action to take when an object already exists:

error: The createAll command fails with an error. (Default)
ignore: The existing object description is kept.
overwrite: The new description replaces the existing object description.

Example

SES>createAll indexProfile --INPUT_FILE=indexprofile.xml --DUPE_METHOD=overwrite
 
createAll operation succeeded for type "indexProfile".
 
  2 object(s) with status DUPLICATE_OVERWRITTEN

createAll lexer

Creates all lexers described in an XML document.

See Also

create lexer

Syntax

createAll lexer --INPUT_FILE=xml_filename [--DUPE_METHOD=action]

createAll lexer -i xml_filename [-d action]

Parameters

xml_filename

Path to the XML document that contains the object descriptions. See "lexer".

action

Action to take when an object already exists:

error: The createAll command fails with an error. (Default)
ignore: The existing object description is kept.
overwrite: The new description replaces the existing object description.

Example

This example overwrites three lexers:

SES>createAll lexer --INPUT_FILE=lexer.xml --DUPE_METHOD=overwrite
 
createAll operation succeeded for type "lexer".
 
  3 object(s) with status DUPLICATE_OVERWRITTEN

createAll proxyLogin

Creates all proxy log-ins described in an XML file.

See Also

create proxyLogin

Syntax

createAll proxyLogin --INPUT_FILE=xml_filename [--DUPE_METHOD=action] [--ENCRYPT_KEY=key]

createAll proxyLogin -i xml_filename [-d action] [-e key]

Parameters

xml_filename

Path to the XML document that contains the object descriptions. See "proxyLogin".

action

Action to take when an object already exists:

error: The createAll command fails with an error. (Default)
ignore: The existing object description is kept.
overwrite: The new description replaces the existing object description.

key

Example

This example creates all proxy log-ins described in proxy.xml. The status message shows that one of them already exists.

SES>createAll proxyLogin --INPUT_FILE=proxy.xml --DUPE_METHOD=ignore --ENCRYPT_KEY=key2decrypt
 
createAll operation succeeded for type "proxyLogin".
 
  2 object(s) with status CREATE_SUCCEEDED
  1 object(s) with status DUPLICATE_IGNORED

createAll schedule

Creates all schedules described in an XML file.

See Also

create schedule

Syntax

createAll schedule --INPUT_FILE=xml_filename [--DUPE_METHOD=action [--IGNORE_INVALID_STATE=state]]

createAll schedule -i xml_filename [-d action [-s state]]

Parameters

xml_filename

Path to the XML document that contains the object descriptions. See "schedule".

action

Action to take when an object already exists:

error: The createAll command fails with an error. (Default)
ignore: The existing object description is kept.
overwrite: The new description replaces the existing object description.

state

Controls whether processing continues when an object cannot be overwritten because it is in an invalid state. This option is used only when --DUPE_METHOD=overwrite.

true: Continue processing with the next object.
false: Stop processing with an error and roll back all changes. (Default)

Example

This example creates three schedules described in schedule.xml. Two of the schedules already exist.

SES>createAll schedule --INPUT_FILE=schedule.xml --DUPE_METHOD=ignore
 
createAll operation succeeded for type "schedule".
 
  3 object(s) with status CREATE_SUCCEEDED
  2 object(s) with status DUPLICATE_IGNORED

createAll searchAttr

Creates all custom search attributes described in an XML file.

See Also

create searchAttr

Syntax

createAll searchAttr --INPUT_FILE=xml_filename [--DUPE_METHOD=action]

createAll searchAttr -i xml_filename [-d action]

Parameters

xml_filename

Path to the XML document that contains the object descriptions. See "searchAttr".

action

Action to take when an object already exists:

error: The createAll command fails with an error. (Default)
ignore: The existing object description is kept.
overwrite: The new description replaces the existing object description.

Example

This example creates three objects described in searchattrx.xml. A fourth object already exists.

SES>createAll searchAttr --INPUT_FILE=searchattrs.xml --DUPE_METHOD=ignore
 
createAll operation succeeded for type "searchAttr".
 
  3 object(s) with status CREATE_SUCCEEDED
  1 object(s) with status DUPLICATE_IGNORED

createAll source

Creates all sources described in an XML file.

See Also

create source

Syntax

createAll source --INPUT_FILE=xml_filename [--DUPE_METHOD=action] [--ENCRYPT_KEY=key]

createAll source -i xml_filename [-d action] [-e key]

Parameters

xml_filename

Path to the XML document that contains the object descriptions. See "source".

action

Action to take when an object already exists:

error: The createAll command fails with an error. (Default)
ignore: The existing object description is kept.
overwrite: The new description replaces the existing object description.

key

Example

This example creates one source defined in sources.xml. The second source already exists.

SES>createAll source --INPUT_FILE=sources.xml --DUPE_METHOD=ignore --ENCRYPT_KEY=key2encrypt

createAll operation succeeded for type "source".
 
  1 object(s) with status CREATE_SUCCEEDED
  1 object(s) with status DUPLICATE_IGNORED

createAll sourceGroup

Creates all source groups described in an XML file.

See Also

create sourceGroup

Syntax

createAll sourceGroup --INPUT_FILE=xml_filename [--DUPE_METHOD=action]

createAll creatable_type -i xml_filename [-d action]

Parameters

xml_filename

Path to the XML document that contains the object descriptions. See "sourceGroup".

action

Action to take when an object already exists:

error: The createAll command fails with an error. (Default)
ignore: The existing object description is kept.
overwrite: The new description replaces the existing object description.

Example

This example creates a source groups described in sourcegroups.xml. A second source group already exists.

SES>createAll sourceGroup --INPUT_FILE=sourcegroups.xml --DUPE_METHOD=ignore
 
createAll operation succeeded for type "sourceGroup".
 
  1 object(s) with status CREATE_SUCCEEDED
  1 object(s) with status DUPLICATE_IGNORED

createAll sourceType

Creates all source types described in an XML file.

See Also

create sourceType

Syntax

createAll sourceType --INPUT_FILE=xml_filename [--DUPE_METHOD=action]

createAll sourceType -i xml_filename [-d action]

Parameters

xml_filename

Path to the XML document that contains the object descriptions. See "sourceType".

action

Action to take when an object already exists:

error: The createAll command fails with an error. (Default)
ignore: The existing object description is kept.
overwrite: The new description replaces the existing object description.

Example

This command creates four source types:

SES>createAll sourceType --INPUT_FILE=sourcetypes.xml --DUPE_METHOD=ignore

createAll operation succeeded for type "sourceType".
 
  4 object(s) with status CREATE_SUCCEEDED
  21 object(s) with status DUPLICATE_IGNORED

createAll storageArea

Creates all of the storage areas described in an XML document.

See Also

create storageArea

Syntax

createAll storageArea --INPUT_FILE=xml_filename [--DUPE_METHOD=action] [--IGNORE_INVALID_STATE=state]

createAll storageArea -i xml_filename [-d action] [-s state]

Parameters

xml_filename

Path to the XML document that contains the object descriptions. See "clusterTree".

action

Action to take when an object already exists:

error: The createAll command fails with an error. (Default)
ignore: The existing object description is kept.
overwrite: The new description replaces the existing object description.

state

Controls whether processing continues when an object cannot be overwritten because it is in an invalid state. This option is used only when --DUPE_METHOD=overwrite.

true: Continue processing with the next object.
false: Stop processing with an error and roll back all changes. (Default)

Example

This example creates a storage area defined in a file named storage.xml:

SES>createAll storageArea --INPUT_FILE=storage.xml
 
createAll operation succeeded for type "storageArea".
 
  1 object(s) with status CREATE_SUCCEEDED

createAll suggContentProvider

Creates all the suggested content providers described in an XML file.

See Also

create suggContentProvider

Syntax

createAll suggContentProvider --INPUT_FILE=xml_filename [--DUPE_METHOD=action]

createAll suggContentProvider -i xml_filename [-d action]

Parameters

xml_filename

Path to the XML document that contains the object descriptions. See "suggContentProvider".

action

Action to take when an object already exists:

error: The createAll command fails with an error. (Default)
ignore: The existing object description is kept.
overwrite: The new description replaces the existing object description.

state

Controls whether processing continues when an object cannot be overwritten because it is in an invalid state. This option is used only when --DUPE_METHOD=overwrite.

true: Continue processing with the next object.
false: Stop processing with an error and roll back all changes. (Default)

Example

This example creates two suggested content providers from the descriptions in suggcontentproviders.xml. A third object already exists.

SES>createAll suggContentProvider --INPUT_FILE=suggcontentproviders.xml --DUPE_METHOD=overwrite
 
createAll operation succeeded for type "suggContentProvider".
 
  2 object(s) with status CREATE_SUCCEEDED
  1 object(s) with status DUPLICATE_OVERWRITTEN

createAll suggestion

Creates all the suggestions described in an XML file.

See Also

create suggestion

Syntax

createAll suggestion --INPUT_FILE=xml_filename [--DUPE_METHOD=action [--IGNORE_INVALID_STATE=state]]

createAll suggestion -i xml_filename [-d action [-s state]]

Parameters

xml_filename

Path to the XML document that contains the object descriptions. See "suggestion".

action

Action to take when an object already exists:

error: The createAll command fails with an error. (Default)
ignore: The existing object description is kept.
overwrite: The new description replaces the existing object description.

state

Controls whether processing continues when an object cannot be overwritten because it is in an invalid state. This option is used only when --DUPE_METHOD=overwrite.

true: Continue processing with the next object.
false: Stop processing with an error and roll back all changes. (Default)

Example

This command creates one of the two suggestions described in suggestions.xml. The second suggestion already exists.

SES>createAll suggestion --INPUT_FILE=suggestions.xml --DUPE_METHOD=overwrite
 
createAll operation succeeded for type "suggestion".
 
  1 object(s) with status CREATE_SUCCEEDED
  1 object(s) with status DUPLICATE_OVERWRITTEN

createAll suggLink

Creates all suggested links described in an XML file.

See Also

create suggLink

Syntax

createAll suggLink --INPUT_FILE=xml_filename [--DUPE_METHOD=action]

createAll suggLink -i xml_filename [-d action]

Parameters

xml_filename

Path to the XML document that contains the object descriptions. See "suggLink".

action

Action to take when an object already exists:

error: The createAll command fails with an error. (Default)
ignore: The existing object description is kept.
overwrite: The new description replaces the existing object description.

Example

This example creates two suggested links from the descriptions in sugglinks.xml. A third object already exists.

SES>createAll suggLink --INPUT_FILE=sugglinks.xml --DUPE_METHOD=overwrite
 
createAll operation succeeded for type "suggLink".
 
  2 object(s) with status CREATE_SUCCEEDED
  1 object(s) with status DUPLICATE_OVERWRITTEN

createAll tag

Creates all the tags described in an XML file.

See Also

create tag

Syntax

createAll tag --INPUT_FILE=xml_filename [--DUPE_METHOD=action]

createAll tag -i xml_filename [-d action]

Parameters

xml_filename

Path to the XML document that contains the object descriptions. See "tag".

action

Action to take when an object already exists:

error: The createAll command fails with an error. (Default)
ignore: The existing object description is kept.
overwrite: The new description replaces the existing object description.

Example

This example creates two tags from the descriptions in tags.xml. A third object already exists.

SES>createAll tag --INPUT_FILE=tags.xml --DUPE_METHOD=overwrite
 
createAll operation succeeded for type "tag".
 
  2 object(s) with status CREATE_SUCCEEDED
  1 object(s) with status DUPLICATE_OVERWRITTEN

deactivate clustering

Deactivates clustering.

Syntax

deactivate clustering

Example

This example deactivates clustering:

SES>deactivate clustering
 
The object "clustering" was successfully deactivated

deactivate clusterTree

Deactivates a cluster tree.

Syntax

deactivate clusterTree --NAME=object_name

deactivate clusterTree -n object_name

Parameters

object_name: Content of a <search:name> element in the XML document.

Example

This example deactivates a cluster tree named Topic Tree:

SES>deactivate clusterTree --NAME="Topic Tree"
 
The object "[name=Topic Tree]" was successfully deactivated.

deactivate identityPlugin

Deactivates an identity plug-in.

Syntax

deactivate identityPlugin --JAR_FILE=jar_filename --MANAGER_CLASS=class

Parameters

jar_filename: Content of a <search:jarFilePath> element in the XML document.
class: Content of a <search:managerClassName> element in the XML document.

Example

This example deactivates an identity plug-in:

SES>deactivate identityPlugin --JAR_FILE=OIDPlugins.jar --MANAGER_CLASS=oracle.search.plugin.security.identity.oid.OIDPluginManager
 
The object "[jarFilePath=OIDPlugins.jar, managerClassName=oracle.search.plugin.security.identity.oid.OIDPluginManager]" was successfully deactivated.

deactivate indexOptimizer

Deactivates index optimization.

Syntax

deactivate indexOptimizer

Example

This example deactivates index optimization:

SES>deactivate indexOptimizer
 
The object "indexOptimizer" was successfully deactivated.

deactivate queryUIFacets

Deactivates queryUIFacets.

Syntax

deactivate queryUIFacets

Example

This example deactivates queryUIFacets:

SES>deactivate queryUIFacets
 
The object "queryUIFacets" was successfully deactivated.

deactivate resultList

Deactivates the result list customizations.

Syntax

deactivate resultList

Example

This example deactivates result list customizations:

SES>deactivate resultList
 
The object "resultList" was successfully deactivated.

deactivate schedule

Deactivates a schedule.

Syntax

deactivate schedule --NAME=object_name

deactivate schedule -n object_name

Parameters

object_name: Content of a <search:name> element in the XML document.

Example

This example fails to deactivate a schedule because it is executing:

SES>deactivate schedule --NAME="Doc Library"
 
Operation "deactivate" cannot be performed on an object with type "schedule" in state "EXECUTING".

deactivate singleSignOnSetting

Deactivates a Single Sign-On setting.

Syntax

deactivate singleSignOnSetting --NAME=object_name

deactivate singleSignOnSetting -n object_name

Parameters

object_name: Content of a <search:name> element in the XML document.

Example

This example deactivates a Single Sign-On setting named OSSO:

SES>deactivate singleSignOnSetting --NAME="OSSO"
 
The object "[name=OSSO]" was successfully deactivated.

deactivate skinBundle

Deactivates a skin bundle.

Syntax

deactivate skinBundle --NAME=object_name

deactivate skinBundle -n object_name

Parameters

object_name: Content of a <search:name> element in the XML document.

Example

This example deactivates a skin bundle named holiday:

SES>deactivate skinBundle --NAME=holiday
 
The object "[name=holiday]" was successfully deactivated.

deactivate suggContentProvider

Deactivates a suggested content provider.

Syntax

deactivate suggContentProvider --NAME=object_name

deactivate suggContentProvider -n object_name

Parameters

object_name: Content of a <search:name> element in the XML document.

Example

This example deactivates a suggested content provider named Provider1:

SES>deactivate suggContentProvider --NAME=Provider1
 
The object "[name=Provider1]" was successfully deactivated.

deactivate tagging

Deactivates the tagging configuration.

Syntax

deactivate tagging

Example

This example deactivates the tagging configuration:

SES>deactivate tagging
 
The object "tagging" was successfully deactivated.

delete creatable_type

Deletes a creatable object.

See Also

deleteAll creatable_type
deleteList creatable_type

Syntax

delete creatable_type object_key

Parameters

creatable_type

A creatable type:

altWord
boostedUrl
classification
clusterTree
docServiceManager
identityPlugin
indexProfile
lexer
proxyLogin
schedule
searchAttr
skinBundle
source
sourceGroup
sourceType
storageArea
suggContentProvider
suggestion
suggLink
tag
thesaurus

object_key

Unique identifier of the object. See the object description in Chapter 2, "Administration Object Types."

Example

This example deletes the Doc Library schedule.

SES>delete schedule --NAME="Doc Library"
 
The object "[name=Doc Library]" was successfully deleted.

deleteAll creatable_type

Deletes all objects of a specified type.

Caution:

This operation deletes all objects, including those supplied with Oracle SES. Use a key_pattern to limit the operation to those objects you want to delete, especially when deleting identityPlugin, sourceType, and storageArea objects.

See Also

delete creatable_type
deleteList creatable_type

Syntax

deleteAll creatable_type [--IGNORE_INVALID_STATE=state] [key_pattern]

deleteAll creatable_type [-s state] [key_pattern]

Parameters

creatable_type

A creatable type:

altWord
boostedUrl
classification
clusterTree
docServiceManager
identityPlugin
indexProfile
lexer
proxyLogin
schedule
searchAttr
skinBundle
source
sourceGroup
sourceType
storageArea
suggContentProvider
suggestion
suggLink
tag

state

Controls whether clusterTree, identityPlugin, schedule, or skinBundle objects are skipped because they are in an invalid state.

true: Objects are deleted regardless of their state.
false: Invalid objects are not deleted. (Default)

key_pattern

Object key that specifies a subset of objects to process in the format key=value. The value can include wildcard characters:

A percent sign (%) matches zero or more characters. In a multibyte character set, it matches zero or more bytes.
An underscore (_) matches exactly one character. In a multibyte character set, it matches one byte.

Examples

This example deletes all clusterTree objects:

SES>deleteAll clusterTree
 
deleteAll operation succeeded for type "clusterTree".
 
  1 object(s) with status DELETE_SUCCEEDED

The next example deletes two sourceType objects with the string Documentum in the name:

SES>deleteAll sourceType --NAME=%Documentum%
 
deleteAll operation succeeded for type "sourceType".
 
  2 object(s) with status DELETE_SUCCEEDED

deleteList creatable_type

Deletes objects of a specified type that are listed in a text file.

See Also

delete creatable_type
deleteAll creatable_type

Syntax

deleteList creatable_type --KEYS_FILE=key_filename [--IGNORE_NOT_FOUND=action] [--IGNORE_INVALID_STATE=state]

deleteList creatable_type -k key_filename [-f action] [-s state]

Parameters

creatable_type

A creatable type:

altWord
boostedUrl
classification
clusterTree
docServiceManager
identityPlugin
indexProfile
lexer
proxyLogin
schedule
searchAttr
skinBundle
source
sourceGroup
sourceType
storageArea
suggContentProvider
suggestion
suggLink
tag

key_filename

Path to a text file that identifies the objects to be deleted. Each line of the file contains an object key. For example:

--NAME=this_proxy
--NAME=that_proxy

action

Controls the resulting action when an object in the list does not exist.

true: The object is skipped and processing continues.
false: Processing stops with an error. (Default)

state

Controls whether clusterTree, identityPlugin, schedule, or skinBundle objects are skipped because they are in an invalid state.

true: Objects are deleted regardless of their state.
false: Invalid objects are not deleted. (Default)

Example

This example deletes the identity plug-ins listed in identity.lst:

SES>deleteList identityPlugin --KEYS_FILE=identity.lst --IGNORE_NOT_FOUND=true
 
deleteList operation succeeded for type "identityPlugin".
 
  2 object(s) with status DELETE_SUCCEEDED

export creatable_type

Returns the XML description of an object.

See Also

export universal_type
exportAll creatable_type
exportList creatable_type

Syntax

export creatable_type object_key [--OUTPUT_FILE=output_file] [--ENCRYPT_KEY=key]

export creatable_type object_key [-o output_file] [-e key]

Parameters

creatable_type

A creatable type:

altWord
boostedUrl
classification
clusterTree
identityPlugin
indexProfile
lexer
proxyLogin
schedule
searchAttr
singleSignOnSetting
skinBundle
source
sourceGroup
sourceType
storageArea
suggContentProvider
suggestion
suggLink
tag
thesaurus

object_key

Unique identifier of the object. See the object description in Chapter 2, "Administration Object Types."

output_file

Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the export command creates a separate file for each one and appends the host name and port number to the base name.

key

Encryption key for passwords in the XML description of identityPlugin, proxyLogin, and source objects. The key must be at least eight ASCII characters long and include at least one letter and one number. Multibyte characters are invalid. If you omit this option, you are prompted for the key.

Example

This example displays the XML for the rac alternative word.

SES>export altWord --KEYWORD=rac --ALT_KEYWORD="Real Application Clusters"
 
<?xml version="1.0" encoding="UTF-8"?>
<search:config productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:altWords>
      <search:altWord>
         <search:keyword>rac</search:keyword>
         <search:altKeyword>Real Application Clusters</search:altKeyword>
         <search:autoExpand>false</search:autoExpand>
      </search:altWord>
   </search:altWords>
</search:config>

The next example creates a file named acme.xml containing the XML document for the acme skin bundle.

SES>export skinBundle --NAME=acme --OUTPUT_FILE=acme.xml
 
The object "[name=acme]" was successfully exported.
 
4 attachment(s) written to file.

export universal_type

Returns the XML description of an object.

See Also

export creatable_type

Syntax

export universal_type [--OUTPUT_FILE=output_file]

export universal_type [-o output_file]

Parameters

universal_type

A universal type:

autoSuggestion
classificationMappings
clustering
crawlerSettings
index
indexOptimizer
languageBasedTokenization
partitionConfig
proxy
queryConfig
queryUIConfig
queryUIFacets
queryUISourceGroups
relevanceRanking
resultList
tagging

output_file

Example

This example displays an XML document for a crawlerSettings object:

SES>export crawlerSettings
 
<?xml version="1.0" encoding="UTF-8"?>
<search:config productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:crawlerSettings>
      <search:numThreads>5</search:numThreads>
      <search:numProcessors>3</search:numProcessors>
      <search:crawlDepth haslimit="">
         <search:limit>2</search:limit>
      </search:crawlDepth>
      <search:languageDetection enabled=""/>
      <search:defaultLanguage>en</search:defaultLanguage>
      <search:crawlTimeout>30</search:crawlTimeout>
      <search:maxDocumentSize>10</search:maxDocumentSize>
      <search:defaultCharSet>8859_1</search:defaultCharSet>
      <search:cacheDirectory>
         /home/oracle/dbs/ses111/cache/
      </search:cacheDirectory>
      <search:preserveDocumentCache enabled=""/>
      <search:servicePipeline enabled="">
         <search:pipelineName>Default pipeline</search:pipelineName>
      </search:servicePipeline>
      <search:verboseLogging enabled=""/>
      <search:logDirectory>/home/oracle/dbs/ses111/log/</search:logDirectory>
      <search:logLanguage>en-US</search:logLanguage>
   </search:crawlerSettings>
</search:config>

exportAll creatable_type

Returns the XML descriptions of all objects of a specific type.

See Also

export creatable_type
exportList creatable_type

Syntax

exportAll creatable_type [key_pattern] [--OUTPUT_FILE=output_file] [--ENCRYPT_KEY=key]

exportAll creatable_type [key_pattern] [-o output_file] [-e key]

Parameters

creatable_type

A creatable object type:

altWord
boostedUrl
classification
clusterTree
identityPlugin
indexProfile
lexer
proxyLogin
schedule
searchAttr
singleSignOnSetting
skinBundle
source
sourceGroup
sourceType
storageArea
suggContentProvider
suggestion
suggLink
tag

output_file

The name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the export command creates a separate file for each one and appends the host name and port number to the base name.

key_pattern

An object key that specifies a subset of objects to process in the format key=value. The value can include wildcard characters:

A percent sign (%) matches zero or more characters. In a multibyte character set, it matches zero or more bytes.
An underscore (_) matches one character. In a multibyte character set, it matches one byte.

key

The encryption key for passwords in the XML description of identityPlugin, proxyLogin, and source objects. The key must be at least eight ASCII characters long and include at least one letter and one number. Multibyte characters are invalid. If you omit this option, you are prompted for the key.

Example

This example displays all suggested links:

SES>exportAll suggLink
 
<?xml version="1.0" encoding="UTF-8"?>
<search:config productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:suggLinks>
      <search:suggLink>
         <search:keyword>database</search:keyword>
         <search:linkUrl>
          http://www.oracle.com/technetwork/database/enterprise-edition/index.html
         </search:linkUrl>
         <search:linkText>Oracle11g</search:linkText>
      </search:suggLink>
      <search:suggLink>
         <search:keyword>oracle</search:keyword>
         <search:linkUrl>http://www.oracle.com</search:linkUrl>
         <search:linkText>Oracle</search:linkText>
      </search:suggLink>
      <search:suggLink>
         <search:keyword>ses</search:keyword>
         <search:linkUrl>
            http://www.oracle.com/technetwork/search/oses/overview/index.html
         </search:linkUrl>
         <search:linkText>Oracle SES</search:linkText>
      </search:suggLink>
   </search:suggLinks>
</search:config>

The next example uses a key pattern to find the suggested link for Oracle.

SES>exportAll suggLink --KEYWORD=ora%
 
<?xml version="1.0" encoding="UTF-8"?>
<search:config productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:suggLinks>
      <search:suggLink>
         <search:keyword>oracle</search:keyword>
         <search:linkUrl>http://www.oracle.com</search:linkUrl>
         <search:linkText>Oracle</search:linkText>
      </search:suggLink>
   </search:suggLinks>
</search:config>

exportList creatable_type

Returns the XML descriptions of a list of objects of the same type.

See Also

export creatable_type
exportAll creatable_type

Syntax

exportList creatable_type --KEYS_FILE=key_filename [--IGNORE_NOT_FOUND=action] [--ENCRYPT_KEY=key]

exportList creatable_type -k key_filename [-f action] [-e key]

Parameters

creatable_type

A creatable object type:

altWord
boostedUrl
classification
clusterTree
identityPlugin
indexProfile
lexer
proxyLogin
schedule
searchAttr
singleSignOnSetting
skinBundle
source
sourceGroup
sourceType
storageArea
suggContentProvider
suggestion
suggLink
tag

key_filename

Path to a text file that containing the keys that identify the objects to be deleted. The objects must be the same object type. Each line of the file identifies an object using this format:

key=value [key=value]

For example, these keys identify altWord objects:

--KEYWORD=oses --ALT_KEYWORD="Oracle Secure Enterprise Search"
--KEYWORD=rac --ALT_KEYWORD="Real Application Clusters"
--KEYWORD=oem --ALT_KEYWORD="Oracle Enterprise Manager"

action

Controls the resulting action when an object in the list does not exist:

true: The object is skipped and processing continues.
false: Processing stops with an error. (Default)

key

Examples

This example exports the XML descriptions of the alternate words listed in altwords.lst:

SES>exportList altWord --KEYS_FILE=altwords.lst
 
<?xml version="1.0" encoding="UTF-8"?>
<search:config productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:altWords>
      <search:altWord>
         <search:keyword>oses</search:keyword>
         <search:altKeyword>Oracle Secure Enterprise Search</search:altKeyword>
         <search:autoExpand></search:autoExpand>
      </search:altWord>
      <search:altWord>
         <search:keyword>rac</search:keyword>
         <search:altKeyword>Real Application Clusters</search:altKeyword>
         <search:autoExpand>false</search:autoExpand>
      </search:altWord>
   </search:altWords>
</search:config>

The next example shows use of the --IGNORE_NOT_FOUND option:

SES>exportList altWord --KEYS_FILE=altwords.lst
 
The object with key "[keyword=oem, altKeyword=Oracle Enterprise Manager]" and type "altWord" was not found.
 
SES>exportList altWord --KEYS_FILE=altwords.lst --IGNORE_NOT_FOUND=true
 
<?xml version="1.0" encoding="UTF-8"?>
<search:config productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:altWords>
      <search:altWord>
         <search:keyword>oses</search:keyword>
         <search:altKeyword>Oracle Secure Enterprise Search</search:altKeyword>
         <search:autoExpand></search:autoExpand>
      </search:altWord>
      <search:altWord>
         <search:keyword>rac</search:keyword>
         <search:altKeyword>Real Application Clusters</search:altKeyword>
         <search:autoExpand>false</search:autoExpand>
      </search:altWord>
   </search:altWords>
</search:config>

getAllObjectKeys

Returns the object keys for the specified object type.

Syntax

getAllObjectKeys creatable_type --OUTPUT_FILE=output_file [key_pattern...]

getAllObjectKeys creatable_type -o output_file [key_pattern...]

Parameters

creatable_type

A creatable object type:

altWord
authorizedPrincipal
boosteUrl
classification
clusterTree
docServiceInstance
docServiceManager
docServicePipeline
facetTree
identityPlugin
indexProfile
lexer
proxyLogin
schedule
searchAttr
singleSignOnSetting
skinBundle
source
sourceGroup
sourceType
storageArea
suggContentProvider
suggestion
suggLink
tag
thesaurus

output_file

Name of a file in which the exported object keys stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getAllObjectKeys command creates a separate file for each one and appends the host name and port number to the base name. You can use this file as input to the deleteList, exportList, and getStateList operations.

key_pattern

Object key that specifies a subset of objects to process in the format key=value. The value can include wildcard characters:

A percent sign (%) matches zero or more characters. In a multibyte character set, it matches zero or more bytes.
An underscore (_) matches one character. In a multibyte character set, it matches one byte.

Examples

This example returns all suggested links:

SES>getAllObjectKeys suggLink

--KEYWORD=database --LINK_URL=http://www.oracle.com/technology/products/database/oracle11g
--KEYWORD=oracle --LINK_URL=http://www.oracle.com
--KEYWORD=ses --LINK_URL=http://www.oracle.com/technology/products/oses/index.html
]

The next example returns only the suggested links with a keyword that begins with data:

SES>getAllObjectKeys suggLink --KEYWORD=data%
 
[--KEYWORD=database --LINK_URL=http://www.oracle.com/technology/products/database/oracle11g]

getAPIVersion

Displays the version number of the Oracle SES Administration API.

Syntax

getAPIVersion

Example

This example displays the current version of the Administration API.

SES>getAPIVersion
 
11.2.2.2.0

getAllStates clusterTree

Returns the current state of all cluster trees as an XML document.

See Also

getState clusterTree
getStateList clusterTree

Syntax

getAllStates clusterTree [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=status] [key_pattern...]

getAllStates clusterTree [-o output_file] [-l status] [key_pattern...]

Parameters

output_file

Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getAllStates command creates a separate file for each one and appends the host name and port number to the base name.

key_pattern

Object key that specifies a subset of objects to process in the format key=value. The value can include wildcard characters:

A percent sign (%) matches zero or more characters. In a multibyte character set, it matches zero or more bytes.
An underscore (_) matches one character. In a multibyte character set, it matches one byte.

Example

This example returns the XML documents for all cluster trees. The XML shows that both cluster trees are currently active.

SES>getAllStates clusterTree
 
<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:objectStates>
      <search:objectState>
         <search:objectType>clusterTree</search:objectType>
         <search:objectKey>
            <search:keyPairs>
               <search:keyPair>
                  <search:name>name</search:name>
                  <search:value>Metadata Tree</search:value>
               </search:keyPair>
            </search:keyPairs>
         </search:objectKey>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>ACTIVE</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
      <search:objectState>
         <search:objectType>clusterTree</search:objectType>
         <search:objectKey>
            <search:keyPairs>
               <search:keyPair>
                  <search:name>name</search:name>
                  <search:value>Topic Tree</search:value>
               </search:keyPair>
            </search:keyPairs>
         </search:objectKey>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>ACTIVE</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates>
</search:state>

getAllStates identityPlugin

Returns the current state of all identity plug-ins as an XML document.

See Also

getState identityPlugin
getStateList identityPlugin

Syntax

getAllStates identityPlugin [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=status] [key_pattern...]

getAllStates identityPlugin [-o output_file] [-l status] [key_pattern...]

Parameters

output_file

Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getAllStates command creates a separate file for each one and appends the host name and port number to the base name.

key_pattern

Object key that specifies a subset of objects to process in the format key=value. The value can include wildcard characters:

A percent sign (%) matches zero or more characters. In a multibyte character set, it matches zero or more bytes.
An underscore (_) matches one character. In a multibyte character set, it matches one byte.

Example

This example returns the current state of all identity plug-ins:

SES>getAllStates identityPlugin
 
<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:objectStates>
      <search:objectState>
         <search:objectType>identityPlugin</search:objectType>
         <search:objectKey>
            <search:keyPairs>
               <search:keyPair>
                  <search:name>jarFilePath</search:name>
                  <search:value>OIDPlugins.jar</search:value>
               </search:keyPair>
               <search:keyPair>
                  <search:name>managerClassName</search:name>
                  <search:value>oracle.search.plugin.security.identity.oid.OIDPluginManager</search:value>
               </search:keyPair>
            </search:keyPairs>
         </search:objectKey>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>ACTIVE</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates>
</search:state>

getAllStates schedule

Returns the current state of all schedules as an XML document.

See Also

getState schedule
getStateList schedule

Syntax

getAllStates schedule [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=state_property] [key_pattern...]

getAllStates schedule [-o output_file] [-l state_property] [key_pattern...]

Parameters

output_file

Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getAllStates command creates a separate file for each one and appends the host name and port number to the base name.

state_properties

List of one or more state properties: lastCrawled, logFilePath, nextCrawl, scheduleError, or status. Separate multiple properties with commas. All state properties are returned by default.

key_pattern

Object key that specifies a subset of objects to process in the format key=value. The value can include wildcard characters:

A percent sign (%) matches zero or more characters. In a multibyte character set, it matches zero or more bytes.
An underscore (_) matches one character. In a multibyte character set, it matches one byte.

Example

This example uses the percent (%) wildcard character to find the Doc Library schedule and requests two status properties. The status is currently SCHEDULED and the next crawl is MANUAL.

SES>getAllStates schedule --NAME=Doc% --PROPERTY_LIST=status,nextCrawl
 
<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:objectStates>
      <search:objectState>
         <search:objectType>schedule</search:objectType>
         <search:objectKey>
            <search:keyPairs>
               <search:keyPair>
                  <search:name>name</search:name>
                  <search:value>Doc Library</search:value>
               </search:keyPair>
            </search:keyPairs>
         </search:objectKey>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>SCHEDULED</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
            <search:stateProperty>
               <search:propertyName>nextCrawl</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>MANUAL</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates>
</search:state>

getAllStates singleSignOnSetting

Returns the current state of all Single Sign-On settings as an XML document.

See Also

getState singleSignOnSetting
getStateList singleSignOnSetting

Syntax

getAllStates singleSignOnSetting [--OUTPUT_FILE=output_file]

getAllStates singleSignOnSetting [-o output_file]

Parameters

output_file: Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getAllStates command creates a separate file for each one and appends the host name and port number to the base name.

Example

This example returns the current state of all the Single Sign-On settings:

SES>getAllStates singleSignOnSetting

<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:objectStates>
      <search:objectState>
         <search:objectType>singleSignOnSetting</search:objectType>
         <search:objectKey>
            <search:keyPairs>
               <search:keyPair>
                  <search:name>name</search:name>
                  <search:value>OSSO</search:value>
               </search:keyPair>
            </search:keyPairs>
         </search:objectKey>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>ACTIVE</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
      <search:objectState>
         <search:objectType>singleSignOnSetting</search:objectType>
         <search:objectKey>
            <search:keyPairs>
               <search:keyPair>
                  <search:name>name</search:name>
                  <search:value>OMA</search:value>
               </search:keyPair>
            </search:keyPairs>
         </search:objectKey>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>INACTIVE</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
      <search:objectState>
         <search:objectType>singleSignOnSetting</search:objectType>
         <search:objectKey>
            <search:keyPairs>
               <search:keyPair>
                  <search:name>name</search:name>
                  <search:value>WNA</search:value>
               </search:keyPair>
            </search:keyPairs>
         </search:objectKey>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>INACTIVE</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates></search:state>

getAllStates skinBundle

Returns the current state of all skin bundles as an XML document.

See Also

getState skinBundle
getStateList skinBundle

Syntax

getAllStates skinBundle [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=state_property] [key_pattern...]

getAllStates skinBundle [-o output_file] [-l state_property] [key_pattern...]

Parameters

output_file

Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getAllStates command creates a separate file for each one and appends the host name and port number to the base name.

state_properties

List of one or more state properties: lastModifiedDate or status. Separate multiple properties with commas. All state properties are returned by default.

key_pattern

Object key that specifies a subset of objects to process in the format key=value. The value can include wildcard characters:

A percent sign (%) matches zero or more characters. In a multibyte character set, it matches zero or more bytes.
An underscore (_) matches one character. In a multibyte character set, it matches one byte.

Example

This example shows that the example skin bundle is active, and the acme skin bundle is inactive:

SES>getAllStates skinBundle

<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:objectStates>
      <search:objectState>
         <search:objectType>skinBundle</search:objectType>
         <search:objectKey>
            <search:keyPairs>
               <search:keyPair>
                  <search:name>name</search:name>
                  <search:value>acme</search:value>
               </search:keyPair>
            </search:keyPairs>
         </search:objectKey>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>INACTIVE</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
      <search:objectState>
         <search:objectType>skinBundle</search:objectType>
         <search:objectKey>
            <search:keyPairs>
               <search:keyPair>
                  <search:name>name</search:name>
                  <search:value>example</search:value>
               </search:keyPair>
            </search:keyPairs>
         </search:objectKey>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>ACTIVE</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates></search:state>

getAllStates suggContentProvider

Returns the current state of all the suggested content providers as an XML document.

See Also

getState suggContentProvider
getStateList schedule

Syntax

getAllStates suggContentProvider [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=status]

getAllStates suggContentProvider [-o output_file] [-l status]

Parameters

output_file: Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getAllStates command creates a separate file for each one and appends the host name and port number to the base name.

Example

This example gets the current state of all the suggested content providers.

SES>getAllStates suggContentProvider
 
<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:objectStates>
      <search:objectState>
         <search:objectType>suggContentProvider</search:objectType>
         <search:objectKey>
            <search:keyPairs>
               <search:keyPair>
                  <search:name>name</search:name>
                  <search:value>Provider1</search:value>
               </search:keyPair>
            </search:keyPairs>
         </search:objectKey>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>ACTIVE</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates>
</search:state>

getState autoSuggestion

Returns the current state of auto suggestion configuration as an XML document.

Syntax

getState autoSuggestion [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=status]

getState autoSuggestion [-o output_file] [-l status]

Parameters

output_file: Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getState command creates a separate file for each one and appends the host name and port number to the base name.

Example

This example gets the current state of auto suggestion configuration:

SES>getState autoSuggestion
 
<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:objectStates>
      <search:objectState>
         <search:objectType>autoSuggestion</search:objectType>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>filterStatus</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>ACTIVE</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates>
</search:state>

getState clustering

Returns the current state of clustering as an XML document.

Syntax

getState clustering [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=status]

getState clustering [-o output_file] [-l status]

Parameters

output_file: Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getState command creates a separate file for each one and appends the host name and port number to the base name.

Example

This example shows the clustering configuration that is currently active:

SES>getState clustering
 
<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:objectStates>
      <search:objectState>
         <search:objectType>clustering</search:objectType>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>ACTIVE</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates>
</search:state>

getState clusterTree

Returns the current state of a cluster tree as an XML document.

See Also

getAllStates clusterTree
getStateList clusterTree

Syntax

getState clusterTree --NAME=object_name [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=status]

getState clusterTree -n object_name [-o output_file] [-l status]

Parameters

object_name: Content of a <search:name> element in the XML document.
output_file: Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getState command creates a separate file for each one and appends the host name and port number to the base name.

Example

This example shows that the Metadata Tree cluster tree is currently active.

SES>getState clusterTree --NAME=Metadata Tree
 
<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:objectStates>
      <search:objectState>
         <search:objectType>clusterTree</search:objectType>
         <search:objectKey>
            <search:keyPairs>
               <search:keyPair>
                  <search:name>name</search:name>
                  <search:value>Metadata Tree</search:value>
               </search:keyPair>
            </search:keyPairs>
         </search:objectKey>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>ACTIVE</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates>
</search:state>

getState identityPlugin

Returns the current state of an identity plug-in as an XML document.

See Also

getAllStates identityPlugin
getStateList identityPlugin

Syntax

getState identityPlugin --JAR_FILE=jar_filename --MANAGER_CLASS=class [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=status]

getState identityPlugin --JAR_FILE=jar_filename --MANAGER_CLASS=class [-o output_file] [-l status]

Parameters

jar_filename: Content of a search:jarFilePath element in the XML document.
class: Content of a search:managerClassName element in the XML document.
output_file: Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getState command creates a separate file for each one and appends the host name and port number to the base name.

Example

This example gets the current state of a particular identity plug-in:

SES>getState identityPlugin --JAR_FILE=OIDPlugins.jar --MANAGER_CLASS=oracle.search.plugin.security.identity.oid.OIDPluginManager
 
<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:objectStates>
      <search:objectState>
         <search:objectType>identityPlugin</search:objectType>
         <search:objectKey>
            <search:keyPairs>
               <search:keyPair>
                  <search:name>jarFilePath</search:name>
                  <search:value>OIDPlugins.jar</search:value>
               </search:keyPair>
               <search:keyPair>
                  <search:name>managerClassName</search:name>
                  <search:value>
                  oracle.search.plugin.security.identity.oid.OIDPluginManager
                  </search:value>
               </search:keyPair>
            </search:keyPairs>
         </search:objectKey>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>ACTIVE</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates>
</search:state>

getState index

Returns the percent of fragmentation of the index as an XML document.

Syntax

getState index [--OUTPUT_FILE=output_file][--PROPERTY_LIST=estimatedFragmentation]

getState index [-o output_file] [-l estimatedFragmentation]

Parameters

output_file: Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getState command creates a separate file for each one and appends the host name and port number to the base name.

Example

This example shows that the index has a current estimated fragmentation level of 52.98% and should be optimized:

SES>getState index
 
<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:objectStates>
      <search:objectState>
         <search:objectType>index</search:objectType>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>estimatedFragmentation</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>52.98</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates>
</search:state>

getState indexOptimizer

Returns the current state of index optimization as an XML document.

Syntax

getState indexOptimizer [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=state_properties]

getState indexOptimizer [-o output_file] [-l state_properties]

Parameters

output_file: Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getState command creates a separate file for each one and appends the host name and port number to the base name.
state_properties: One or more of the indexOptimizer state properties. Separate multiple properties with commas. All state properties are returned by default. See "indexOptimizer" for the list of state properties.

Example

This example shows that the index optimizer started at 5:44 PM GMT and is still executing:

SES>getState indexOptimizer
 
<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:objectStates>
      <search:objectState>
         <search:objectType>indexOptimizer</search:objectType>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>EXECUTING</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
            <search:stateProperty>
               <search:propertyName>startTime</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>Thu, 09 Jul 2009 17:44:43 GMT</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates>
</search:state>

getState partitionConfig

Returns the current state of partitionConfig configuration as an XML document.

Syntax

getState partitionConfig [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=status]

getState partitionConfig [-o output_file] [-l status]

Parameters

output_file: Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getState command creates a separate file for each one and appends the host name and port number to the base name.

Example

This example gets the current state of partitionConfig configuration:

SES>getState partitionConfig
 
<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:objectStates>
      <search:objectState>
         <search:objectType>partitionConfig</search:objectType>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>ACTIVE</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates>
</search:state>

getState queryUIFacets

Returns the current state of queryUIFacets configuration as an XML document.

Syntax

getState queryUIFacets [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=status]

getState queryUIFacets [-o output_file] [-l status]

Parameters

output_file: Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getState command creates a separate file for each one and appends the host name and port number to the base name.

Example

This example gets the current state of queryUIFacets configuration:

SES>getState queryUIFacets
 
<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:objectStates>
      <search:objectState>
         <search:objectType>queryUIFacets</search:objectType>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>ACTIVE</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates>
</search:state>

getState resultList

Returns the current state of the result list customizations as an XML document.

Syntax

getState resultList [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=status]

getState resultLIst [-o output_file]

Parameters

output_file: Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getState command creates a separate file for each one and appends the host name and port number to the base name.

Example

This example shows that the result list is currently active:

SES>getState resultList
 
<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:objectStates>
      <search:objectState>
         <search:objectType>resultList</search:objectType>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>ACTIVE</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates>
</search:state>

getState schedule

Returns the current state of a schedule as an XML document.

See Also

getAllStates schedule
getStateList schedule

Syntax

getState schedule --NAME=object_name [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=state_properties]

getState schedule -n object_name [-o output_file] [-l state_properties]

Parameters

object_name: Content of a <search:name> element in the XML document.
output_file: Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getState command creates a separate file for each one and appends the host name and port number to the base name.
state_properties: One or more of these state properties: lastCrawled, logFilePath, nextCrawl, scheduleError, and status. Separate multiple properties with commas. All state properties are returned by default.

Example

This example directs a schedule to a file named mailing_schedule.xml. The XML shows that the current status of the schedule is disabled.

SES>getState schedule --NAME="Mailing List Schedule" --OUTPUT_FILE=mailing_schedule.xml
 
The getState operation succeeded.

$ more mailing_schedule.xml
<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/
search">
   <search:objectStates>
      <search:objectState>
         <search:objectType>schedule</search:objectType>
         <search:objectKey>
            <search:keyPairs>
               <search:keyPair>
                  <search:name>name</search:name>
                  <search:value>Mailing list Schedule</search:value>
               </search:keyPair>
            </search:keyPairs>
         </search:objectKey>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>DISABLED</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates>

getState singleSignOnSetting

Returns the current state of a Single Sign-On setting as an XML document.

See Also

getAllStates singleSignOnSetting
getStateList singleSignOnSetting

Syntax

getState singleSignOnSetting --NAME=object_name [--OUTPUT_FILE=output_file]

getState singleSignOnSetting -n object_name [-o output_file]

Parameters

object_name: Content of a <search:name> element in the XML document.
output_file: Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getState command creates a separate file for each one and appends the host name and port number to the base name.

Example

This example shows that the WNA Single Sign-On setting is currently inactive.

SES>getState singleSignOnSetting -n WNA
 
<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:objectStates>
      <search:objectState>
         <search:objectType>singleSignOnSetting</search:objectType>
         <search:objectKey>
            <search:keyPairs>
               <search:keyPair>
                  <search:name>name</search:name>
                  <search:value>WNA</search:value>
               </search:keyPair>
            </search:keyPairs>
         </search:objectKey>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>INACTIVE</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates>
</search:state>

getState skinBundle

Returns the current state of a skin bundle as an XML document.

See Also

getAllStates skinBundle
getStateList skinBundle

Syntax

getState skinBundle --NAME=object_name [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=state_properties]

getState skinBundle -n object_name [-o output_file] [-l state_properties]

Parameters

object_name: Content of a <search:name> element in the XML document.
output_file: Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getState command creates a separate file for each one and appends the host name and port number to the base name.
state_properties: One or more of these state properties: lastModifiedDate and status. Separate multiple properties with commas. All state properties are returned by default.

Example

This example shows that the Holiday skin bundle is currently inactive.

SES>getState skinBundle -n holiday
 
<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:objectStates>
      <search:objectState>
         <search:objectType>skinBundle</search:objectType>
         <search:objectKey>
            <search:keyPairs>
               <search:keyPair>
                  <search:name>name</search:name>
                  <search:value>Holiday</search:value>
               </search:keyPair>
            </search:keyPairs>
         </search:objectKey>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>INACTIVE</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates>
</search:state>

getState suggContentProvider

Returns the current state of a suggested content provider as an XML document.

See Also

getAllStates suggContentProvider
getStateList skinBundle

Syntax

getState suggContentProvider --NAME=object_name [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=status]

getState suggContentProvider -n object_name [-o output_file] [-l status]

Parameters

object_name: Content of a <search:name> element in the XML document.
output_file: Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getState command creates a separate file for each one and appends the host name and port number to the base name.

Example

This example shows that the suggested content provider Provider1 is currently active.

SES>getState suggContentProvider -n Provider1
 
<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:objectStates>
      <search:objectState>
         <search:objectType>suggContentProvider</search:objectType>
         <search:objectKey>
            <search:keyPairs>
               <search:keyPair>
                  <search:name>name</search:name>
                  <search:value>Provider1</search:value>
               </search:keyPair>
            </search:keyPairs>
         </search:objectKey>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>ACTIVE</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates>
</search:state>

getState tagging

Returns the current state of the tagging configuration as an XML document.

Syntax

getState tagging [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=status]

getState tagging [-o output_file] [-l status]

Parameters

output_file: Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getState command creates a separate file for each one and appends the host name and port number to the base name.

Example

This example shows that the tagging configuration is currently active:

SES>getState tagging
 
<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:objectStates>
      <search:objectState>
         <search:objectType>tagging</search:objectType>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>ACTIVE</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates>
</search:state>

getStateList clusterTree

Returns the current state of a list of objects of the same type.

See Also

getState clusterTree
getAllStates clusterTree

Syntax

getStateList clusterTree --KEYS_FILE=key_filename [--OUTPUT_FILE=output_file]

getStateList clusterTree -k key_filename [-o output_file]

Parameters

key_filename

Path to a text file that identifies the objects. Each line of the file contains an object key. For example:

--NAME="Topic Tree"

output_file

Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getStateList command creates a separate file for each one and appends the host name and port number to the base name.

Example

This example displays the last crawl and next crawl dates for the schedules listed in clustertrees.lst:

SES>getStateList clusterTree --KEYS_FILE=clustertrees.lst
 
<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:objectStates>
      <search:objectState>
         <search:objectType>clusterTree</search:objectType>
         <search:objectKey>
            <search:keyPairs>
               <search:keyPair>
                  <search:name>name</search:name>
                  <search:value>Topic Tree</search:value>
               </search:keyPair>
            </search:keyPairs>
         </search:objectKey>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>ACTIVE</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates>
</search:state>

getStateList identityPlugin

Returns the current state of a list of identity plugin objects.

See Also

getAllStates identityPlugin
getState identityPlugin

Syntax

getStateList object_type --KEYS_FILE=key_filename [--OUTPUT_FILE=output_file]

getStateList object_type -k key_filename [-o output_file]

Parameters

key_filename

Path to a text file that identifies the objects. Each line of the file contains an object key. For example:

--JAR_FILE=OIDPlugins.jar --MANAGER_CLASS=oracle.search.plugin.security.identity.oid.OIDPluginManager
--JAR_FILE=../oracleapplications/Siebel8Crawler.jar --MANAGER_CLASS=oracle.search.plugin.security.identity.siebel.SiebelIdentityPluginMgr

output_file

Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getStateList command creates a separate file for each one and appends the host name and port number to the base name.

Example

This example displays the last crawl and next crawl dates for the schedules listed in identity.lst:

SES>getStateList identityPlugin --KEYS_FILE=identity.lst

<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:objectStates>
      <search:objectState>
         <search:objectType>identityPlugin</search:objectType>
         <search:objectKey>
            <search:keyPairs>
               <search:keyPair>
                  <search:name>jarFilePath</search:name>
                  <search:value>OIDPlugins.jar</search:value>
               </search:keyPair>
               <search:keyPair>
                  <search:name>managerClassName</search:name>
                  <search:value>
                    oracle.search.plugin.security.identity.oid.OIDPluginManager
                  </search:value>
               </search:keyPair>
            </search:keyPairs>
         </search:objectKey>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>ACTIVE</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
      <search:objectState>
         <search:objectType>identityPlugin</search:objectType>
         <search:objectKey>
            <search:keyPairs>
               <search:keyPair>
                  <search:name>jarFilePath</search:name>
                  <search:value>
                    ../oracleapplications/Siebel8Crawler.jar
                  </search:value>
               </search:keyPair>
               <search:keyPair>
                  <search:name>managerClassName</search:name>
                  <search:value>
           oracle.search.plugin.security.identity.siebel.SiebelIdentityPluginMgr
                  </search:value>
               </search:keyPair>
            </search:keyPairs>
         </search:objectKey>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>INACTIVE</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates>
</search:state>

getStateList schedule

Returns the current state of a list of schedules.

See Also

getAllStates schedule
getState schedule

Syntax

getStateList schedule --KEYS_FILE=key_filename [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=state_properties]

getStateList schedule -k key_filename [-o output_file] [-l state_properties]

Parameters

key_filename

Path to a text file that identifies the objects. Each line of the file contains an object key. For example:

--NAME="Doc Library"
--NAME="SQL Script Library"

output_file

Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getStateList command creates a separate file for each one and appends the host name and port number to the base name.

state_properties

One or more state properties: lastCrawled, logFilePath, nextCrawl, scheduleError, and status. Separate multiple properties with commas. All state properties are returned by default.

Example

This example displays the last crawl and next crawl dates for the schedules listed in schedules.lst:

SES>getStateList schedule --KEYS_FILE=schedules.lst --PROPERTY_LIST=lastCrawled,nextCrawl
 
<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:objectStates>
      <search:objectState>
         <search:objectType>schedule</search:objectType>
         <search:objectKey>
            <search:keyPairs>
               <search:keyPair>
                  <search:name>name</search:name>
                  <search:value>Doc Library</search:value>
               </search:keyPair>
            </search:keyPairs>
         </search:objectKey>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>nextCrawl</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>MANUAL</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
            <search:stateProperty>
               <search:propertyName>lastCrawled</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue key="Doc Library">
                     <search:value>Thu, 21 May 2009 16:54:17 GMT</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
      <search:objectState>
         <search:objectType>schedule</search:objectType>
         <search:objectKey>
            <search:keyPairs>
               <search:keyPair>
                  <search:name>name</search:name>
                  <search:value>SQL Script Library</search:value>
               </search:keyPair>
            </search:keyPairs>
         </search:objectKey>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>nextCrawl</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>MANUAL</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
            <search:stateProperty>
               <search:propertyName>lastCrawled</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue key="SQL Script Library">
                     <search:value>Thu, 21 May 2009 16:57:18 GMT</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates>
</search:state>

getStateList singleSignOnSetting

Returns the current state of list of Single Sign-On settings.

See Also

getAllStates singleSignOnSetting
getState singleSignOnSetting

Syntax

getStateList singleSignOnSetting --KEYS_FILE=key_filename [--OUTPUT_FILE=output_file]

getStateList singleSignOnSetting -k key_filename [-o output_file]

Parameters

key_filename

Path to a text file that identifies the objects. Each line of the file contains an object key. For example:

--NAME="OAM"
--NAME="OSSO"

output_file

Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getStateList command creates a separate file for each one and appends the host name and port number to the base name.

Example

This example stores the current state of all Single Sign-On settings listed in singlesignonsettings.lst in a file named singlesignonsettingsstate.xml.

SES>getStateList singleSignOnSetting --KEYS_FILE=singlesignonsettings.lst --OUTPUT_FILE=singlesignonsettingsstate.xml
 
The getStateList operation succeeded.

getStateList skinBundle

Returns the current state of a list of skin bundles.

See Also

getAllStates skinBundle
getState skinBundle

Syntax

getStateList skinBundle --KEYS_FILE=key_filename [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=state_properties]

getStateList skinBundle -k key_filename [-o output_file] [-l state_properties]

Parameters

key_filename

Path to a text file that identifies the objects. Each line of the file contains an object key. For example:

--NAME="Doc Library"
--NAME="SQL Script Library"

output_file

Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getStateList command creates a separate file for each one and appends the host name and port number to the base name.

state_properties

One or more state properties: lastModifiedDate and status. Separate multiple properties with commas. All state properties are returned by default.

Example

This example stores the current state of all skin bundles listed in skins.lst in a file named skinstate.xml.

SES>getStateList skinBundle --KEYS_FILE=skins.lst --OUTPUT_FILE=skinstate.xml
 
The getStateList operation succeeded.

getStateList suggContentProvider

Returns the current state of a list of suggested content provider objects.

See Also

getState suggContentProvider
getAllStates suggContentProvider

Syntax

getStateList suggContentProvider --KEYS_FILE=key_filename [--OUTPUT_FILE=output_file]

getStateList suggContentProvider -k key_filename [-o output_file]

Parameters

key_filename

Path to a text file that identifies the objects. Each line of the file contains an object key. For example:

--NAME="Provider1"

output_file

Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getStateList command creates a separate file for each one and appends the host name and port number to the base name.

Example

This example displays the status for the suggested content providers listed in suggcontentproviders.lst:

SES>getStateList suggContentProvider --KEYS_FILE=suggcontentproviders.lst
 
<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.2.2.2.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:objectStates>
      <search:objectState>
         <search:objectType>suggContentProvider</search:objectType>
         <search:objectKey>
            <search:keyPairs>
               <search:keyPair>
                  <search:name>name</search:name>
                  <search:value>Provider1</search:value>
               </search:keyPair>
            </search:keyPairs>
         </search:objectKey>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>ACTIVE</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates>
</search:state>

start autoSuggestion

Starts jobs for applying filter expression specified in <search:filterExpression> to suggestion keywords that have already been populated from queries.

Syntax

start autoSuggestion --ACTION=filter

Example

This example starts job that removes existing suggestion keywords populated from queries that match the filter expression:

SES>start autoSuggestion --ACTION=filter
 
The "start" operation succeeded for "autoSuggestion".

start indexOptimizer

Starts index optimization.

Syntax

start indexOptimizer

Example

This example starts the index optimizer:

SES>start indexOptimizer
 
The "start" operation succeeded for "indexOptimizer".

start schedule

Starts a schedule.

Syntax

start schedule --NAME=object_name

start schedule -n object_name

Parameters

object_name: Content of a <search:name> element in the XML document.

Example

This example starts a schedule named SQL Script Library:

SES>start schedule --NAME='SQL Script Library'
 
The "start" operation succeeded for "[name=SQL Script Library]".

stop indexOptimizer

Stops index optimization.

Syntax

stop indexOptimizer

Example

This example stops the index optimizer:

SES>stop indexOptimizer
 
The "stop" operation succeeded for "indexOptimizer".

stop schedule

Stops a schedule from initiating a crawl, or stops the crawler if it has already started.

Syntax

stop schedule --NAME=object_name

stop schedule -n object_name

Parameters

object_name: Content of a <search:name> element in the XML document.

Example

This example stops a schedule named My File Source:

SES>stop schedule --NAME="My File Source"
 
The "stop" operation succeeded for "[name=My File Source]".

update altWord

Changes the properties of an alternate word from an XML file.

See Also

updateAll altWord

Syntax

update altWord --KEYWORD=keyword --ALT_KEYWORD=alt_keyword object_key --INPUT_FILE=xml_filename --UPDATE_METHOD=method

update altWord --KEYWORD=keyword --ALT_KEYWORD=alt_keyword -i xml_filename -a method

Parameters

keyword

Content of a <search:keyword> element in the XML document.

alt_keyword

Content of a <search:altKeyword> element in the XML document.

xml_filename

Path to the XML document that configures the object. See "altWord".

method

Method to use when updating the properties of an object:

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

Example

This example overwrites the parameter settings for RAC:

SES>update altWord --KEYWORD=rac --ALT_KEYWORD="Real Application Clusters" --INPUT_FILE=altwords.xml --UPDATE_METHOD=overwrite

The object "[keyword=rac, altKeyword=Real Application Clusters]" was successfully updated.

update autoSuggestion

Sets one or more auto suggestion properties from an XML description.

Syntax

update autoSuggestion --UPDATE_METHOD=method --INPUT_FILE=xml_filename

update autoSuggestion -a method -i xml_filename

Parameters

method

Method to use when updating the properties of an object:

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

xml_filename

Path to the XML document that configures the object. See "clustering".

Example

This example updates the clustering properties:

SES>update autoSuggestion --INPUT_FILE=autoSuggestion.xml --UPDATE_METHOD=overwrite
 
The object "autoSuggestion" was successfully updated.

update boostedUrl

Changes the properties of a boosted URL from an XML document.

See Also

updateAll boostedUrl

Syntax

update boostedUrl --DOC_URL=url --QUERY=query_term --INPUT_FILE=xml_filename --UPDATE_METHOD=method

update boostedUrl --DOC_URL=url --QUERY=query_term -i xml_filename -a method

Parameters

url

The URL of a document being boosted.

query_term

The exact query term that returns the boosted URL.

xml_filename

Path to the XML document that configures the object. See "boostedUrl".

method

Method to use when updating the properties of an object:

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

Example

This example updates the definition of a boosted URL for the term "indexing":

SES>update boostedUrl --DOC_URL="http://example.com/doctools/b32440/xref_foot_in.htm" --QUERY="indexing" --UPDATE_METHOD=overwrite --INPUT_FILE=boost.xml 

The object "[query=indexing, docUrl=http://example.com/doctools/b32440/xref_foot_in.htm]" was successfully updated

update classification

Updates a classification.

See Also

updateAll classification

Syntax

update classification --NAME=object_name --INPUT_FILE=xml_filename --UPDATE_METHOD=method

update classification -n object_name -i xml_filename -a method

Parameters

object_name

Content of a <search:name> element in the XML document.

xml_filename

Path to the XML document that configures the object. See "classification".

method

Method to use when updating the properties of an object:

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

Example

This example updates the status of classification_1:

SES>update classification --NAME=classification_1 --INPUT_FILE=classification_update.xml --UPDATE_METHOD=overwrite
 
The object "[name=classification_1]" was successfully updated.

update classificationMappings

Sets one or more classificationMappings properties from an XML description.

Syntax

update classificationMappings --UPDATE_METHOD=method --INPUT_FILE=xml_filename

update classificationMappings -a method -i xml_filename

Parameters

method

Method to use when updating the properties of an object:

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

xml_filename

Path to the XML document that configures the object. See "classificationMappings".

Example

This example updates the classificationMappings properties:

SES>update classificationMappings --INPUT_FILE=classificationMappings.xml --UPDATE_METHOD=overwrite
 
The object "classificationMappings" was successfully updated.

update clustering

Sets one or more clustering properties from an XML description.

Syntax

update clustering --UPDATE_METHOD=method --INPUT_FILE=xml_filename

update clustering -a method -i xml_filename

Parameters

method

Method to use when updating the properties of an object:

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

xml_filename

Path to the XML document that configures the object. See "clustering".

Example

This example updates the clustering properties:

SES>update clustering --INPUT_FILE=clustering.xml --UPDATE_METHOD=overwrite
 
The object "clustering" was successfully updated.

update clusterTree

Changes the properties of a cluster tree from an XML file.

See Also

updateAll clusterTree

Syntax

update clusterTree --NAME=object_name --INPUT_FILE=xml_filename --UPDATE_METHOD=method

update clusterTree -n object_key -i xml_filename -a method

Parameters

object_name

Content of a <search:name> element in the XML document.

xml_filename

Path to the XML document that configures the object. See "clusterTree".

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

Example

This example overwrites the parameter settings for the Topic Tree cluster tree:

SES>update clusterTree --NAME=Topic Tree --UPDATE_METHOD=overwrite --INPUT_FILE=clustertree.xml
 
The object "[name=Topic Tree]" was successfully updated.

update crawlerSettings

Sets one or more global crawler properties from an XML description.

Syntax

update crawlerSettings --UPDATE_METHOD=method --INPUT_FILE=xml_filename

update crawlerSettings -a method -i xml_filename

Parameters

method

Method to use when updating the properties of an object:

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

xml_filename

Path to the XML document that configures the object. See "crawlerSettings".

Example

This example updates the crawler settings:

SES>update crawlerSettings --INPUT_FILE=crawler.xml --UPDATE_METHOD=overwrite
 
The object "crawlerSettings" was successfully updated.

update docServiceInstance

Sets one or more parameters of a document service instance from an XML description.

See Also

updateAll docServiceInstance

Syntax

update docServiceInstance --NAME=object_name --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--ENCRYPT_KEY=key]

update docServiceInstance -n object_name -i xml_filename -a method [-e key]

Parameters

object_name

Content of a <search:name> element in the XML document.

xml_filename

Path to the XML document that configures the object. See "docServiceInstance".

method

Method to use when updating the properties of an object:

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

key

Example

This example updates a the default summarizer document service instance:

SES>update docServiceInstance --NAME="Default summarizer service instance" --UPDATE_METHOD=overwrite --INPUT_FILE=docserviceinstance.xml --ENCRYPT_KEY=key2encrypt
 
The object "[name=Default summarizer service instance]" was successfully updated.

update docServicePipeline

Sets one or more parameters of a document service pipeline from an XML description.

See Also

updateAll docServicePipeline

Syntax

update docServicePipeline --UPDATE_METHOD=method --INPUT_FILE=xml_filename

update docServicePipeline -a method -i xml_filename

Parameters

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

xml_filename

Path to the XML document that configures the object. See "docServicePipeline".

Example

This example updates the default document service pipeline:

SES>update docServicePipeline --NAME=Default pipeline --UPDATE_METHOD=add --INPUT_FILE=docservicepipeline.xml
 
The object "[name=Default pipeline]" was successfully updated.

update facetTree

Updates a facet tree from an XML description.

See Also

updateAll facetTree

Syntax

update facetTree --UPDATE_METHOD=method --INPUT_FILE=xml_filename

update facetTree -a method -i xml_filename

Parameters

object_name

Content of a <search:name> element in the XML document.

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

xml_filename

Path to the XML document that defines the object. See "facetTree".

Example

This example updates a facet tree named Country:

SES>update facetTree --FACETNAME=Country --UPDATE_METHOD=add --INPUT_FILE=facettree.xml
 
The object "[facetName=Country]" was successfully updated.

update globalBoundaryRules

Sets one or more global boundary rules from an XML document.

Syntax

update globalBoundaryRules --UPDATE_METHOD=method --INPUT_FILE=xml_filename

update globalBoundaryRules -a method -i xml_filename

Parameters

method

Method to use when updating the properties of an object:

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

xml_filename

Path to the XML document that configures the object. See "globalBoundaryRules".

Example

This example updates the global boundary rules:

SES>update globalBoundaryRules -a overwrite --INPUT_FILE=globalboundaryrules.xml
 
The object "globalBoundaryRules" was successfully updated.

update globalDocumentTypes

Sets one or more parameters of a global document type from an XML document.

Syntax

update globalDocumentTypes --UPDATE_METHOD=method --INPUT_FILE=xml_filename

update globalDocumentTypes -a method -i xml_filename

Parameters

method

Method to use when updating the properties of an object:

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

xml_filename

Path to the XML document that configures the object. See "globalDocumentTypes".

Example

This example updates the global document types:

SES>update globalDocumentTypes -a overwrite --INPUT_FILE=globaldocumenttypes.xml
 
The object "globalDocumentTypes" was successfully updated.

update index

Sets one or more index properties from an XML description.

Syntax

update index --UPDATE_METHOD=method --INPUT_FILE=xml_filename

update index -a method -i xml_filename

Parameters

method

Method to use when updating the properties of an object:

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

xml_filename

Path to the XML document that configures the object. See "index".

Example

This example updates the indexing settings:

SES>update index --INPUT_FILE=index.xml --UPDATE_METHOD=overwrite
 
The object "index" was successfully updated.

update indexOptimizer

Sets one or more index optimizer properties from an XML description.

Syntax

update indexOptimizer --UPDATE_METHOD=method --INPUT_FILE=xml_filename

update indexOptimizer -a method -i xml_filename

Parameters

method

Method to use when updating the properties of an object:

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

xml_filename

Path to the XML document that configures the object. See "indexOptimizer".

Example

This example updates the index optimization settings:

SES>update indexOptimizer --INPUT_FILE=indexoptimizer.xml --UPDATE_METHOD=overwrite
 
The object "indexOptimizer" was successfully updated.

update indexProfile

Sets one or more parameters of an index profile from an XML document.

See Also

updateAll indexProfile

Syntax

update indexProfile --UPDATE_METHOD=method --INPUT_FILE=xml_filename

update indexProfile -a method -i xml_filename

Parameters

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

xml_filename

Path to the XML document that configures the object. See "indexProfile".

Example

This example updates My Index Profile:

SES>update indexProfile --NAME="My IndexProfile" --UPDATE_METHOD=add --INPUT_FILE=indexprofile.xml
 
The object "[name=My Index Profile]" was successfully updated.

update languageBasedTokenization

Sets one or more parameters for language-based tokenization from an XML document.

Syntax

update languageBasedTokenization --UPDATE_METHOD=method --INPUT_FILE=xml_filename

update languageBasedTokenization -a method -i xml_filename

Parameters

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

xml_filename

Path to the XML document that configures the object. See "languageBasedTokenization".

Example

This example updates the mapping rules for language-based tokenization.

SES>update languageBasedTokenization --UPDATE_METHOD=add --INPUT_FILE=languagebasedtokenization.xml
 
The object "languageBasedTokenization" was successfully updated.

update lexer

Sets one or more parameters of a lexer from an XML document.

See Also

updateAll lexer

Syntax

update lexer --UPDATE_METHOD=method --INPUT_FILE=xml_filename

update lexer -a method -i xml_filename

Parameters

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

xml_filename

Path to the XML document that configures the object. See "lexer".

Example

This example updates the default German lexer:

SES>update lexer --NAME=OracleDefaultGermanLexer --UPDATE_METHOD=add --INPUT_FILE=lexer.xml
 
The object "[name=OracleDefaultGermanLexer]" was successfully updated.

update partitionConfig

Changes the settings of the partition configuration parameters from an XML description. You can update the configuration only under these conditions:

Immediately after installing Oracle SES.
Before crawling any data source.
After dropping all data sources.

When a partition rule is in use, you cannot modify it.

Syntax

update partitionConfig --UPDATE_METHOD=method --INPUT_FILE=xml_filename

update partitionConfig -a method -i xml_filename

Parameters

method

Controls the method used to update the properties of an object. Enter an update method:

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

xml_filename

Path to the XML document that configures the object. See "partitionConfig".

Example

The following example updates the partitioning configuration:

SES>update partitionConfig --INPUT_FILE=part.xml --UPDATE_METHOD=overwrite
 
The object "partitionConfig" was successfully updated.

update proxy

Sets HTTP proxy server configuration parameters from an XML description.

Syntax

update proxy --UPDATE_METHOD=method --INPUT_FILE=xml_filename

update proxy -a method -i xml_filename

Parameters

method

Method to use when updating the properties of an object:

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

xml_filename

Path to the XML document that configures the object. See "proxy".

Example

This example updates the HTTP proxy server settings:

SES>update proxy --INPUT_FILE=proxy.xml
 
The object "proxy" was successfully updated.

update proxyLogin

Changes the properties of a proxy log-in (federation entrusted entity) from an XML description.

See Also

updateAll proxyLogin

Syntax

update proxyLogin --NAME=object_name --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--ENCRYPT_KEY=key]

update proxyLogin -n object_name -i xml_filename -a method [-e key]

Parameters

object_name

Content of a <search:name> element in the XML document.

xml_filename

Path to the XML document that configures the object. See "proxyLogin".

method

Method to use when updating the properties of an object:

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

key

Example

This example overwrites the parameter settings for a proxy:

SES>update proxyLogin --NAME=this_proxy --INPUT_FILE=proxy.xml --UPDATE_METHOD=overwrite --ENCRYPT_KEY=key2encrypt
 
The object "[name=this_proxy]" was successfully updated.

update queryConfig

Sets one or more query configuration parameters from an XML description.

Syntax

update queryConfig --UPDATE_METHOD=method --INPUT_FILE=xml_filename

update queryConfig -a method -i xml_filename

Parameters

method

Method to use when updating the properties of an object:

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

xml_filename

Path to the XML document that configures the object. See "queryConfig".

Example

This example updates the query settings:

SES>update queryConfig --INPUT_FILE=query.xml
 
The object "queryConfig" was successfully updated.

update queryUIConfig

Sets one or more queryUIConfig properties from an XML description.

Syntax

update queryUIConfig --UPDATE_METHOD=method --INPUT_FILE=xml_filename

update queryUIConfig -a method -i xml_filename

Parameters

method

Method to use when updating the properties of an object:

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

xml_filename

Path to the XML document that configures the object. See "queryUIConfig".

Example

This example updates the queryUIConfig properties:

SES>update queryUIConfig --INPUT_FILE=queryUIConfig.xml --UPDATE_METHOD=overwrite
 
The object "queryUIConfig" was successfully updated.

update queryUIFacets

Sets one or more queryUIFacets properties from an XML description.

Syntax

update queryUIFacets --UPDATE_METHOD=method --INPUT_FILE=xml_filename

update queryUIFacets -a method -i xml_filename

Parameters

method

Method to use when updating the properties of an object:

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

xml_filename

Path to the XML document that configures the object. See "queryUIFacets".

Example

This example updates the queryUIFacets properties:

SES>update queryUIFacets --INPUT_FILE=queryUIFacets.xml --UPDATE_METHOD=overwrite
 
The object "queryUIFacets" was successfully updated.

update queryUISourceGroups

Sets one or more queryUISourceGroups properties from an XML description.

Syntax

update queryUISourceGroups --UPDATE_METHOD=method --INPUT_FILE=xml_filename

update queryUISourceGroups -a method -i xml_filename

Parameters

method

Method to use when updating the properties of an object:

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

xml_filename

Path to the XML document that configures the object. See "queryUISourceGroups".

Example

This example updates the queryUISourceGroups properties:

SES>update queryUISourceGroups --INPUT_FILE=queryUIFacets.xml --UPDATE_METHOD=overwrite
 
The object "queryUISourceGroups" was successfully updated.

update relevanceRanking

Sets one or more relevance ranking parameters from an XML description.

Syntax

update relevanceRanking --UPDATE_METHOD=method --INPUT_FILE=xml_filename

update relevanceRanking -a method -i xml_filename

Parameters

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

xml_filename

Path to the XML document that configures the object. See "relevanceRanking".

Example

This example updates the ranking attributes:

SES>update relevanceRanking -a remove --INPUT_FILE=relevance.xml
 
The object "relevanceRanking" was successfully updated.

update resultList

Updates the list of search attributes that can be used for rendering the result list. However, these attributes appear in the result list only if the XSLT style sheet uses them.

Syntax

update resultList --UPDATE_METHOD=method --INPUT_FILE=xml_filename

update resultList -a method -i xml_filename

Parameters

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

xml_filename

Path to the XML document that configures the object. See "resultList".

Example

This example updates the result list properties:

SES>update resultList --UPDATE_METHOD=add --INPUT_FILE=resultlist.xml
 
The object "resultList" was successfully updated.

update schedule

Changes the properties of a schedule from an XML file.

See Also

updateAll schedule

Syntax

update schedule --NAME=object_name --INPUT_FILE=xml_filename --UPDATE_METHOD=method

update creatable_type -n object_name -i xml_filename -a method

Parameters

object_name

Content of a <search:name> element in the XML document.

xml_filename

Path to the XML document that configures the object. See "schedule".

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

Example

This example adds a source to the Doc Library schedule:

SES>update schedule --NAME="Doc Library" --UPDATE_METHOD=add --INPUT_FILE=schedule.xml
 
The object "[name=Doc Library]" was successfully updated.

update searchAttr

Changes the properties of a search attribute from an XML file. You can add translations of search attribute names and LOVs to the default search attributes.

See Also

updateAll searchAttr

Syntax

update searchAttr --NAME=object_name --INPUT_FILE=xml_filename --UPDATE_METHOD=method

update searchAttr -n object_name -i xml_filename -a method

Parameters

object_name

Content of a <search:name> element in the XML document.

xml_filename

Path to the XML document that configures the object. See "searchAttr".

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

Note:

The add and remove methods cannot be used for adding and removing attribute properties (specified using the <search:properties> element). Only the overwrite method can be used for updating the attribute properties.

Example

This example overwrites the parameter settings for the Owner search attribute:

SES>update searchAttr --NAME=Owner --UPDATE_METHOD=overwrite --INPUT_FILE=searchattrs.xml
 
The object "[name=Owner]" was successfully updated.

update singleSignOnSetting

Updates a Single Sign-On setting.

Syntax

update singleSignOnSetting --NAME=object_name --INPUT_FILE=xml_filename --UPDATE_METHOD=method

update singleSignOnSetting -n object_name -i xml_filename -a method

Parameters

object_name

Content of a <search:name> element in the XML document.

xml_filename

Path to the XML document that configures the object. See "singleSignOnSetting".

method

Method to use when updating the properties of an object:

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

Example

This example updates the status of OSSO:

SES>update singleSignOnSetting --NAME=OSSO --INPUT_FILE=sso_update.xml --UPDATE_METHOD=overwrite
 
The object "[name=OSSO]" was successfully updated.

update skinBundle

Changes the properties of a skin bundle from an XML file.

Syntax

update skinBundle --NAME=object_name --INPUT_FILE=xml_filename [--ATTACHMENT_LIST=list_filename] --UPDATE_METHOD=method

update skinBundle -n object_name -i xml_filename [-h list_filename] -a method

Parameters

object_name

Content of a <search:name> element in the XML document.

xml_filename

Path to the XML document that configures the object. See "skinBundle".

list_filename

Path to the text file that lists the files in the skin bundle. This parameter is optional when the XML description does not update the files. See the Notes for "create skinBundle".

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

Example

This example updates the Holiday skin bundle.

SES>update skinBundle --NAME=holiday --INPUT_FILE=skins_update.xml --ATTACHMENT_LIST=skins/resources.lst --UPDATE_METHOD=remove
 
The object "[name=holiday]" was successfully updated.

update source

Changes the properties of a source from an XML file.

See Also

updateAll singleSignOnSetting

Syntax

update source --NAME=object_name --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--ENCRYPT_KEY=key]

update source -n object_name -i xml_filename -a method [-e key]

Parameters

object_name

Content of a <search:name> element in the XML document.

xml_filename

Path to the XML document that configures the object. See "source".

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

key

Example

This example updates the Doc Library source with the changes in sources.xml:

SES>update source --NAME="Doc Library" --UPDATE_METHOD=overwrite --INPUT_FILE=sources.xml --ENCRYPT_KEY=key2encrypt
 
The object "[name=Doc Library]" was successfully updated.

update sourceGroup

Changes the properties of a source group from an XML file.

See Also

updateAll sourceGroup

Syntax

update sourceGroup --NAME=object_name --INPUT_FILE=xml_filename --UPDATE_METHOD=method

update sourceGroup -n object_name -i xml_filename -a method

Parameters

object_name

Content of a <search:name> element in the XML document.

xml_filename

Path to the XML document that configures the object. See "sourceGroup".

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

Example

This example updates the Libraries source group:

SES>update sourceGroup --NAME=Libraries --UPDATE_METHOD=overwrite --INPUT_FILE=sourcegroups.xml
 
The object "[name=Libraries]" was successfully updated.

update sourceType

Changes the properties of a source type from an XML file.

See Also

updateAll sourceType

Syntax

update sourceType --NAME=object_name --INPUT_FILE=xml_filename --UPDATE_METHOD=method

update sourceType -n object_name -i xml_filename -a method

Parameters

object_name

Content of a <search:name> element in the XML document.

xml_filename

Path to the XML document that configures the object. See "sourceType".

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

Example

This example updates the definition of the EMC Documentum Content Server source type:

SES>update sourceType --NAME="EMC Documentum Content Server" --UPDATE_METHOD=overwrite --INPUT_FILE=sourcetypes.xml
 
The object "[name=EMC Documentum Content Server]" was successfully updated.

update storageArea

Changes the properties of a storage area from an XML file.

Syntax

update storageArea --NAME=object_name --INPUT_FILE=xml_filename --UPDATE_METHOD=method

update storageArea -n object_name -i xml_filename -a method

Parameters

object_name

Content of a <search:name> element in the XML document.

xml_filename

Path to the XML document that configures the object. See "storageArea".

method

Method to use when updating the properties of an object:

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

Example

This example updates the parameter settings for the OES_ASSM2 storage area:

SES>update storageArea --NAME=OES_ASSM2 --UPDATE_METHOD=overwrite --INPUT_FILE=storage.xml
 
The object "[name=OES_ASSM2]" was successfully updated.

update suggContent

Sets suggested content configuration parameters from an XML description.

Syntax

update suggContent --UPDATE_METHOD=method --INPUT_FILE=xml_filename

update suggContent -a method -i xml_filename

Parameters

method

Method to use when updating the properties of an object:

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

xml_filename

Path to the XML document that configures the object. See "suggContent".

Example

This example updates the suggested content settings:

SES>update suggContent --INPUT_FILE=suggContent.xml
 
The object "suggContent" was successfully updated.

update suggContentProvider

Changes the properties of a suggested content provider from an XML file.

See Also

updateAll suggContentProvider

Syntax

update suggContentProvider --NAME=object_name --INPUT_FILE=xml_filename --UPDATE_METHOD=method

update suggContentProvider -n object_name -i xml_filename -a method

Parameters

object_name

Content of a <search:name> element in the XML document.

xml_filename

Path to the XML document that configures the object. See "suggContentProvider".

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

Example

This example updates the suggested content provider Provider1:

SES>update suggContentProvider --NAME=Provider1 --UPDATE_METHOD=overwrite --INPUT_FILE=suggcontentproviders.xml
 
The object "[name=Provider1]" was successfully updated.

update suggestion

Updates a suggestion.

See Also

updateAll suggestion

Syntax

update suggestion --NAME=object_name --INPUT_FILE=xml_filename --UPDATE_METHOD=method

update suggestion -n object_name -i xml_filename -a method

Parameters

object_name

Content of a <search:name> element in the XML document.

xml_filename

Path to the XML document that configures the object. See "suggestion".

method

Method to use when updating the properties of an object:

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

Example

This example updates the status of suggestion_1:

SES>update suggestion --NAME=suggestion_1 --INPUT_FILE=suggestion_update.xml --UPDATE_METHOD=overwrite
 
The object "[name=suggestion_1]" was successfully updated.

update suggLink

Changes the properties of a suggested link from an XML file.

See Also

updateAll suggLink

Syntax

update suggLink --KEYWORD=keyword --LINK_URL=url --INPUT_FILE=xml_filename --UPDATE_METHOD=method

update suggLink --KEYWORD=keyword --LINK_URL=url -i xml_filename -a method

Parameters

keyword

Content of the search:keyword element in the XML document.

url

Content of the search:linkUrl element in the XML document.

xml_filename

Path to the XML document that configures the object. See "suggLink".

method

Method to use when updating the properties of an object:

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

Example

This example updates the suggested link for oracle:

SES>update suggLink --KEYWORD=oracle --LINK_URL=http://www.oracle.com --UPDATE_METHOD=overwrite --INPUT_FILE=sugglinks.xml
 
The object "[keyword=oracle, linkUrl=http://www.oracle.com]" was successfully updated.

update tag

Changes the properties of a tag from an XML file.

See Also

updateAll tag

Syntax

update tag --NAME=object_name --INPUT_FILE=xml_filename --UPDATE_METHOD=method

update tag -n object_name -i xml_filename -a method

Parameters

object_name

Content of a <search:name> element in the XML document.

xml_filename

Path to the XML document that configures the object. See "tag".

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

Example

This example updates the definition of the OSES tag:

SES>update tag --NAME="OSES" --UPDATE_METHOD=overwrite --INPUT_FILE=tags.xml
 
The object "[name=OSES]" was successfully updated.

update tagging

Updates the tagging configuration.

Syntax

update tagging --UPDATE_METHOD=method --INPUT_FILE=xml_filename

update tagging -a method -i xml_filename

Parameters

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

xml_filename

Path to the XML document that configures the object. See "tagging".

Example

This example updates the tagging configuration:

SES>update tagging --UPDATE_METHOD=add --INPUT_FILE=tagging.xml
 
The object "tagging" was successfully updated.

update thesaurus

Changes the properties of a thesaurus from an XML file.

Syntax

update thesaurus --NAME=DEFAULT --INPUT_FILE=xml_filename --UPDATE_METHOD=method

update thesaurus -n DEFAULT -i xml_filename -a method

Parameters

xml_filename

Path to the XML document that configures the object. See "thesaurus".

method

Method to use when updating the properties of an object:

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

Example

This example updates the default thesaurus:

SES>update thesaurus --NAME=DEFAULT --UPDATE_METHOD=overwrite --INPUT_FILE=thesaurus_update.xml
 
The object "[name=DEFAULT]" was successfully updated.

updateAll altWord

Sets one or more parameters for all alternate words from an XML description.

See Also

update altWord

Syntax

updateAll altWord --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]

updateAll altWord -i xml_filename -a method [-t action]

Parameters

xml_filename

Path to the XML document that configures the object. See "altWord".

method

Method to use when updating the properties of an object:

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

action

Action to take when an object does not exist:

create: A new object is created from the XML description and processing continues.
error: The command fails with an error. (Default)
ignore: The new description is ignored and processing continues.

Example

This example updates the alternate word list by adding a new altWord object in altword2.xml:

SES>updateAll altWord --INPUT_FILE=altword2.xml --UPDATE_METHOD=overwrite --NOT_FOUND_METHOD=create
 
updateAll operation succeeded for type "altWord".
 
  1 object(s) with status NOT_FOUND_CREATED

updateAll boostedUrl

Changes the properties of all boosted URLs described in an XML document.

See Also

update boostedUrl

Syntax

updateAll boostedUrl --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]

updateAll boostedUrl -i xml_filename -a method [-t action]

Parameters

xml_filename

Path to the XML document that configures the object. See "boostedUrl".

method

Method to use when updating the properties of an object:

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

action

Action to take when an object does not exist:

create: A new object is created from the XML description and processing continues.
error: The command fails with an error. (Default)
ignore: The new description is ignored and processing continues.

Example

This example updates all the boosted URLs described in boost.xml:

SES>updateAll boostedUrl --UPDATE_METHOD=overwrite --NOT_FOUND_METHOD=ignore --INPUT_FILE=boost.xml 

updateAll operation succeeded for type "boostedUrl".
 
  2 object(s) with status UPDATE_SUCCEEDED

updateAll classification

Sets one or more parameters for all the classifications from an XML description.

See Also

update classification

Syntax

updateAll classification --INPUT_FILE=xml_filename --UPDATE_METHOD=method  [--NOT_FOUND_METHOD=action]

updateAll classification -i xml_filename -a method [-t action]

Parameters

xml_filename

Path to the XML document that configures the object. See "classification".

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

action

Action to take when an object does not exist:

create: A new object is created from the XML description and processing continues.
error: The command fails with an error. (Default)
ignore: The new description is ignored and processing continues

Example

This example updates two classifications:

SES>updateAll classification --UPDATE_METHOD=add --NOT_FOUND_METHOD=create --INPUT_FILE=classification2.xml
 
updateAll operation succeeded for type "classification".
 
  2 object(s) with status UPDATE_SUCCEEDED

updateAll clusterTree

Sets one or more parameters for all cluster trees from an XML description.

See Also

update clusterTree

Syntax

updateAll clusterTree --INPUT_FILE=xml_filename --UPDATE_METHOD=method  [--NOT_FOUND_METHOD=action]

updateAll clusterTree -i xml_filename -a method [-t action]

Parameters

xml_filename

Path to the XML document that configures the object. See "clusterTree".

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

action

Action to take when an object does not exist:

create: A new object is created from the XML description and processing continues.
error: The command fails with an error. (Default)
ignore: The new description is ignored and processing continues

Example

This example updates two cluster trees:

SES>updateAll clusterTree --UPDATE_METHOD=add --NOT_FOUND_METHOD=create --INPUT_FILE=clustertree2.xml
 
updateAll operation succeeded for type "clusterTree".
 
  2 object(s) with status UPDATE_SUCCEEDED

updateAll docServiceInstance

Sets one or more parameters of all document service instances described in an XML document.

See Also

update docServiceInstance

Syntax

updateAll docServiceInstance --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action] [--ENCRYPT_KEY=key]

updateAll docServiceInstance -i xml_filename -a method [-t action] [-e key]

Parameters

xml_filename

Path to the XML document that configures the object. See "docServiceInstance".

method

Method to use when updating the properties of an object:

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

action

Action to take when an object does not exist:

create: A new object is created from the XML description and processing continues.
error: The command fails with an error. (Default)
ignore: The new description is ignored and processing continues

key

Example

This example updates two document service instances:

SES>updateAll docServiceInstance --UPDATE_METHOD=overwrite --NOT_FOUND_METHOD=create --INPUT_FILE=docserviceinstance.xml --ENCRYPT_KEY=key2encrypt
 
updateAll operation succeeded for type "docServiceInstance".
 
  2 object(s) with status UPDATE_SUCCEEDED

updateAll docServicePipeline

Sets one or more parameters of all document services pipelines described in an XML document.

See Also

update docServicePipeline

Syntax

updateAll docServicePipeline --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]

updateAll docServicePipeline -i xml_filename -a method [-t action]

Parameters

xml_filename

Path to the XML document that configures the object. See "docServicePipeline".

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file. It also appends new service instances described in the XML to the end of the execution list, so that the new instances are executed last.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

action

Action to take when an object does not exist:

create: A new object is created from the XML description and processing continues.
error: The command fails with an error. (Default)
ignore: The new description is ignored and processing continues

Example

This example updates two document service pipelines:

updateAll docServicePipeline --UPDATE_METHOD=remove --NOT_FOUND_METHOD=create --INPUT_FILE=docservicepipeline.xml
 
updateAll operation succeeded for type "docServicePipeline".
 
  2 object(s) with status UPDATE_SUCCEEDED

updateAll facetTree

Updates all the facet trees described in an XML document.

See Also

update facetTree

Syntax

updateAll facetTree --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]

updateAll facetTree -i xml_filename -a method [-t action]

Parameters

xml_filename

Path to the XML document that configures the object. See "facetTree".

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file. It also appends new service instances described in the XML to the end of the execution list, so that the new instances are executed last.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

action

Action to take when an object does not exist:

create: A new object is created from the XML description and processing continues.
error: The command fails with an error. (Default)
ignore: The new description is ignored and processing continues

Example

This example updates two facet trees:

updateAll facetTree --UPDATE_METHOD=remove --NOT_FOUND_METHOD=create --INPUT_FILE=facettree.xml
 
updateAll operation succeeded for type "facetTree".
 
  2 object(s) with status UPDATE_SUCCEEDED

updateAll indexProfile

Sets one or more parameters of all index profiles described in an XML document.

See Also

update indexProfile

Syntax

updateAll indexProfile --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]

updateAll indexProfile -i xml_filename -a method [-t action]

Parameters

xml_filename

Path to the XML document that configures the object. See "indexProfile".

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file. It also appends new service instances described in the XML to the end of the execution list, so that the new instances are executed last.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

action

Action to take when an object does not exist:

create: A new object is created from the XML description and processing continues.
error: The command fails with an error. (Default)
ignore: The new description is ignored and processing continues

Example

This example updates two index profiles:

SES>updateAll indexProfile --UPDATE_METHOD=remove --NOT_FOUND_METHOD=create --INPUT_FILE=indexprofile.xml
 
updateAll operation succeeded for type "indexProfile".
 
  2 object(s) with status UPDATE_SUCCEEDED

updateAll lexer

Sets one or more parameters of all lexers described in an XML document.

See Also

update lexer

Syntax

updateAll lexer --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]

updateAll lexer -i xml_filename -a method [-t action]

Parameters

xml_filename

Path to the XML document that configures the object. See "lexer".

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file. It also appends new service instances described in the XML to the end of the execution list, so that the new instances are executed last.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

action

Action to take when an object does not exist:

create: A new object is created from the XML description and processing continues.
error: The command fails with an error. (Default)
ignore: The new description is ignored and processing continues

Example

This example updates three lexers:

SES>updateAll lexer --UPDATE_METHOD=remove --NOT_FOUND_METHOD=create --INPUT_FILE=lexer.xml
 
updateAll operation succeeded for type "lexer".
 
  3 object(s) with status UPDATE_SUCCEEDED

updateAll proxyLogin

Sets one or more parameters for all proxy log-ins (federated trusted entities) from an XML description.

See Also

update proxyLogin

Syntax

updateAll proxyLogin --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--ENCRYPT_KEY=key] [--NOT_FOUND_METHOD=action]

updateAll proxyLogin -i xml_filename -a method [-e key] [-t action]

Parameters

xml_filename

Path to the XML document that configures the object. See "proxyLogin".

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

key

action

Action to take when an object does not exist:

create: A new object is created from the XML description and processing continues.
error: The command fails with an error. (Default)
ignore: The new description is ignored and processing continues

Example

This example updates all proxy log-ins described in proxy.xml:

SES>updateAll proxyLogin --INPUT_FILE=proxy.xml --UPDATE_METHOD=overwrite --ENCRYPT_KEY=key2encrypt
 
updateAll operation succeeded for type "proxyLogin".
 
  3 object(s) with status UPDATE_SUCCEEDED

updateAll schedule

Sets one or more parameters for all schedules from an XML description.

See Also

update schedule

Syntax

updateAll schedule --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]

updateAll schedule -i xml_filename -a method [-t action]

Parameters

xml_filename

Path to the XML document that configures the object. See "schedule".

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

action

Action to take when an object does not exist:

create: A new object is created from the XML description and processing continues.
error: The command fails with an error. (Default)
ignore: The new description is ignored and processing continues

Example

This example updates the schedules with the XML document in schedule_rev1.xml:

SES>updateAll schedule --UPDATE_METHOD=add --NOT_FOUND_METHOD=create --INPUT_FILE=schedule_rev1.xml
 
updateAll operation succeeded for type "schedule".
 
  1 object(s) with status UPDATE_SUCCEEDED

updateAll searchAttr

Updates all search attributes from the descriptions in an XML file. You can add LOVs to the default search attributes.

See Also

update searchAttr

Syntax

updateAll searchAttr --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]

updateAll searchAttr -i xml_filename -a method [-e key] [-t action]

Parameters

xml_filename

Path to the XML document that configures the object. See "searchAttr".

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

Note:

action

Action to take when an object does not exist:

create: A new object is created from the XML description and processing continues.
error: The command fails with an error. (Default)
ignore: The new description is ignored and processing continues

Example

This example updates a search attribute using the description in searchattrs_update.xml:

SES>updateAll searchAttr --UPDATE_METHOD=add --NOT_FOUND_METHOD=create --INPUT_FILE=searchattrs_update.xml
 
updateAll operation succeeded for type "searchAttr".
 
  1 object(s) with status UPDATE_SUCCEEDED

updateAll schedule

Sets one or more parameters for all schedules from an XML description.

See Also

update schedule

Syntax

updateAll schedule --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]

updateAll schedule -i xml_filename -a method [-t action]

Parameters

xml_filename

Path to the XML document that configures the object. See "schedule".

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

action

Action to take when an object does not exist:

create: A new object is created from the XML description and processing continues.
error: The command fails with an error. (Default)
ignore: The new description is ignored and processing continues

Example

This example updates the schedules with the XML document in schedule_rev1.xml:

SES>updateAll schedule --UPDATE_METHOD=add --NOT_FOUND_METHOD=create --INPUT_FILE=schedule_rev1.xml
 
updateAll operation succeeded for type "schedule".
 
  1 object(s) with status UPDATE_SUCCEEDED

updateAll singleSignOnSetting

Sets one or more parameters for the Single Sign-On settings from an XML description.

See Also

update singleSignOnSetting

Syntax

updateAll singleSignOnSetting --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action] [--ENCRYPT_KEY=key]

updateAll singleSignOnSetting -i xml_filename -a method [-t action] [-e key]

Parameters

xml_filename

Path to the XML document that configures the object. See "singleSignOnSetting".

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

key

action

Action to take when an object does not exist:

create: A new object is created from the XML description and processing continues.
error: The command fails with an error. (Default)
ignore: The new description is ignored and processing continues

Example

This example creates a new singleSignOnSetting object described in singleSignOnSetting_update.xml:

SES>updateAll singleSignOnSetting --UPDATE_METHOD=add --NOT_FOUND_METHOD=create --INPUT_FILE=singleSignOnSetting_update.xml --ENCRYPT_KEY=key2encrypt
 
updateAll operation succeeded for type "singleSignOnSetting".
 
  1 object(s) with status NOT_FOUND_CREATED

updateAll sourceGroup

Sets one or more parameters for all source groups from an XML description.

See Also

update sourceGroup

Syntax

updateAll sourceGroup --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]

updateAll sourceGroup -i xml_filename -a method [-t action]

Parameters

xml_filename

Path to the XML document that configures the object. See "sourceGroup".

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

action

Action to take when an object does not exist:

create: A new object is created from the XML description and processing continues.
error: The command fails with an error. (Default)
ignore: The new description is ignored and processing continues

Example

This example updates two source groups:

SES>updateAll sourceGroup --UPDATE_METHOD=add --NOT_FOUND_METHOD=ignore --INPUT_FILE=sourcegroups_update.xml
 
updateAll operation succeeded for type "sourceGroup".
 
  2 object(s) with status UPDATE_SUCCEEDED
  2 object(s) with status NOT_FOUND_IGNORED

updateAll sourceType

Sets one or more parameters for all source types from an XML description.

See Also

update sourceType

Syntax

updateAll sourceType --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]

updateAll sourceType -i xml_filename -a method [-e key] [-t action]

Parameters

xml_filename

Path to the XML document that configures the object. See "sourceType".

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

action

Action to take when an object does not exist:

create: A new object is created from the XML description and processing continues.
error: The command fails with an error. (Default)
ignore: The new description is ignored and processing continues.

Example

This example updates one source type and creates one source type:

SES>updateAll sourceType --UPDATE_METHOD=add --NOT_FOUND_METHOD=create --INPUT_FILE=sourcetypes_update.xml
 
updateAll operation succeeded for type "sourceType".
 
  1 object(s) with status UPDATE_SUCCEEDED
  1 object(s) with status NOT_FOUND_CREATED

updateAll storageArea

Changes the properties of all storage areas from an XML file.

Syntax

updateAll storageArea --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]

updateAll storageArea -n object_name -i xml_filename -a method [-t action]

Parameters

xml_filename

Path to the XML document that configures the object. See "storageArea".

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

action

Action to take when an object does not exist:

create: A new object is created from the XML description and processing continues.
error: The command fails with an error. (Default)
ignore: The new description is ignored and processing continues

Example

This example creates a storage area and updates the parameter settings of another storage area:

SES> updateAll storageArea --UPDATE_METHOD=remove --NOT_FOUND_METHOD=create --INPUT_FILE=storage.xml
 
updateAll operation succeeded for type "storageArea".
 
  1 object(s) with status UPDATE_SUCCEEDED
  1 object(s) with status NOT_FOUND_CREATED

updateAll suggContentProvider

Sets one or more parameters for all the suggested content providers from an XML description.

See Also

update suggContentProvider

Syntax

updateAll suggContentProvider --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]

updateAll suggContentProvider -i xml_filename -a method [-e key] [-t action]

Parameters

xml_filename

Path to the XML document that configures the object. See "suggContentProvider".

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

action

Action to take when an object does not exist:

create: A new object is created from the XML description and processing continues.
error: The command fails with an error. (Default)
ignore: The new description is ignored and processing continues.

Example

This example updates one suggested content provider and creates one suggested content provider:

SES>updateAll suggContentProvider --UPDATE_METHOD=add --NOT_FOUND_METHOD=create --INPUT_FILE=suggcontentprovider_update.xml
 
updateAll operation succeeded for type "suggContentProvider".
 
  1 object(s) with status UPDATE_SUCCEEDED
  1 object(s) with status NOT_FOUND_CREATED

updateAll suggestion

Sets one or more parameters for all the suggestions from an XML description.

See Also

update suggestion

Syntax

updateAll suggestion --INPUT_FILE=xml_filename --UPDATE_METHOD=method  [--NOT_FOUND_METHOD=action]

updateAll suggestion -i xml_filename -a method [-t action]

Parameters

xml_filename

Path to the XML document that configures the object. See "suggestion".

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

action

Action to take when an object does not exist:

create: A new object is created from the XML description and processing continues.
error: The command fails with an error. (Default)
ignore: The new description is ignored and processing continues

Example

This example updates two suggestions:

SES>updateAll suggestion --UPDATE_METHOD=add --NOT_FOUND_METHOD=create --INPUT_FILE=suggestions2.xml
 
updateAll operation succeeded for type "suggestion".
 
  2 object(s) with status UPDATE_SUCCEEDED

updateAll suggLink

Updates all suggested links from an XML description.

See Also

update suggLink

Syntax

updateAll suggLink --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]

updateAll suggLink -i xml_filename -a method [-t action]

Parameters

xml_filename

Path to the XML document that configures the object. See "suggLink".

method

Method to use when updating the properties of an object:

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

action

Action to take when an object does not exist:

create: A new object is created from the XML description and processing continues.
error: The command fails with an error. (Default)
ignore: The new description is ignored and processing continues

Example

This example updates one suggested link and creates two more:

SES>updateAll suggLink --UPDATE_METHOD=overwrite --NOT_FOUND_METHOD=create --INPUT_FILE=sugglinks_update.xml
 
updateAll operation succeeded for type "suggLink".
 
  1 object(s) with status UPDATE_SUCCEEDED
  2 object(s) with status NOT_FOUND_CREATED

updateAll tag

Sets one or more parameters for all the tags from an XML description.

See Also

update tag

Syntax

updateAll tag --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]

updateAll tag -i xml_filename -a method [-e key] [-t action]

Parameters

xml_filename

Path to the XML document that configures the object. See "tag".

method

Method to use when updating the properties of an object:

add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted in the XML file.
remove: Removes existing properties that are defined in the XML file.
overwrite: Replaces the existing property values with the new values.

action

Action to take when an object does not exist:

create: A new object is created from the XML description and processing continues.
error: The command fails with an error. (Default)
ignore: The new description is ignored and processing continues.

Example

This example updates one tag and creates another tag:

SES>updateAll tag --UPDATE_METHOD=add --NOT_FOUND_METHOD=create --INPUT_FILE=tags_update.xml
 
updateAll operation succeeded for type "tag".
 
  1 object(s) with status UPDATE_SUCCEEDED
  1 object(s) with status NOT_FOUND_CREATED