Für Nutzer, die Modularität v2 in Ninox 3.17 Beta in der Private Cloud testen

1. Einführung

Hinweise zum Testen der Beta-Version

• Einige Phasen befinden sich in der aktiven Entwicklung, daher sind Änderungen an der Benutzeroberfläche und gelegentliche Unstimmigkeiten zu erwarten.
• Halten Sie das Modularität-Glossar für Definitionen von Begriffen wie Anbieterdatenbank, externe Tabelle und Schnittstellenname bereit.
• Wir werden diesen Artikel aktualisieren, wenn neue Phasen verfügbar sind.

Mit Modularität können Sie eine eigenständige Ninox-Datenbank (ein Modul) erstellen, die über eine Modulschnittstelle in andere Arbeitsbereiche eingebunden werden kann. Die Vorteile sind Isolation, Wiederverwendbarkeit und sichere Updates – Fehler und Schemaänderungen bleiben in ihrem eigenen Modul, und Sie können neue Versionen veröffentlichen, ohne dass dies Auswirkungen auf die Nutzer hat.

Dieser Artikel richtet sich an Partner, die Modularität in der Beta-Phase testen. Wir begleiten Sie vom ersten Kontakt über die tägliche Nutzung bis hin zur Fehlerbehebung. Bei Bedarf finden Sie vollständige Definitionen im Glossar, das Sie in einer zweiten Registerkarte geöffnet lassen können.

2. Wichtige Rollen und Begriffe

• Modulautor: Erstellt die Anbieterdatenbank, gibt Tabellen/Felder frei, versioniert die Schnittstelle und veröffentlicht später das Modul.
• Modulverbraucher: Fügt das Modul einem Arbeitsbereich hinzu, stellt eine Verbindung zu seiner Schnittstelle her, wählt Lese- oder Schreibzugriff und kann es später möglicherweise innerhalb der eigenen Ninox-App erweitern.
• Endnutzer: Arbeitet in der fertigen Lösung und ist in der Regel nicht darüber informiert, dass diese im Hintergrund von Modulen unterstützt wird.

3. Module und Schnittstellen verstehen

Was ist ein Modul?

Ein Modul ist eine eigenständige Ninox-Datenbank, die nur die von Ihnen ausgewählten Daten und Logik gemeinsam nutzt. Sie können es in vielen Arbeitsbereichen wiederverwenden und sicher aktualisieren, ohne Ihre interne Konfiguration offenzulegen. In Zukunft werden wir möglicherweise Möglichkeiten zum Verpacken oder Monetarisieren von Modulen hinzufügen, aber diese Features sind in dieser Beta-Version noch nicht verfügbar.

Was ist eine Schnittstelle?

Eine Schnittstelle ist der öffentliche Vertrag zwischen Ihrer Anbieterdatenbank und allen untergeordneten Datenbanken, die mit ihr verbunden sind. Sie definiert alle Tabellen und Felder, die Sie freigeben, anhand folgender Angaben:

• Der Schnittstellenname (eine versionierte Kennung)
• Jede Tabellen-ID mit ihrem öffentlichen Namen
• Jede Feld-ID mit ihrem öffentlichen Namen
• Die Zugriffsrechte für jedes Feld (Lesen oder Schreiben)

Visuelle Hilfe – Aufbau eines Moduls

Dieses Diagramm zeigt, wie die 3 Teile eines Moduls derzeit zusammenwirken:

• Anbieterdatenbank: Hier befinden sich Ihre Tabellen, Felder und Skripte. Alles, was Sie hier freigeben, wird über die Schnittstelle ausgegeben. Sie behalten immer Schreibzugriff.
• Modulschnittstelle: Die Liste der Tabellen und Felder, die Sie freigegeben haben, mit ihren internen Namen, den Namen, die Ihre Verbraucher sehen, und der Zugriffsebene jedes Elements.
• Untergeordnete Datenbank: Was Ihre Endnutzer installieren. Ninox erstellt hier externe Tabellen, die Ihre freigegebenen Daten spiegeln und während der Verbindung synchronisiert bleiben. Sie entscheiden, ob Endnutzer in diese Tabellen zurückschreiben können.

4. Lebenszyklus eines Moduls

