GetStatus Response

This section describes the XML tags that return in the response to a GetStatus action sent to the Proxy component in a unified configuration that does not use a DAH or DIH.

For details about unified configurations, refer to the Knowledge Discovery Getting Started Guide.

The GetStatus response from Proxy contains information from all its child components. Most tags result from the GetStatus response of the child components. However, the unified GetStatus response does not display all tags from child servers, and Proxy returns additional tags that none of the components return (such as, component status).

Tag Description Related configuration parameters

product

The component that returns the GetStatus data.

 

version

The version of the component.

NOTE: In the unified GetStatus response, this version is the version of the Proxy component.

 

indexport

The port used to send index actions to the component.

IndexPort

aciport

The port used to send ACI actions to the component.

Port

serviceport

The port used to send service actions to the component.

ServicePort

directory

The directory that contains the component (or the Proxy component in the unified configuration).

 

acithreads

The number of allowed ACI threads.

Threads

component

The status of each child component. This section contains a subsection for each component.

 

  status

The status of the component.

 

  aciport

The port used to send ACI actions to the component.

 

  indexport

The port used to send index actions to the component.

NOTE: This port applies only to indexing components, such as Content.

 

  serviceport

The port used to send service actions to the component.

 

licensed_languages

A comma-separated list of the languages that your license allows the Content component to use.

 

termsperdoc

The configured number of best terms to generate for each document.

TermsPerDoc

suggestterms

The configured number of best terms to use in a Suggest action.

SuggestTerms

documents

The number of documents in the index that are available for search.

 

document_sections

The number of document sections in the index.

 

committed_documents

The number of documents that have been indexed, including any deleted documents that have not been removed in a compaction.

 

deleted_sections The number of document sections for deleted sections in your index. This number represents the number of deleted sections since the last compaction operation. You can use it to check whether you need to compact the index to permanently delete these documents.  
indexed_data_kb

The amount of indexed data in the Content component.

NOTE: This number does not specify the amount of disk space that Content is using. This value specifies the index size for licensing purposes.

 

full

Whether the data index has reached the maximum size specified in the MaxDocumentCount or MaxIndexSizeKb configuration parameter.

The DIH uses this tag when distributing index actions. You can configure DIH to stop indexing to full servers by using the RespectChidlFullness DIH configuration parameter.

MaxDocumentCount

MaxIndexSizeKb

full_ratio

How close the data index is to reaching the configured maximum number of documents, as determined by the MaxDocumentCount configuration parameter. If you have not set MaxDocumentCount, Content uses the MaxIndexSizeKb limit instead.

MaxDocumentCount

MaxIndexSizeKb

terms

The number of terms in the data index for which you can search.

 

total_terms

The total number of terms in the data index, including internal terms.

 

term_hashes

The nearest power of 2 above the value of the DiskHash parameter.

DiskHash

record_size

The maximum size of terms in the data index.

TermSize

max_occurrences

The highest number of documents in which any single term occurs.

 

mindate

The earliest date of any document in the data index (in AUTNDATE format).

 

maxdate

The latest date of any document in the data index (in AUTNDATE format).

 

ref_fields

The number of reference fields that the documents in the data index use.

 

ref_hashes

The value of the internal RefHashes parameter.

 

indexqueue

Details about the index queue. See Check Index Status.

 

  indexqueuereceived

The number of index actions that the component has received.

 

  indexqueuecompleted

The number of index actions that the component has completed.

 

  indexqueuequeued

The number of index actions remaining in the index queue.

 

  initialid The initial ID of the last DREINITIAL index action that the server processed. You set this ID when you send a DREINITIAL index action, by using the InitialID parameter. See Initialize the Data Index.  

termcache

Details about the term cache. See [TermCache] Section.

 

  used_kb

The current size of the term cache (in KB).

 

  num_terms

The number of terms currently stored in the term cache.

 

  limit_kb

The maximum configured size of the term cache (in KB).

 

  requests

The number of terms that have been requested from the cache.

 

  hits

The number of matches for terms in the cache that Content has received.

 

  hitrate

