Elements

The following sections provide reference information for the elements that you may see/use in Watson™ Explorer Engine XML.

_temporary
Internal element created when adding some new elements.
activity-feed-cache-copy
A container for the activity feed crawl-data.
add-attribute
In a regexp parser, add an attribute to the XML output when entering the containing state/match
add-content
In a regexp parser, add a content element to the XML output when entering the containing state/match
add-document
In a regexp parser, add a document to the XML output when entering in the containing state/match
added-source
Node containing information about an added source
add-parse-string
Add a parse tag which contains a string
add-parse-uri
Add a parse tag
add-processed-xsl
In a regex parser, process some XSL code on an empty document and insert the resulting XML in the output
add-source
Process the source referenced
add-sources
Process the sources referenced
add-string
In a regexp parser, add a string to the XML output when entering the containing state/match
added
admin-option
Element describing an option for the Admin Tool
advanced-content
A container object that allows specification of both textual content and how that text will be tokenized and converted to terms to be indexed.
always
Contains identifying content which has been configured to always be returned.
always-allow-one-collection
When set to true, at least one collection will be allowed. This prevents pathological cases where no progress can be made. This option takes precedence over the maximum-collections setting.
append
In a regexp parser, append a string to the current "active" string
application
Application definition
attribute
Set an attribute of the first parent element
audit-log-entry
A node representing an individual audit log entry.
audit-log-purge
A request to purge entries from the audit log.
audit-log-retrieve
A request to retrieve entries from the audit log.
audit-log-retrieve-response
Returned in response to an audit-log-retrieve request. Contains all audit log entries corresponding to the request. If the request failed, an exception will be thrown detailing the error.
availability
Section used in the function editing interface to specify which versions of a node are available/deprecated/unavailable
available
After this version, Watson Explorer begins supporting this node.
base64
bin
An internal bin of the full binning set
binning-calculation
Specify a calculation that needs to be done on the set of values.
binning
Element containing the hierarchy of bins as returned by the Watson Explorer Search Engine, as configured
binning-full
Element containing the hierarchy of bins as returned by the Watson Explorer Search Engine, when double-binning is enabled
binning-range
Specifies a range of numeric values that should be gathered together in the same refinement/bin
binning-set
Creates a specific set of refinements/bins
binning-sets
A specification for creating a refinement/binning from the input documents
binning-state
A description of the current state of navigation in the configured binning sets
binning-state-token
One element of the current state of navigation in the configured binning sets
binning-tree
Indicates hierarchical content in a binning-set
boost
Elements contained in this node will be "boosted" to the top of the list of results
brand
cache
Indicates that this document has text cache data available.
call-function
Function reference
call-function-temporary
Internal element created when adding new call-function elements
catch
changes
Contains updated content for a newly modified document.
check-memory-usage-time
The number of seconds to wait between successive checks to determine if a collection needs to be stopped in order to maintain a healthy amount of available memory on the system.
check-online-are-responsive-time
The number of seconds to wait between successive checks to determine if a collection needs to be terminated because it has become deadlocked.
check-online-are-responsive-timeout-time
The number of seconds to wait for a single collection to respond when checking if the collection has become deadlocked. If no response has been received within this amount of time, the collection will be terminated.
check-online-time
The number of seconds to wait between successive checks of each online collection to tell if it is still online.
choose
Selective processing
cluster
Cluster the documents that have been added into the object so far
collection
Status for a single collection tracked by the collection broker.
collection-broker-collection-status
collection-broker-configuration
Contains the configuration for the collection broker.
collection-broker-crawler-offline-status
collection-broker-crawler-offline-status-response
collection-broker-delete-keys-status
collection-broker-enqueue
collection-broker-enqueue-response
collection-broker-export-data
collection-broker-export-data-response
collection-broker-ignore-collection
collection-broker-ignore-collection-response
collection-broker-search
collection-broker-search-response
collection-broker-start-collection
collection-broker-start-collection-response
collection-broker-status-response
The status for the collection broker. This status includes all collections currently tracked by the collection broker and all ongoing and completed collection data exports.
collection-service-delete-status
This command causes the specified subcollection to be cleaned.
collection-service-delete-working-copy
This command rejects the working-copy configuration.
collection-service
This node is used to provide initial configuration when starting the collection-service.
collection-service-external-lock
This command requests a lock on the entire collection. While the lock is active, many actions on the collection are restricted.
collection-service-external-unlock
This command unlocks the lock requested by collection-service-external-lock.
collection-service-failure
Used to denote that a command did not complete successfully.
collection-service-fork-working-copy
This command creates a working copy.
collection-service-get-my-indexer
This command is used by the crawler to connect to the indexer.
collection-service-get-my-indexer-timeout
This command is used by the crawler to obtain the indexer's start-up timeout.
collection-service-get-rebase-files
This command is used by the crawler to get a list of files to transfer for distributed crawling.
collection-service-indexer-port
This command provides a lightweight way to request the search port for the specified indexer.
collection-service-join-working-copy
This command accepts the working-copy configuration.
collection-service-purge-audit-log
A container element for the node used to purge the audit log.
collection-service-push-staging
This command pushes the staging subcollection to live if the source tests pass.
collection-service-query-url-status
A container element for the node used to query URL status.
collection-service-rebase-file
A single file to use for the rebase operation.
collection-service-rebase-files
A container element for the files to use for a rebase operation.
collection-service-retrieve-audit-log
A container element for the node used to retrieve the audit log.
collection-service-service-command
This command is used to send a command directly to the crawler or indexer.
collection-service-service-complete
This command is sent from a service when the service is complete.
collection-service-service-final-status
This command is sent from a service when the service is exiting. It contains the final status for that service.
collection-service-service-restart
This command restarts the specified service in the specified subcollection.
collection-service-service-start
This command starts the specified service in the specified subcollection.
collection-service-service-stop
This command stops the specified service in the specified subcollection.
collection-service-set-config
This command is used to provide new configuration XML for the collection.
collection-service-set-meta
This command is used to provide new meta configuration XML for the collection.
collection-service-set-test-it-values
This command is used to provide new test-it values for the collection.
collection-service-status
Contains status information about the collection as a whole.
collection-service-success
Used to denote that a command was completed successfully.
collection-service-swap-file
The path of a file which will be swapped.
collection-service-swap-files
This command is sent from the collection-service to stop the crawler and indexer and then swap this list of files.
collection-service-update-run-node
This command is sent from the collection-service to services that are already running when the collection-service starts. This provides a way for services to contact the collection-service.
comment
completed-crawl
Used by distributed search.
condition
Describes a SQL query, used for creating reports
content
Contents hold the data for clustering
content-analytics-stream
Specifies that the content text will be tokenized and lemmatized using lexical analysis.
contextual-msg
Contains extra information about certain processes (query expansion, query conversion) that may be worth displaying to the user
converter
Configuration of a single step of the converting process.
converter-execute
Command to execute to perform the conversion.
converters
Container for the configuration of the converters.
converter-test
Definition of the condition that must be passed before this rule may be applied.
converter-timing
Timing information about a single converter rule.
converter-timings
Container for all the timing status.
converter-trace-data
converter-trace
converter-trace-file
copy-of
Evaluates an XPath expression.
crawl-activities
A container for crawl-activity entries.
crawl-activity
Contains information regarding document activity.
crawl-checkpoint
A crawl pipeline checkpoint.
crawl-client-status
A node indicating the status of the distributed search clients.
crawl-condition-except
A crawl-condition to be applied except when the URL matches the condition.
crawl-condition-when
A crawl-condition to be applied when the URL matches the condition.
crawl-data
Node that encapsulates all crawler state corresponding to a particular document.
crawl-delete
A node used to remove a URL or set of URLs from the index.
crawler
A container to hold the crawler's configuration.
crawler-jvm
Configuration information for a JVM created by the crawler for running Java Converters.
crawler-jvms
A container tag for config nodes for each JVM started and used by the crawler.
crawler-minimum
The minimum number of bytes of memory that a crawler is expected to use. If the calculated memory usage of the crawler is less than this number, the calculated memory usage will be set to this value.
crawler-offline-status
A node used to communicate information about the crawler's offline queue.
crawler-overhead
This number will be subtracted from the crawler memory usage as reported by the system. This can be used to adjust memory calculations because the system may report a larger virtual memory usage than the process will use.
crawler-rpc-applied
crawler-rpc-available
crawler-rpc
crawler-rpc-export-blob
crawler-rpc-identify
crawler-rpc-notification
crawler-rpc-range
crawler-rpc-rebase
crawler-rpc-request
crawler-rpcs
crawler-rpc-update
crawler-service-enqueue
Container for nodes that are to be enqueued by the crawler.
crawler-service-enqueue-response
Returned in response to an enqueue request. Child nodes detail the results for each node that the crawler attempted to enqueue.
crawler-service-get-hosts
Node sent to the crawler to request that the crawler reply with the crawl-hosts node. Used to obtain statistics about the hosts that the crawler has encountered.
crawler-service-synchronize-logs
Node sent to the crawler to request that the crawler synchronize its internal state with secondary storage.
crawler-service-vacuum-initiated
Node returned to the caller in response to a log vacuum request.
crawler-service-vacuum-logs
Node sent to the crawler to request that the crawler vacuum its log files.
crawler-status
A node used to communicate the crawler's current state and crawl progress.
crawl-extender-complete
crawl-extender
A container used to associate protocols with connectors.
crawl-extender-enqueue
crawl-extender-option
crawl-extender-status
crawl-extender-token
crawl-graph
crawl-header
Node containing HTTP header data for an associated URL.
crawl-hop
Container for hop statistic information.
crawl-hops-input
Contains hop statistics for all URLs currently being processed by the crawler.
crawl-hops-output
Contains hop statistics for all URLs completely processed by the crawler.
crawl-hosts
Container for the crawler state that resulted from crawling a particular host.
crawl-link
Used by distributed search.
crawl-links
Used by distributed search.
crawl-log
crawl-logs-synchronized
Node returned to the caller in response to a log synchronization request.
crawl-may-not-have
Node indicating that a URL will be filtered if it matches the crawl-pattern child.
crawl-must-have
Node indicating that a URL will be filtered if it does not match the crawl-pattern child.
crawl-option
Configuration options that apply to the entire crawl.
crawl-options
A container for various crawler configuration options.
crawl-pattern
Node containing a pattern value used to filter URLs.
crawl-pipeline
Container node for profiling data.
crawl-remote-all-status
A container for nodes describing the state of a distributed search collection's clients and servers.
crawl-remote-client-status
A container for nodes describing the state of a distributed search collection configured as a client. This node's children describe the state of this client's servers.
crawl-remote-collection-status
A node describing the state of a distributed search collection.
crawl-remote-connection-status
A node describing the state of a connection between a distributed search client and server collection.
crawl-remote-server-status
A container for nodes describing the state of a distributed search collection configured as a server. This node's children describe the state of this server's clients.
crawl-remote-status
A node indicating the status of a distributed seach collection that this collection is requesting or serving.
crawl-replace
Node containing a replacement pattern for URL values.
crawl-runtime-options
A container for the runtime option api call.
crawl-state
crawl-stopping
Node returned to the caller in response to a crawler stop request.
crawl-thread
A node that indicates the state of a crawler thread.
crawl-url
A node that encapsulates all crawler state for a particular URL.
crawl-urls
A container for elements that are enqueued to the crawler. The crawler will not reply to the caller until all of the contained nodes are processed.
crawl-url-status
A container for querying the status of multiple URL nodes. URLs will be subject to the filter-sets contained in this node. If no filters are contained, the unfiltered result set will be returned.
crawl-url-status-filter
A filter to apply to a set of URLs.
crawl-url-status-filter-operation
A boolean operation to perform on the child nodes.
crawl-url-status-response
Returned after a crawl-url-status request. Its child crawl-urls node will contain all matching crawl-url nodes. If the request failed, the error attribute will be set to a value indicating a reason for the failure.
create-element
Analogous to xsl:element.
created
Contains added content for a newly created document.
critical-section
Use a lock file to protect a critical section of code.
curl-option
Configuration options that may be applied on a per-URL basis.
curl-options
Container for options used in fetching a particular URL.
current
Contains the current version of an updated content.
current-status-time
The number of seconds to wait between successive checks of each collection to determine the current collection state.
debug-directory
The installation's directory for debug files.
debug
Triggers a log debugging message
declare
Variable declaration
declare-setting
declare-setting-group
deleted
Contains removed content for a newly deleted document.
deprecated
After this version, Watson Explorer is no longer formally supporting this node, but it will still work.
description
A (possibly long) description associated with a prototype or a declare in the admin interface.
descriptor
A schema.x.element.node (cluster) label
dictionary
Contains the inputs, outputs, and options to build a Watson Explorer spelling dictionary
dictionary-input
Describes a single input to build a dictionary
dictionary-input-option
Describes an option of single input to build a dictionary
dictionary-inputs
Describes the inputs used to build a dictionary
dictionary-output
Describes a single output of building a dictionary
dictionary-output-option
Describes an option of single output of building a dictionary
dictionary-outputs
Describes the outputs of building a dictionary
directory
dispatch-request
Used by the crawler to communicate with its dispatch process.
document
One document to be clustered (input) or that has been clustered (in tree in the output) or a duplicate (in documents in the output)
documents
Contains documents to be clustered or documents that have not been put into the tree by the clustering process
double-group-by
Describes a SQL query, used for creating reports
duplicate-documents
A container element for the key- and near-duplicates documents to the containing document.
encoded-data
encoding-replacement
A node describing a particular encoding replacement that the crawler should attempt to perform.
enum-value
enum-values
error
Triggers an error
eval
Evaluate child nodes and/or XPath expression and discard the results
evoke
Input text triggers the addition of new data for clustering
example
An example value associated with a variable declaration in the admin interface
exception
expand-macro
Macro reference
export
Status for an ongoing or completed data export operation.
fallback
When the parent node failed to be processed, catch the error and process the XML under this node instead.
fetch
Fetch the enqueued URLs for a certain period of time
field
Query field definition
field-map
Field mapping definition
field-mapping
field-to
Field mapping target definition
file
forced-attribute
Has the same effect as attribute but is always processed no matter what the containing element is.
for-each
Repeated processing of a nodeset
form
A form specifies how to convert a set of CGI parameters, i.e, a set of name value pairs, into a structured (Boolean) query and vice versa.
form-authentication-procedure
A container for a Form-Based Authentication procedure. It is used to wrap an ordered set of steps for processing and submitting HTML forms that protect a website.
function
Function definition
generator
Specifies a query used to test a source
generic-option
get-pipeline-size
group-by
Describes a SQL query, used for creating reports
group
help
Contains XML which gives a description of a source and some useful information about using the source
history
Element describing an interaction with the Admin Tool
if
Conditional processing (test an XPath expression)
if-var
Conditional processing (test a variable value)
index-atomic
Container for crawl-url and crawl-delete elements that should be indexed together in an atomic operation.
indexed-crawl
Used by distributed search.
indexer-minimum
The minimum number of bytes of memory that an indexer is expected to use. If the calculated memory usage of the indexer is less than this number, the calculated memory usage will be set to this value.
indexer-overhead
This number will be subtracted from the indexer memory usage as reported by the system. This can be used to adjust memory calculations because the system may report a larger virtual memory usage than the process will use.
indexer-status
indexer-sync
initial-value
Overwrite the initial value of a variable when loaded from a certain project/source
input
Input "box" in a schema.x.element.form
jvm-ping
A command used to request a response from the JVM. Used to health-check for responsiveness.
jvm-ping-response
The expected response to a jvm-ping command. Used to check that the crawler jvm is still alive and responsive.
jvm-shutdown
An XML command used to tell the JVM to clean up any resources and exit.
kb
Knowledge base container
key-match-db
Top-level node for key-match databases
key-match
An individual element in a key-match-db
label
A short description associated with a variable declaration in the admin interface
la-scores-status
Status of one run of the la-scores computation to compute the link-analysis weights of all the URLs.
la-scores-statuses
A container to hold the status of the last few la-scores computations.
light-crawler-entry
A node representing an crawl-data that was indexed with a light-crawler-url attribute.
link
Navigation links to page through the results.
list
Element containing the list of documents currently viewed
live-ping-probability
The probability that a collection will be actively pinged. Doing an active ping will cause the collection service to be started, which will ensure that the collection status is completely up to date. A high probability is not required, as the status will usually be up to date.
load-application
Application reference
load-kb
Knowledge base container reference
load-options
Global options container reference
load-parser
Global named parser reference
load-syntax
Syntax container reference
load-user
Element containing user information
load-vars
log
Tag in which the log nodes are collected
macro
Macro definition
match
Defines regular expression matches to go from one state to another in a regexp parser
maximum-collections
The maximum number of collections to have running at one time, regardless of allocatable memory. A value of -1 means no limit will be applied. To completely disable collections from being started, you must also set the always-allow-one-collection setting to false.
memory-granularity
In order for two collections to be considered to have different memory usages, there must be a difference of this many bytes of memory between the collections. A smaller value will create more distinction between services with similar memory usage.
meta
Specify the "query words" for clustering optimizitation
metadata
minimum-free-memory
The number of bytes of memory to always leave free on the system. This prevents the collection broker from completely exhausting the available memory.
msg
Triggers a log message
navigation
Container node for all the navigation links for the query-* API.
node
An internal node of the clustering (contains more nodes or documents)
normalize
In a regexp parser, apply different types of normalization to the "active" string
old-crawl
A container for the previous copy of a crawl-url.
operator
Logical operator definition
option
Specify Watson Explorer options
options
Global options container (projects)
otherwise
overcommit-factor
A multiplication factor applied to the amount of free memory on the system. If greater than 1, collections can use memory that other executables are using. When less than 1, a percentage of free memory will be left unused.
param
CGI parameter passed to the Vivisimo object
parameter
An element used to pass additional parameters that would otherwise be manually added to the form that Engine will automatically submit (for example, a username).
parse
Parse data (eventually after fetching it from a URL) into XML
parse-param
CGI parameter (name/value pair) for a containing schema.x.element.parse element
parsed-data
The XML returned from crawler JVM containing the results of a successful parse-request. The result data is attached as a base64 encoded text node.
parser
Parser definition
parser-creation-success
In a Java parser, reports that the parser was created successfully on the remote JVM.
parse-request
Holds data sent to the JVM responsible for running Java Parsers. Contains information about the specific parser to use, and the data to parse.
parser-error
In a Java parser, reports an error creating or running the parser on the remote JVM.
permission
Element describing a user permission
persistent-save-time
The number of seconds to wait between successive saving of persistent status data to the disk.
phrase
pipeline-size-reply
pipeline-stat
Status about a pipeline stage.
pong
post-conversion-hook
Configuration for a Java parser based hook which can be invoked for each crawl-url at the conclusion of the conversion pipeline.
prefer-requests
Select which type of request should be preferred when multiple requests are received, but not enough resources are available to handle all requests.
prepend
In a regexp parser, prepend a string to the current "active" string
previous
Contains the previous version of an updated content.
print
probe
Specifies conditions used to validate a source test
process
Evaluates an XPath expression and further processes its output
process-xsl
Process some XSL code
profile
profile-end
End profiling
profile-start
Start profiling
projection
Describes a SQL query, used for creating reports
proto-section
Prototype section
prototype
Prototype of a function or source
qp-utf8
query
Converts the current set of CGI parameters into a structured query
query-performance
Profiling information for searches. An index contains multiple index files that together form the full index file. Each index file has three sections that are distinct for caching purposes. Section 0 contains the starting and ending position of each content tag and ACL that was indexed. Section 1 contains the location of each term that was indexed (the so called inverted index in search terminology). Section 2 contains all of the text, including the XML of the documents and contents, that is available for retrieval at search time (ie, not indexed with index-only).
query-results
Container node for the query-* API output.
queues
Container for detailed request queue status information.
ran
ranking-info
Information about the ranking of an individual document.
r
Information about the ranking of an individual passage of a document.
read-only-state-all
Information returned when attempting to apply read-only operations across all collections. Note that the information returned by the API call is not transactional in that collections may change states while it is executing.
read-only-state
State information about a collection's read-only status.
reconstructor-status
Status of one run of the reconstructor.
reconstructor-statuses
A container to hold the status of the last few reconstructor runs.
redisplay
Hard code the output of a word in the cluster labels
removed
rephrase
Conceptually like a search-and-replace on the clustered input
replace
In a regexp parser, do a replacement in the current "active" string
replace-xpath
In a regex parser, replace the current "active" string with the result of the evaluation of an XPath expression.
report
Set of nodes describing a view of reporting output
reporting
Main reporting node used to add data to the database
reporting-item
A value or a key/value pair of reporting information to be added to the appropriate table.
report-item
Describes one section of a view of reporting output
request-queue
Status information about an XML queue.
result
Set of nodes describing results of a report build
results-binning
Element containing the hierarchy of bins as returned by Watson Explorer, as configured, and as restricted by the current binning state
results-binning-full
Element containing the hierarchy of bins as returned by Watson Explorer, as configured
retrieval-performance
Container to hold profiling information about the query.
returns
rich-cache
Indicates that this document has rich cache data available.
scope
Variable scope
search-collection-duplicate-file-list
security-token
select
Similar to the HTML select. Used for fields accepting a finite set of values.
service-status
Reponse containing status information of a service
setting
settings
set-var
Set a variable
sort
Sort node configuration, multiple values can be specified in case of tie (though all values are always evaluated for each search result).
sort-key
Keys used to sort documents using new XML tags
source
Necessary information to meta-search a remote resource
spelling-correction
When query-time spelling correction is enabled, a corrected version of the query will be available here.
spelling-corrector-configuration
A container for configuration options for the spelling corrector.
spelling-corrector-field
Configures how the spelling corrector will correct one or many fields.
start-offline-time
The number of seconds to wait between successive checks of each collection with data in the offline queue to determine if it can be started to process the offline queue.
state
Flex-like state for regexp parsers
state-param
CGI parameter passed to the Vivisimo object WHILE browsing a state
state-process
Contains XML which will processed when the node is browsed only
steal-var
Gets the current value of the variable and unsets the variable.
stem
Override the stemming of a specific word
stopword
Clustering stopwords are words that are not interesting or at least less interesting in the input data.
submit
Submits the current structured query using the underlying form(s) (query to CGI conversion step)
subsearch
Perform a subsearch in the current tree using the schema.x.element.query element underneath
suggestion
suggestions
syntax
Syntax container
system-report
Container node for the reports-system-reporting API output.
system-reporting-database
One database used to generate a system report.
system-report-item
One item from a system report.
tag
Customizes the handling of HTML tags
term
A "leaf" in a structured query
term-expand-dictionary
term-expand-dicts-status
A container of the status of all term expansion dictionaries.
term-expand-dict-status
Status of one dictionary.
test
One set of testing and validation conditions for a source
test-it-values
tests
List of tests for a source
text
throws
time-granularity
In order for two collections to be considered to have different idle times, there must be a difference of this many seconds between the collections. A smaller value will create more distinction between services with similar idle times.
tree
Holds the clustered output or, in a state output, the state of the tree
unavailable
After this version, Watson Explorer no longer supports this node.
updated
Contains newly updated content.
url-query-string
Element containing the configuration necessary to extract and submit a URL pulled from a query string by its name.
url-xpath
Element containing the configuration necessary to extract and submit a URL. A Form-Based Authentication procedure may require submitting URLs scraped from the page, and not simply the submitting of forms. Use this to specify an XPath to a URL that Engine needs to send a request to in order to continue the authentication procedure.
user-admin-history
Element containing the last user interaction with the admin tool
user-admin-options
Element containing the user options for the Admin Tool
user-alerts
Element containing alerts configured for the user
user-authenticate
Authenticate a user in the current object
user-create
Create a new user
user
Element containing user information
user-globals
Element containing user defined global variables
user-identity
Element containing user identity information
user-modify
Modify a user profile
user-options
Element containing user defined options
user-permissions
Element containing permissions assigned to the user
user-query
Element describing a user query
user-query-history
Element containing the last user queries
user-session-id
A randomly generated session-id used to authenticate a user for the duration of a session.
user-source-variables
Element containing user defined sources variables
value
value-of
Evaluates an XPath expression
value-of-var
String value of the variable it refers to.
value-set-field
vars
vce
Used by convention as the top element, processed the same way schema.x.element.scope is processed.
vertex-ack
vse-collapsed
A container element for documents that have been collapsed by the search-engine using the key collapsing feature.
vse-collection
Search collection configuration, status and running service information.
vse-config
Container for the configuration of each component of the collection.
vse-index-builder-status
Each indexing thread (vse-index-option named n-build-threads) will have one of these elements that provides details about this single thread's status.
vse-index-cache-status
Cache allocation information for a single index file. Sub-elements break down the cache information for each sub-segment of an index file.
vse-index-cache-statuses
A container to hold information about the allocate of disk cache by index file.
vse-index-cache-status-segment
Cache allocation information for one segment of an index file. There are three segments (see the i attribute).
vse-index-content
Information about a content within this index file.
vse-index
vse-index-file
Information about a single index file.
vse-index-info
Additional information about the data in the index.
vse-index-merger-status
The status of a single merging thread. This element contains summary information about the merger and the status of the last few merging operations performed.
vse-index-merge-status
The status of a single merging thread's merge operation.
vse-index-merging-status
A container to hold the status of the merging threads.
vse-index-option
Optional settings for the indexer-service.
vse-index-runtime-options
vse-index-service
vse-index-status
vse-index-stream
Specifies how the content text will be tokenized and how terms will be created from the tokenized result.
vse-index-streams
Specifying a set of indexing streams will override all of the options: stem, kb, segmenter, tokenizer, tokenizer-word tokenizer-punct (and the *2 versions).
vse-indices
A container to hold information about the index files.
vse-meta
Meta information about a search collection
vse-meta-info
vse-qs-disable
vse-qs
A container to hold the query-service configuration.
vse-qs-error
vse-qs-ok
vse-qs-option
Optional settings for the query-service.
vse-qs-serving
One entry for each collection for which the query-service has received a search request. When the service is restarted this status is reset to empty.
vse-qs-status
Status of the query-service.
vse-read-only
Request a change to the read-only mode.
vse-read-only-enabled
Respond stating a change to the read-only mode.
vse-remote
Container for the configuration of remote collection pushing.
vse-remote-hello
vse-remote-mirror
Definition of the server(s) that make up a full mirror of this collection.
vse-remote-option
Optional settings for the remote pushing.
vse-remote-push
vse-remote-push-file
vse-remote-push-slice
vse-remote-push-status
Status of the push operation. All sub-elements are for internal use only.
vse-remote-push-swap
vse-remote-receive
vse-remote-server
Definition of a single server within a complete mirror of this collection.
vse-remote-server-option
Optional settings for server definitions.
vse-remote-status
Container to hold the status of all the mirrors.
vse-remote-status-mirror
Container to hold the status of a mirror.
vse-remote-status-server
Container to hold the status of a single server in a mirror.
vse-run
vse-serving
Information about the search-service's status. This is the sub-service that responds to queries.
vse-set-ping
vse-status
Container for the status of each component of the collection.
vse-tag
Defines for the tag with name name that it should be indexed with weight importance. The default is weight 1. If multiple tag weights are specified for the same tag, the last one specified will take precedence.
vse-tags
A container to hold url tag weights. Tag weights are applied at indexing time to modify the relevance of text based on HTML tags in the contents.
vse-test-it-values
vse-tokenizer
Specifies how the content text will be tokenized.
vse-url-equiv
At indexing time, URLs may be remapped from what was crawled to what is returned by search results. The URL equiv rules are applied in order and if the old-prefix is matched at the start of the URL then it is replaced with new-prefix.
vse-url-equivs
A container to hold url mappings.
vxml
warning
Triggers a warning
when
The child elements of this element (apart from forced-attribute elements which are always processed) will only be processed when its condition is fulfilled and it is the first to be so.
when-var
The child elements of this element (apart from forced-attribute elements which are always processed) will only be processed when its condition is fulfilled and it is the first to be so.
while
Conditional repeated processing (test an XPath expression)
with
Function (or source) argument initial value
xml
xml-to-text
Converts XML to text
xpath-performance
Profiling information for XPath evaluations.
xpath-performances
Container to hold profiling information about the query.

Parent topic: Watson Explorer Engine Schema Reference