ELONIQ / ELONIQ Handbuch
Deutsch English Français

ELO Base

Zentrale ELO-Verbindung und Infrastruktur

ELO Base ist das zentrale Modul für die Verbindung zwischen ELONIQ und dem ELO DMS. Es verwaltet Authentifizierung, Caching, Dokumentenoperationen, Workflows und Benachrichtigungen — und bildet die Grundlage für alle anderen ELO-Module.

Übersicht

Das ELO Base-Modul ist das Herzstück von ELONIQ. Es stellt die sichere Verbindung zum ELO Indexserver her und bietet allen anderen Modulen (ELO Importer, ELO Exporter, ELO Mail Importer usw.) die nötige Infrastruktur für den Zugriff auf das ELO DMS.

Kernfunktionen
  • Verbindungsmanagement — Authentifizierung, Session-Pooling und automatische Wiederverbindung zu einem oder mehreren ELO-Archiven.
  • Caching — Masken, Benutzer, Aspekte und Serverdaten werden lokal in SQLite gespeichert und im Hintergrund aktualisiert.
  • Dokumentenoperationen — Upload, Download, Suche, Verschieben, Kopieren, Verlinken und Berechtigungen verwalten.
  • Workflow-Engine — Workflows starten, überwachen und automatisch über Chain-Trigger verarbeiten.
  • Benachrichtigungen — Multi-Kanal-Benachrichtigungen (E-Mail, Discord, Teams, Slack, Telegram) für Workflow-Aufgaben.
Architektur
┌────────────────────────────────────────────────────────┐
│                    ELONIQ Module                       │
│  ┌──────────┐  ┌──────────┐  ┌───────────────────┐    │
│  │Importer  │  │Exporter  │  │Mail Importer      │    │
│  └─────┬────┘  └─────┬────┘  └─────────┬─────────┘    │
│        │             │                 │               │
│  ┌─────▼─────────────▼─────────────────▼───────────┐  │
│  │              ELO Base Modul                      │  │
│  │  ┌──────────┐ ┌─────────┐ ┌──────────────────┐  │  │
│  │  │ Sessions │ │ Cache   │ │ Circuit Breaker  │  │  │
│  │  └──────────┘ └─────────┘ └──────────────────┘  │  │
│  │  ┌──────────┐ ┌─────────┐ ┌──────────────────┐  │  │
│  │  │ IX API   │ │ Tools   │ │ Benachrichtigung │  │  │
│  │  └────┬─────┘ └─────────┘ └──────────────────┘  │  │
│  └───────┼─────────────────────────────────────────┘  │
└──────────┼────────────────────────────────────────────┘
           │
     ┌─────▼─────┐
     │ ELO IX    │
     │ Server    │
     └───────────┘

Funktionen

  • Multi-Archive-Support — Verbindung zu mehreren ELO-Archiven gleichzeitig. Jedes Archiv wird unabhängig verwaltet mit eigenem Cache und eigener Session.
  • Intelligentes Caching — Masken, Benutzer, Aspekte und Serverdaten werden in SQLite zwischengespeichert. Kaltstart erfolgt aus der Datenbank, im Hintergrund wird der Cache automatisch aktualisiert.
  • Circuit Breaker — Automatische Erkennung von ELO-Ausfällen. Bei wiederholten Fehlern wird die Verbindung temporär gesperrt, um Überlastung zu vermeiden. Automatische Wiederherstellung nach 30 Sekunden.
  • Session-Management — Persistente HTTP-Verbindungen mit automatischer Erneuerung. Sessions werden wiederverwendet und bei Ablauf transparent erneuert.
  • Dokumentenoperationen — Upload, Download, Suche, Verschieben, Kopieren und Verlinken von Dokumenten über eine einheitliche API.
  • Workflow-Management — Workflows starten, Knoten abfragen, Aufgaben weiterleiten und Workflow-Status überwachen.
  • Multi-Kanal-Benachrichtigungen — Workflow-Aufgaben per E-Mail, Discord, Microsoft Teams, Slack oder Telegram an Benutzer senden. Sofort-Benachrichtigungen oder stündliche/tägliche Zusammenfassungen.
  • Berechtigungsverwaltung (ACL) — Zugriffsrechte auf Dokumente und Ordner setzen, erweitern oder einschränken. Drei Merge-Modi: Ersetzen, Erweitern (OR), Reduzieren (AND NOT).
  • Gen1 & Gen2 Metadaten — Unterstützung für klassische Indexfelder (Gen1) und moderne Aspekte (Gen2). Automatische Erkennung und Caching beider Generationen.
  • Health-Monitoring — Kontinuierliche Überwachung der Verbindungsqualität mit detailliertem Status pro Archiv.
  • Workflow-Chain-Trigger — Automatische Auslösung von Automation Chains basierend auf Workflow-Knoten. Ideal für Dokumentklassifikation und DATEV-Integration.
  • Automatische Dokumentklassifikation — ML-basierte Klassifikation über spezielle Workflow-Knoten mit DATEV SmartDB-Anreicherung für Finanzbelege.
  • Ordner-Tools — Ordner erstellen, Ordnerpfade anlegen und Objekte zwischen Ordnern verschieben oder kopieren.
  • Benutzer-Webinterface — Dashboard, erweiterte Suche, Archiv-Browser, Workflow-Inbox, Upload und gemeinsamer Posteingang für Endbenutzer.

Verwendung

