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
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.
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.
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
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-swap-files
This command 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.
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-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.
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-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-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-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.
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.
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.
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.
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
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.
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.
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-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.
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.
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.
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.
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.
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.
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
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-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-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-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-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-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.
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)