...
| Eintrag | Inhalt |
|---|---|
| Übersicht | Die Schnittstellen Ihres Mandanten: Adresse, Art der Anmeldung, Zugangsdaten. |
| Keystores | Zertifikatsdateien mit ihrem Passwort, die Schnittstellen verwenden. |
| Transaktionen | Die Aufrufe, die über eine Schnittstelle laufen. |
...
Schnittstellen
Die Übersicht
Die Liste zeigt beim Öffnen alle Schnittstellen Ihres Mandanten und die Schnittstellen übergeordneter Mandanten, die für Sie freigegeben sind.
| Spalte | Bedeutung |
|---|---|
| Service-Key | Der eindeutige Schlüssel der Schnittstelle. Transaktionen und Formulare verwenden ihn als Verweis. |
| Aktiv | Ampel: aktiv oder deaktiviert. |
| Service-Typ, Auth-Typ | Art der Schnittstelle und Art der Anmeldung, als Symbol mit Text beim Überfahren. |
| Secrets | Anzahl der hinterlegten Zugangsdaten und Keystores. Ein Klick zeigt, welche es sind, nie ihren Wert. |
| URL | Die Adresse des Drittsystems. |
| Herkunft | «eigen» oder der Name des übergeordneten Mandanten. Der Zusatz «(überdeckt)» bedeutet: Ihr Mandant hat eine eigene Schnittstelle mit demselben Schlüssel, und diese gilt. |
| Freigabe | Symbol, wenn die Schnittstelle für untergeordnete Mandanten freigegeben ist. |
| GeändertLetzte Anpassung | Zeitpunkt der letzten Änderung. |
...
- In der Übersicht eine neue Schnittstelle anlegen.
- Service-Key, Service-Typ und Auth-Typ wählen. Je nach Auth-Typ erscheinen weitere Felder.
- URL und die Angaben zur Anmeldung ausfüllen.
- Die Zugangsdaten setzen, siehe «Zugangsdaten setzen».
- «Speichern».
| Info | ||
|---|---|---|
| ||
Nach dem ersten Speichern ist die Schnittstelle aktiv. Sie muss deshalb beim ersten Speichern vollständig sein, einschliesslich der Zugangsdaten. |
...
- In der Zeile auf das Stift-Symbol «Neuen Wert setzen …» klicken.
- Im Dialog den Wert in «Neuer Wert» und nochmals in «Wert wiederholen» eingeben.
- «Übernehmen». Die Zeile zeigt «neuer Wert gesetzt».
- Die Schnittstelle speichern. Erst jetzt wird der Wert verschlüsselt abgelegt.
| Warnung | ||
|---|---|---|
| ||
Bewahren Sie Zugangsdaten zusätzlich dort auf, wo Ihre Organisation Passwörter verwaltet. In der Schnittstellen-Verwaltung können Sie einen Wert überschreiben, aber nicht mehr anzeigen. Das Auge-Symbol «Anzeigen» steht nur berechtigten Support-Benutzern des Betreibers zur Verfügung; jede Anzeige wird protokolliert. |
...
Die Auswahl zeigt Name, Typ und Ablaufdatum jedes Keystores. Verwenden weitere Schnittstellen denselben Keystore, nennt das Formular sie unter «Keystores auch verwendet von».
Speichern, aktivieren, deaktivieren
...
Das Stethoskop-Symbol «Diagnose» in der Zeile einer Schnittstelle zeigt, was ein Formular oder eine Transaktion Ihres Mandanten mit diesem Service-Key tatsächlich erhält.
- Herkunft: die eigene Schnittstelle, eine freigegebene Schnittstelle eines übergeordneten Mandanten oder eine bisherige Konfigurationsdatei («Legacy-Datei»).
- Mandant: der Mandant, für den die Diagnose gilt.
- Typ, URL, Benutzername, Properties.
- Secrets: pro Zugangswert «lesbar» mit der Länge oder «nicht lesbar» mit dem Grund. Nie der Wert.
- Keystores: Name, Typ und Ablaufdatum.
...
Ein Keystore ist eine Zertifikatsdatei zusammen mit ihrem Passwort. Sie erfassen ihn einmal und ordnen ihn beliebig vielen Schnittstellen zu. Läuft ein Zertifikat ab, ersetzen Sie die Datei an einer Stelle.
Die Liste
| Spalte | Bedeutung |
|---|---|
| Name | Der Name des Keystores. |
| Art | Client-Keystore oder Truststore. |
| Typ | Das Format der Datei: PKCS12, JKS oder JCEKS. Es wird aus der Datei erkannt. |
| Ablauf | Das früheste Ablaufdatum der enthaltenen Zertifikate. Orange: läuft in weniger als 30 Tagen ab. Rot: abgelaufen. |
| Verwendet von | Anzahl der Schnittstellen, die den Keystore verwenden. Ein Klick zeigt ihre Service-Keys. |
| Geändert, Geändert vonLetzte Anpassung, Benutzer letzte Anpassung | Zeitpunkt und Benutzer der letzten Änderung. |
...
- In der Liste einen neuen Keystore anlegen.
- Name und Art wählen.
- In der Zeile «Datei» auf «Datei und Passwort hochladen …» klicken.
- Im Dialog zuerst die Datei wählen (
.p12,.pfx,.jksoder.jceks, höchstens 1'024 KB), dann das Passwort eingeben. Bei einem Truststore ist das Passwort freiwillig. - Der Dialog prüft die Datei sofort und zeigt ihre Einträge mit Ablaufdatum.
- «Übernehmen».
- Den Keystore speichern. Erst jetzt werden Datei und Passwort verschlüsselt abgelegt.
| Feld | Pflicht | Beschreibung |
|---|---|---|
| Name | ✔ | Höchstens 128 Zeichen, im Mandanten eindeutig. |
| Art | ✔ | Client-Keystore oder Truststore. Nicht mehr änderbar, solange eine Schnittstelle den Keystore verwendet. |
| Beschreibung | ❌ | Freier Text, höchstens 255 Zeichen. |
| Datei | ✔ | Zeigt den Zustand: «keine Datei», Typ und Ablaufdatum der gespeicherten Datei oder «neue Datei: … – wird mit dem Speichern übernommen». |
| Verwendet von | – | Die Service-Keys der Schnittstellen, die den Keystore verwenden. Nur Anzeige. |
...
Eine Transaktion beschreibt, was beim Aufruf eines Drittsystems geschieht: eine geordnete Folge von Schritten. Jeder Schritt nennt eine Implementation und deren Eigenschaften. Die Zugangsdaten stehen nie in der Transaktion, sondern in der Schnittstelle, auf die sie verweist.
Die Liste
Die Liste zeigt die Transaktionen Ihres Mandanten mit ID und Name, UUID, Name sowie dem Zeitpunkt der Erstellung und der letzten Änderung. Die Suchmaske filtert nach ID und Name. Mit «Neues Element hinzufügen» legen Sie eine Transaktion an, mit «Öffnen» bearbeiten Sie eine bestehende.
Aufbau einer Transaktion
| Feld | Pflicht | Beschreibung |
|---|---|---|
| Name | ✔ | Der Name, unter dem die Transaktion in Listen und Auswahlen erscheint. |
| Beschreibung | ✔ | Freier Text zum Zweck der Transaktion. |
| Transaktions-Schritte | ✔ | Mindestens ein Schritt. Die Schritte laufen in der Reihenfolge der Liste und lassen sich umsortieren. Ein Schritt kann Unterschritte haben. |
...
| Feld | Pflicht | Beschreibung | ||
|---|---|---|---|---|
| ID | ❌ | Eine Kennung des Schritts. | ||
| Verhalten im Fehlerfall | ❌ | CONTINUE: Die Transaktion läuft nach einem Fehler dieses Schritts weiter. Ohne diese Wahl bricht ein Fehler die Transaktion ab. ROLLBACK: Ein Fehler dieses Schritts bricht die Transaktion ab; bricht sie später ab, wird dieser Schritt rückgängig gemacht, sofern seine Implementation das unterstützt. Ohne Wahl bricht ein Fehler die Transaktion ab. | ||
| Implementation | ✔ | Implementation | ✔ | Die Klasse, die den Schritt ausführt. Die Auswahl zeigt alle verfügbaren Klassen mit ihrem vollständigen Namen. |
| Eigenschaften | ❌ | Liste der Einstellungen des Schritts, siehe unten. |
...
| Feld | Beschreibung |
|---|---|
| Schlüssel | Der Name der Eigenschaft, zum Beispiel path. |
| Statischer Wert | Ein fester Wert. |
| Formel | Eine Formel, die den Wert zur Laufzeit berechnet. Sie hat Vorrang vor dem statischen Wert. |
| Typ | Der Datentyp als Java-Klasse, Standard ist java.lang.String (Text). Für Zahlen und Ja/Nein-Werte den passenden Typ wählen. |
| Referenzierte Eigenschaft | Verweis auf eine vordefinierte Eigenschaft einer Klasse. |
...
Die Zugangsdaten beim Anbieter prüfen und neu setzen. Bei einem Client-Zertifikat das Ablaufdatum in der Liste «Keystores» kontrollieren.
...
- Elf Screenshots aufnehmen und mit den vorgegebenen Dateinamen anhängen
- Beschriftung des Knopfs für eine neue Schnittstelle und einen neuen Keystore in der Oberfläche prüfen und im Text ergänzen
- Prüfen, ob die Felder «Name» und «Beschreibung» einer Transaktion in der Oberfläche als Pflicht gelten
- Diesen Abschnitt vor der Veröffentlichung entfernen