enaio® lumee-administrator

Mit enaio® lumee-administrator wird die Indizierung von Objekttypen für den Datenbezug in enaio® lumee konfiguriert und gesteuert.

Für Objekttypen, die eingebunden werden sollen, wird ein objekttyp-spezifischer Batch erstellt, der die Indizierung bestehender und neu angelegter Objekte in der Vektor-Datenbank ausführt.

Für den Zugriff auf enaio® lumee-administrator ist die Systemrolle 'Administrator: Konfiguration Gesamtsystem' notwendig. Der Parameter useVectorStore muss den Wert true haben.

Der Aufruf von enaio® lumee-administrator erfolgt über folgende Adresse: <service-manager-ip>:<port>/admin

Standard-Port des Services 'lumee': 8360

Über Icons in der Kopfzeile kann die Sprache gewählt und zwischen dunklem und hellem Modus gewechselt werden.

Über die Kopfzeile wechseln Sie zwischen den Bereichen:

• Batches

  Angezeigt werden alle Objekttypen der Objektdefinition. Für Objekttypen werden Batches angelegt, die festlegen, welche Objekte indizierte werden.

• Aufgaben

  Alle laufenden Aufgaben zur Indizierung werden angezeigt. Angezeigt werden ebenfalls fehlgeschlagene Indizierungen.

• Inspektor

  Informationen zu einzelnen Objekten können aufgerufen werden.

• Einstellungen

  Angezeigt werden Daten der Konfiguration von enaio® lumee.

Zu jedem Bereich und Dialog kann eine Kontexthilfe eingeblendet werden.

Batches

Die Anzeige im Bereich Batches kann über die Funktionsleiste auf die Objekttypen eingeschränkt werden, für die bereits ein Batch konfiguriert ist.

Batches hinzufügen

Batches steuern die Indizierung bestehender und neu angelegter Objekte des Objekttyps.

Über + Batch hinzufügen eines angezeigten Objekttyps wird ein Batch für den entsprechenden Objekttyp erstellt.

Batch-Parameter

Parameter	Wert
Typ-ID	Die Typ-ID ist voreingetragen. Wählen Sie + Batch hinzufügen aus der Funktionsleiste, dann müssen Sie die Typ-ID angeben.
Bedingung	Für die Indizierung könne Objektbedingungen angegeben werden. Objektbedingungen beziehen sich auf die Daten der Objekte des Objekttyps. Nur Objekte, die die Bedingungen erfüllen, werden indiziert.
Ordnerbedingung	Ordnerbedingungen beziehen sich auf die Daten des Ordners, in dem Objekte angelegt sind.
Kategorie	Für Ordner- und Registertypen können die Indexdaten, für Dokumenttypen die Indexdaten, der Inhalt oder Indexdaten und Inhalt indiziert werden.

Batch-Bedingungen werden vor dem Speichern gegen die Objektdefinition validiert. Sind Bedingungen nicht valide, wird der Batch nicht gespeichert.

Nach dem Speichern des Batches wird die Indizierung sofort gestartet.

Der Batch wird als 'aktiv' gekennzeichnet. Die laufenden Aufgaben werden angezeigt. Klicken Sie auf einen Aufgabe, dann werden die Aufgaben mit dem entsprechenden Status im Bereich Aufgaben angezeigt.

Der Status des Indizierungs-Jobs wird angezeigt. Ist der Indizierungs-Job abgeschlossen, erhält er den Status 'finished'. Bericht und das ausführliche Protokoll können angezeigt werden. Der Bericht zeigt die Batch-Eigenschaften, die Job-Eigenschaften und die Aktionsübersicht. Das Protokoll zeigt alle Objekte und Aktionen.

Der Indizierungs-Job kann gelöscht werden. Das Löschen löscht den Bericht und das Protokoll.

In der Batch-Ansicht werden alle Jobs, die für den Batch ausgeführt wurden, angezeigt. Abgeschossene Jobs werden als Standard automatisch nach 14 Tagen gelöscht.

Batch-Bedingungen

Bedingungen können sich auf die Daten der Objekte und auf die Daten der Ordner, in dem Objekte angelegt sind, beziehen.

Objektbedingungen und Ordnerbedingungen können kombiniert werden. Sie werden logisch durch AND verknüpft.

Ohne Bedingungen werden alle Objekte entsprechend der Kategorie indiziert.

Objektbedingungen

Objektbedingungen - Beispiel:

d.date = > '2025-01-01'

Nur Objekte, die im Feld 'date' mit einem Datum nach dem 1.1.2025 indexiert sind, werden indiziert.

Objekttyp-Felder werden mit dem Alias 'd' angegeben.

Ordnerbedingungen

Ordnerbedingungen - Beispiel:

f.status = 'active'

Nur Objekte, die im Feld 'status' mit 'active' indexiert sind, werden indiziert.

Ordnertyp-Felder werden mit dem Alias 'f' angegeben.

Details zu Bedingungen finden Sie in der Entwicklerdokumentation.

Batches bearbeiten und verwalten

Über das Menü-Icon öffnen Sie die Liste der Bearbeitungsfunktionen für den Batch.

Batch bearbeiten

Über Batch bearbeiten öffnen Sie den Batch.

Objektbedingungen, Ordnerbedingungen und Kategorie können ergänzt und geändert werden.

Änderungen haben keine Auswirkungen auf bestehende Indizierungen. Änderungen haben nur Auswirkungen auf die Indizierung neu angelegter Objekte.

Index-Job hinzufügen

Mit einem Index-Job können für den Objekttyp Bedingungen ergänzt werden. Falls Batch-Bedingungen konfiguriert sind werden die Job-Bedingungen logisch durch AND verknüpft.

