IDOL Server GetStatus Response

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

For details about unified HPE IDOL Server configurations, refer to the IDOL Getting Started Guide.

The GetStatus response from IDOL Proxy contains information from all its child components. Most tags result from the GetStatus response of the HPE IDOL Server child components. However, the unified HPE IDOL Server does not display all tags from child servers, and IDOL 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 HPE IDOL Server GetStatus response, this version is the version of the HPE IDOL Proxy.

 

indexport

The port used to send index actions to HPE IDOL Server.

IndexPort

aciport

The port used to send ACI actions to HPE IDOL Server.

Port

serviceport

The port used to send service actions to HPE IDOL Server.

ServicePort

directory

The directory that contains HPE IDOL Server.

 

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 this HPE IDOL Server 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 HPE IDOL Server that are available for search.

 

document_sections

The number of document sections in HPE IDOL Server.

 

committed_documents

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

 

deleted_sections The number of document sections for deleted sections in HPE IDOL Server. 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 HPE IDOL Server is using. This value specifies the index size for licensing purposes.

 

full

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

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

MaxDocumentCount

MaxIndexSizeKb

full_ratio

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

MaxDocumentCount

MaxIndexSizeKb

terms

The number of terms in HPE IDOL Server for which you can search.

 

total_terms

The total number of terms in HPE IDOL Server, 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 HPE IDOL Server.

TermSize

max_occurrences

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

 

mindate

The earliest date of any document in HPE IDOL Server (in AUTNDATE format).

 

maxdate

The latest date of any document in HPE IDOL Server (in AUTNDATE format).

 

ref_fields

The number of reference fields that the documents in HPE IDOL Server use.

 

ref_hashes

The configured value of the RefHashes parameter.

RefHashes

indexqueue

Details about the HPE IDOL Server index queue. See Check Index Status.

 

  indexqueuereceived

The number of index actions that HPE IDOL Server has received.

 

  indexqueuecompleted

The number of index actions that HPE IDOL Server 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 HPE IDOL Server term cache. See [TermCache] Section.

 

  used_kb

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

 

  num_terms

The number of terms currently stored in the HPE IDOL Server term cache.

 

  limit_kb

The maximum configured size of the HPE IDOL Server 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 HPE IDOL Server has received.

 

  hitrate

The rate at which HPE IDOL Server has matched terms in the cache.

 

indexcache

Details about the HPE IDOL Server index cache. See [IndexCache] Section.

 

  used_kb

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

 

  num_terms

The number of terms currently stored in the HPE IDOL Server index cache.

 

  limit_kb

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

IndexCacheMaxSize

  num_blocks

The number of memory blocks allocated for HPE IDOL Server indexing.

 

fieldcodes

Details of fields in HPE IDOL Server documents.

 

  base

The number of distinct field names in HPE IDOL Server.

 

  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 HPE IDOL Server. See Create and Delete Databases.

 

  max_databases

The maximum allowed number of databases.

 

  num_databases

The total number of databases in HPE IDOL Server.

NumDBs

  active_databases

The number of active (not deleted) databases.

 

  database

Details of individual HPE IDOL Server 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.

ReadOnly

    expiry_hours

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

ExpiryTime

    expiry_action

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

ExpireIntoDatabase

security_settings

Details of the configured security types in HPE IDOL Server. See Set up Security.

 

  no_of_security_types

The total number of configured security types in HPE IDOL Server.

 

  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 in HPE IDOL Server. See Language Support.

 

  no_of_language_types

The number of configured language types in HPE IDOL Server.

 

  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

    type

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

  • diskindex

  • nodetable

  • refindex

  • unstemmed

  • secindex

  • numeric

ValidateDiskIndex

ValidateNodeTable

ValidateRefIndex

ValidateUnstemmed

ValidateSecIndex

ValidateNumeric

    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 HPE IDOL Server.

 

autn:maxusers

The maximum number of users allowed in HPE IDOL Server. This value depends on your product license.

 

securitytypes

User security information from the Community component.

[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 HPE IDOL Server.

 


_HP_HTML5_bannerTitle.htm