Konfigurationsknoten "General"
Konfigurationsknoten "Cache"
In dem Konfigurationsknote Cache können Sie definieren, welche Datenbank für die Zwischenspeicherung genutzt wird.
Eigenschaft | Beschreibung |
|---|---|
ConnectionString | Verbindungszeichenfolge zur Cache-Datenbank |
ConsistencyCheck | Wenn diese Eigenschaft aktiviert ist, wird eine Konsistenzprüfung durchgeführt. |
DatabaseName | Name der Datenbank |
DriverType | Treiber-Typ der Cache-Datenbank |
Tenant | Mandant (optional) Wenn kein Mandant angegeben ist, wird die globale Cache-Datenbank verwendet. |
Konfigurationsknoten "License"
Der Konfigurationsknoten License zeigt den aktuellen Lizenzstatus an. Der Knoten License → CurrentLicense zeigt Ihre aktuelle Lizenz an.
xSuite Archive Prism kennt nur Volumenlizenzen, keine Benutzer-Modelle. Pro Lizenz können folgenden Werte beschränkt werden:
Anzahl der Archive
Anzahl der Dokument in allen Archiven
Die Überprüfung der Beschränkung erfolgt bei dem Versuch, ein neues Archiv anzulegen (Anzahl Archive) sowie beim Einfügen von Dokumenten. Die Prüfung findet nur einmal pro Stunde statt, sodass die Dokumentmengen nicht scharf begrenzt sind. Bei 10 % Überschreitung erfolgt eine Warnung im Log. In diesem Archiv ist dann keine Anlage von Dokumenten mehr möglich.
Eine Lizenz kann außerdem für ein bestimmtes Major-Release und/oder für eine gewisse Laufzeit in Tagen ausgestellt werden.
Lizenzdaten
Die folgenden Eigenschaften sind in dem Konfigurationsknoten License → CurrentLicense verfügbar.
Eigenschaft | Typ | Beschreibung |
|---|---|---|
MajorVersion | Zahl | Major-Version, bis zu der die Lizenz gültig ist Wenn der Wert |
Customer | Text | Name des Kunden, für den die Lizenz ausgestellt wurde |
MaxArchives | Zahl | maximale Anzahl der Archive. Ist eine Wenn der Wert |
MaxDocuments | Zahl | Anzahl der Dokumente in allen Archiven Wenn der Wert |
Expires | Datum | Datum, an dem die Lizenz abläuft Wenn kein Wert angegeben ist, gilt die Lizenz unbegrenzt. |
Signature | Text | Signatur |
Lizenz-Status
Die folgenden Eigenschaften sind in dem Konfigurationsknoten License → State verfügbar.
Eigenschaft | Typ | Beschreibung |
|---|---|---|
Archives | Zahl | Liste aller Archive und ihrer Dokumentanzahl |
Limitation not exceeded | Text | Dokumentanzahlbegrenzung
|
Number of free archives | Zahl | Zahl der Archive, die noch angelegt werden dürfen (nur bei Archivbegrenzung) |
Time for counting documents | Zahl | Zeit, die der Server gebraucht hat, um die Dokumentanzahl zu ermitteln |
Version | Text | Versionsnummer der installierten Software |
Konfigurationsknoten "Log"
Hinweis
Wenn Sie Logging-Einstellungen ändern, starten Sie den Webserver und den Archiv-Dienst neu.
Der xSuite-Archive-Server kann in verschiedene Ziele Protokolle schreiben. Im Standard wird das Protokoll in eine MongoDB-Datenbank geschrieben. Diese Protokolleinträge können Sie über das Log einsehen.
Im Standard werden alle Meldungen außer Debug-Meldungen protokolliert. Sie können das Protokollieren von Debug-Meldungen für einen festgelegten Zeitraum aktivieren. Geben Sie hierzu im Feld Debug Folder einen Speicherort für die Log-Datei an und im Feld Enable Debug Logging until ein Enddatum für das Debug-Logging.
Die Ausgabeziele des Protokolls werden über Logger definiert. Die Verwendung von mehreren Loggern gleichzeitig ist möglich. Mehrere Logger werden über einen CompositeLogger zusammengefasst.
Im Standard sind die folgenden Logger verfügbar:
Logger | Beschreibung |
|---|---|
ConsoleLogger | schreibt in die Konsole Dieser Logger ist für eine Serveranwendung nicht sinnvoll. Bei Kommandozeilentools kann dieser Logger hilfreich sein. Im Standard ist dieser Logger nicht aktiv. |
FileLogger | schreibt in eine Datei Im Standard ist dieser Logger nicht aktiv. |
MongoDbLogger | schreibt in eine MongoDB-Datenbank Dieser Logger ist im Standard aktiv und protokolliert auch das Audit-Trail. |
CompositeLogger
Der CompositeLogger trägt die globalen Log-Einstellungen und verteilt die Log-Einträge auf die einzelnen Logger weiter.
Eigenschaft | Typ | Standardwert | Beschreibung |
|---|---|---|---|
Description | String |
| Kurze Beschreibung des Loggers |
IsInternalLoggingEnabled | Bool |
| Internes Logging des Loggers eingeschaltet. |
LoggerFactoryType | String |
| Vollqualifizierter Name der Factory-Klasse, welche Instanzen vom Typ ILog erzeugt. |
LogThreshold | String |
| Log-Level |
MaxSize | Integer |
| Max. Größe des Logs, z. B. für Log-Dateien |
Name | String |
| Name des Loggers |
ShowLogName | Bool |
| Anzeigen der Logquelle in formatierten Log-Einträgen |
ShowLogThreshold | Bool |
| Anzeigen des Log-Levels in formatierten Log-Einträgen |
ShowTimestamp | Bool |
| Anzeigen des Zeitstempels in formatierten Log-Einträgen |
Tenant | String | Wenn gesetzt, werden Log-Einträge in das entsprechende Mandanten-Log geschrieben. Im Standard nicht setzen. | |
TimeStampFormat | String |
| Zeitstempelformat |
ChildLogger | Array | Zugeordnete Logger |
ConsoleLogger
Der ConsoleLogger ist ein Logger, welcher z. B. bei den Tools die Log-Einträge im Ausgabefenster ausgibt. Im Auslieferungszustand ist dieser Logger ausgeschaltet.
Eigenschaft | Typ | Standardwert | Beschreibung |
|---|---|---|---|
Description | String |
| Kurze Beschreibung des Loggers |
IsInternalLoggingEnabled | Bool |
| Internes Logging des Loggers eingeschaltet. |
LoggerFactoryType | String |
| Vollqualifizierter Name der Factory-Klasse, welche Instanzen vom Typ ILog erzeugt. |
LogThreshold | String |
| Log-Level |
Name | String |
| Name des Loggers |
ShowLogName | Bool |
| Anzeigen der Logquelle in formatierten Log-Einträgen |
ShowLogThreshold | Bool |
| Anzeigen des Log-Levels in formatierten Log-Einträgen |
ShowTimestamp | Bool |
| Anzeigen des Zeitstempels in formatierten Log-Einträgen |
Tenant | String | Wenn gesetzt, werden Log-Einträge in das entsprechende Mandanten-Log geschrieben. Im Standard nicht setzen. | |
TimeStampFormat | String |
| Zeitstempelformat |
Filters | Array | Zugeordnete Filter |
FileLogger
Der FileLogger schreibt Log-Ausgaben in Dateien.
Eigenschaft | Typ | Standardwert | Beschreibung |
|---|---|---|---|
Description | String |
| Kurze Beschreibung des Loggers |
IsInternalLoggingEnabled | Bool |
| Internes Logging des Loggers eingeschaltet. |
LoggerFactoryType | String |
| Vollqualifizierter Name der Factory-Klasse. |
LogThreshold | String |
| Log-Level |
Name | String |
| Name des Loggers |
MaxSize | Integer |
| Max. Größe der Log-Datei |
Path | String |
| Pfad für Log-Dateien |
Pattern | String |
| Maske für Dateinamen. Platzhalter: 0=Datum, 1=Log-Quelle, 2=Loglevel, 3=Aktion, 4=Mandant, 5=Tracking Key |
ShowLogName | Bool |
| Anzeigen Logquelle in Log-Einträgen |
ShowLogThreshold | Bool |
| Anzeigen Log-Levels in Log-Einträgen |
ShowTimestamp | Bool |
| Anzeigen Zeitstempels in Einträgen |
Tenant | String | Wenn gesetzt, werden Log-Einträge in das entsprechende Mandanten-Log geschrieben. | |
TimeStampFormat | String |
| Zeitstempelformat |
Filters | Array | Zugeordnete Filter |
MongoDbLogger
Dieser Logger schreibt Log-Einträge in eine MongoDB.
Eigenschaft | Typ | Standardwert | Beschreibung |
|---|---|---|---|
Description | String |
| Kurze Beschreibung des Loggers |
IsInternalLoggingEnabled | Bool |
| Internes Logging des Loggers eingeschaltet. |
LoggerFactoryType | String |
| Vollqualifizierter Name der Factory-Klasse, welche Instanzen vom Typ ILog erzeugt. |
LogThreshold | String |
| Log-Level |
Name | String |
| Name des Loggers |
ConnectionString | String |
| Verbindungszeichenfolge für MongoDB |
DatabaseName | String |
| Name der Datenbank |
ShowLogName | Bool |
| Anzeigen der Logquelle in formatierten Log-Einträgen |
ShowLogThreshold | Bool |
| Anzeigen des Log-Levels in formatierten Log-Einträgen |
ShowTimestamp | Bool |
| Anzeigen des Zeitstempels in formatierten Log-Einträgen |
Tenant | String | Wenn gesetzt, werden Log-Einträge in das entsprechende Mandanten-Log geschrieben. Im Standard nicht setzen. | |
TimeStampFormat | String |
| Zeitstempelformat |
Filters | Array | Zugeordnete Filter |
Debug-Ausgaben
Wenn Debug-Ausgaben benötigt werden, können Sie den FileLogger aktivieren. Dieser ist im Auslieferungszustand so konfiguriert, dass er nach C:\Temp jeweils max. 5-MB-große Dateien erstellt, die nur Debug- und Trace-Meldungen enthalten.
Hinweis
Debug-Ausgaben sind umfangreich und können dazu führen, dass das konfigurierte Laufwerk vollläuft. Schalten Sie die Debug-Ausgaben nur für den benötigten Zeitraum ein.
Hinweis
Sie können die Ausgabe von Debug-Meldungen auch direkt im Konfigurationsknoten Log einschalten.
Das Einschalten erfolgt über das Deaktivieren der Checkbox Enabled am NullLoggerFilter des FileLoggers, welcher sich unter /Log/Config → Logger/ChildLogger befindet. Das Einschalten wirkt für bereits gestartete Prozesse nicht sofort, sondern erst nach einer gewissen Zeit. Für sofortiges Einschalten Archiv-Dienste durchstarten.
Das Ausschalten erfolgt über das Aktivieren der Checkbox Enabled am NullLoggerFilter des FileLoggers welcher sich unter /Log/Config → Logger/ChildLogger befindet. Das Ausschalten wirkt für bereits gestartete Prozesse nicht sofort, sondern nur nach einer gewissen Zeit. Für sofortiges Ausschalten Archiv-Dienste durchstarten.
Filter
Filter schränken die Ausgabe der Log-Einträge ein. Eine Besonderheit stellt der NullLoggerFilter dar: Er filtert alle Log-Ausgaben für einen Logger heraus und kann als Ein-/Aus-Schalter verwendet werden. Dieser ist an allen Loggern bis auf den FileLogger im Auslieferungszustand ausgeschaltet. Derzeit sind folgende Filter möglich:
Name | Zweck/Auswirkung |
|---|---|
NullLoggerFilter | Unterdrückt alle Log-Ausgaben. |
ThresholdRangeLoggerFilter | Filtert auf bestimmte Loglevel (von-bis). |
StringMatchLoggerFilter | Filtert auf bestimmte Zeichenfolgen in Log-Einträgen (Meldungstext). |
TenantMatchLoggerFilter | Filtert auf Log-Ausgaben für einen bestimmten Mandanten. |
ActionMatchLoggerFilter | Filtert auf den Beginn des Namens von Aktionen. |
TrackingKeyMatchLoggerFilter | Filtert auf den Beginn eines Tracking Keys. |
NullloggerFilter
Eigenschaft | Typ | Standardwert | Beschreibung |
|---|---|---|---|
Description | String |
| Kurze Beschreibung des Logger-Filters. |
LoggerFilterType | String |
| Vollqualifizierter Name des Typs. |
Name | String |
| Name des Logger-Filters |
Enabled | Bool |
| Ein- oder ausgeschaltet. |
ThresholdRangeLoggerFilter
Eigenschaft | Typ | Standardwert | Beschreibung |
|---|---|---|---|
Description | String |
| Kurze Beschreibung des Logger-Filters. |
LoggerFilterType | String |
| Vollqualifizierter Name des Typs. |
Name | String |
| Name des Logger-Filters |
AcceptOnMatch | Bool |
| Wenn |
Enabled | Bool |
| Ein- oder ausgeschaltet. |
ThresholdMin | String |
| Minimaler Loglevel |
ThresholdMax | String |
| Maximaler Loglevel |
StringMatchLoggerFilter
Eigenschaft | Typ | Standardwert | Beschreibung |
|---|---|---|---|
Description | String |
| Kurze Beschreibung des Logger-Filters. |
LoggerFilterType | String |
| Vollqualifizierter Name des Typs. |
Name | String |
| Name des Logger-Filters |
AcceptOnMatch | Bool |
| Wenn |
StringToMatch | String | Zeichenfolge, nach der gefiltert werden soll | |
RegexToMatch | String | Regulärer Ausdruck, nach dem gefiltert werden soll. |
TenantMatchLoggerFilter
Eigenschaft | Typ | Standardwert | Beschreibung |
|---|---|---|---|
Description | String |
| Kurze Beschreibung des Logger-Filters. |
LoggerFilterType | String |
| Vollqualifizierter Name des Typs. |
Name | String |
| Name des Logger-Filters |
AcceptOnMatch | Bool |
| Wenn True, dann werden Log-Ausgaben nach angegebenen TenantToMatch gefiltert. Bei False werden die entsprechend übereinstimmenden Einträge nicht ausgegeben. |
TenantToMatch | String | Mandant, nach dem gefiltert werden soll |
ActionMatchLoggerFilter
Eigenschaft | Typ | Standardwert | Beschreibung |
|---|---|---|---|
Description | String |
| Kurze Beschreibung des Logger-Filters. |
LoggerFilterType | String |
| Vollqualifizierter Name des Typs. |
Name | String |
| Name des Logger-Filters |
AcceptOnMatch | Bool |
| Wenn |
ActionToMatch | String | Beginn des Namens der Aktion, nach der gefiltert werden soll |
TrackingKeyMatchLoggerFilter
Eigenschaft | Typ | Standardwert | Beschreibung |
|---|---|---|---|
Description | String |
| Kurze Beschreibung des Logger-Filters. |
LoggerFilterType | String |
| Vollqualifizierter Name des Typs. |
Name | String |
| Name des Logger-Filters |
AcceptOnMatch | Bool |
| Wenn |
TrackingKeyToMatch | String | Beginn des Tracking Key, nach dem gefiltert werden soll |
Konfigurationsknoten "SystemSettings"
Die "System Settings" sind grundsätzliche Systemeinstellungen für untergeordnete Systeme innerhalb von xSuite Archive Prism.
Unter DefaultSettings können Sie über die Tabs verschiedene Bereiche von Systemeinstellungen aufrufen.
![]() |
Index
In dem Tab Index sind Einstellung für die Indexierung verfügbar.
Eigenschaft | Typ | Beschreibung |
|---|---|---|
DefaultElasticSearchUri | Text | Standard-URI für Elasticsearch Diese URI kann auch Credentials in unverschlüsselter und verschlüsselter Form enthalten. |
HighlightingPostTag | Text | HTML-Code, der ein Highlighting beendet. Beispiel: Beendet das Highlighting, wie es im Beispiel für den PreTag eingeleitet wurde. |
HighlightingPreTag | Text | HTML-Code, der ein Highlighting einleitet Beispiel: Dieses Beispiel erzeugt ein Highlighting in fetter, roter Schrift. |
IndexJobTimeout | Zahl | Zeit in Sekunden, die der Indexjob auf eine Antwort von Elasticsearch wartet |
MaxBulkContentSize | Zahl | maximale Größe eines Index-Bulks für Elasticsearch Dieser Wert korrespondiert mit der Einstellung in der http.max_content_length: Es wird empfohlen, MaxBulkContentSize auf etwa die Hälfte einzustellen. |
Storage
In dem Tab Storage sind Einstellungen für den Storage-Bereich verfügbar.
Eigenschaft | Typ | Beschreibung |
|---|---|---|
CheckHashOnLoad | Ja/Nein | Beim Laden eines Dokuments im Client wird der Hash geprüft und eine Meldung ausgegeben. Im Standard ist dies nicht der Fall. |
StorageCacheTime | Zahl | Zeit in Minuten, die der Storage ein Archiv, einen Index oder Ähnliches im Cache behält. |
Permissions
In dem Tab Permissions sind Einstellungen für Berechtigungen verfügbar.
Eigenschaft | Typ | Beschreibung |
|---|---|---|
PermissionCacheTime | Zahl | Zeit in Minuten, die der Server Berechtigungen im Cache hält |
AuthProvider
In dem Tab AuthProvider sind Einstellungen für Rollen und Proxy-Server verfügbar.
Hinweis
Die Einstellungen sind vom Setup bereits vorbelegt. Ändern Sie diese Einstellungen nur, wenn ein Support-Problem vorliegt.
Eigenschaft | Typ | Beschreibung |
|---|---|---|
AllowedProxies | Text | kommaseparierte Liste der Proxy-Server-Namen, denen der Archiv-Server vertraut |
RoleProvider | Text | .NET-Klasse, die dem Server die Rollen liefert |
RolesCacheTime | Zahl | Zeit in Minuten, die der Server die Rollen cacht |
AuthorityCore
In dem Tab AuthorityCore sind Einstellungen für den xSuite-Authority-Core verfügbar.
Hinweis
Die Einstellungen sind vom Setup bereits vorbelegt. Ändern Sie diese Einstellungen nur, wenn ein Support-Problem vorliegt.
Eigenschaft | Typ | Beschreibung |
|---|---|---|
ApplicationName | Text | Name der Anwendung für die Rollen |
AuthType | Text | Typ der Autorisierung Es wird immer der Typ Basic verwendet. |
CustomerKey | Text | Customer, der in xSuite Encore Prism angelegt ist |
ServiceURL | Text | Service-URL des xSuite-Core-Servers |
ServiceUserDomain | Text | Domain |
ServiceUserName | Text | Service-Username |
ServiceUserPassword | Text | Service-User-Passwort |
TenantKey | Text | Mandant, der in xSuite Encore Prism angelegt ist |
TenantMap | Text | Zusammengesetzt aus TenantKey und CustomerKey: HinweisxSuite Encore Prism kennt Customers und Tenants, die technisch voneinander getrennt sind. Jede Kombination wird in xSuite Archiv Prism als ein xSuite-Archive-Mandant behandelt, da das xSuite Archive Prism nur Tenants kennt. |
TempFiles
In dem Tab TempFiles sind Einstellungen für temporäre Dateien verfügbar.
Eigenschaft | Typ | Beschreibung |
|---|---|---|
TemporaryFolder | Text | Existierender oder anlegbarer Ordner, in dem temporäre Dateien verwaltet werden. Diese werden vom Server dann auch wieder aufgeräumt. Ist dieser Wert nicht korrekt gesetzt, werden die Dateien im Temp-Verzeichnis gehalten und nicht aufgeräumt. |
MaxMemSizeStream | Zahl | Dateien, die der Server nicht im Temp-Verzeichnis erzeugt, sondern im Speicher hält. Die Einheit ist Bytes. |
Locking
In dem Tab Locking sind Einstellungen für das Sperren von Objekten verfügbar.
Eigenschaft | Typ | Beschreibung |
|---|---|---|
LockExpire | Zahl | Zeit in Sekunden, nachdem ein angeforderter Lock wieder freigeben wird, wenn der Prozess dies nicht selbst getan hat |
LockTimeOut | Zahl | Zeit in Millisekunden, die auf die Freigabe eines Locks gewartet wird |
Reporting
In dem Tab Reporting sind Einstellung für den E-Mail-Versand von Import-Job-Benachrichtigungen verfügbar.
Eigenschaft | Typ | Beschreibung |
|---|---|---|
SmtpHost | Text | SMTP-Server für E-Mail-Versand |
SmtpPort | Zahl | SMTP-Portnummer |
SmptUser | Text | Benutzer für E-Mail-Versand |
SmtpPassword | Text | Kennwort für den Benutzer des E-Mail-Versands |
ReportSender | Text | Absender |
ReportRecipient | Text | Empfänger |
IndexJobManager
In dem Tab IndexJobManager sind Einstellungen für die asynchrone Indexierung verfügbar.
Eigenschaft | Typ | Beschreibung |
|---|---|---|
Collection | Text | MongoDB-Collection für die Index-Jobs (asynchrone Indexierung) |
Database | Text | MongoDB-Datenbank für die Index-Jobs (asynchrone Indexierung) |
Translation
In dem Tab Translation sind Einstellungen für die Übersetzungen im System verfügbar.
Eigenschaft | Typ | Beschreibung |
|---|---|---|
SystemLanguage | Text | interne Systemsprache für das Logging |
Security
In dem Tab Security sind Sicherheitseinstellungen verfügbar.
Eigenschaft | Typ | Beschreibung |
|---|---|---|
Salted | Ja/Nein | Steuert, ob User-Role-Passwörter mit einem Salt versehen werden. |
Replica
In dem Tab Replica sind Einstellungen für die Replikation verfügbar.
Eigenschaft | Typ | Beschreibung |
|---|---|---|
Collection | Text | MongoDB-Collection, in der ReplicaJobs verwaltet werden |
Database | Text | MongoDB-Datenbank, in der ReplicaJobs verwaltet werden |
Directory | Text | Verzeichnis im Dateisystem, in dem Replikationsdaten verwaltet werden, die noch in lokale Archive zu schreiben sind. |
ForeignDirectory | Text | Verzeichnis im Dateisystem, in dem Replikationsdaten verwaltet werden, die von einem anderen Server zur Replikation übertragen wurden. |
ReplicaActionTimeout | Zahl | Zeit in Sekunden, für die ein ReplicaJob zur Ausführung gesperrt wird |
Monitoring
In dem Tab Monitoring sind Einstellungen für die Überwachung und Protokollierung verfügbar.
Hinweis
Die Ergebnisse der Überwachung werden im Archiv-Monitor angezeigt.
Eigenschaft | Typ | Beschreibung |
|---|---|---|
ArchiveStorageController | Ja/Nein | Dieser Schalter bewirkt eine Protokollierung des Zusammenspiels zwischen den Archivdatenbanken (Verwaltung, Versionierung, Notizen) und der eigentlichen Ablage. |
ArchiveStorageDriver | Ja/Nein | Dieser Schalter bewirkt eine Protokollierung der eigentlichen Archiv-Ablage. |
Indexer | Ja/Nein | Dieser Schalter bewirkt eine Protokollierung der Indexierung. |
Searcher | Ja/Nein | Dieser Schalter bewirkt eine Protokollierung der Suchfunktionen. |
SAP
In dem Tab SAP sind Einstellung für SAP verfügbar.
Eigenschaft | Typ | Beschreibung |
|---|---|---|
CertCacheTime | Zahl | Zeit in Minuten, die Zertifikate gecacht werden |