Objektbedingungen und Ordnerbedingungen können als Job-Bedingungen ergänzt werden.

Beispiel:

Batch-Bedingung: d.date = > '2025-01-01'

Index-Job-Bedingung: d.status = 'active'

Indizierungs-Bedingung: (d.createdDate > '2025-01-01') AND (d.status = 'active')

Index-Jobs können im Testlauf ausgeführt werden. Im Testlauf wird nur ein Protokoll erstellt. Protokolliert werden Daten zu allen Objekten, die durch die Änderung betroffen sind.

Index-Jobs führen zu einer Neuindizierung bestehender Objekte. Die Indizierungsbedingungen neu angelegter Objekte werden nicht geändert.

In der Batch-Ansicht werden alle Jobs, die für den Batch ausgeführt wurden, angezeigt. Abgeschossene Jobs werden als Standard automatisch nach 14 Tagen gelöscht.

Check-Index-Job hinzufügen

Mit einem Index-Job werden alle bestehenden Indizierungen für den Objekttyp geprüft.

• Existenzprüfung
  Geprüft wird, ob Objekte noch existieren, also weder gelöscht noch in den Papierkorb verschoben wurde.
  Falls Objekte nicht mehr existieren, dann werden die Indizierungen gelöscht.
• Bedingungsprüfung
  Geprüft wird, ob Objekte noch den Bedingungen des Batches entsprechen. Falls das nicht der Fall ist, dann werden die Indizierungen der entsprechenden Objekte gelöscht.
• Änderungsdatum-Prüfung
  Geprüft wird, ob das Änderungsdatum der Objekte mit dem Datum der letzten Indizierungsänderung übereinstimmt. Falls das nicht der Fall ist, dann werden die Indizierungen der entsprechenden Objekte aktualisiert.

Check-Index-Jobs können im Testlauf ausgeführt werden. Im Testlauf wird nur ein Protokoll erstellt. Protokolliert werden Daten zu allen Objekten, die durch die Änderung betroffen sind.

In der Batch-Ansicht werden alle Jobs, die für den Batch ausgeführt wurden, angezeigt. Abgeschossene Jobs werden als Standard automatisch nach 14 Tagen gelöscht.

Pausieren

Das Pausieren eines Batches stoppt laufende Indizierungen und führt keine Indizierungen neuer oder geänderter Objekte aus.

Pausierte Batches können über Fortsetzen wieder aktiviert werden. Laufende Indizierungen werden fortgeführt, neue und geänderte Objekte werden indiziert.

Sie können über die Funktionsleiste ebenfalls alle Batches pausieren und alle Batches fortsetzen.

Batch löschen

Das Löschen eines Batches löscht alle Daten des Batches: die durch den Batch angelegten Indizierungen, alle laufende Indizierungen und die Protokolle.

Die Daten werden endgültig gelöscht und können nicht wiederhergestellt werden.

Aufgaben

Im Bereich Aufgaben können laufenden Aufgaben zur Indizierung angezeigt werden und ebenfalls fehlgeschlagene Indizierungen.

Für die Suche nach Aufgaben können Filter verwendet werden. Ohne Filter werden alle Aufgaben angezeigt.

Folgende Funktionen können ausgeführt werden:

• Fehlgeschlagene wiederholen

  Aufgaben mit dem Status FAILED werden auf den Status PENDING zurückgesetzt. Dadurch wird bei folgenden Indizierungen erneut versucht, die entsprechenden Objekte zu indizieren.

• Fehlgeschlagene ignorieren

  Aufgaben mit dem Status FAILED werden auf den Status IGNORED zurückgesetzt. Dadurch werden die Objekte bei folgenden Indizierungen nicht erneut indiziert.

• Ignorierte wiederholen
  

  Angezeigte Aufgaben mit dem Status IGNORED werden auf den Status PENDING zurückgesetzt. Dadurch wird bei folgenden Indizierungen erneut versucht, die entsprechenden Objekte zu indizieren.

Inspektor

Im Bereich Inspektor können Daten zu einem Objekt angezeigt werden.

Das Objekt wird über die Objekt-ID angegeben.

Mit der Option Textdarstellung einschließen wird für Dokumente ebenfalls der Textinhalt angezeigt.

Für das Objekt kann die Funktion Aus Index entfernen ausgeführt werden. Dadurch wird die Indizierung des Objekts gelöscht.

Einstellungen

Im Bereich Einstellungen werden technische Daten zur Konfiguration von enaio® lumee angezeigt.

Die Werte können über die Konfigurationsdatei lumee-prod.yml aus dem Verzeichnis \config von enaio® service-manager geändert werden.

Folgende Daten sind für die Indizierung durch enaio® lumee-administrator relevant:

Indizierungs-Parameter

Parameter	Bemerkung	Standard-Wert
lumee.index.batch-size	Anzahl der Objekte pro Batch beim Erstellen von Indizierungsaufgaben.	1000
lumee.index.max-retry	Maximale Anzahl an Wiederholungen, bevor eine Aufgabe durch den Status FAILEDals fehlgeschlagen markiert wird.	5
lumee.index.retry-delay	Verzögerung in Sekunden zwischen Wiederholungen, multipliziert mit der Wiederholungszahl. Beispiel: Bei dem Standardwert von 30 Sekunden wartet der erste Versuch 30 Sekunden, der zweite 60Sekunden, der dritte 90Sekunden.	30
lumee.index.job-max-age-days	Maximales Alter in Tagen für abgeschlossene Batch-Jobs. Ein Bereinigungsprozess läuft einmal täglich im Hintergrund und entfernt abgeschlossene Jobs und deren Protokoll-Einträge, die älter als dieser Wert sind.	14