The rate at which Content has matched terms in the cache.

 

indexcache

Details about the index cache. See [IndexCache] Section.

 

  used_kb

The current size of the index cache (in KB).

 

  num_terms

The number of terms currently stored in the index cache.

 

  limit_kb

The maximum configured size of the index cache (in KB).

IndexCacheMaxSize

  num_blocks

The number of memory blocks allocated for indexing.

 

fieldcodes

Details of fields in Content component index documents.

 

  base

The number of distinct field names in the data index.

 

  total

The total number of field codes.

If you have set the XMLFullStructure configuration parameter to True, this value is the total number of distinct occurrences of fields.

XMLFullStructure

databases

Details of the databases in the data index. See Create and Delete Databases.

 

  max_databases

The maximum allowed number of databases.

 

  num_databases

The total number of databases in the data index.

NumDBs

  active_databases

The number of active (not deleted) databases.

 

  database

Details of individual databases.

 

    name

The name of the database.

Name

    documents

The number of documents in the database.

 

    sections

The number of document sections in the database.

 

    internal

Whether the database is configured as internal.

Internal

    readonly

Whether the database is configured as read-only.

DatabaseReadOnly

    expiry_hours

The expiration time (in hours) for documents in this database.

ExpireTime

    expiry_action

The expiration action to perform when documents expire from this database.

ExpireIntoDatabase

security_settings

Details of the configured security types in the Content component. See Set up Security.

 

  no_of_security_types

The total number of configured security types.

 

  security_type

Details of individual configured document security types. See [Security] Section.

[Security] section

    name

The name of the security type.

This value is the name of the configuration section where you define the security settings.

 

    documents

The number of documents that this security type applies to.

 

    sections

The number of document sections that this security type applies to.

 

language_type_settings

Details of the configured language types. See Language Support.

 

  no_of_language_types

The number of configured language types.

 

  language_type

Details of an individual language type. See [LanguageTypes] Section.

[LanguageTypes] section

    name

The name of the language type. This value is the name given to one encoding for a language, set in the Encodings configuration parameter.

Encodings

    language

The language that applies to this language type. This value is the name of the language configuration section for this language type.

 

    encoding

The encoding that applies to this language type.

Encodings

    documents

The number of documents with this language type.

 

    sections

The number of document sections with this language type.

 

Validation

The results of index validation.

 

  result

The result of validation on a particular index. There is a result tag for each type of index validation. This tag contains one of the following values:

  • N/A. No index validation has run for the index type.

  • Success. Index validation has passed.

  • An error message. Indicates a validation failure. In this case you might need to regenerate a data index.

ValidateDiskIndex

ValidateNodeTable

ValidateRefIndex

ValidateUnstemmed

ValidateSecIndex

ValidateNumeric

ValidateGeospatial

ValidatePhraseIndex

    type

The type of index for the result. This can be one of the following values:

  • diskindex

  • nodetable

  • refindex

  • unstemmed

  • secindex

  • numeric

  • geospatial

  • phraseindex

ValidateDiskIndex

ValidateNodeTable

ValidateRefIndex

ValidateUnstemmed

ValidateSecIndex

ValidateNumeric

ValidateGeospatial

ValidatePhraseIndex

    timestamp

The time of the last validation, in epoch seconds.

 

    duration

The duration (in seconds) of the last validation operation.

 

autn:numusers

The number of users in the Community component.

 

autn:maxusers

The maximum number of users allowed in Community. This value depends on your product license.

 

securitytypes

User security information from the Community component. See [UserSecurity] Section.

[UserSecurity] section

  defaultsecuritytype

The default user security type.

DefaultSecurityType

    name

The name of the user security type.

 

    fields

The user security fields associated with the security type.

SecurityFieldCSVs

    documentsecurity

Whether the security type uses the document security module.

DocumentSecurity

    documentsecuritytype

The document security module that applies to the user security type.

DocumentSecurityType

autn:scheduledthreads

The number of threads available for scheduled tasks.

 

autn:categories

The number of categories in the Category component.