Das Diagramm zeigt den idealen End-to-End-Prozess eines Moduls: Entwerfen → Freigeben → Testen → Veröffentlichen → Verbrauchen/Bereitstellen → Aktualisieren/Abkündigen.

Im Folgenden finden Sie einen Überblick über die einzelnen Phasen mit Hinweisen dazu, was Sie derzeit in der Beta-Version tun können und was noch nicht verfügbar ist.

1. Entwerfen – heute verfügbar
   Erstellen Sie Ihr Schema, Ihre Skripte und Ihre Geschäftslogik in einer normalen Ninox-Datenbank. Betrachten Sie dies als Blaupause für Ihr zukünftiges Modul.
2. Freigeben – heute verfügbar (mit Einschränkungen)
   Öffnen Sie die Moduleinstellungen > Öffentliche Felder konfigurieren und wählen Sie aus, welche Tabellen und Datenfelder Sie freigegeben wollen. In der aktuellen Beta-Version können nur Datenfelder freigegeben werden. Beziehungs-, Formel-, Bild- und dynamische (Mehrfach-)Auswahlfelder sind in dieser Beta-Version nicht verfügbar.
3. Testen – nicht verfügbar
   Automatisierte Integrationstests, die Ihre freigegebene Schnittstelle vor der Veröffentlichung überprüfen, sind in der Beta-Version noch nicht verfügbar. Erstellen Sie vorerst eine temporäre untergeordnete Datenbank und testen Sie manuell.
4. Veröffentlichen – nicht verfügbar
   In späteren Versionen können Sie das Modul (einschließlich seiner Schnittstelle) möglicherweise verpacken und für einen Kanal freigeben, sodass es von jedem Arbeitsbereich gefunden und hinzugefügt werden kann. Während der Beta-Phase ist die Freigabe auf private Arbeitsbereiche oder Importe (direkte Kopien) beschränkt.
5. Verbrauchen/Bereitstellen – heute verfügbar
   • Verbrauchen: Fügen Sie das Modul einem anderen Arbeitsbereich hinzu. Ninox erstellt externe Tabellen, die synchronisiert bleiben.
   • Bereitstellen: Sobald ein Verbraucher eine Verbindung herstellt, liefert Ihre Anbieterdatenbank Live-Daten (und akzeptiert Schreibvorgänge, wenn Sie diese Berechtigung erteilt haben) über die freigegebene Schnittstelle.
6. Aktualisieren (heute verfügbar – mit Einschränkungen) und Abkündigen (nicht verfügbar)
   Wenn Sie etwas bearbeiten, wodurch sich der Schnittstellenname ändert, wird automatisch eine neue Version erstellt, sodass Verbraucher das Upgrade vornehmen können, sobald sie bereit sind. Ein formeller Ablauf für die Einstellung, bei dem Sie alte Versionen als veraltet markieren und Verbraucher zum Upgrade auffordern, ist noch nicht verfügbar.

5. Erstellen, Bearbeiten und Speichern einer Schnittstelle (Autoren)

1. Öffnen Sie die Anbieterdatenbank und wechseln Sie in den Bearbeitungsmodus.
2. Öffnen Sie das Dropdown-Menü über das Kebab-Menü und wählen Sie Moduleinstellungen.
3. Klicken Sie auf Öffentliche Felder konfigurieren und legen Sie nur die Felder offen, die die Verbraucher wirklich benötigen – weniger Synchronisierungspunkte bedeuten weniger Überraschungen.
4. Speichern Sie die Änderungen. Ninox erhöht die Schnittstellenversion automatisch, wenn Sie Änderungen an der Schnittstelle vornehmen, die gespeichert werden müssen.
5. Testen Sie die Änderungen in einer untergeordneten Datenbank, bevor Sie sie veröffentlichen.

Tipp: Vergeben Sie Schreibzugriff nur mit Bedacht, da Verbraucher nach Aktivierung Ihre Quelldaten überschreiben können.

6. Datenfreigabe und -synchronisierung

Derzeit unterstützt: Tabellen und einfache Datenfelder wie Text, Zahl, Datum + Uhrzeit, Ja / Nein, Auswahl und Mehrfachauswahl.

