Enaio-Plugin

Geändert am Mo, 9 Jan, 2023 um 3:27 NACHMITTAGS

Plugin-Download (erfordert Anmeldung)

Über das kostenpflichtige enaio Plugin ist es möglich das enaio DMS System an FORMCYCLE anzubinden.

Auf Seiten des enaio Dokumenten Management Systems muss ein Webservice mit Namen FormsService verfügbar sein. Dies ist im Vorfeld zu prüfen. Wenden Sie sich dazu bitte an ihren OSVH-Vertriebsansprechpartner.

Die Installation erfolgt unter Mandant > Plugins.

Konfiguration der Verbindungseinstellungen

Die nachfolgenden Einstellungen sind durch einen Administrator, der die Rechte zum Konfigurieren von Plugins besitzt, vorzunehmen. Das Plugin kann nur im Bereich eines Mandanten installiert werden.Folgende Eigenschaften für die Anbindung des enaio Systems können definiert werden:

Webservice-Endpoint URL (Pflichtangabe): Absolute URL zu einem Webservice-Endpoint im enaio DMS-System
Basic-Auth Account: Login für eine Basic-Auth Kommunikation
Basic-Auth Passwort: Passwort für eine Basic-Auth Kommunikation
KeyStore Name (.p12 Datei): Name einer Datei-Ressource, welche einen Keystore im PKCS12 Format enthält. Dieser Keystore kann verwendet werden, um SSL-Zertifikate für die Kommunikation mit dem enaio Webservice verfügbar zu machen, wenn diese beispielsweise nicht im Standard-JAVA-Truststore verfügbar sind.
KeyStore Passwort: Passwort für den Zugriff auf den Keystore
Connection Timeout (Pflichtangabe): Wert für ein Connection-Timeout in Millisekunden. (Standardwert: 10 Sekunden)
Read Timeout (Read-Timeout): Wert für ein Read-Timeout in Millisekunden. (Standardwert: 30 Sekunden)

Aktions-Plugin enaio DMS Upload

Konfigurationsmöglichkeiten an der enaio Workflow-Aktion

Für die Übermittlung von Dateien eines Vorgangs an das enaio DMS steht das Aktions-Plugin enaio DMS Upload im Workflow zur Verfügung. Zusätzlich zu den übermittelten Dateien können Metadaten aus Werten des aktuellen Vorgangs bzw. selbst definierte Daten an das DMS übergeben werden. Die dafür notwendige Konfigurationsoberfläche des Plugins ist in einzelne Funktionsbereiche unterteilt, die nachfolgend beschrieben werden.

Definition Metadaten und Upload-Dateien

Über den Konfigurations-Parameter FormType wird der in enaio spezifizierte Prozess angesprochen, welcher die von FORMCYCLE übermittelten Daten im enaio DMS weiterverarbeitet.

Mit dem -Button kann ein Platzhalter festgelegt werden, der den zu nutzenden FormType erst zum Ausführungszeitpunkt konkret definiert. Damit wird es möglich Daten, ja nach vorgelagerten Verarbeitungsprozess, an unterschiedliche enaio Prozesse zu übergeben.

In der Tabelle Definition von Metadaten erfolgt die Festlegung von Daten, welche mit den zu übertragenden Dateien übermittelt werden. Diese Metadaten können anschließend im enaio DMS dazu verwendet werden, um die übertragenen Dateien ordnungsgemäß zu verarbeiten. Die Metadaten sind dabei frei durch den Nutzer konfigurierbar. Über den-Button kann der Tabelle ein neues Metadatum hinzugefügt werden.Für ein Feld sind dabei jeweils Name und Wert festzulegen. Als Wert können eine fest vorgegebene Zeichenkette oder Platzhalter verwendet werden. Mit den -Buttons können einzelne oder mehrere selektierte Metadaten-Definitionen aus der Liste entfernt werden.

Mit dem -Button kann eine Aktualisierung der Metadaten mit vorhandenen Formularelementen durchgeführt werden. Es werden dabei alle Elemente, die bisher nicht in der Metadatenliste vorhanden sind, hinzugefügt. Der Abgleich der Zuordnung erfolgt dabei über den Formularelementnamen. Der Wert wird in Form eines Platzhalters eingefügt, welcher nicht editiert werden kann. Felder die mit markiert sind, wurden als "wiederholbare" Elemente identifiziert. Bei einer Übermittlung an das enaio DMS werden sie gesondert behandelt. Wie genau, kann direkt im Aktions-Plugin unter dem Bereich Verarbeitungshinweise bei wiederholbaren Elementen nachgelesen werden.

Mit dem Konfigurations-Parameter Dateien können die zu übertragenden Dateien festgelegt werden.
Die Dateien können dabei aus folgenden Bereichen stammen:

Formular-Uploads
Dateien aus dateibereitstellenden Aktionen
Datei-Ressourcen des Mandanten
Datei-Ressourcen des Formulars
Dateien aus externen Quellen
Anhänge aus dem aktuellen Vorgang, welche mittels Dateinamen-Suche ermittelt wurden

Serverkonfiguration

Hier finden Sie einen Button, welcher die Erreichbarkeit des aktuell angebunden Webservice prüft. Die zur Prüfung der Konnektivität verwendeten Parameter sind direkt am Plugin-Bundle zu hinterlegen.

Rückgabewerte

Wenn Dateien und Metadaten erfolgreich an das enaio DMS übermittelt werden konnten, terminiert die Plugin-Aktion normal. Es wird dabei kein zusätzlicher Rückgabewert durch die Plugin-Aktion zur Verfügung gestellt, da der enaio Webservice bei einem erfolgreichen Aufruf keine weiter reichenden Informationen zurück liefert.

Fehler, während der Plugin-Verarbeitung, werden in folgende Typen unterschieden:

AUTHORIZATION_FAILED: Tritt auf, wenn mit den hinterlegten Login-Daten keine erfolgreiche Authentifizierung am enaio System durchgeführt werden konnte.
NO_FORM_TYPE: Tritt auf, wenn der FormType zur Laufzeit nicht ermittelt werden konnte. Beispielsweise, wenn dieser aus einem Platzhalter stammt, welcher zur Laufzeit nicht ermittelt werden konnte oder keinen Wert enthielt.
SERVICE_ERROR: Tritt auf, wenn der enaio Webservice einen Fehler zurück lieferte.
INTERNAL_ERROR: Tritt auf, wenn es bei der Verarbeitung zu einer Ausnahme kam, welche nicht mit den anderen Fehler-Typen bereits verarbeitet wurde.