Nach der Konfiguration stehen folgende Funktionen zur Verfügung:

  1. Verbindung prüfen — Öffnen Sie die Statusseite des Moduls. Hier sehen Sie den Verbindungsstatus, Circuit-Breaker-Zustand und Cache-Informationen für jedes konfigurierte Archiv.
  2. Cache verwalten — Über die Statusseite können Sie den Cache manuell aktualisieren. Dies ist nützlich nach Masken-Änderungen in ELO, damit ELONIQ die neuen Definitionen sofort übernimmt.
  3. Masken und Felder prüfen — Der Cache zeigt alle geladenen Masken, Indexfelder (Gen1) und Aspekte (Gen2). Nutzen Sie dies zur Überprüfung, ob die gewünschten Masken verfügbar sind.
  4. Benutzer und Gruppen — Der Benutzer-Cache zeigt alle ELO-Benutzer und -Gruppen. Diese werden von anderen Modulen für Berechtigungszuweisungen verwendet.
  5. Workflow-Inbox — Wenn Workflow-Caching aktiviert ist, werden aktive Workflow-Aufgaben regelmäßig abgefragt und im Benutzer-Webinterface angezeigt.
  6. Benachrichtigungen einrichten — Aktivieren Sie die gewünschten Kanäle im ConfigStore und konfigurieren Sie die E-Mail-/Messaging-Templates nach Bedarf.
  7. Dokumente verwalten — Über das Benutzer-Webinterface können Dokumente gesucht, hochgeladen, heruntergeladen und im Archiv navigiert werden.
  8. Integration mit anderen Modulen — ELO Base wird automatisch von ELO Importer, ELO Exporter und ELO Mail Importer genutzt. Stellen Sie sicher, dass die Auth-Konfiguration mit dem authName der anderen Module übereinstimmt.

Best Practices

  • Dedizierten ELO-Benutzer verwenden — Erstellen Sie einen eigenen Servicebenutzer für ELONIQ (z.B. svc_eloniq). Verwenden Sie niemals persönliche Benutzerkonten, da diese bei Passwortwechsel die gesamte Integration unterbrechen.
  • Minimale Berechtigungen — Geben Sie dem Servicebenutzer nur die Rechte, die tatsächlich benötigt werden. Für reine Import-Szenarien genügen Schreibrechte auf die Zielordner.
  • TLS aktivieren — Verwenden Sie HTTPS für die IX-URL (https://elo-server:9090/ix-Archive/ix), um Anmeldedaten und Dokumentdaten verschlüsselt zu übertragen.
  • Cache-Intervalle anpassen — In Umgebungen mit häufigen Masken-Änderungen: Refresh-Intervall verkürzen (z.B. 360 Minuten). In stabilen Umgebungen: Standard (720 Minuten) beibehalten.
  • Health-Checks überwachen — Prüfen Sie regelmäßig die Statusseite. Der Circuit Breaker zeigt an, wenn die ELO-Verbindung instabil ist. Reagieren Sie auf wiederholte OPEN-Zustände.
  • Multi-Archive sinnvoll einsetzen — Nutzen Sie separate Auth-Konfigurationen für Produktion und Test. Benennen Sie diese eindeutig (z.B. prod, staging, test).
  • Benachrichtigungen testen — Konfigurieren Sie zuerst einen einzelnen Kanal (z.B. E-Mail) und testen Sie mit einem einfachen Workflow, bevor Sie weitere Kanäle aktivieren.
  • Masken-Limit beachten — Bei sehr vielen Masken (> 500) kann das Caching langsam werden. Setzen Sie masklimit auf einen sinnvollen Wert, um nur relevante Masken zu laden.
  • Regelmäßige Updates — Halten Sie ELONIQ aktuell, um von Verbesserungen im ELO-API-Wrapper und Cache-System zu profitieren.

Beispiele

1. Einzelner ELO-Server
auth:
  - name: production
    ixurl: http://elo-server:9090/ix-Archive/ix
    username: svc_eloniq
    password: geheim123
2. Mehrere ELO-Archive (Multi-Tenant)
auth:
  - name: produktion
    ixurl: https://elo-prod.firma.de/ix-Archiv/ix
    username: svc_eloniq
    password: prod_pw
  - name: test
    ixurl: http://elo-test.firma.de:9090/ix-TestArchiv/ix
    username: svc_eloniq_test
    password: test_pw
3. Optimiertes Caching für große Archive
masklimit: 200
cache_refresh_interval_minutes: 360
cache_max_age_minutes: 720
connection_check_interval_minutes: 2

Nur die 200 wichtigsten Masken laden, Cache alle 6 Stunden aktualisieren und Verbindung alle 2 Minuten prüfen.

4. Workflow-Benachrichtigungen per E-Mail und Teams
# Im ConfigStore:
notifications.enabled: true
notifications.channels.email_enabled: true
notifications.channels.teams_enabled: true
workflow_refresh_interval: 30
workflow_cache_enabled: true

Workflow-Aufgaben werden alle 30 Sekunden abgefragt und Benutzer per E-Mail und Teams benachrichtigt.

5. Produktionsumgebung mit TLS
auth:
  - name: production
    ixurl: https://elo.firma.de/ix-Archive/ix
    username: svc_eloniq
    password: sicheres_passwort
connection_check_interval_minutes: 1
cache_refresh_interval_minutes: 720
6. Workflow-Chain-Trigger (Automatische Klassifikation)
workflow_chain_triggers:
  - id: datev_classify
    enabled: true
    description: DATEV-Rechnungen automatisch klassifizieren
    authName: production
    templateId: 42
    nodeName: Klassifikation
    chainId: datev_classifier

Wenn ein Dokument den Workflow-Knoten "Klassifikation" erreicht, wird automatisch die Chain datev_classifier ausgelöst.