Geplant, noch nicht unterstützt: Beziehungsfelder, Formelfelder, Bildfelder, dynamische (Mehrfach-)Auswahlfelder.

 Hinweis: Sie können Ihr Setup selbstverständlich testen, auch wenn die nicht unterstützten Feldtypen noch nicht verfügbar sind. Workarounds sind optionale Hilfsmittel in Ihrem Toolkit – sie können in manchen Fällen hilfreich sein, sind jedoch nicht zwingend erforderlich und möglicherweise nicht immer für Ihr Szenario geeignet.

7. Modul verbinden (Verbraucher)

1. Klicken Sie im Arbeitsbereich auf Modul hinzufügen.
2. Wählen Sie ein Modul in der Galerie aus und klicken Sie auf die entsprechende Karte.
3. Benennen Sie das Modul und bestätigen Sie mit Modul hinzufügen. Ninox erstellt externe Tabellen, die die Daten des Anbieters widerspiegeln.
4. Arbeiten Sie wie gewohnt weiter oder wechseln Sie in den Bearbeitungsmodus, um das Modul zu erweitern.

Tipp: Sie können mehrere Module zum selben Arbeitsbereich hinzufügen; jedes Modul befindet sich in einer eigenen Datenbank mit einer eigenen Schnittstelle.

8. Modul erneut verbinden oder verschieben

Wenn ein Anbieter oder eine untergeordnete Datenbank gelöscht oder verschoben wird, bleiben die Daten erhalten, jedoch wird die Synchronisierung unterbrochen. Verwenden Sie das Modal Wieder verbinden, um die Verknüpfung wiederherzustellen: Wenn Sie Wieder verbinden auswählen, werden konfligierende untergeordnete Daten mit den Werten des Anbieters überschrieben, während mit Abbrechen die untergeordneten Änderungen beibehalten werden, sodass Sie diese zunächst korrigieren können.

9. Namen und IDs – was Sie bedenkenlos umbenennen können

• Schnittstellenname: Eindeutige Bezeichnung, die die API identifiziert. Durch Umbenennen wird eine neue Schnittstelle erstellt und bestehende Verbindungen auf der Verbraucherseite werden unterbrochen, bis der Verbraucher auf die neue Version aktualisiert wird.
• Tabellen-/Feldname: Nur für Autoren sichtbar, kann jederzeit ohne Bedenken umbenannt werden.
• Öffentlicher Tabellen-/Feldname: Verbraucherorientierter Name, der mit einer versteckten System-ID verknüpft ist. Kann ohne Bedenken umbenannt werden, da sich die versteckte ID nie ändert.

10. Felder entfernen

Hinweis: Die Benutzeroberfläche zum Entfernen von Feldern befindet sich noch in der Entwicklung. Sobald der Ablauf zum Entfernen von Feldern verfügbar ist, wird neben jedem öffentlichen Feld ein eigenes Symbol zum Löschen angezeigt, und Sie müssen die Felder nicht mehr manuell deaktivieren.

Führen Sie in der Zwischenzeit die folgenden Schritte aus, um ein öffentliches Feld aus Ihrer Schnittstelle zu entfernen:

1. Wechseln Sie in Ihrer Anbieterdatenbank in den Bearbeitungsmodus.
2. Öffnen Sie die Moduleinstellungen.
3. Klicken Sie auf der Schnittstellenseite auf Schnittstelle bearbeiten.
4. Wählen Sie im Modal Öffentliche Felder konfigurieren die Tabelle aus, die Sie aktualisieren möchten.
5. Deaktivieren Sie die Felder, die Sie nicht mehr anzeigen möchten.
6. Klicken Sie im Modal auf Speichern, um Ihre Änderungen zu übernehmen.
7. Klicken Sie auf der Schnittstellenseite auf Schnittstelle speichern, um den Vorgang abzuschließen.

Tipp: Wenn Sie alle Felder aus einer Tabelle entfernen, wird diese Tabelle automatisch aus der Schnittstelle entfernt, da ein Modul keine leere Tabelle freigeben kann.

11. Fazit und nächste Schritte

Vielen Dank, dass Sie uns bei der Gestaltung der Modularität unterstützen. Ihr Feedback während der Beta-Phase ist für uns von unschätzbarem Wert – teilen Sie uns bitte mit, was funktioniert, was nicht funktioniert und was Sie sich als Nächstes wünschen.