System properties
This document describes the system properties available on the System properties page, sorted by module. Removed modules are listed at the end.
cmas-analytics
metabase.secret.key
- Module: cmas-analytics
- Description: Determines the string used to generate the private key used to validate Metabase JWT messages. Needs to match the setting String used by the JWT signing key in the Metabase configuration.
- Beschreibung: Bestimmt den String, der zum Erzeugen des privaten Schlüssels für die Validierung von Metabase-JWT-Meldungen verwendet wird. Muss mit der Einstellung Vom JWT-Signaturschlüssel verwendeter String in der Metabase-Konfiguration übereinstimmen.
- Type: String
- Restart required: No
- System: No
- Optional: No
- Example value: 50e2230c98344f183c996e6a3954c1a1e43ed100cc36f4ea093800aa2d8a1075
- Since: 6.13.0
metabase.url
- Module: cmas-analytics
- Description: Determines the URL where the Metabase application runs. Needs to match the setting Site URL in the Metabase configuration. The default value is
http://localhost:3000 - Beschreibung: Bestimmt die URL, auf der die Metabase-Applikation läuft. Muss mit der Einstellung Site-URL in der Metabase-Konfiguration übereinstimmen. Der Standardwert ist
http://localhost:3000 - Type: String
- Restart required: No
- System: No
- Optional: No
- Example value: http://localhost:3000
- Since: 6.13.0
cmas-archive-core-server
archive.enabled
- Module: cmas-archive-core-server
- Description: Determines if GDPR-compliant deletions or anonymizations, which delete case or contact data from the ConSol CM database, are applied to CM/Archive as well. By default, this property is set to "false", meaning that no data is deleted from CM/Archive. If you set this property to "true", GDPR-compliant deletions or anonymizations are also performed in CM/Archive. This affects both already archived cases and newly archived cases.
- Beschreibung: Legt fest, ob DSGVO-konforme Lösch- und Anonymisierungsvorgänge, mit denen Vorgangs- oder Kontaktdaten aus der ConSol CM-Datenbank entfernt werden, auch nach CM/Archive übernommen werden. Standardmäßig ist diese Property auf "false" gesetzt, sodass keine Daten aus CM/Archive gelöscht werden. Wenn Sie die Property auf "true" setzen, werden DSGVO-konforme Löschungen und Anonymisierungen auch in CM/Archive durchgeführt. Dies gilt sowohl für bereits archivierte Vorgänge als auch für neu zu archivierende Vorgänge.
- Type: Boolean
- Restart required: No
- System: Yes
- Optional: No
- Example value: false
- Since: 6.11.2.5
archive.uri
- Module: cmas-archive-core-server
- Description: Sets the URL where the CM/Archive application is running.
- Beschreibung: Legt die URL fest, auf der die CM/Archive-Applikation läuft.
- Type: String
- Restart required: No
- System: No
- Optional: No
- Example value: http://localhost:8080
- Since: 6.11.2.0
cmas-core-cache
cache-cluster-name
- Module: cmas-core-cache
- Description: Unique name of a cluster consisting of several ConSol CM nodes. This value is used to identify the nodes belonging to the same cluster during network communication. Please do not change this value manually unless advised by ConSol.
- Beschreibung: Eindeutiger Name eines Clusters, der aus mehreren ConSol CM-Nodes besteht. Dieser Wert wird verwendet, um die Nodes, die zum selben Cluster gehören, bei der Netzwerkkommunikation zu identifizieren. Ändern Sie diesen Wert nicht manuell, außer wenn Sie von ConSol dazu aufgefordert werden.
- Type: String
- Restart required: Yes
- System: Yes
- Optional: No
- Example value: 635a6de1-629a-4129-8299-2d98633310f0
- Since: 6.4.0
cache.logging.listener.enabled
- Module: cmas-core-cache
- Description: Determines whether cache events (
CacheEntryRemoved,CacheEntryInvalidated,CacheEntriesEvicted) are logged toinfinispan.logfor standalone andjgroups-infinispan.logfor cluster mode. The default value is "false". - Beschreibung: Legt fest, ob Cache-Events (
CacheEntryRemoved,CacheEntryInvalidated,CacheEntriesEvicted) in der Dateiinfinispan.log(für den Standalone-Modus) undjgroups-infinispan.log(für den Cluster-Modus) protokolliert werden. Der Standardwert ist "false". - Type: Boolean
- Restart required: Yes
- System: No
- Optional: Yes
- Example value: false
- Since: 6.12.0.5
eviction.event.queue.size (removed)
- Module: cmas-core-cache
- Description: The size of the queue holding cache events. Default value is 200000, it is recommended to increase the value slightly (up to 400000) on systems with high traffic or load. [Deprecated - not used for infinispan]
- Beschreibung: Die Größe der Queue mit den Cache-Events. Der Standardwert ist 200000. Auf Systemen mit viel Traffic oder Last wird empfohlen, diesen Wert leicht zu erhöhen (bis 400000). [Deprecated - gilt nicht für infinispan]
- Type: Integer
- Restart required: Yes
- System: Yes
- Optional: No
- Example value: 200000
- Since: 6.4.0
- Removed in: 6.17.3
eviction.lifeSpan
- Module: cmas-core-cache
- Description: Sets the interval (in milliseconds) for cache entry validity. When this time is elapsed, the entry is removed from the cache.
- Beschreibung: Setzt das Intervall (in Millisekunden) für die Gültigkeit von Cache-Einträgen. Nach der angegebenen Zeit wird der Eintrag aus dem Cache gelöscht.
- Type: Integer
- Restart required: Yes
- System: No
- Optional: Yes
- Example value: 86400000 (default)
- Since: 6.11.1.0
eviction.max.nodes
- Module: cmas-core-cache
- Description: Sets the maximum size of internal caches. The default value is 100000, increasing it will lead to higher memory consumption and is not recommended unless explicitly advised by ConSol.
- Beschreibung: Setzt die maximale Größe der internen Caches. Der Standardwert ist 100000. Das Erhöhen dieses Wertes führt zu einem höheren Speicherverbrauch und wird nicht empfohlen, außer wenn ConSol explizit dazu auffordert.
- Type: Integer
- Restart required: Yes
- System: Yes
- Optional: No
- Example value: 100000
- Since: 6.4.0
eviction.maxIdle
- Module: cmas-core-cache
- Description: Maximum idle time (in milliseconds) a cache entry will be maintained in the cache. If the idle time is exceeded, the entry will be expired cluster-wide. -1 means that the entries never expire. The default value is 126060*1000.
- Beschreibung: Maximale Leerlaufzeit (in Millisekunden), die ein Cache-Eintrag im Cache verbleibt. Wenn die Leerlaufzeit überschritten ist, läuft der Eintrag im gesamten Cluster ab. -1 bedeutet, dass Einträge nie ablaufen. Der Standardwert ist 126060*1000.
- Type: Integer
- Restart required: Yes
- System: No
- Optional: Yes
- Example value: 43200000
- Since: 6.11.1.0
eviction.strategy
- Module: cmas-core-cache
- Description: Determines the cache eviction strategy. Please see the Infinispan documentation for details.
- Beschreibung: Bestimmt die Cache-Löschstrategie. Details hierzu finden Sie in der Infinispan-Dokumentation.
- Type: String
- Restart required: Yes
- System: No
- Optional: Yes
- Example value: LRU, LIRS (default)
- Since: 6.11.1.0
eviction.wakeup.interval
- Module: cmas-core-cache
- Description: Sets the interval (in milliseconds) between two cache queue event processing cycles. The default value is 3000, it is recommended to decrease it (minimum is 1500) on systems with high traffic or load.
- Beschreibung: Setzt das Intervall (in Millisekunden) zwischen zwei Verarbeitungszyklen von Cache-Queue-Events. Der Standardwert ist 3000. Auf Systemen mit viel Traffic oder Last wird empfohlen, den Wert zu verringern (Minimalwert ist 1500).
- Type: Integer
- Restart required: Yes
- System: Yes
- Optional: No
- Example value: 3000
- Since: 6.4.0
statistics.enabled
- Module: cmas-core-cache
- Description: Determines whether cache statistics are gathered. The default value is 'false'.
- Beschreibung: Legt fest, ob Cache-Statistiken gesammelt werden. Der Standardwert ist 'false'.
- Type: Boolean
- Restart required: Yes
- System: No
- Optional: Yes
- Example value: false
- Since: 6.11.1.0
cmas-core-index-common
big.task.minimum.size
- Module: cmas-core-index-common
- Description: Indicates the minimum size of index task (in parts, each part has 100 entities) to qualify this task as a big one. Big tasks have a lower priority than runtime tasks.
- Beschreibung: Gibt die Minimalgröße eines Index-Tasks an (in Teilen, jeder Teil hat 100 Einheiten), um diesen Task als einen großen Task zu qualifizieren. Große Tasks haben eine niedrigere Priorität als Laufzeit-Tasks.
- Type: Integer
- Restart required: No
- System: Yes
- Optional: No
- Example value: 15 (default)
- Since: 6.8.3
database.notification.enabled
- Module: cmas-core-index-common
- Description: Indicates whether the database should be used as a notification channel for index updates instead of JMS. The default value is "true".
- Beschreibung: Legt fest, ob als Benachrichtigungskanal für Index-Aktualisierungen die Datenbank statt JMS verwendet werden soll. Der Standardwert ist "true".
- Type: Boolean
- Restart required: No
- System: Yes
- Optional: No
- Example value: false
- Since: 6.8.4.7
database.notification.redelivery.delay.seconds
- Module: cmas-core-index-common
- Description: If the database is used as a notification channel for index updates, this property indicates the delay for notification redelivery when an exception occurs.
- Beschreibung: Wenn die Datenbank als Benachrichtigungskanal für Index-Aktualisierungen verwendet wird, legt diese Property fest, mit welcher Verzögerung die Benachrichtigung erneut gesendet wird, wenn eine Ausnahme auftritt.
- Type: Integer
- Restart required: No
- System: Yes
- Optional: No
- Example value: 60
- Since: 6.8.4.7
database.notification.redelivery.max.attempts
- Module: cmas-core-index-common
- Description: If the database is used as a notification channel for index updates, this property indicates maximum redelivery attempts when an exception occurs.
- Beschreibung: Wenn die Datenbank als Benachrichtigungskanal für Index-Aktualisierungen verwendet wird, legt diese Property fest, wie oft maximal versucht wird, die Benachrichtigung erneut zu senden, wenn eine Ausnahme auftritt.
- Type: Integer
- Restart required: No
- System: Yes
- Optional: No
- Example value: 60
- Since: 6.8.4.7
disable.admin.task.auto.commit
- Module: cmas-core-index-common
- Description: Toggle for the automatic execution of administrative index update tasks. If set to "false", possibly expensive index tasks created as a result of configuration changes will be automatically executed right after creation. It is recommended to set this value to true, so that the execution of administrative index tasks needs to be manually triggered in the Web Admin Suite.
- Beschreibung: Schalter für die automatische Ausführung von administrativen Index-Update-Aufgaben. Wenn diese Property auf "false" gesetzt ist, werden möglicherweise teure Index-Aufgaben, die aufgrund von Konfigurationsänderungen erzeugt wurden, automatisch direkt nach der Erzeugung ausgeführt. Es wird empfohlen, diesen Wert auf true zu setzen, sodass die Ausführung von administrativen Index-Aufgaben manuell in der Web Admin Suite gestartet werden muss.
- Type: Boolean
- Restart required: No
- System: Yes
- Optional: No
- Example value: false
- Since: 6.6.1
index.attachment
- Module: cmas-core-index-common
- Description: Determines whether the content of attachments is indexed.
- Beschreibung: Legt fest, ob der Inhalt von Attachments indiziert wird.
- Type: Boolean
- Restart required: No
- System: Yes
- Optional: No
- Example value: true
- Since: 6.4.3
index.history (removed)
- Module: cmas-core-index-common
- Description: Determines whether the case and contact history should be indexed.
- Beschreibung: Legt fest, ob die Vorgangs- und Kontakthistorie indiziert wird.
- Type: Boolean
- Restart required: No
- System: Yes
- Optional: No
- Example value: false
- Since: 6.1.0
- Removed in: 6.11.0
index.status
- Module: cmas-core-index-common
- Description: Index synchronization status, possible values are GREEN, YELLOW or RED. This value is set internally by the index system, please do not change it manually unless advised by ConSol.
- Beschreibung: Status der Indexsynchronisierung, mögliche Werte sind GREEN, YELLOW oder RED. Dieser Wert wird intern von Indexsystem gesetzt. Ändern Sie ihn nur, wenn Sie von ConSol dazu aufgefordert werden.
- Type: String
- Restart required: No
- System: Yes
- Optional: No
- Example value: GREEN
- Since: 6.6.1
index.task.worker.threads
- Module: cmas-core-index-common
- Description: Sets the number of threads that will be used to execute index tasks. The default value is 1, we recommend to increase it slightly on systems with large indexer load up to a value of 4.
- Beschreibung: Legt die Anzahl der Threads fest, die für die Ausführung von Index-Aufgaben verwendet werden. Der Standardwert ist 1. Wir empfehlen, diesen Wert auf Systemen mit großer Index-Last leicht, auf bis zu 4, zu erhöhen.
- Type: Integer
- Restart required: No
- System: Yes
- Optional: No
- Example value: 1 (default)
- Since: 6.6.14, 6.7.3
index.version.current
- Module: cmas-core-index-common
- Description: Holds information about the current index version. This value is maintained internally, please do not change it unless advised by ConSol.
- Beschreibung: Enthält Informationen über die derzeitige Indexversion. Dieser Wert wird intern verwaltet. Ändern Sie ihn nur, wenn Sie von ConSol dazu aufgefordert werden.
- Type: Integer
- Restart required: No
- System: Yes
- Optional: No
- Example value: 1 (default)
- Since: 6.7.0
index.version.newest
- Module: cmas-core-index-common
- Description: Holds information about which index version is considered newest. This value is maintained internally, please do never change it unless advised by ConSol.
- Beschreibung: Enthält Informationen, welche Indexversion als die neueste betrachtet wird. Dieser Wert wird intern verwaltet. Ändern Sie ihn nur, wenn Sie von ConSol dazu aufgefordert werden.
- Type: Integer
- Restart required: No
- System: Yes
- Optional: No
- Example value: 1 (default)
- Since: 6.7.0
indexed.engineers.per.thread.in.memory
- Module: cmas-core-index-common
- Description: Determines how many users should be loaded into memory at once, per thread, during indexing. Increasing it slightly will lead to better indexer performance at the price of higher memory consumption.
- Beschreibung: Legt fest, wie viele Benutzer während des Indizierens pro Thread auf einmal in den Speicher geladen werden. Eine leichte Erhöhung führt zu einer besseren Indexer-Performance, verbraucht aber mehr Arbeitsspeicher.
- Type: Integer
- Restart required: No
- System: Yes
- Optional: No
- Example value: 300 (default)
- Since: 6.6.14, 6.7.3
indexed.resources.per.thread.in.memory
- Module: cmas-core-index-common
- Description: Determines how many resources should be loaded into memory at once, per thread, during indexing. Increasing it slightly will lead to better indexer performance at the price of higher memory consumption.
- Beschreibung: Legt fest, wie viele Ressourcen während des Indizierens pro Thread auf einmal in den Speicher geladen werden. Eine leichte Erhöhung führt zu einer besseren Indexer-Performance, verbraucht aber mehr Arbeitsspeicher.
- Type: Integer
- Restart required: No
- System: Yes
- Optional: No
- Example value: 200 (default)
- Since: 6.10.0.0
indexed.tickets.per.thread.in.memory
- Module: cmas-core-index-common
- Description: Determines how many cases should be loaded into memory at once, per thread, during indexing. Increasing it slightly will lead to better indexer performance at the price of higher memory consumption.
- Beschreibung: Legt fest, wie viele Vorgänge während des Indizierens pro Thread auf einmal in den Speicher geladen werden. Eine leichte Erhöhung führt zu einer besseren Indexer-Performance, verbraucht aber mehr Arbeitsspeicher.
- Type: Integer
- Restart required: No
- System: Yes
- Optional: No
- Example value: 100 (default)
- Since: 6.6.14, 6.7.3
indexed.units.per.thread.in.memory
- Module: cmas-core-index-common
- Description: Determines how many contacts should be loaded into memory at once, per thread, during indexing. Increasing it slightly will lead to better indexer performance at the price of higher memory consumption.
- Beschreibung: Legt fest, wie viele Kontakte während des Indizierens pro Thread auf einmal in den Speicher geladen werden. Eine leichte Erhöhung führt zu einer besseren Indexer-Performance, verbraucht aber mehr Arbeitsspeicher.
- Type: Integer
- Restart required: No
- System: Yes
- Optional: No
- Example value: 200 (default)
- Since: 6.6.14, 6.7.3
multi.term.query.rewrite.method
- Module: cmas-core-index-common
- Description: Configures the
MultiTermQueryrewrite method in Lucene. The default isCONSTANT_SCORE_AUTO_REWRITE_DEFAULT. Other possible values areCONSTANT_SCORE_BOOLEAN_QUERY_REWRITE(prone toTooGenericSearchCriteriaException),CONSTANT_SCORE_FILTER_REWRITEandSCORING_BOOLEAN_QUERY_REWRITE(seeMultiTermQueryjavadoc for more details). - Beschreibung: Konfiguriert die Rewrite-Methode
MultiTermQueryin Lucene. Der Standardwert istCONSTANT_SCORE_AUTO_REWRITE_DEFAULT. Andere mögliche Werte sindCONSTANT_SCORE_BOOLEAN_QUERY_REWRITE(kann zuTooGenericSearchCriteriaExceptionführen),CONSTANT_SCORE_FILTER_REWRITEundSCORING_BOOLEAN_QUERY_REWRITE(siehe Javadoc vonMultiTermQueryfür Details). - Type: String
- Restart required: No
- System: Yes
- Optional: No
- Example value: CONSTANT_SCORE_BOOLEAN_QUERY_REWRITE (default)
- Since: 6.17.1.0
synchronize.archive.timeout.minutes
- Module: cmas-core-index-common
- Description: Determines the time period in minutes during which index updates are archived. The default value of this property is 60. If the master node is switched, the new master can recover missing data in case it had not been fully synchronized with the previous master indexing server at the moment of switch. The property is ignored for non-clustered environments.
- Beschreibung: Legt den Zeitraum (in Minuten) fest, in dem Indexaktualisierungen archiviert werden. Der Standardwert für diese Property ist 60. Wenn der Master-Node wechselt, kann der neue Master fehlende Daten wiederherstellen, falls er zum Zeitpunkt des Wechsels nicht vollständig mit dem vorherigen Master-Index-Server synchronisiert war. Die Property wird für nicht geclusterte Umgebungen ignoriert.
- Type: Integer
- Restart required: No
- System: Yes
- Optional: No
- Example value: 60
- Since: 6.12.0, changed in 6.15.0
synchronize.master.address
- Module: cmas-core-index-common
- Description: Value of
-Dcmas.http.host.portspecifying how to connect to the indexing master server. You can switch the node acting as master node by entering the address of the new master node. The index updates are archived for the time configured in the propertycmas-core-index-common, synchronize.archive.timeout.minutes, so the new master can recover missing data in case it had not been fully synchronized with the previous master indexing server at the moment of switch. - Beschreibung: Wert von
-Dcmas.http.host.port, der angibt, unter welcher URL der Index-Master-Server erreichbar ist. Es ist möglich, den Node, der als Master-Node dient, zu wechseln. Dazu wird die Adresse des neuen Master-Nodes angegeben. Die Indexaktualisierungen werden für den in der Propertycmas-core-index-common, synchronize.archive.timeout.minuteskonfigurierten Zeitraum archiviert, sodass der neue Master fehlende Daten wiederherstellen kann, sofern er zum Zeitpunkt des Wechsels nicht vollständig mit dem vorherigen Master-Index-Server synchronisiert war. - Type: Integer
- Restart required: No
- System: Yes
- Optional: Yes
- Example value: 127.0.0.1:80
- Since: 6.6.0, changed in 6.12.0
synchronize.master.security.token
- Module: cmas-core-index-common
- Description: The password for accessing the index snapshot via URL, e.g., for index synchronization or for backups. This value is negotiated between nodes internally, please do not change it manually unless advised by ConSol.
- Beschreibung: Das Passwort für den URL-Zugriff auf den Index-Snapshot, z. B. für die Index-Synchronisierung oder für Backups. Dieser Wert wird intern zwischen den Nodes ausgehandelt. Ändern Sie ihn nicht manuell, außer wenn Sie von ConSol dazu aufgefordert werden.
- Type: String
- Restart required: No
- System: Yes
- Optional: Yes
- Example value: token
- Since: 6.6.0
synchronize.master.security.user
- Module: cmas-core-index-common
- Description: The username for accessing the index snapshot via URL, e.g., for index synchronization or for backups. This value is negotiated between nodes internally, please do not change it manually unless advised by ConSol.
- Beschreibung: Der Benutzername für den URL-Zugriff auf den Index-Snapshot, z. B. für die Index-Synchronisierung oder für Backups. Dieser Wert wird intern zwischen den Nodes ausgehandelt. Ändern Sie ihn nicht manuell, außer wenn Sie von ConSol dazu aufgefordert werden.
- Type: String
- Restart required: No
- System: Yes
- Optional: Yes
- Example value: user
- Since: 6.6.0
synchronize.master.timeout.minutes
- Module: cmas-core-index-common
- Description: Determines how much time (in minutes) the master server may continually fail until a new master gets elected. 0 means that master server will never change (failover mechanism is disabled). The default value is 5.
- Beschreibung: Legt fest, wie lange (in Minuten) die Index-Synchronisierung ausgehend vom aktuellen Master-Server fehlschlagen darf, bis ein neuer Master für die Index-Reparatur ausgewählt wird. 0 bedeutet, dass der Master-Server nie geändert wird (Failover-Mechanismus deaktiviert). Der Standardwert ist 5.
- Type: Integer
- Restart required: No
- System: Yes
- Optional: No
- Example value: 5
- Since: 6.6.0