Wiki-Quellcode von KomXwork-Plugin

Zeige letzte Bearbeiter
1 [[**Plugin-Download**>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/KomXwork-Plugin%20(plugin-bundle-komxwork)&fileid=13425||rel="noopener noreferrer" target="_blank"]] (erfordert Anmeldung)
2
3 {{content/}}
4
5 Über das kostenpflichtige KomXwork Plugin ist es möglich die durch das KomXwork System bereitgestellte Schnittstelle zum KomXflow in Formcycle anzubinden.
6
7
8 {{panel title="Konfiguration der Verbindungseinstellungen zum KomXwork System" initial="hidden" triggerable="true"}}
9
10 {{figure image="bundle_props.png"}}
11 Globale Einstellungen am Plugin-Bundle
12 {{/figure}}
13
14 (((
15 Die nachfolgenden Einstellungen sind durch einen Administrator, der die Rechte zum Konfigurieren von Plugins besitzt, vorzunehmen.
16 )))
17
18 (((
19 Folgende Eigenschaften für die Anbindung des KomXwork Systems können definiert werden:
20
21
22 )))
23
24 ; rest.srv.url (Pflichtangabe) {{id name="bundle_prop_rest_url"/}}
25 : Protokoll und Host zu einen KomXwork REST Service. (Die Angabe erfolgt ohne konkrete Pfad-Angabe zu einer REST-Aktion.
26 : Die vom System unterstützten Pfade werden in anderen Einstellungen hinterlegt.)
27 ; rest.api.auth (Pflichtangabe)
28 : REST-API für die Ermittlung eines Authentifizerungstokens unter Zuhilfenahme der Daten aus dem unten stehenden Bereich //Konfiguration der Authentifizierungsdaten//.
29 : (Hinweis: Der hier vorgegebene Standardwert //api~/v1~/token// muss nur angepasst werden, wenn sich die Schnittstelle auf Seiten von KomXwork ändert.)
30 ; rest.api.workflow (Pflichtangabe)
31 : REST API für das Starten eines KomXflow-Prozesses. Der Platzhalter '{key}' wird dabei in der jeweiligen Konfiguration eines Aktions-Plugin gesetzt, welches diese REST-API nutzt.
32 : (Hinweis: Der hier vorgegebene Standardwert //workflow~/process-definition~/key~/~{key~}~/start// muss nur angepasst werden, wenn sich die Schnittstelle auf Seiten von KomXwork ändert.)
33 ; rest.srv.connection.timeout
34 : Wert für ein Connection-Timeout in Millisekunden. (Standardwert: 10 Sekunden)
35 ; rest.srv.read.timeout
36 : Wert für ein Read-Timeout in Millisekunden. (Standardwert: 30 Sekunden)
37 ; rest.srv.proxy.host
38 : Die Host-Angabe, bei Kommunikation über einen Proxy-Server.
39 ; rest.srv.proxy.port
40 : Die Port-Angabe, bei Kommunikation über einen Proxy-Server.
41
42 (((
43 **Konfiguration der Authentifizierungsdaten**
44
45 )))
46 Die Authentifizerung am REST-Service erfolgt unter Nutzung des OAuth 2.0 Protokolls im Verfahren "Resource Owner Password Credentials".
47 Die Werte der nachfolgend aufgeführten Parameter sind durch das jeweilige KomXwork-System vorgegeben und werden dort im Zuge einer internen Registrierung erzeugt.
48
49
50 ; client.id {{id name="bundle_prop_client_id"/}}
51 : Diese ID repräsentiert die öffentliche Kennung der KomXwork-Anwendung
52 ; client.secret {{id name="bundle_prop_client_secret"/}}
53 : Das Secret, vom KomXwork-System vorgegeben.
54 ; username {{id name="bundle_prop_user"/}}
55 : Namen des Nutzers (~=Resource-Owner) über den der Zugriff auf die Web-Service erfolgen soll.
56 ; password {{id name="bundle_prop_pwd"/}}
57 : Passwort für den zuvor definierten Nutzer
58 ; granttype {{id name="bundle_prop_granttype"/}}
59 : Definiert das aktuell genutzte Authentifizierungs- und Autorisierungsverfahren. Momentan wird nur "Resource Owner Password Credentials" in der KomXwork-Anbindung unterstützt, weshalb der Parameter standardmäßig leer ist.
60
61
62 {{/panel}}
63
64
65 == Aktions-Plugin //KomXwork:Workflow-Prozess starten// ==
66
67 Für die Übermittlung von Formulardaten an die //KomXwork//-interne Workflow-Engine (//KomXflow//) steht das Aktions-Plugin **KomXwork:Workflow-Prozess starten** zur Verfügung.
68 Dieses ermöglicht es, an einen in //KomXflow// erstellten Prozess, Daten zu übergeben, welche sich anschließend weiterverarbeiten und gegebenenfalls im //KomXwork//-DMS ablegen lassen.
69
70 Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt die nachfolgend kurz beschrieben werden.
71
72 === Festlegung des zu verwendenden KomXwork-Prozesses und der zu übermittelnden Daten ===
73
74 Über den Konfigurations-Parameter **Name des KomXwork-Prozesses** wird der Prozess bestimmt, an den die anschließend festgelegten Daten zu übermitteln sind.
75
76 {{info}}
77 Mittels [[image:icon_placeholder.png]]-Button kann ein Platzhalter festgelegt werden, der den aktuell zu nutzenden Prozess-Namen zur Ausführungszeit enthält.
78 Dadurch wird es beispielsweise möglich die Daten, je nach vorgelagerten Verarbeitungsprozessen, an verschiedene KomXwork-Prozesse zu übergeben.
79 {{/info}}
80
81
82 In der Tabelle **KomXflow-Feld-Definitionen** erfolgt die eigentliche Festlegung der zu übermittelnden Daten.
83 Beim Anlegen der neuen **KomXwork:Workflow-Prozess starten**-Aktion wird automatisch das mit der Statusverarbeitung verbundene Formular nach allen Elementen durchsucht und diese als neue
84 **KomXflow-Feld-Definition**s-Elemente angelegt.
85
86 {{info}}
87 Bei späteren Änderungen im Formular kann über den [[image:icon_update]]-Button eine Aktualisierung der **KomXflow-Feld-Definition**s-Elemente durchgeführt werden.
88 Es werden dabei alle nicht aktuell vorhandenen Formular-Elemente in die Auflistung eingefügt.
89 {{/info}}
90
91
92 Die nachfolgende Abbildung zeigt wie anhand eines Beispiel-Formulars die Tabelle befüllt wird.
93 Die Felder, welche mit einem[[image:icon_info.png]]markiert sind, wurden dabei als "wiederholbare" Elemente identifiziert. Bei der Übermittlung an //KomXwork// werden diese gesondert behandelt.
94 __Hinweis:__ Felder welche automatisiert aus dem Formular ermittelt wurden und bei denen es sich nicht um Upload-Felder handelt, können im Bereich //Wert// nicht angepasst werden.
95
96
97 Über den[[image:icon_add.png]]-Button können der Tabelle weitere Elemente hinzugefügt werden.
98 Für ein einzelnes Feld sind dabei //Datentyp//, //KomXflow-Feld-Id//, und (zu übermittelnder) //Wert //festzulegen.
99 Diese Einstellungen haben folgende Bedeutung:
100
101 ; Datentyp
102 : Unterstützt wird: //Textfeld//, //Boolean// (Wahrheitswert), //Ganzzahl//, //Fließkommazahl// und //Datei//.
103 : Der ausgewählte Datentyp hat dabei Auswirkung darauf, in welcher Form der zur Laufzeit übermittelte Wert interpretiert und an //KomXwork// übermittelt wird.
104 : Beispielsweise wird bei Festlegung des Datentyps //Ganzzahl// vor der Übermittlung an //KomXwork// geprüft, ob der zu übermittelnde Wert, welcher perse eine Zeichenkette darstellt, sich in eine Ganzzahl umwandeln lässt.
105 : Ist dies nicht der Fall, wird die Datenübermittlung mit einem entsprechenden Fehler abgebrochen. Dadurch ist es möglich bereits vor Übermittlung eine Datentyp-Sicherheit zu gewährleisten.
106 ; KomXflow-Feld-Id
107 : Enthält den Namen der Variablen, wie er auf Seiten von //KomXflow// genutzt werden kann. Zu beachten ist dabei, dass sich bei Übermittlung von wiederholbaren Formular-Elementen dieser Name dynamisch,
108 : um ein Suffix der Form: "_//<aktuelle Laufvariable, beginnend bei 1>//" erweitert. Näheres dazu ist der Beschreibung im Fieldset //Verarbeitungshinweise bei wiederholbaren Elementen//, welche sich unterhalb der
109 : Tabelle **KomXflow-Feld-Definitionen** befindet, zu entnehmen.
110 ; Wert
111 : Enthält den an //KomXflow// zu übermittelnden Wert. Dieser kann aus Platzhalter{{{(n)}}} oder fest hinterlegten Werten bestehen. Bei einer vom Datentyp //Textfeld// **abweichenden** Festlegung, **muss** sich der zu Laufzeit ergebende Gesamtwert,
112 : in den entsprechenden Datentyp umwandeln lassen.
113 : Wird zur Laufzeit kein Wert ermittelt, weil beispielsweise ein Platzhalter keinen Wert referenziert, dann wird dieses //KomXflow-Feld// von der Übermittlung ausgenommen.
114
115 Im unteren Beispiel wurde zusätzlich ein neues Feld (Id: FormToPDF) vom Typ //Datei// hinzugefügt und mit dem Ergebnis einer "dateibereitstellenden"-Aktion belegt.
116 Zusätzlich zu Upload-Elementen aus dem Formular lassen sich damit auch Aktionen, welche als Ergebnis ihrer Abarbeitung eine Datei in der Statusverarbeitung zur Verfügung stellen, einbinden.
117
118
119 [[image:plugin_elem_config_example.png]]
120
121
122 === Übersteuern der Serverkonfiguration ===
123
124 {{figure image="plugin_srv_config.png"}}
125 Einstellungen zur Übersteuerung global definierter Verbindungsparameter
126 {{/figure}}
127
128 In diesem Bereich besteht die Möglichkeit die global am Plugin-Bundle registrierten Eigenschaften für den anzubindenden //KomXwork//-Server und deren Authentifizierungs-Informationen formular-prozess-spezifisch zu übersteuern.
129 Es können Platzhalter (Auswahlmöglichkeit über Button [[image:icon_placeholder.png]]) für einzelne Einstellungen verwendet werden.
130
131 ; REST-Service URL
132 : Protokoll und Host zu einen KomXwork REST Service. (z.B. //https:~/~/my.komxwork-server.de//)
133 : Übersteuert den global definierten Parameter **[[rest.srv.url>>doc:||anchor="bundle_prop_rest_url"]]**.
134 ; Client-Id
135 : Die ID, welche die öffentliche Kennung der KomXwork-Anwendung repräsentiert.
136 : Übersteuert den global definierten Parameter **[[client.id>>doc:||anchor="bundle_prop_client_id"]]**.
137 ; Client-Secret
138 : Das Client-Secret, vom KomXwork-System vorgegeben.
139 : Übersteuert den global definierten Parameter **[[client.secret>>doc:||anchor="bundle_prop_client_secret"]]**.
140 ; Nutzername
141 : Namen des Nutzers (=Resource-Owner) über den der Zugriff auf den Web-Service erfolgen soll.
142 : Übersteuert den global definierten Parameter **[[username>>doc:||anchor="bundle_prop_user"]]**.
143 ; Passwort
144 : Passwort zum //Nutzernamen//. Übersteuert den global definierten Parameter **[[password>>doc:||anchor="bundle_prop_pwd"]]**.
145 ; Grant-Type
146 : Definiert das aktuell genutzte Authentifizierungs- und Autorisierungsverfahren.
147 : Übersteuert den global definierten Parameter **[[granttype>>doc:||anchor="bundle_prop_granttype"]]**.
148
149 === Allgemeine Rückgabeparameter ===
150
151 {{figure image="plugin_result.png"}}
152 Konfiguration der Plugin Rückgabedaten (Platzhalter)
153 {{/figure}}
154
155 (((
156 In diesem Bereich werden die vom Plugin als Ergebnis des //KomXflow// Service-Aufrufs zurückgelieferten Parameter aufgeführt.
157 Für die einzelnen Parameter kann ein Alias vergeben werden.
158 In weiteren Aktionen kann auf den entsprechenden Rückgabeparameter per Platzhalter-Syntax zugegriffen werden.
159 Der Platzhalter wird dabei nach dem folgenden Muster gebildet:
160 )))
161
162 {{code language="javascript"}}
163 [%$<Plugin-Name>.RESULT[0].<Name oder vergebener Alias der Rückgabeparameters>%]
164 {{/code}}
165
166 {{info}}
167 Über den [[image:icon_copy.png]] Button kann der aus dem Namen oder Alias erzeugte Platzhalter einfach in die Zwischenablage kopiert
168 und an anderer Stelle, zum Beispiel im Text einer E-Mail-Aktion, mittels {{code language="none"}}Ctrl+V{{/code}} eingefügt werden.
169 {{/info}}
170
171
172 ; ResultCode
173 : Das Ergebnis der Ausführung der Plugin-Aktion wird in Form eines Statuscode zurückgeliefert.
174 : Dabei definiert der Statuscode **"0"**, dass das Plugin fehlerfrei ausgeführt werden konnte.
175 : Im Fehlerfall werden unterschiedliche Statuscodes zurückgeliefert, welche die folgenden Bedeutungen haben:
176 :; 10:
177 :: Es konnte kein //KomXwork//-Prozess zur Ausführung ermittelt werden.
178 :: (Prüfen Sie bitte die Einstellungen im Bereich **Name des KomXwork-Prozesses**)
179 :; 11:
180 :: Es konnten keine Daten für eine Übermittlung an //KomXwork// ermittelt werden.
181 :: (Prüfen Sie bitte die Einstellungen im Bereich **KomXflow-Feld-Definitionen** auf Korrektheit)
182 :; 12:
183 :: Die Werte von folgenden KomXflow-Felder konnten nicht in den festgelegten Datentyp umgewandelt werden: //<Auflistung aller betroffenen KomXflow-Feld-ID's>//
184 :; 30:
185 :: Es konnte keine Verbindung zum Service unter dem URL '//<URL des angefragten Service>//' aufgebaut werden.
186 :; 31:
187 :: Der Serviceaufruf lieferte folgenden Fehler: //<Detailierte Fehlerinformationen die vom gerufenen Service zurückgeliefert wurde>//
188 :; 40:
189 :: In FORMCYCLE ist ein nicht näher spezifizierter Fehler aufgetreten: //<Platzhalter für nähere Fehlerbeschreibung>//
190 ; ResultMessage
191 : Eine zum Statuscode zugehörige Meldung
192 ; ResultJSONString
193 : Das vom Service-Aufruf zurückgelieferte JSON (**J**ava**S**cript **O**bject **N**otation) - Objekt zur weiteren Verarbeitung
194
195 == Videos ==
196
197 Demonstration der Schnittstelle zwischen FORMCYCLE und komXwork Teil 1
198
199 {{externalVimeoVideo id="451130593" image="Workshops.WebHome@fc_video_play.png" height="400"/}}
200
201
202 Demonstration der Schnittstelle zwischen FORMCYCLE und komXwork Teil 2
203
204 {{externalVimeoVideo id="451130661" image="Workshops.WebHome@fc_video_play.png" height="400"/}}
205
206
207 == Versionshistorie ==
208
209 === 1.1.2 ===
210
211 * Fehlerbehebung: Ein Fehler, welcher beim Aktualisieren der KomXflow-Feld-Definitionen aus den Formulardaten in der Oberfläche aufgetreten ist, wurde behoben.
212
213 === 1.1.1 ===
214
215 * Fehlerbehebung: Einstellungen für Read- und Connection-Timeout bei der Webservice-Kommunikation werden jetzt beachtet.
216 * Refactoring: Umstellung von ID auf UUID
217
218 === 1.1.0 ===
219
220 * Erweiterung der Schnittstelle, um die Möglichkeit zur Übermittlung von dynamischen (wiederholbaren) Elementen.
221 * Es können zusätzlich zu Upload-Elementen aus dem Formular, auch dateibereitstellende Aktionen angebunden werden
222
223 === 1.0.0 ===
224
225 * initiale Anbindung der KomXflow-Schnittstelle

Navigation

Copyright 2000-2024