This chapter describes all the searchadmin
commands of Oracle SES.
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
Activates a cluster tree.
A clusterTree
object is active when it is created. You must activate a clusterTree
only after deactivating it.
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.
activate identityPlugin --JAR_FILE=jar_filename --MANAGER_CLASS=class [--INPUT_FILE=xml_filename --ENCRYPT_KEY=key]
or
activate identityPlugin --JAR_FILE=jar_filename --MANAGER_CLASS=class [-i xml_filename -e key]
Content of a <search:jarFilePath>
element in the XML document.
Content of a <search:managerClassName>
element in the XML document.
Path to an XML document that contains parameter settings for the object. See "identityPlugin".
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.
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.
Activates a schedule.
activate schedule --NAME=object_name [--INPUT_FILE=xml_filename]
or
activate schedule -n object_name [-i xml_filename]
Content of a <search:name>
element in the XML document.
Path to the XML document that describes the object. See "schedule".
Activates a Single Sign-On setting.
activate singleSignOnSetting --NAME=object_name
or
activate singleSignOnSetting -n object_name]
Activates a skin bundle.
activate skinBundle --NAME=object_name [--INPUT_FILE=xml_filename] [--ATTACHMENT_LIST=list_filename]
or
activate skinBundle -n object_name [-i xml_filename] [-h list_filename]
Content of a <search:name>
element in the XML document.
Path to the XML document that describes the object. See "skinBundle".
Path to the text file that lists the files in the skin bundle. See the Notes for "create skinBundle".
Activates a suggested content provider.
activate suggContentProvider --NAME=object_name
or
activate suggContentProvider -n object_name]
Creates an alternate word pair from an XML description.
create altWord --KEYWORD=keyword --ALT_KEYWORD=alt_keyword --INPUT_FILE=xml_filename
or
create altWord --KEYWORD=keyword --ALT_KEYWORD=alt_keyword -i xml_filename
Content of a <search:keyword>
element in the XML document.
Content of a <search:altKeyword>
element in the XML document.
Path to the XML document that defines the object. See "altWord".
Creates a boostedUrl object from an XML description.
The URL of a document being boosted.
The exact query term that returns the boosted URL.
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.
Creates classification from an XML description.
create classification --NAME=object_name --INPUT_FILE=xml_filename
or
create classification -n object_name -i xml_filename
Content of a <search:name>
element in the XML document.
Path to the XML document that defines the object. See "classification".
Creates a cluster tree from an XML description.
create clusterTree --NAME=object_name --INPUT_FILE=xml_filename
or
create clusterTree -n object_name -i xml_filename
Content of a <search:name>
element in the XML document.
Path to the XML document that defines the object. See "clusterTree".
Creates a document service instance from an XML description.
create docServiceInstance --NAME=object_name --INPUT_FILE=xml_filename [--ENCRYPT_KEY=key]
or
create docServiceInstance -n object_name -i xml_filename [-e key]
Content of a <search:name>
element in the XML document.
Path to the XML document that defines the object. See "docServiceInstance".
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.
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.
Creates a document service manager from an XML description.
create docServiceManager --NAME=object_name --INPUT_FILE=xml_filename]
or
create docServiceManager -n object_name -i xml_filename]
Content of a <search:name>
element in the XML document.
Path to the XML document that defines the object. See "docServiceManager".
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.
Creates a document service pipeline from an XML description.
create docServicePipeline --NAME=object_name --INPUT_FILE=xml_filename
or
create docServicePipeline -n object_name -i xml_filename
Content of a <search:name>
element in the XML document.
Path to the XML document that defines the object. See "docServicePipeline".
Creates a facet tree from an XML description.
create facetTree --NAME=object_name --INPUT_FILE=xml_filename
or
create facetTree -n object_name -i xml_filename
Content of a <search:name>
element in the XML document.
Path to the XML document that defines the object. See "facetTree".
Creates an identity plug-in from an XML description.
create identityPlugin --JAR_FILE=jar_filename --MANAGER_CLASS=class --INPUT_FILE=xml_filename]
or
create identityPlugin --JAR_FILE=jar_filename --MANAGER_CLASS=class -i xml_filename]
Content of a <search:jarFilePath>
element in the XML document.
Content of a <search:managerClassName>
element in the XML document.
Path to the XML document that defines the object. See "identityPlugin".
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.
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.
Creates an index profile from an XML description.
create indexProfile --NAME=object_name --INPUT_FILE=xml_filename
or
create indexProfile -n object_name -i xml_filename
Content of a <search:name>
element in the XML document.
Path to the XML document that defines the object. See "indexProfile".
Creates a lexer from an XML document.
create lexer --NAME=object_name --INPUT_FILE=xml_filename
or
create lexer -n object_name -i xml_filename
Content of a <search:name>
element in the XML document.
Path to the XML document that defines the object. See "lexer".
Creates a proxy log-in (federation trusted entity) from an XML description.
create proxyLogin --NAME=object_name --INPUT_FILE=xml_filename [--ENCRYPT_KEY=key]
or
create proxyLogin -n object_name -i xml_filename [-e key]
Content of a <search:name>
element in the XML document.
Path to the XML document that defines the object. See "proxyLogin".
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.
Creates a schedule from an XML description. You must create the source before creating the schedule. See create source.
create schedule --NAME=object_name --INPUT_FILE=xml_filename
or
create schedule -n object_name -i xml_filename
Content of a <search:name>
element in the XML document.
Path to the XML document that defines the object. See "schedule".
Creates a custom search attribute from an XML description.
create searchAttr --NAME=object_name --INPUT_FILE=xml_filename
or
create searchAttr -n object_name -i xml_filename
Content of a <search:name>
element in the XML document.
Path to the XML document that defines the object. See "searchAttr".
Creates a skin bundle from an XML description and a structured directory of files.
create skinBundle --NAME=object_name --INPUT_FILE=xml_filename --ATTACHMENT_LIST=list_filename
or
create searchAttr -n object_name -i xml_filename -h list_filename
Content of a <search:name>
element in the XML document.
Path to the XML document that defines the object. See "skinBundle".
Path to the text file that lists the files in the skin bundle. See the 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
Creates a source from an XML description.
create source --NAME=object_name --INPUT_FILE=xml_filename [--ENCRYPT_KEY=key]
or
create source -n object_name -i xml_filename [-e key]
Content of a <search:name>
element in the XML document.
Path to the XML document that defines the object. See "source".
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.
Creates a source group from an XML description.
create sourceGroup --NAME=object_name --INPUT_FILE=xml_filename
or
create sourceGroup -n object_name -i xml_filename
Content of a <search:name>
element in the XML document.
Path to the XML document that defines the object. See "sourceGroup".
Creates a source type from an XML description.
create sourceType --NAME=object_name --INPUT_FILE=xml_filename
or
create sourceType -n object_name -i xml_filename
Content of a <search:name>
element in the XML document.
Path to the XML document that defines the object. See "sourceType".
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.
create storageArea --NAME=object_name --INPUT_FILE=xml_filename
or
create storageArea -n object_name -i xml_filename
Content of a <search:name>
element in the XML document.
Path to the XML document that defines the object. See "storageArea".
Creates a suggested content provider from an XML description.
create suggContentProvider --NAME=object_name --INPUT_FILE=xml_filename
or
create suggContentProvider -n object_name -i xml_filename
Content of a <search:name>
element in the XML document.
Path to the XML document that defines the object. See "suggContentProvider".
Creates a suggestion from an XML description.
create suggestion --NAME=object_name --INPUT_FILE=xml_filename
or
create suggestion -n object_name -i xml_filename
Content of a <search:name>
element in the XML document.
Path to the XML document that defines the object. See "suggestion".
Creates a suggested link from an XML description.
create suggLink --KEYWORD=keyword --LINK_URL=url --INPUT_FILE=xml_filename
or
create suggLink --KEYWORD=keyword --LINK_URL=url -i xml_filename
Content of the <search:keyword>
element in the XML document.
Content of the <search:linkUrl>
element in the XML document.
Path to the XML document that defines the suggested link. See "suggLink".
Creates a tag from an XML description.
create tag --NAME=object_name --INPUT_FILE=xml_filename
or
create tag -n object_name -i xml_filename
Content of a <search:name>
element in the XML document.
Path to the XML document that defines the object. See "tag".
Creates a thesaurus from an XML description.
create thesaurus --NAME=object_name --INPUT_FILE=xml_filename
or
create thesaurus -n object_name -i xml_filename
Content of a <search:name>
element in the XML document.
Path to the XML document that defines the object. See "thesaurus".
Creates all alternate words described in an XML file.
createAll altWord --INPUT_FILE=xml_filename [--DUPE_METHOD=action]
or
createAll altWord -i xml_filename [-d action]
Path to the XML document that contains the object descriptions. See "altWord".
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.
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
Creates all the boostedUrl objects described in an XML document.
createAll boostedUrl --INPUT_FILE=xml_filename [--DUPE_METHOD=action]
or
createAll boostedUrl -i xml_filename [-d action]
Path to the XML document that contains the object descriptions. See "boostedUrl".
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.
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
Creates all the authorizedPrincipal objects described in an XML document.
createAll authorizedPrincipal --INPUT_FILE=xml_filename [--DUPE_METHOD=action]
or
createAll authorizedPrincipal -i xml_filename [-d action]
Path to the XML document that contains the object descriptions. See "authorizedPrincipal".
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.
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
Creates all the classifications described in an XML file.
createAll classification --INPUT_FILE=xml_filename [--DUPE_METHOD=action [--IGNORE_INVALID_STATE=state]]
or
createAll classification -i xml_filename [-d action [-s state]]
Path to the XML document that contains the object descriptions. See "classification".
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.
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)
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
Creates all cluster trees described in an XML file.
createAll clusterTree --INPUT_FILE=xml_filename [--DUPE_METHOD=action [--IGNORE_INVALID_STATE=state]]
or
createAll clusterTree -i xml_filename [-d action [-s state]]
Path to the XML document that contains the object descriptions. See "clusterTree".
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.
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)
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
Creates all document service instances described in an XML file.
createAll docServiceInstance --INPUT_FILE=xml_filename [--DUPE_METHOD=action]
or
createAll docServiceInstance -i xml_filename [-d action]
Path to the XML document that contains the object descriptions. See "docServiceInstance".
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.
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
Creates all document service managers described in an XML file.
createAll docServiceManager --INPUT_FILE=xml_filename [--DUPE_METHOD=action]
or
createAll docServiceManager -i xml_filename [-d action]
Path to the XML document that contains the object descriptions. See "docServiceManager".
Action to take when an object already exists:
error
: The createAll
command fails with an error. (Default)
ignore
: The existing object description is kept.
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.
Creates all document service pipelines described in an XML document.
createAll docServicePipeline --INPUT_FILE=xml_filename [--DUPE_METHOD=action]
or
createAll docServicePipeline -i xml_filename [-d action]
Path to the XML document that contains the object descriptions. See "docServicePipeline".
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.
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
Creates all facet trees described in an XML document.
createAll facetTree --INPUT_FILE=xml_filename [--DUPE_METHOD=action]
or
createAll facetTree -i xml_filename [-d action]
Path to the XML document that contains the object descriptions. See "facetTree".
Action to take when an object already exists:
error
: The createAll
command fails with an error. (Default)
ignore
: The existing object description is kept.
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
Creates all identity plug-ins described in an XML file.
createAll identityPlugin --INPUT_FILE=xml_filename [--DUPE_METHOD=action] [--ENCRYPT_KEY=key]
or
createAll identityPlugin -i xml_filename [-d action [-s state]] [-e key]
Path to the XML document that contains the object descriptions. See "identityPlugin".
Action to take when an object already exists:
error
: The createAll
command fails with an error. (Default)
ignore
: The existing object description is kept.
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.
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
Creates all index profiles described in an XML document
createAll indexProfile --INPUT_FILE=xml_filename [--DUPE_METHOD=action]
or
createAll indexProfile -i xml_filename [-d action]
Path to the XML document that contains the object descriptions. See "indexProfile".
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.
Creates all lexers described in an XML document.
createAll lexer --INPUT_FILE=xml_filename [--DUPE_METHOD=action]
or
createAll lexer -i xml_filename [-d action]
Path to the XML document that contains the object descriptions. See "lexer".
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.
Creates all proxy log-ins described in an XML file.
createAll proxyLogin --INPUT_FILE=xml_filename [--DUPE_METHOD=action] [--ENCRYPT_KEY=key]
or
createAll proxyLogin -i xml_filename [-d action] [-e key]
Path to the XML document that contains the object descriptions. See "proxyLogin".
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.
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.
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
Creates all schedules described in an XML file.
createAll schedule --INPUT_FILE=xml_filename [--DUPE_METHOD=action [--IGNORE_INVALID_STATE=state]]
or
createAll schedule -i xml_filename [-d action [-s state]]
Path to the XML document that contains the object descriptions. See "schedule".
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.
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)
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
Creates all custom search attributes described in an XML file.
createAll searchAttr --INPUT_FILE=xml_filename [--DUPE_METHOD=action]
or
createAll searchAttr -i xml_filename [-d action]
Path to the XML document that contains the object descriptions. See "searchAttr".
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.
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
Creates all sources described in an XML file.
createAll source --INPUT_FILE=xml_filename [--DUPE_METHOD=action] [--ENCRYPT_KEY=key]
or
createAll source -i xml_filename [-d action] [-e key]
Path to the XML document that contains the object descriptions. See "source".
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.
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.
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
Creates all source groups described in an XML file.
createAll sourceGroup --INPUT_FILE=xml_filename [--DUPE_METHOD=action]
or
createAll creatable_type -i xml_filename [-d action]
Path to the XML document that contains the object descriptions. See "sourceGroup".
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.
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
Creates all source types described in an XML file.
createAll sourceType --INPUT_FILE=xml_filename [--DUPE_METHOD=action]
or
createAll sourceType -i xml_filename [-d action]
Path to the XML document that contains the object descriptions. See "sourceType".
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.
Creates all of the storage areas described in an XML document.
createAll storageArea --INPUT_FILE=xml_filename [--DUPE_METHOD=action] [--IGNORE_INVALID_STATE=state]
or
createAll storageArea -i xml_filename [-d action] [-s state]
Path to the XML document that contains the object descriptions. See "clusterTree".
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.
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)
Creates all the suggested content providers described in an XML file.
createAll suggContentProvider --INPUT_FILE=xml_filename [--DUPE_METHOD=action]
or
createAll suggContentProvider -i xml_filename [-d action]
Path to the XML document that contains the object descriptions. See "suggContentProvider".
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.
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)
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
Creates all the suggestions described in an XML file.
createAll suggestion --INPUT_FILE=xml_filename [--DUPE_METHOD=action [--IGNORE_INVALID_STATE=state]]
or
createAll suggestion -i xml_filename [-d action [-s state]]
Path to the XML document that contains the object descriptions. See "suggestion".
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.
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)
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
Creates all suggested links described in an XML file.
createAll suggLink --INPUT_FILE=xml_filename [--DUPE_METHOD=action]
or
createAll suggLink -i xml_filename [-d action]
Path to the XML document that contains the object descriptions. See "suggLink".
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.
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
Creates all the tags described in an XML file.
createAll tag --INPUT_FILE=xml_filename [--DUPE_METHOD=action]
or
createAll tag -i xml_filename [-d action]
Path to the XML document that contains the object descriptions. See "tag".
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.
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
Deactivates an identity plug-in.
Content of a <search:jarFilePath>
element in the XML document.
Content of a <search:managerClassName>
element in the XML document.
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.
Deactivates a Single Sign-On setting.
deactivate singleSignOnSetting --NAME=object_name
or
deactivate singleSignOnSetting -n object_name
Deactivates a suggested content provider.
deactivate suggContentProvider --NAME=object_name
or
deactivate suggContentProvider -n object_name
Deletes a creatable object.
A creatable type:
altWord boostedUrl classification clusterTree docServiceManager identityPlugin indexProfile lexer proxyLogin schedule searchAttr skinBundle source sourceGroup sourceType storageArea suggContentProvider suggestion suggLink tag thesaurus
Unique identifier of the object. See the object description in Chapter 2, "Administration Object Types."
Deletes all objects of a specified type.
Caution:
This operation deletes all objects, including those supplied with Oracle SES. Use akey_pattern
to limit the operation to those objects you want to delete, especially when deleting identityPlugin
, sourceType
, and storageArea
objects.deleteAll creatable_type [--IGNORE_INVALID_STATE=state] [key_pattern]
or
deleteAll creatable_type [-s state] [key_pattern]
A creatable type:
altWord boostedUrl classification clusterTree docServiceManager identityPlugin indexProfile lexer proxyLogin schedule searchAttr skinBundle source sourceGroup sourceType storageArea suggContentProvider suggestion suggLink tag
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)
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.
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
Deletes objects of a specified type that are listed in a text file.
deleteList creatable_type --KEYS_FILE=key_filename [--IGNORE_NOT_FOUND=action] [--IGNORE_INVALID_STATE=state]
or
deleteList creatable_type -k key_filename [-f action] [-s state]
A creatable type:
altWord boostedUrl classification clusterTree docServiceManager identityPlugin indexProfile lexer proxyLogin schedule searchAttr skinBundle source sourceGroup sourceType storageArea suggContentProvider suggestion suggLink tag
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
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)
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)
Returns the XML description of an object.
export creatable_type object_key [--OUTPUT_FILE=output_file] [--ENCRYPT_KEY=key]
or
export creatable_type object_key [-o output_file] [-e key]
A creatable type:
altWord boostedUrl classification clusterTree identityPlugin indexProfile lexer proxyLogin schedule searchAttr singleSignOnSetting skinBundle source sourceGroup sourceType storageArea suggContentProvider suggestion suggLink tag thesaurus
Unique identifier of the object. See the object description in Chapter 2, "Administration Object Types."
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.
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.
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.
Returns the XML description of an object.
A universal type:
autoSuggestion classificationMappings clustering crawlerSettings index indexOptimizer languageBasedTokenization partitionConfig proxy queryConfig queryUIConfig queryUIFacets queryUISourceGroups relevanceRanking resultList tagging
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.
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>
Returns the XML descriptions of all objects of a specific type.
exportAll creatable_type [key_pattern] [--OUTPUT_FILE=output_file] [--ENCRYPT_KEY=key]
or
exportAll creatable_type [key_pattern] [-o output_file] [-e key]
A creatable object type:
altWord boostedUrl classification clusterTree identityPlugin indexProfile lexer proxyLogin schedule searchAttr singleSignOnSetting skinBundle source sourceGroup sourceType storageArea suggContentProvider suggestion suggLink tag
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.
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.
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.
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>
Returns the XML descriptions of a list of objects of the same type.
exportList creatable_type --KEYS_FILE=key_filename [--IGNORE_NOT_FOUND=action] [--ENCRYPT_KEY=key]
or
exportList creatable_type -k key_filename [-f action] [-e key]
A creatable object type:
altWord boostedUrl classification clusterTree identityPlugin indexProfile lexer proxyLogin schedule searchAttr singleSignOnSetting skinBundle source sourceGroup sourceType storageArea suggContentProvider suggestion suggLink tag
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"
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)
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.
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>
Returns the object keys for the specified object type.
getAllObjectKeys creatable_type --OUTPUT_FILE=output_file [key_pattern...]
or
getAllObjectKeys creatable_type -o output_file [key_pattern...]
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
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.
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.
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]
Returns the current state of all cluster trees as an XML document.
getAllStates clusterTree [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=status] [key_pattern...]
or
getAllStates clusterTree [-o output_file] [-l status] [key_pattern...]
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.
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.
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>
Returns the current state of all identity plug-ins as an XML document.
getAllStates identityPlugin [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=status] [key_pattern...]
or
getAllStates identityPlugin [-o output_file] [-l status] [key_pattern...]
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.
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.
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>
Returns the current state of all schedules as an XML document.
getAllStates schedule [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=state_property] [key_pattern...]
or
getAllStates schedule [-o output_file] [-l state_property] [key_pattern...]
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.
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.
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.
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>
Returns the current state of all Single Sign-On settings as an XML document.
getAllStates singleSignOnSetting [--OUTPUT_FILE=output_file]
or
getAllStates singleSignOnSetting [-o 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.
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>
Returns the current state of all skin bundles as an XML document.
getAllStates skinBundle [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=state_property] [key_pattern...]
or
getAllStates skinBundle [-o output_file] [-l state_property] [key_pattern...]
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.
List of one or more state properties: lastModifiedDate
or status
. Separate multiple properties with commas. All state properties are returned by default.
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.
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>
Returns the current state of all the suggested content providers as an XML document.
getAllStates suggContentProvider [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=status]
or
getAllStates suggContentProvider [-o output_file] [-l status]
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.
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>
Returns the current state of auto suggestion configuration as an XML document.
getState autoSuggestion [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=status]
or
getState autoSuggestion [-o output_file] [-l status]
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.
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>
Returns the current state of clustering as an XML document.
getState clustering [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=status]
or
getState clustering [-o output_file] [-l status]
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.
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>
Returns the current state of a cluster tree as an XML document.
getState clusterTree --NAME=object_name [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=status]
or
getState clusterTree -n object_name [-o output_file] [-l status]
Content of a <search:name>
element in the XML document.
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.
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>
Returns the current state of an identity plug-in as an XML document.
getState identityPlugin --JAR_FILE=jar_filename --MANAGER_CLASS=class [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=status]
or
getState identityPlugin --JAR_FILE=jar_filename --MANAGER_CLASS=class [-o output_file] [-l status]
Content of a search:jarFilePath
element in the XML document.
Content of a search:managerClassName
element in the XML document.
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.
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>
Returns the percent of fragmentation of the index as an XML document.
getState index [--OUTPUT_FILE=output_file][--PROPERTY_LIST=estimatedFragmentation]
or
getState index [-o output_file] [-l estimatedFragmentation]
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.
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>
Returns the current state of index optimization as an XML document.
getState indexOptimizer [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=state_properties]
or
getState indexOptimizer [-o output_file] [-l state_properties]
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.
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.
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>
Returns the current state of partitionConfig configuration as an XML document.
getState partitionConfig [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=status]
or
getState partitionConfig [-o output_file] [-l status]
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.
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>
Returns the current state of queryUIFacets configuration as an XML document.
getState queryUIFacets [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=status]
or
getState queryUIFacets [-o output_file] [-l status]
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.
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>
Returns the current state of the result list customizations as an XML document.
getState resultList [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=status]
or
getState resultLIst [-o 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.
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>
Returns the current state of a schedule as an XML document.
getState schedule --NAME=object_name [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=state_properties]
or
getState schedule -n object_name [-o output_file] [-l state_properties]
Content of a <search:name>
element in the XML document.
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.
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.
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>
Returns the current state of a Single Sign-On setting as an XML document.
getState singleSignOnSetting --NAME=object_name [--OUTPUT_FILE=output_file]
or
getState singleSignOnSetting -n object_name [-o output_file]
Content of a <search:name>
element in the XML document.
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.
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>
Returns the current state of a skin bundle as an XML document.
getState skinBundle --NAME=object_name [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=state_properties]
or
getState skinBundle -n object_name [-o output_file] [-l state_properties]
Content of a <search:name>
element in the XML document.
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.
One or more of these state properties: lastModifiedDate
and status
. Separate multiple properties with commas. All state properties are returned by default.
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>
Returns the current state of a suggested content provider as an XML document.
getState suggContentProvider --NAME=object_name [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=status]
or
getState suggContentProvider -n object_name [-o output_file] [-l status]
Content of a <search:name>
element in the XML document.
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.
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>
Returns the current state of the tagging configuration as an XML document.
getState tagging [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=status]
or
getState tagging [-o output_file] [-l status]
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.
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>
Returns the current state of a list of objects of the same type.
getStateList clusterTree --KEYS_FILE=key_filename [--OUTPUT_FILE=output_file]
or
getStateList clusterTree -k key_filename [-o output_file]
Path to a text file that identifies the objects. Each line of the file contains an object key. For example:
--NAME="Topic Tree"
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.
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>
Returns the current state of a list of identity plugin objects.
getStateList object_type --KEYS_FILE=key_filename [--OUTPUT_FILE=output_file]
or
getStateList object_type -k key_filename [-o output_file]
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
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.
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>
Returns the current state of a list of schedules.
getStateList schedule --KEYS_FILE=key_filename [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=state_properties]
or
getStateList schedule -k key_filename [-o output_file] [-l state_properties]
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"
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.
One or more state properties: lastCrawled
, logFilePath
, nextCrawl
, scheduleError
, and status
. Separate multiple properties with commas. All state properties are returned by default.
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>
Returns the current state of list of Single Sign-On settings.
getStateList singleSignOnSetting --KEYS_FILE=key_filename [--OUTPUT_FILE=output_file]
or
getStateList singleSignOnSetting -k key_filename [-o output_file]
Path to a text file that identifies the objects. Each line of the file contains an object key. For example:
--NAME="OAM" --NAME="OSSO"
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.
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.
Returns the current state of a list of skin bundles.
getStateList skinBundle --KEYS_FILE=key_filename [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=state_properties]
or
getStateList skinBundle -k key_filename [-o output_file] [-l state_properties]
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"
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.
One or more state properties: lastModifiedDate
and status
. Separate multiple properties with commas. All state properties are returned by default.
Returns the current state of a list of suggested content provider objects.
getStateList suggContentProvider --KEYS_FILE=key_filename [--OUTPUT_FILE=output_file]
or
getStateList suggContentProvider -k key_filename [-o output_file]
Path to a text file that identifies the objects. Each line of the file contains an object key. For example:
--NAME="Provider1"
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.
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>
Starts jobs for applying filter expression specified in <search:filterExpression>
to suggestion keywords that have already been populated from queries.
Stops a schedule from initiating a crawl, or stops the crawler if it has already started.
Changes the properties of an alternate word from an XML file.
update altWord --KEYWORD=keyword --ALT_KEYWORD=alt_keyword object_key --INPUT_FILE=xml_filename --UPDATE_METHOD=method
or
update altWord --KEYWORD=keyword --ALT_KEYWORD=alt_keyword -i xml_filename -a method
Content of a <search:keyword>
element in the XML document.
Content of a <search:altKeyword>
element in the XML document.
Path to the XML document that configures the object. See "altWord".
Method to use when updating the properties of an object:
overwrite
: Replaces the existing property values with the new values.
Sets one or more auto suggestion properties from an XML description.
update autoSuggestion --UPDATE_METHOD=method --INPUT_FILE=xml_filename
or
update autoSuggestion -a method -i xml_filename
Method to use when updating the properties of an object:
overwrite
: Replaces the existing property values with the new values.
Path to the XML document that configures the object. See "clustering".
Changes the properties of a boosted URL from an XML document.
update boostedUrl --DOC_URL=url --QUERY=query_term --INPUT_FILE=xml_filename --UPDATE_METHOD=method
or
update boostedUrl --DOC_URL=url --QUERY=query_term -i xml_filename -a method
The URL of a document being boosted.
The exact query term that returns the boosted URL.
Path to the XML document that configures the object. See "boostedUrl".
Method to use when updating the properties of an object:
overwrite
: Replaces the existing property values with the new values.
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
Updates a classification.
update classification --NAME=object_name --INPUT_FILE=xml_filename --UPDATE_METHOD=method
or
update classification -n object_name -i xml_filename -a method
Content of a <search:name>
element in the XML document.
Path to the XML document that configures the object. See "classification".
Method to use when updating the properties of an object:
overwrite
: Replaces the existing property values with the new values.
Sets one or more classificationMappings properties from an XML description.
update classificationMappings --UPDATE_METHOD=method --INPUT_FILE=xml_filename
or
update classificationMappings -a method -i xml_filename
Method to use when updating the properties of an object:
overwrite
: Replaces the existing property values with the new values.
Path to the XML document that configures the object. See "classificationMappings".
Sets one or more clustering properties from an XML description.
update clustering --UPDATE_METHOD=method --INPUT_FILE=xml_filename
or
update clustering -a method -i xml_filename
Method to use when updating the properties of an object:
overwrite
: Replaces the existing property values with the new values.
Path to the XML document that configures the object. See "clustering".
Changes the properties of a cluster tree from an XML file.
update clusterTree --NAME=object_name --INPUT_FILE=xml_filename --UPDATE_METHOD=method
or
update clusterTree -n object_key -i xml_filename -a method
Content of a <search:name>
element in the XML document.
Path to the XML document that configures the object. See "clusterTree".
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.
Sets one or more global crawler properties from an XML description.
update crawlerSettings --UPDATE_METHOD=method --INPUT_FILE=xml_filename
or
update crawlerSettings -a method -i xml_filename
Method to use when updating the properties of an object:
overwrite
: Replaces the existing property values with the new values.
Path to the XML document that configures the object. See "crawlerSettings".
Sets one or more parameters of a document service instance from an XML description.
update docServiceInstance --NAME=object_name --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--ENCRYPT_KEY=key]
or
update docServiceInstance -n object_name -i xml_filename -a method [-e key]
Content of a <search:name>
element in the XML document.
Path to the XML document that configures the object. See "docServiceInstance".
Method to use when updating the properties of an object:
overwrite
: Replaces the existing property values with the new values.
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.
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.
Sets one or more parameters of a document service pipeline from an XML description.
update docServicePipeline --UPDATE_METHOD=method --INPUT_FILE=xml_filename
or
update docServicePipeline -a method -i xml_filename
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.
Path to the XML document that configures the object. See "docServicePipeline".
Updates a facet tree from an XML description.
update facetTree --UPDATE_METHOD=method --INPUT_FILE=xml_filename
or
update facetTree -a method -i xml_filename
Content of a <search:name>
element in the XML document.
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.
Path to the XML document that defines the object. See "facetTree".
Sets one or more global boundary rules from an XML document.
update globalBoundaryRules --UPDATE_METHOD=method --INPUT_FILE=xml_filename
or
update globalBoundaryRules -a method -i xml_filename
Method to use when updating the properties of an object:
overwrite
: Replaces the existing property values with the new values.
Path to the XML document that configures the object. See "globalBoundaryRules".
Sets one or more parameters of a global document type from an XML document.
update globalDocumentTypes --UPDATE_METHOD=method --INPUT_FILE=xml_filename
or
update globalDocumentTypes -a method -i xml_filename
Method to use when updating the properties of an object:
overwrite
: Replaces the existing property values with the new values.
Path to the XML document that configures the object. See "globalDocumentTypes".
Sets one or more index properties from an XML description.
update index --UPDATE_METHOD=method --INPUT_FILE=xml_filename
or
update index -a method -i xml_filename
Method to use when updating the properties of an object:
overwrite
: Replaces the existing property values with the new values.
Path to the XML document that configures the object. See "index".
Sets one or more index optimizer properties from an XML description.
update indexOptimizer --UPDATE_METHOD=method --INPUT_FILE=xml_filename
or
update indexOptimizer -a method -i xml_filename
Method to use when updating the properties of an object:
overwrite
: Replaces the existing property values with the new values.
Path to the XML document that configures the object. See "indexOptimizer".
Sets one or more parameters of an index profile from an XML document.
update indexProfile --UPDATE_METHOD=method --INPUT_FILE=xml_filename
or
update indexProfile -a method -i xml_filename
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.
Path to the XML document that configures the object. See "indexProfile".
Sets one or more parameters for language-based tokenization from an XML document.
update languageBasedTokenization --UPDATE_METHOD=method --INPUT_FILE=xml_filename
or
update languageBasedTokenization -a method -i xml_filename
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.
Path to the XML document that configures the object. See "languageBasedTokenization".
Sets one or more parameters of a lexer from an XML document.
update lexer --UPDATE_METHOD=method --INPUT_FILE=xml_filename
or
update lexer -a method -i xml_filename
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.
Path to the XML document that configures the object. See "lexer".
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.
update partitionConfig --UPDATE_METHOD=method --INPUT_FILE=xml_filename update partitionConfig -a method -i xml_filename
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.
Path to the XML document that configures the object. See "partitionConfig".
Sets HTTP proxy server configuration parameters from an XML description.
update proxy --UPDATE_METHOD=method --INPUT_FILE=xml_filename
or
update proxy -a method -i xml_filename
Method to use when updating the properties of an object:
overwrite
: Replaces the existing property values with the new values.
Path to the XML document that configures the object. See "proxy".
Changes the properties of a proxy log-in (federation entrusted entity) from an XML description.
update proxyLogin --NAME=object_name --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--ENCRYPT_KEY=key]
or
update proxyLogin -n object_name -i xml_filename -a method [-e key]
Content of a <search:name>
element in the XML document.
Path to the XML document that configures the object. See "proxyLogin".
Method to use when updating the properties of an object:
overwrite
: Replaces the existing property values with the new values.
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.
Sets one or more query configuration parameters from an XML description.
update queryConfig --UPDATE_METHOD=method --INPUT_FILE=xml_filename
or
update queryConfig -a method -i xml_filename
Method to use when updating the properties of an object:
overwrite
: Replaces the existing property values with the new values.
Path to the XML document that configures the object. See "queryConfig".
Sets one or more queryUIConfig properties from an XML description.
update queryUIConfig --UPDATE_METHOD=method --INPUT_FILE=xml_filename
or
update queryUIConfig -a method -i xml_filename
Method to use when updating the properties of an object:
overwrite
: Replaces the existing property values with the new values.
Path to the XML document that configures the object. See "queryUIConfig".
Sets one or more queryUIFacets properties from an XML description.
update queryUIFacets --UPDATE_METHOD=method --INPUT_FILE=xml_filename
or
update queryUIFacets -a method -i xml_filename
Method to use when updating the properties of an object:
overwrite
: Replaces the existing property values with the new values.
Path to the XML document that configures the object. See "queryUIFacets".
Sets one or more queryUISourceGroups properties from an XML description.
update queryUISourceGroups --UPDATE_METHOD=method --INPUT_FILE=xml_filename
or
update queryUISourceGroups -a method -i xml_filename
Method to use when updating the properties of an object:
overwrite
: Replaces the existing property values with the new values.
Path to the XML document that configures the object. See "queryUISourceGroups".
Sets one or more relevance ranking parameters from an XML description.
update relevanceRanking --UPDATE_METHOD=method --INPUT_FILE=xml_filename
or
update relevanceRanking -a method -i xml_filename
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.
Path to the XML document that configures the object. See "relevanceRanking".
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.
update resultList --UPDATE_METHOD=method --INPUT_FILE=xml_filename
or
update resultList -a method -i xml_filename
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.
Path to the XML document that configures the object. See "resultList".
Changes the properties of a schedule from an XML file.
update schedule --NAME=object_name --INPUT_FILE=xml_filename --UPDATE_METHOD=method
or
update creatable_type -n object_name -i xml_filename -a method
Content of a <search:name>
element in the XML document.
Path to the XML document that configures the object. See "schedule".
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.
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.
update searchAttr --NAME=object_name --INPUT_FILE=xml_filename --UPDATE_METHOD=method
or
update searchAttr -n object_name -i xml_filename -a method
Content of a <search:name>
element in the XML document.
Path to the XML document that configures the object. See "searchAttr".
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:
Theadd
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.Updates a Single Sign-On setting.
update singleSignOnSetting --NAME=object_name --INPUT_FILE=xml_filename --UPDATE_METHOD=method
or
update singleSignOnSetting -n object_name -i xml_filename -a method
Content of a <search:name>
element in the XML document.
Path to the XML document that configures the object. See "singleSignOnSetting".
Method to use when updating the properties of an object:
overwrite
: Replaces the existing property values with the new values.
Changes the properties of a skin bundle from an XML file.
update skinBundle --NAME=object_name --INPUT_FILE=xml_filename [--ATTACHMENT_LIST=list_filename] --UPDATE_METHOD=method
or
update skinBundle -n object_name -i xml_filename [-h list_filename] -a method
Content of a <search:name>
element in the XML document.
Path to the XML document that configures the object. See "skinBundle".
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 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.
Changes the properties of a source from an XML file.
update source --NAME=object_name --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--ENCRYPT_KEY=key]
or
update source -n object_name -i xml_filename -a method [-e key]
Content of a <search:name>
element in the XML document.
Path to the XML document that configures the object. See "source".
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.
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.
Changes the properties of a source group from an XML file.
update sourceGroup --NAME=object_name --INPUT_FILE=xml_filename --UPDATE_METHOD=method
or
update sourceGroup -n object_name -i xml_filename -a method
Content of a <search:name>
element in the XML document.
Path to the XML document that configures the object. See "sourceGroup".
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.
Changes the properties of a source type from an XML file.
update sourceType --NAME=object_name --INPUT_FILE=xml_filename --UPDATE_METHOD=method
or
update sourceType -n object_name -i xml_filename -a method
Content of a <search:name>
element in the XML document.
Path to the XML document that configures the object. See "sourceType".
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.
Changes the properties of a storage area from an XML file.
update storageArea --NAME=object_name --INPUT_FILE=xml_filename --UPDATE_METHOD=method
or
update storageArea -n object_name -i xml_filename -a method
Content of a <search:name>
element in the XML document.
Path to the XML document that configures the object. See "storageArea".
Method to use when updating the properties of an object:
overwrite
: Replaces the existing property values with the new values.
Sets suggested content configuration parameters from an XML description.
update suggContent --UPDATE_METHOD=method --INPUT_FILE=xml_filename
or
update suggContent -a method -i xml_filename
Method to use when updating the properties of an object:
overwrite
: Replaces the existing property values with the new values.
Path to the XML document that configures the object. See "suggContent".
Changes the properties of a suggested content provider from an XML file.
update suggContentProvider --NAME=object_name --INPUT_FILE=xml_filename --UPDATE_METHOD=method
or
update suggContentProvider -n object_name -i xml_filename -a method
Content of a <search:name>
element in the XML document.
Path to the XML document that configures the object. See "suggContentProvider".
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.
Updates a suggestion.
update suggestion --NAME=object_name --INPUT_FILE=xml_filename --UPDATE_METHOD=method
or
update suggestion -n object_name -i xml_filename -a method
Content of a <search:name>
element in the XML document.
Path to the XML document that configures the object. See "suggestion".
Method to use when updating the properties of an object:
overwrite
: Replaces the existing property values with the new values.
Changes the properties of a suggested link from an XML file.
update suggLink --KEYWORD=keyword --LINK_URL=url --INPUT_FILE=xml_filename --UPDATE_METHOD=method
or
update suggLink --KEYWORD=keyword --LINK_URL=url -i xml_filename -a method
Content of the search:keyword
element in the XML document.
Content of the search:linkUrl
element in the XML document.
Path to the XML document that configures the object. See "suggLink".
Method to use when updating the properties of an object:
overwrite
: Replaces the existing property values with the new values.
Changes the properties of a tag from an XML file.
update tag --NAME=object_name --INPUT_FILE=xml_filename --UPDATE_METHOD=method
or
update tag -n object_name -i xml_filename -a method
Content of a <search:name>
element in the XML document.
Path to the XML document that configures the object. See "tag".
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.
Updates the tagging configuration.
update tagging --UPDATE_METHOD=method --INPUT_FILE=xml_filename
or
update tagging -a method -i xml_filename
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.
Path to the XML document that configures the object. See "tagging".
Changes the properties of a thesaurus from an XML file.
update thesaurus --NAME=DEFAULT --INPUT_FILE=xml_filename --UPDATE_METHOD=method
or
update thesaurus -n DEFAULT -i xml_filename -a method
Path to the XML document that configures the object. See "thesaurus".
Method to use when updating the properties of an object:
overwrite
: Replaces the existing property values with the new values.
Sets one or more parameters for all alternate words from an XML description.
updateAll altWord --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]
or
updateAll altWord -i xml_filename -a method [-t action]
Path to the XML document that configures the object. See "altWord".
Method to use when updating the properties of an object:
overwrite
: Replaces the existing property values with the new values.
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.
Changes the properties of all boosted URLs described in an XML document.
updateAll boostedUrl --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]
or
updateAll boostedUrl -i xml_filename -a method [-t action]
Path to the XML document that configures the object. See "boostedUrl".
Method to use when updating the properties of an object:
overwrite
: Replaces the existing property values with the new values.
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.
Sets one or more parameters for all the classifications from an XML description.
updateAll classification --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]
or
updateAll classification -i xml_filename -a method [-t action]
Path to the XML document that configures the object. See "classification".
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 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
Sets one or more parameters for all cluster trees from an XML description.
updateAll clusterTree --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]
or
updateAll clusterTree -i xml_filename -a method [-t action]
Path to the XML document that configures the object. See "clusterTree".
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 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
Sets one or more parameters of all document service instances described in an XML document.
updateAll docServiceInstance --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action] [--ENCRYPT_KEY=key]
or
updateAll docServiceInstance -i xml_filename -a method [-t action] [-e key]
Path to the XML document that configures the object. See "docServiceInstance".
Method to use when updating the properties of an object:
overwrite
: Replaces the existing property values with the new values.
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
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.
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
Sets one or more parameters of all document services pipelines described in an XML document.
updateAll docServicePipeline --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]
or
updateAll docServicePipeline -i xml_filename -a method [-t action]
Path to the XML document that configures the object. See "docServicePipeline".
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 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
Updates all the facet trees described in an XML document.
updateAll facetTree --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]
or
updateAll facetTree -i xml_filename -a method [-t action]
Path to the XML document that configures the object. See "facetTree".
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 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
Sets one or more parameters of all index profiles described in an XML document.
updateAll indexProfile --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]
or
updateAll indexProfile -i xml_filename -a method [-t action]
Path to the XML document that configures the object. See "indexProfile".
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 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
Sets one or more parameters of all lexers described in an XML document.
updateAll lexer --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]
or
updateAll lexer -i xml_filename -a method [-t action]
Path to the XML document that configures the object. See "lexer".
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 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
Sets one or more parameters for all proxy log-ins (federated trusted entities) from an XML description.
updateAll proxyLogin --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--ENCRYPT_KEY=key] [--NOT_FOUND_METHOD=action]
or
updateAll proxyLogin -i xml_filename -a method [-e key] [-t action]
Path to the XML document that configures the object. See "proxyLogin".
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.
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.
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
Sets one or more parameters for all schedules from an XML description.
updateAll schedule --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]
or
updateAll schedule -i xml_filename -a method [-t action]
Path to the XML document that configures the object. See "schedule".
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 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
Updates all search attributes from the descriptions in an XML file. You can add LOVs to the default search attributes.
updateAll searchAttr --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]
or
updateAll searchAttr -i xml_filename -a method [-e key] [-t action]
Path to the XML document that configures the object. See "searchAttr".
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:
Theadd
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.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
Sets one or more parameters for all schedules from an XML description.
updateAll schedule --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]
or
updateAll schedule -i xml_filename -a method [-t action]
Path to the XML document that configures the object. See "schedule".
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 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
Sets one or more parameters for the Single Sign-On settings from an XML description.
updateAll singleSignOnSetting --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action] [--ENCRYPT_KEY=key]
or
updateAll singleSignOnSetting -i xml_filename -a method [-t action] [-e key]
Path to the XML document that configures the object. See "singleSignOnSetting".
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.
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.
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
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
Sets one or more parameters for all source groups from an XML description.
updateAll sourceGroup --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]
or
updateAll sourceGroup -i xml_filename -a method [-t action]
Path to the XML document that configures the object. See "sourceGroup".
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 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
Sets one or more parameters for all source types from an XML description.
updateAll sourceType --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]
or
updateAll sourceType -i xml_filename -a method [-e key] [-t action]
Path to the XML document that configures the object. See "sourceType".
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 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.
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
Changes the properties of all storage areas from an XML file.
updateAll storageArea --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]
or
updateAll storageArea -n object_name -i xml_filename -a method [-t action]
Path to the XML document that configures the object. See "storageArea".
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 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
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
Sets one or more parameters for all the suggested content providers from an XML description.
updateAll suggContentProvider --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]
or
updateAll suggContentProvider -i xml_filename -a method [-e key] [-t action]
Path to the XML document that configures the object. See "suggContentProvider".
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 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.
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
Sets one or more parameters for all the suggestions from an XML description.
updateAll suggestion --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]
or
updateAll suggestion -i xml_filename -a method [-t action]
Path to the XML document that configures the object. See "suggestion".
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 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
Updates all suggested links from an XML description.
updateAll suggLink --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]
or
updateAll suggLink -i xml_filename -a method [-t action]
Path to the XML document that configures the object. See "suggLink".
Method to use when updating the properties of an object:
overwrite
: Replaces the existing property values with the new values.
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
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
Sets one or more parameters for all the tags from an XML description.
updateAll tag --INPUT_FILE=xml_filename --UPDATE_METHOD=method [--NOT_FOUND_METHOD=action]
or
updateAll tag -i xml_filename -a method [-e key] [-t action]
Path to the XML document that configures the object. See "tag".
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 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.