Wiki-Quellcode von Enaio-Plugin

Zeige letzte Bearbeiter
1 [[**Plugin-Download**>>https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/Enaio-Plugin%20(plugin-bundle-enaio-dms)&fileid=28964||rel="noopener noreferrer" target="_blank"]] (erfordert Anmeldung)
2
3 {{content/}}
4
5 Über das kostenpflichtige //enaio// Plugin ist es möglich das //enaio// DMS System an {{formcycle/}} anzubinden.
6
7 {{info}}
8 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.
9 {{/info}}
10
11 Die Installation erfolgt unter Mandant > [[Plugins>>doc:Formcycle.UserInterface.Client.Plugins]].
12
13
14 {{panel title="Konfiguration der Verbindungseinstellungen zum enaio System" initial="hidden" triggerable="true"}}
15
16
17 (((
18 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.
19 )))
20
21 (((
22 Folgende Eigenschaften für die Anbindung des enaio Systems können definiert werden:
23
24
25 )))
26
27 ; Webservice-Endpoint URL (Pflichtangabe) {{id name="bundle_prop_endpoint_url"/}}
28 : Absolute URL zu einem Webservice-Endpoint im //enaio// DMS-System
29 ; Basic-Auth Account
30 : Login für eine Basic-Auth Kommunikation
31 ; Basic-Auth Passwort
32 : Passwort für eine Basic-Auth Kommunikation
33 ; KeyStore Name (.p12 Datei)
34 : 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.
35 ; KeyStore Passwort
36 : Passwort für den Zugriff auf den Keystore
37 ; Connection Timeout (Pflichtangabe)
38 : Wert für ein Connection-Timeout in Millisekunden. (Standardwert: 10 Sekunden)
39 ; Read Timeout (Read-Timeout)
40 : Wert für ein Read-Timeout in Millisekunden. (Standardwert: 30 Sekunden)
41
42 {{/panel}}
43
44 == Aktions-Plugin //enaio DMS Upload// ==
45
46 {{figure image="enaio_config.png"}}
47 Konfigurationsmöglichkeiten an der //enaio// Workflow-Aktion
48 {{/figure}}
49
50 Für die Übermittlung von Dateien eines Vorgangs an das //enaio// DMS steht das Aktions-Plugin **enaio DMS Upload** im Workflow zur Verfügung.
51 Zusätzlich zu den übermittelten Dateien können Metadaten aus Werten des aktuellen Vorgangs bzw. selbst definierte Daten an das DMS übergeben werden.
52 Die dafür notwendige Konfigurationsoberfläche des Plugins ist in einzelne Funktionsbereiche unterteilt, die nachfolgend beschrieben werden.
53
54 === Definition Metadaten und Upload-Dateien ===
55
56 Über den Konfigurations-Parameter **FormType** wird der in //enaio// spezifizierte Prozess angesprochen, welcher die von {{formcycle/}} übermittelten Daten im //enaio// DMS weiterverarbeitet.
57
58 {{info}}
59 Mit dem [[image:icon_placeholder.png]]-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.
60 {{/info}}
61
62 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.
63
64 Über den[[image:icon_add.png]]-Button kann der Tabelle ein neues Metadatum hinzugefügt werden.
65 Für ein Feld sind dabei jeweils Name und Wert festzulegen. Als Wert können eine fest vorgegebene Zeichenkette oder Platzhalter verwendet werden.
66
67 Mit den [[image:icon_del.png]]-Buttons können einzelne oder mehrere selektierte Metadaten-Definitionen aus der Liste entfernt werden.
68
69 (% class="box infomessage" %)
70 (((
71 Mit dem [[image:icon_update.png]]-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. 
72 Felder die mit [[image:icon_info.png]] markiert sind, wurden als "wiederholbare" Elemente identifiziert. Bei einer Übermittlung an das //enaio// DMS werden sie gesondert behandelt.
73 Wie genau, kann direkt im Aktions-Plugin unter dem Bereich **Verarbeitungshinweise bei wiederholbaren Elementen** nachgelesen werden.
74 )))
75
76 Mit dem Konfigurations-Parameter **Dateien** können die zu übertragenden Dateien festgelegt werden. 
77 Die Dateien können dabei aus folgenden Bereichen stammen:
78
79 * Formular-Uploads
80 * Dateien aus dateibereitstellenden Aktionen
81 * Datei-Ressourcen des Mandanten
82 * Datei-Ressourcen des Formulars
83 * Dateien aus externen Quellen
84 * Anhänge aus dem aktuellen Vorgang, welche mittels Dateinamen-Suche ermittelt wurden
85
86 === Serverkonfiguration ===
87
88 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.
89
90 === Rückgabewerte ===
91
92 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.
93
94 Fehler, während der Plugin-Verarbeitung, werden in folgende Typen unterschieden:
95
96 * AUTHORIZATION_FAILED: Tritt auf, wenn mit den hinterlegten Login-Daten keine erfolgreiche Authentifizierung am //enaio //System durchgeführt werden konnte.
97 * 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.
98 * SERVICE_ERROR: Tritt auf, wenn der //enaio //Webservice einen Fehler zurück lieferte.
99 * INTERNAL_ERROR: Tritt auf, wenn es bei der Verarbeitung zu einer Ausnahme kam, welche nicht mit den anderen Fehler-Typen bereits verarbeitet wurde.