Skip to main content
Version: 2025.2

AliasSubIndexSearch

This page provides generated reference documentation for the AliasSubIndexSearch data model.

Overview​

PropertySummary
canManageCollectionSpecifies whether the ADITO server may create the collection of the index and update the contained schema with patches.
collectionNameThe name of the solr collection in which the index is stored.
configHandlerTimeoutThe timeout for requests to configure the index.
indexerTimeoutThe timeout for requests from the indexer.
remoteAuthenticationMethodThe authentication method used to access the remote Solr server.
remoteSolrUrlThe URL of the external SolrServer.
remoteUsesSolrCloudModeSets the API, which is used to communicate with Solr.
remoteZooKeeperHostThe address of the zookeeper, which manages the SolrCloud.
searchTimeoutThe timeout for search queries.
solrConnectionTimeoutThe connection timeout for the connection to the Solr server.
solrPasswordThe password for the authentication user.
solrUserThe username for the authentication.
stateControlTimeoutThe timeout for the index status check.
userTitleUsertitle in whose context jdito processes will be executed. In some instances processes cant be executed if nothing is configured.
zkClientTimeoutThe timeout for requests to the ZooKeeper.
zkConnectionTimeoutThe connection timeout for the connection to the ZooKeeper.
zkRetryExpiryTimeThe time span in seconds that must be waited before the status of the ZooKeeper cluster can be retrieved again.

canManageCollection​

Type: Boolean
Default: true

Specifies whether the ADITO server may create the collection of the index and update the contained schema with patches.

The default is true.

If the option is deactivated, the server can only add new fields for an existing index to the schema.

collectionName​

Type: String

The name of the solr collection in which the index is stored.

If empty, a collection with a generated default name will be used.

The generated name follows the pattern {projectName}_{system}, for example basic2020_default or basic2020_prod.

If no project name was defined the collection name is equal to the system name. Example: default or prod.

IMPORTANT: The server will create a new index when the name of the collection is changed. The previous index will not be deleted.

configHandlerTimeout​

Type: Long

The timeout for requests to configure the index.

This applies to all requests for creating the index and for updating the schema and other configurations.

Default is 10 minutes (10M).

If the value is not set, 0 or negative, the default timeout is used.

indexerTimeout​

Type: Long

The timeout for requests from the indexer.

Default is 5 minutes (5M).

If the value is not set, 0 or negative, the default timeout is used.

remoteAuthenticationMethod​

Type: SolrLoginType

The authentication method used to access the remote Solr server.

remoteSolrUrl​

Type: String

The URL of the external SolrServer.

The URL must point to the base address ( default: /solr ) of the Solr server. Example: "http://localhost:8983/solr"

If a SolrCloud is used, it is possible to set multiple URLs as a comma separated list. Example: "http://localhost:8983/solr, http://localhost:7743/solr}"

remoteUsesSolrCloudMode​

Type: Boolean
Default: true

Sets the API, which is used to communicate with Solr.

  • false The old Core-API is used. Required for non-cloud Solr servers.

  • true The Collections-API is used. Required for SolrCloud systems.

remoteZooKeeperHost​

Type: String
Requires: remoteUsesSolrCloudMode property group

The address of the zookeeper, which manages the SolrCloud.

Required the IP-Address and port of the zookeeper. Example: "localhost:9983"

searchTimeout​

Type: Long

The timeout for search queries.

Default is 10 seconds (10S).

If the value is not set, 0 or negative, the default timeout is used.

solrConnectionTimeout​

Type: Long

The connection timeout for the connection to the Solr server.

The timeout is used for all Solr clients of the index search.

Default is one minute (1M).

If the value is not set, 0 or negative, the default timeout is used.

solrPassword​

Type: String
Requires: remoteAuthenticationMethod property group

The password for the authentication user.

solrUser​

Type: String
Requires: remoteAuthenticationMethod property group

The username for the authentication.

stateControlTimeout​

Type: Long

The timeout for the index status check.

The status check is used to determine whether the index and the external service can still be used, which is why the timeout should be set to a low value.

Default is 5 seconds (5S).

If the value is not set, 0 or negative, the default timeout is used.

userTitle​

Type: String

Usertitle in whose context jdito processes will be executed. In some instances processes cant be executed if nothing is configured.

Example: Admin

zkClientTimeout​

Type: Long
Requires: remoteUsesSolrCloudMode property group

The timeout for requests to the ZooKeeper.

The timeout is used for all Solr clients of the index search.

Default is 15 seconds (15S).

If the value is not set, 0 or negative, the default timeout is used.

zkConnectionTimeout​

Type: Long
Requires: remoteUsesSolrCloudMode property group

The connection timeout for the connection to the ZooKeeper.

The timeout is used for all Solr clients of the index search.

Default is 30 seconds (30S).

If the value is not set, 0 or negative, the default timeout is used.

zkRetryExpiryTime​

Type: Long
Requires: remoteUsesSolrCloudMode property group

The time span in seconds that must be waited before the status of the ZooKeeper cluster can be retrieved again.

The value is used for all Solr clients of the index search.

Default is 5 seconds (5S).

If the value is not set, 0 or negative, the internal default wait time is used.