ConfigUI

Die ConfigUI ermöglicht eine einfache Konfiguration der Schnittstelle und ist erreichbar unter: <Protokoll>://<CMI API>:<Port>/<Mandant>

Beim Aufruf der ConfigUI gelangt man zunächst zum STS, bei dem man sich einloggen muss. Der Benutzer benötigt die Berechtigungsgruppe Konfiguration CMI API verwalten um das ConfigUI verwenden zu können. Falls diese Benutzergruppe nicht vorhanden ist, wird ein entsprechender Hinweis angezeigt.

Erklärung der Benutzeroberfläche (UI)

Die ConfigUI ist in zwei "Modulen" aufgeteilt:

Typdefinitionen

Hier können Typdefinitionen sowie Felder und Assoziationen ausgewählt werden. Die ausgewählten Typdefinitionen stehen in der API zur Verfügung. Mit dem Filter oberhalb der Tabelle können Typdefinitionen gesucht und die Spalten durch Klicken sortiert werden.

Felder und Assocs

Rechts werden alle möglichen Felder und Assoziationen der ausgewählten Typdefinition aufgelistet, die sich an- und abwählen lassen. Ausgegraute Felder sind Pflichtfelder und können nicht abgewählt werden. Mit dem Filter oberhalb der Tabelle können Felder gesucht und die Spalten durch Klicken sortiert werden.

Content Provider

Diese Funktion ist nur mit CMI Version >= 24.4.0 verfügbar.

Im Tab "Content Provider" (rechter Teil) können Content Provider ausgewählt werden. Diese Auswahl ist auch auf die Typdefinition bezogen und kann pro Typdefinition gesetzt werden. Content Provider sind jeweils nur Readonly-Felder und können vom Typ Objekt, Liste oder String sein. Es werden die CMI-Standard-Content-Provider sowie die KPF-Content-Provider unterstützt.

Aktivierte Operationen

Im Tab "Aktivierte Operationen" (rechter Teil) können Operationen wie Search oder Create deaktiviert werden. Diese Auswahl ist auf die Typdefinition bezogen und kann pro Typdefinition gesetzt werden.

Prozess-Modul / Prozess-Layer

In dieser Auflistung lassen sich die Prozess-Layer an- und abwählen.

Prozess-Layer sind Gruppierungen von Aktionen, die in der CMI API ausgeführt werden können. Wenn ein Prozess-Layer aktiviert wird, stehen alle Aktionen innerhalb des Prozess-Layers zur Verfügung.

Operationen (Buttons)

Alle Operationen befinden sich oben rechts im Menü:

• Download: Download-Button generiert ein Config-File mit der aktuellen Auswahl, welches im Anschluss automatisch heruntergeladen wird. Wichtig: Beim Download wird die aktuelle Auswahl NICHT gespeichert.
• Speichern: Speichern-Button speichert die aktuelle Auswahl. Die Schnittstelle MUSS nach dem Speichern manuell neu gestartet werden.
• Speichern & Neustarten: Speichern-Button speichert die aktuelle Auswahl. Die Schnittstelle startet automatisch neu.
• Importieren: Hier kann ein Config-File importiert werden. Die Schnittstelle MUSS nach dem Speichern manuell neu gestartet werden.
• Importieren & Neustarten: Hier kann ein Config-File importiert werden. Die Schnittstelle startet automatisch neu.
• Verwerfen: Verwirft die aktuelle Auswahl.

Gruppen

Über das Config-UI lassen sich Gruppen definieren. Die Dokumentation ist hier zu finden.

API Endpunkte

Model-Modul

Für jede ausgewählte Typdefinition werden folgende Endpunkte automatisch angelegt (ausser bei Deaktivierung der jeweiligen Operation):

• GET (SINGLE): Ermöglicht das Laden einzelner Objekte (immer nur ein Objekt kann geladen werden).
• PUT: Ändert ein Objekt.
• DELETE: Löscht ein Objekt.
• POST: Erstellt ein neues Objekt. Optional kann auch der Pfad einer Objektvorlage mitgeschickt werden.
• GET (QUERY): Sucht mittels TentaQL Query.
• GET (MENUE): Gibt alle Menüs für ein Objekt zurück.
• POST (MENUE): Führt ein Menü aus.

Hat eine Typdefinition ein E-Dokument, das auch unter den Feldern ausgewählt wurde, so werden folgende Endpunkte ergänzt:

• POST (CHECKOUT): Exklusiver "CheckOut" von einem Dokument.
• POST (CHECKIN): Ausgechecktes Dokument wieder ein CheckIn (wird eine neue Zwischenversion angelegt).
• GET (FILECONTENT): Herunterladen des Dokumentinhalts (Download).
• POST (UNDOCHECKOUT): Verwirft den CheckOut.

Prozess-Modul

Welche Endpunkte ein Prozess-Layer mit sich bringt, ist hier dokumentiert.