Datenbank- und Verzeichnisstrukturen
Bei der Nutzung einer relationalen Datenbank werden die folgende Tabellen angelegt:
Hinweis
Einige Eigenschaften der internen Objektmodelle werden nicht vollständig in elementare Eigenschaften auf Datenbank-Ebene aufgelöst.
Einige Tabellenfelder enthalten stattdessen multiple Werte in Form von JSON-Objekten oder in Form von Einzelwerten, die durch Trennzeichen separiert sind.
Hinweis
Unter bestimmten Umständen werden für Datenobjekte wie Logs (Tabelle "Log") und Konfigurationen (Tabelle "Configs") Datenbanken verwendet, die namentlich voneinander getrennt sind. In diesen Datenbanken ist nur die betreffende Tabelle relevant. Die übrigen Tabellen werden dennoch automatisch angelegt, aber bleiben leer.
Tabelle [Verknüpfung] | Beschreibung |
|---|---|
Batches | Stapel |
[1:n] Documents | Dokumente pro Stapel |
[1:n] Fields | Indexfelder pro Dokument (flache Liste der Kopf- und Tabellenfelder) |
[1:n] Attachments | Dateianlagen pro Dokument (nur Metadaten, Binärdaten liegen im temporären Storage) |
[1:n] DocHistory | Historie der Verarbeitungsschritte pro Dokument für das Monitoring |
BatchUpdateQueue | Warteschlange für die Stapelstatuswerte, die vom BatchUpdate-Worker aktualisiert werden |
CustomStore | Hilfstabelle zur Zwischenspeicherung benutzerdefinierter Werte über Makrofunktionen |
DataImport | Hilfstabelle zur Speicherung der Hashes der Datensätze für die xSuite-Helix-Stammdatenübertragung (Task "XSuiteHelixDataImport") |
Log | Protokolleinträge bei aktivem Logging in die interne Datenbank |
Status | aktueller Aktivitätsstatus der Worker-Instanzen für das Monitoring |
Configs | datenbankbasierte Konfigurationsdaten |
Bei Verwendung der NoSQL-Datenbank MongoDB werden analog zu den obigen Tabellen Collections erstellt. Für die Unterelemente von Documents existieren jedoch keine separaten Collections. Diese Daten werden stattdessen direkt in den Dokumentobjekten abgelegt.
Für die primären Verarbeitungsobjekte "Stapel" und "Dokument" sind nachfolgend die wichtigste Eigenschaften erläutert.
Allgemeine Eigenschaften
Die folgenden Eigenschaften gelten für Objekte des Typs "Stapel", "Dokument" und "Dateianlage".
Hinweis
Das Objekt vom Typ "Indexfeld" besitzt von den folgenden Eigenschaften nur die Eigenschaft Id.
Objekteigenschaft | Beschreibung |
|---|---|
Id | numerischer, fortlaufender Primär-Schlüssel des Objektes |
FixedGuid | zusätzlicher Schlüssel in Form einer UUID Der Schlüssel bleibt die Lebensdauer des Objektes unverändert. |
TempGuid | temporärer Schlüssel in Form einer UUID Der Schlüssel wird mit jeder Änderung am Objekt aktualisiert. |
Created | Zeitstempel der Erstellung des Objektes |
Modified | Zeitstempel der letzten Änderung des Objektes |
ProcessedBy | Kennung des Prozesses, der die letzte Änderung am Objekt durchgeführt hat Die Kennung kann der Rechnername, der Benutzername, der Prozessname oder die Prozess-ID sein. |
MetaData | optionale zusätzliche Metadaten zum Objekt, für die keine dedizierte Eigenschaft existiert |
Spezifische Eigenschaften – Stapel und Dokument
Die folgenden Eigenschaften gelten für alle Objekte des Typs "Stapel" und "Dokument".
Objekteigenschaft | Beschreibung |
|---|---|
ExternalId | technischer Name des Stapels oder Dokumentes Der Name wird in der Regel aus dem Eingabesystem übernommen. |
DisplayName | Anzeigename des Stapels oder Dokumentes |
Creator | "Ersteller" des Stapels oder Dokumentes Die Ausprägung ist abhängig vom Eingabesystem. Der "Ersteller" kann z. B. der Besitzer einer Datei, der Benutzer eines Postfachs oder der Anmeldename bei einem Webservice-Zugriff sein. |
Status | aktueller Verarbeitungsstatus des Stapels oder Dokumentes |
Step | aktueller Verarbeitungsschritt des Stapels oder Dokumentes |
ErrorText | Meldungstext eines stapelbezogenen oder dokumentbezogenen Verarbeitungsfehlers |
BackupData | Liste der Backup-Dateien auf Stapelebene oder auf Dokumentebene bei dateisystembasiertem Eingabesystem |
BatchLogFile | Pfad einer stapelspezifischen Log-Datei, wenn diese Datei gemäß der Konfiguration erstellt wird |
Spezifische Eigenschaften – Stapel
Objekteigenschaft | Beschreibung |
|---|---|
Scenarios | Liste der Namen der aktuellen Verarbeitungsszenarien über alle enthaltenen Dokumente hinweg Die aktuellen Verarbeitungsszenarien können durch dynamischen Wechsel vom |
OriginalScenario | Name des ursprünglichen Verarbeitungsszenarios, unter dem der Stapel eingelesen wurde |
TrackingIds | Liste der Tracking-IDs über alle Dokumente hinweg |
TrackingKeys | Liste der Tracking-Schlüssel über alle Dokumente hinweg |
CustomKeys | Liste der benutzerdefinierten Schlüssel über alle Dokumente hinweg |
DocCount | Anzahl der Dokumente, die in dem Stapel enthalten sind |
Spezifische Eigenschaften – Dokument
Objekteigenschaft | Beschreibung |
|---|---|
Number | laufende Nummer des Dokuments im Stapel Die Zählung beginnt bei 1. |
SubStep | Kennung des Unter-Verarbeitungsschritts bei einer mehrstufigen Ausgabe |
Scenario | Name des Verarbeitungsszenarios |
FieldCatalog | Name des verwendeten Feldkatalogs |
Priority | Priorität der Verarbeitung durch eine Worker-Instanz, die mehrere Szenarien bedient |
RetryNo | Nummer des Wiederholungsversuchs |
NextRetryTime | frühester Zeitpunkt der nächsten Ausführung bei automatischer Wiederholung der Verarbeitung im Fehlerfall |
TrackingId | Tracking-ID |
TrackingKey | Tracking-Schlüssel |
CustomKey | benutzerdefinierter Schlüssel |
ExternalKeys | Liste externer Schlüssel, die von Ausgabesystemen generiert wurden |
Spezifische Eigenschaften – Indexfeld
Objekteigenschaft | Beschreibung |
|---|---|
Name | Name des Feldes aus dem Feldkatalog |
Path | Pfad bei geschachtelten Tabellenfeldern, z. B. |
Value | aktueller Wert des Feldes in interner String-Notation (analog zu konstanten Makrowerten) |
Spezifische Eigenschaften – Dateianlage
Objekteigenschaft | Beschreibung |
|---|---|
Number | laufende Nummer der Dateianlage im Dokument Die Zählung beginnt bei 1. |
Type | Art der Dateianlage Mögliche Werte:
|
OriginalFile | Pfad oder Name der Ursprungsdatei aus dem Eingabesystem |
Name | Name der Dateianlage |
Size | Größe der Dateianlage in Bytes |
StorageKey | Schlüssel des zugehörigen Objektes mit den Binärdaten im temporären Storage |
ExternalKeys | Liste externer Schlüssel, die von Ausgabesystemen generiert wurden |
IsPrimaryFile | Kennzeichnung, ob die Datei die Primärdatei eines Dokumentes ist |
IsDocSplitFile | Kennzeichnung, ob die Datei aus einer künstlichen Dokumententrennung entstanden ist |
IsIndexFile | Kennzeichnung, ob die Datei eine Indexdatei ist |
Verzeichnisstruktur des Dateisystem-Storages
Die Binärdaten der Dateianlagen werden nicht in der Datenbank, sondern in einem temporären Storage zwischengespeichert. Wenn für die Zwischenspeicherung das Dateisystem genutzt wird, wird folgende Verzeichnisstruktur verwendet:
Ordner-/Dateiname | Beschreibung |
|---|---|
{Wurzelverzeichnis} | Wurzelverzeichnis gemäß der globalen Konfigurationseigenschaft |
…\{Mandant} | Unterverzeichnis des Mandanten Wenn der Standardmandant verwendet wird, hat das Unterverzeichnis den Namen |
…\...\{Stapel-ID} | Datenbank-ID des übergeordneten Stapels |
…\...\...\{UUID}_{Name} | Dateiname des Objektes im temporären Storage Der Dateiname besteht aus einer eindeutigen UUID und dem Namen der Dateianlage. Die Referenz auf das Objekt ist in der Datenbank als "StorageKey" gespeichert und setzt sich zusammen aus |
…\...\temp\{Instanz-ID}\inputWs …\...\temp\{Instanz-ID}\indexWs …\...\temp\{Instanz-ID}\stackOrg\output …\...\temp\stackOrg\{Stapel-ID} | Verzeichnisse für temporäre Arbeitsdateien des Input-Webservices, des Office+ Index Clients und der Stack-Organizer-Anwendung Die Instanz-ID ist eine eindeutige ID für jede parallelläufige Programminstanz. Durch diese ID wird sichergestellt, dass die Temporärdateien der Programminstanzen nicht mit den Temporärdateien der anderen Instanzen kollidieren. |