Neues Fehlerhandling im Open-Xchange Connector für UCS

Eine neue Version des Open-Xchange Connectors für UCS bringt ein deutlich verändertes Verhalten bei Synchronisationsfehlern – eine Funktion, die von vielen Kunden gewünscht wurde.

Da es sich um eine grundlegende Anpassung handelt, ist das neue Fehlerhandling zunächst optional und kann in den App-Einstellungen aktiviert werden. Einige Änderungen betreffen jedoch bereits alle Kunden.

Der Open-Xchange Connector (kurz OX Connector) provisioniert die in Univention Nubus gepflegten Informationen – etwa zu Benutzern, ihren Mailadressen, Gruppenmitgliedschaften und Berechtigungen – an die Groupware Open-Xchange (OX). Dadurch können Anwender*innen direkt nach der Registrierung ihres Accounts in Nubus mit OX arbeiten, und Änderungen an ihren Berechtigungen werden zeitnah auch in OX umgesetzt.

Der OX Connector arbeitet dabei „Event-basiert“, d. h. er erhält einzelne Änderungen als „Events“ aus einer Warteschlange und überträgt diese nacheinander an OX. In Einzelfällen kann es dabei zu Fehlern bei der Übertragung kommen, beispielsweise aufgrund von Konfigurationsfehlern oder inkonsistenten Daten. In solchen Fällen versucht der Connector bislang, eine fehlgeschlagene Änderung nach kurzer Wartezeit erneut zu übertragen. Sobald der Fehler beseitigt ist, werden auch die weiteren Änderungen in der Warteschlange bearbeitet.

Dieses Verhalten führt jedoch dazu, dass sich bei schwer zu behebenden Fehlern Änderungen in der Warteschlange aufstauen. In Umgebungen mit vielen Änderungen – etwa während Migrationsphasen – kann ein individuelles Problem mit einem Nutzerkonto somit Verzögerungen für alle folgenden Änderungen an anderen Konten verursachen.

Mit der neuen, bisher optionalen Veränderung der Fehlerbehandlung werden auch bei Auftreten eines Fehlers die nachfolgenden Änderungen weiter bearbeitet. Dadurch wirkt sich ein einzelnes Problem nicht mehr störend auf viele Nutzerkonten aus.

• Der Umfang der Informationen, die zwischen UCS und OX synchronisiert werden, ändert sich nicht. Auch die Attribute in UDM bleiben unverändert.
• Für Kubernetes-Deployments gibt es vorerst keine Anpassungen: Der OX Connector für Kubernetes stoppt weiterhin bei jedem Fehler.

Auch ohne aktiviertes neues Fehlerhandling bringt die aktuelle Version grundlegende Änderungen mit sich:

• Ablösung der JSON-Dateien: Die bisher genutzten JSON-Dateien werden nun direkt in eine lokale SQLite-Datenbank geschrieben, bevor sie verarbeitet werden. Für Debugging können JSON-Dateien daher nicht mehr verwendet werden.
• Neues Kommandozeilen-Tool: Mit univention-ox-connector-task-management lassen sich der aktuelle Verarbeitungsstatus und die „zu synchronisierenden“ Änderungen einsehen und steuern. Dieses Tool ersetzt die bisherige Nutzung der JSON-Dateien.
• Resynchronisation von Objekten: Über das neue Tool können Objekte erneut synchronisiert werden. Das frühere Bash-Snippet aus der Dokumentation ist nicht mehr notwendig.
• Status der letzten Synchronisation: Die Datenbank speichert den Stand der letzten erfolgreichen Synchronisation, der ebenfalls per Kommandozeilen-Tool abgefragt werden kann.

Wird die neue Fehlerbehandlung aktiviert, verändert sich das Verhalten des Connectors bei Fehlern deutlich:

• Gezieltes Stoppen: Der Connector stoppt nur noch bei Fehlern, die voraussichtlich eine Vielzahl von Folgefehlern nach sich ziehen würden. Das betrifft aktuell die Unerreichbarkeit von OX-APIs oder Probleme beim Anlegen eines neuen Kontexts in OX. In diesen Fällen wiederholt der Connector die Synchronisation automatisch, sodass er nach einer API-Störung selbstständig fortfährt, sobald die Schnittstelle wieder verfügbar ist.
• „Morgue“-Speicher für Einzelfehler: Alle anderen Fehler werden in einer separaten Datenbanktabelle („morgue“) zusammen mit einer Fehlermeldung oder einem Traceback abgelegt. Der Connector setzt die Verarbeitung anschließend sofort mit der nächsten Änderung fort.
• Keine automatische Wiederholung: Einträge in der „morgue“ werden nicht automatisch erneut synchronisiert. Sie verschwinden jedoch, sobald dasselbe Objekt erneut in UDM geändert und erfolgreich mit OX synchronisiert wurde.
• Manuelle Steuerung möglich: Mit univention-ox-connector-task-management können die „morgue“-Einträge eingesehen, gelöscht oder zur erneuten Verarbeitung freigegeben werden.

Die Neuerungen werden zunächst nicht automatisch aktiviert. Univention begleitet die Umstellung aktiv bei bestehenden Kunden – wenn Sie Interesse am Einsatz haben, empfehlen wir Ihnen, unser Support- oder Prof. Service Team anzusprechen. Alternativ können Sie sich über die Details der Änderung in der Dokumentation informieren. Mit einem zukünftigen Release wird die neue Fehlerbehandlung als neues Standardverhalten aktiviert werden.