| ... |
... |
@@ -1,9 +1,12 @@ |
| 1 |
|
-{{info}} |
|
1 |
+[[**Plugin-Download**>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/B%C3%BCrgerservice%20Plugin%20(buerger-service)&fileid=52647||rel="noopener noreferrer" target="_blank"]] (erfordert Anmeldung) |
|
2 |
+ |
|
3 |
+(% class="box infomessage" %) |
|
4 |
+((( |
| 2 |
2 |
**Achtung:** |
| 3 |
|
-Bevor Sie die Bürger Services in ihre Formular-Prozesse einbinden, stellen Sie bitte sicher, dass die konfigurative Anbindung der Dienste durch einen {{formcycle/}}-Administrator erfolgt ist! |
| 4 |
|
-{{/info}} |
|
6 |
+Bevor Sie die Bürger Services in ihre Formular-Prozesse einbinden, stellen Sie bitte sicher, dass die konfigurative Anbindung der Dienste durch einen (% class="xm-smallcaps" %)Xima® Formcycle(%%)-Administrator erfolgt ist! |
|
7 |
+))) |
| 5 |
5 |
|
| 6 |
|
-Über das kostenpflichtige //Bürger Services Plugin// werden Möglichkeiten zur Einbindung verschiedener Bürger Services in {{formcycle/}} bereitgestellt. |
|
9 |
+Über das kostenpflichtige //Bürger Services Plugin// werden Möglichkeiten zur Einbindung verschiedener Bürger Services in (% class="xm-smallcaps" %)Xima® Formcycle(%%) bereitgestellt. |
| 7 |
7 |
Dabei kann zwischen den Anbindungen für |
| 8 |
8 |
|
| 9 |
9 |
* **BundID** |
| ... |
... |
@@ -14,7 +14,7 @@ |
| 14 |
14 |
|
| 15 |
15 |
== Einbindung der Bürger Services in Formulare == |
| 16 |
16 |
|
| 17 |
|
-Für eine Einbindung der Bürger Services in {{formcycle/}} Formulare bestehen grundsätzlich folgende Möglichkeiten: |
|
20 |
+Für eine Einbindung der Bürger Services in (% class="xm-smallcaps" %)Xima® Formcycle(%%) Formulare bestehen grundsätzlich folgende Möglichkeiten: |
| 18 |
18 |
|
| 19 |
19 |
* Anmeldung über Formular-Zugriffssteuerung: hier erfolgt eine Nutzer-Legitimierung **vor** der Anzeige des Formulars |
| 20 |
20 |
* Anmeldung über Login-Button: In diesem Szenario kann eine Nutzer-Legitimierung während der Anzeige des Formulars (zu jedem Zeitpunkt), durchgeführt werden. |
| ... |
... |
@@ -25,7 +25,7 @@ |
| 25 |
25 |
Konfiguration der Bürger Services als Formularanmeldung |
| 26 |
26 |
{{/figure}} |
| 27 |
27 |
|
| 28 |
|
-Um den Login für einen oder mehrere Bürger Services über einen [[Externen Benutzer>>path:/xwiki/bin/view/Formcycle/UserInterface/UserSettings/ExternalUsers/]] am jeweiligen Formular zu ermöglichen, muss dies als [[Formularanmeldung>>path:/xwiki/bin/view/Formcycle/UserInterface/MyForms/Access]] am Formular hinterlegt sein. |
|
31 |
+Um den Login für einen oder mehrere Bürger Services über einen (% class="wikiinternallink wikiinternallink" %)[[Externen Benutzer>>path:/xwiki/bin/view/Formcycle/UserInterface/UserSettings/ExternalUsers/]](%%) am jeweiligen Formular zu ermöglichen, muss dies als (% class="wikiinternallink wikiinternallink" %)[[Formularanmeldung>>path:/xwiki/bin/view/Formcycle/UserInterface/MyForms/Access]](%%) am Formular hinterlegt sein. |
| 29 |
29 |
|
| 30 |
30 |
Die in der Auswahl zur Verfügung stehenden Bürger Services sind abhängig von der Lizenzierung, sowie vom vollständigen Konfigurations-Status der als Externe Benutzer definierten Bürger Service-Anbindungen. |
| 31 |
31 |
|
| ... |
... |
@@ -42,7 +42,7 @@ |
| 42 |
42 |
; Bezeichner |
| 43 |
43 |
: Beschriftung des Login-Buttons im Formular |
| 44 |
44 |
; Authentikator |
| 45 |
|
-: Hier muss ein konkreter Bürger Services aus den im System konfigurierten [[Externen Benutzern>>path:/xwiki/bin/view/Formcycle/UserInterface/UserSettings/ExternalUsers/]] ausgewählt werden. Zu diesem konkreten Bürger Service (ELSTER, BundID etc.) wird zum Aufrufzeitpunkt weitergeleitet. |
|
48 |
+: Hier muss ein konkreter Bürger Services aus den im System konfigurierten (% class="wikiinternallink wikiinternallink" %)[[Externen Benutzern>>path:/xwiki/bin/view/Formcycle/UserInterface/UserSettings/ExternalUsers/]](%%) ausgewählt werden. Zu diesem konkreten Bürger Service (ELSTER, BundID etc.) wird zum Aufrufzeitpunkt weitergeleitet. |
| 46 |
46 |
; Seite bei Login |
| 47 |
47 |
: Hier wird die Formularseite festgelegt, welche angezeigt werden soll, wenn der Login **erfolgreich **war. |
| 48 |
48 |
; Seite bei Abbruch |
| ... |
... |
@@ -112,7 +112,6 @@ |
| 112 |
112 |
Elementkatalog mit allen möglichen Datenelementen |
| 113 |
113 |
{{/figure}} |
| 114 |
114 |
|
| 115 |
|
- |
| 116 |
116 |
Um die Daten aus dem jeweiligen Bürger Service-Portal im Formular anzuzeigen, existieren unterschiedliche Vorlagen im Designer. Diese Vorlagen sind nach dem Schwerpunkt, ob sie für eine Anzeige von Personen- oder Organisationsdaten eingesetzt werden sollen, gestaltet. Sie enthalten bereits eine Reihe sinnvoller Elemente für die Datenanzeige, können aber mit weiteren Elementen (auch eigens Definierten) erweitert werden. |
| 117 |
117 |
Für die Erweiterung der Anzeigedaten steht der ebenfalls im Designer eingebundene Elementkatalog //Bürger Services Elemente //zur Verfügung//.// |
| 118 |
118 |
|
| ... |
... |
@@ -119,9 +119,13 @@ |
| 119 |
119 |
Die aus dem Bürger Service-Portal zurück gelieferten Daten können mittels JavaScript auch anderweitig weiterverarbeitet werden. Dafür werden sie in Form einer JSON-Struktur im Zielformular zur Verfügung gestellt. Die JSON Struktur kann über folgende JavaScript-Variable ausgelesen werden: |
| 120 |
120 |
|
| 121 |
121 |
|
| 122 |
|
-{{code language="javascript"}} |
|
124 |
+(% class="box" %) |
|
125 |
+((( |
|
126 |
+(% class="code" %) |
|
127 |
+((( |
| 123 |
123 |
XFC_METADATA.pluginResults.XM_BuergerServicesLoginAnalyzer |
| 124 |
|
-{{/code}} |
|
129 |
+))) |
|
130 |
+))) |
| 125 |
125 |
|
| 126 |
126 |
=== Darstellung des genutzten Authentifizierungsverfahren === |
| 127 |
127 |
|
| ... |
... |
@@ -148,8 +148,8 @@ |
| 148 |
148 |
|
| 149 |
149 |
Zusätzlich werden die Felder bei Wiederanzeige durch kleine Icons gekennzeichnet, wodurch ersichtlich wird aus welcher Quelle die Anmeldeinformationen entstammen. |
| 150 |
150 |
|
| 151 |
|
-* [[image:verified.png||alt="Icon für Informationen aus Bürgerservice-Portal" height="22" width="21"]] Felder mit diesem Icon wurden aus dem Bürgerservice-Portal übermittelt |
| 152 |
|
-* [[image:none_verified.png||alt="Icon für Informationen die der Nutzer nachträglich eingegeben hat" height="20" width="23"]] Felder mit diesem Icon wurden vom Nutzer nachträglich eingegeben und wurden deshalb nicht durch einen Identitätsprüfer verifiziert |
|
157 |
+* [[image:attach:verified.png||alt="Icon für Informationen aus Bürgerservice-Portal" height="22" width="21"]] Felder mit diesem Icon wurden aus dem Bürgerservice-Portal übermittelt |
|
158 |
+* [[image:attach:none_verified.png||alt="Icon für Informationen die der Nutzer nachträglich eingegeben hat" height="20" width="23"]] Felder mit diesem Icon wurden vom Nutzer nachträglich eingegeben und wurden deshalb **nicht **durch einen Identitätsprüfer verifiziert |
| 153 |
153 |
|
| 154 |
154 |
Die Feld-Icons werden mittels CSS-Klassen an den Eingabe-Elementen hinzugefügt und können dadurch mittels eigenem CSS Definitionen übersteuert werden. Die dafür notwendigen Klassen haben folgende Namen: |
| 155 |
155 |
|
| ... |
... |
@@ -222,6 +222,12 @@ |
| 222 |
222 |
|=(% style="text-align:left" %)tfPersTyp|Personentyp|((( |
| 223 |
223 |
mögliche Werte: |
| 224 |
224 |
|
|
231 |
+* //NatPers //(der Inhaber des Kontos wird als Privatperson angesehen) |
|
232 |
+* //NNatPers// (der Inhaber des Kontos wird als Organisation betrachtet) |
|
233 |
+)))|(% style="background-color:#c6efce" %)Pflichtfeld|(% style="background-color:#c6efce" %)Pflichtfeld|(% style="background-color:#c6efce" %)Pflichtfeld|(% style="background-color:#c6efce" %)Pflichtfeld|(% style="background-color:#c6efce" %)Pflichtfeld|(% style="background-color:#c6efce" %)Pflichtfeld|(% style="background-color:#c6efce" %)Pflichtfeld|(% style="background-color:#c6efce" %)Pflichtfeld|(% style="background-color:#c6efce" %)Pflichtfeld|(% style="background-color:#c6efce" %)Pflichtfeld|(% style="background-color:#c6efce" %)Pflichtfeld|(% style="background-color:#c6efce" %)Pflichtfeld|(% style="background-color:#c6efce" %)Pflichtfeld |
|
234 |
+|=(% style="text-align:left" %)selOrgPersTyp|Inhabertyp des Steuerkontos|((( |
|
235 |
+mögliche Werte: |
|
236 |
+ |
| 225 |
225 |
* //NatPers //(der Inhaber des Kontos ist eine natürliche Person, z.B.: Einzelunternehmer) |
| 226 |
226 |
* //NNatPers// (bei einer nicht natürlichen Person, z.B.: GmbH) |
| 227 |
227 |
)))|(% style="background-color:#c6efce" %)Pflichtfeld|(% style="background-color:#c6efce" %)Pflichtfeld|(% style="background-color:#c6efce" %)Pflichtfeld|(% style="background-color:#c6efce" %)Pflichtfeld|(% style="background-color:#c6efce" %)Pflichtfeld|(% style="background-color:#c6efce" %)Pflichtfeld|(% style="background-color:#c6efce" %)Pflichtfeld|(% style="background-color:#c6efce" %)Pflichtfeld|(% style="background-color:#c6efce" %)Pflichtfeld|(% style="background-color:#c6efce" %)Pflichtfeld|(% style="background-color:#c6efce" %)Pflichtfeld|(% style="background-color:#c6efce" %)Pflichtfeld|(% style="background-color:#c6efce" %)Pflichtfeld |
| ... |
... |
@@ -259,7 +259,117 @@ |
| 259 |
259 |
|
| 260 |
260 |
== Anbindung Postkorb im Workflow == |
| 261 |
261 |
|
| 262 |
|
-Für die Anbindung zum Versand Nachrichten an den Postkorb des jeweiligen Bürger Service steht die Workflow-Aktion _Postkorbnachricht senden_ zur Verfügung. |
| 263 |
|
-Mittels dieser Aktion, können ähnlich einer E-Mail Aktion, Nachrichten weitergeleitet werden, wenn zum Ausführungszeitpunkt eine Postkorb-ID ermittelt werden kann. |
|
274 |
+{{figure image="workflow_bedingung_aktion.png"}} |
|
275 |
+Workflow mit Bedingung für Prüfung des Authentifikationslevels und einer Postkorb Nachricht versenden Aktion |
|
276 |
+{{/figure}} |
| 264 |
264 |
|
|
278 |
+Für die Anbindung zum Versand Nachrichten an den Postkorb des jeweiligen Bürger Service steht die Workflow-Aktion //Postkorbnachricht senden// zur Verfügung. |
|
279 |
+Mittels dieser Workflow-Aktion können (ähnlich einer E-Mail Aktion) Nachrichten weitergeleitet werden, wenn zum Ausführungszeitpunkt eine Postkorb ID ermittelt werden kann. |
|
280 |
+ |
| 265 |
265 |
Die Konfigurationsoberfläche der Aktion ist in einzelne Bereiche unterteilt die nachfolgend kurz beschrieben werden. |
|
282 |
+ |
|
283 |
+=== Absender === |
|
284 |
+ |
|
285 |
+{{figure image="workflow_postkorb_absender.png"}} |
|
286 |
+Einstellungen für den Absender einer Postkorb Nachricht |
|
287 |
+{{/figure}} |
|
288 |
+ |
|
289 |
+; Mandant / Absender |
|
290 |
+: Wird als Information in der Postkorb-Ansicht im Bürgerservice-Portal verwendet. |
|
291 |
+; Dienst |
|
292 |
+: Wird als Information in der Postkorb-Ansicht im Bürgerservice-Portal verwendet. |
|
293 |
+; Absender-Link |
|
294 |
+: Falls sich die Angabe im Feld Mandant auf einen Mandanten bezieht, der nicht im Bürger Service-Portal registriert ist, kann über den Absender-Link ein Link mitgegeben werden, |
|
295 |
+: mit dem der Mandant bei der Anzeige im Postkorb der **BundID **oder **BayernID **verlinkt wird. |
|
296 |
+; TransferId-Referenz |
|
297 |
+: Diese Eigenschaft findet nur in Zusammenhang mit der Postkorbanbindung von **ELSTER** Verwendung. |
|
298 |
+: An dieser Stelle kann ein eindeutige Kennung (ELSTER-TransferTicket) angegeben werden, um mit der aktuell versendeten (Antwort-)Nachricht einen Bezug zu einer vorhergehenden Nachricht herzustellen |
|
299 |
+ |
|
300 |
+=== Empfänger === |
|
301 |
+ |
|
302 |
+{{figure image="workflow_postkorb_empfaenger.png"}} |
|
303 |
+Einstellungen für den Empfänger einer Postkorb Nachricht |
|
304 |
+{{/figure}} |
|
305 |
+ |
|
306 |
+; Postkorb ID aus einer Anmeldung innerhalb der Vorgangsdaten ermitteln? |
|
307 |
+: Diese Angabe dient zur Bestimmung der Postkorb ID. Über diese ID wird das genaue Ziel für den Nachrichtenversand bestimmt, also der Nachrichten-Empfänger. |
|
308 |
+: Wird bei einem Bürger Service-Login die Postkorb ID übermittelt, so wird diese standardmäßig am Formulareingang hinterlegt. Für den Fall, dass es mehrere konfigurierte Anmeldungen |
|
309 |
+: innerhalb eines Formulars gibt, kann die Auswahl über den Daten-Suffix eingegrenzt werden. |
|
310 |
+: Darüber hinaus ist es möglich die Postkorb-ID fest oder über einen Platzhalter **[%$POSTKORB%]** zu definieren. (Diese Platzhalter wird über das Plugin zur Verfügung gestellt.) |
|
311 |
+: Wird an dieser Stelle die standardmäßig ausgewählte Einstellung entfernt, so werden andere Konfigurationseigenschaften sichtbar, welche das direkte Festlegen einer Postkorb ID ermöglichen: |
|
312 |
+:; Postkorb ID (Pflichtfeld) |
|
313 |
+:: Hier ist die Angabe einer konkreten Postkorb ID erforderlich. Diese muss zur Laufzeit mit dem in Feld //Webservice Umgebung// definierten Authentikator korrespondieren. |
|
314 |
+:; Webservice Umgebung |
|
315 |
+:: Hier werden alle registrierten Bürger Service Authentikatoren zur Auswahl aufgeführt. Es muss darauf geachtet werden, dass der gewählte Authenticator den angebundenen Bürger Service widerspiegelt, in dessen Kontext zur Laufzeit die Postkorb ID verortet ist. |
|
316 |
+; Vertrauensniveau der Anmeldung für Zugriff auf Postkorb-Nachricht weiterreichen? |
|
317 |
+: Diese Option steht nur im BundID und BayernID Portal zur Verfügung. |
|
318 |
+: Hier können Sie festlegen, ob das Vertrauensniveau der Anmeldung (wenn dies ermittelt werden kann) für den Zugriff auf die Postkorb-Nachricht weitergereicht werden soll. |
|
319 |
+: Wenn kein Vertrauensniveau aus den Anmeldedaten ermittelt werden kann, wird das niedrigste Vertrauensniveau für den Zugriff auf die Nachricht gesetzt. |
|
320 |
+; E-Mailversand als Alternative? |
|
321 |
+: Über diese Option können Sie festlegen, dass als alternative Versandmöglichkeit der Versand mittels E-Mail verwendet wird. Diese Alternative kommt dann zur Anwendung, wenn keine Postkorb ID ermittelt werden konnte, oder die Übermittlung der Postkorb-Nachricht mit Fehlern beendet wurde. Voraussetzungen für dem E-Mailversand ist die Verfügbarkeit einer E-Mail-Adresse (im Feld //tfAntragstellerEmail//) in den verwendeten Anmeldedaten, sowie die Erreichbarkeit eines konfigurierten E-Mail-Servers. |
|
322 |
+; Bitte wählen oder geben Sie ggf. einen abweichend Daten-Suffix an, aus welchem die Postkorb ID für die Übermittlung der Nachricht bezogen werden soll: |
|
323 |
+: Die Angabe eines Daten-Suffixes ist immer dann notwendig, wenn innerhalb des Formularprozesses mehrere unterschiedliche Authentifizierungen stattgefunden haben. Die Angabe stellt sicher, dass zur Laufzeit die richtigen Anmeldedaten und damit der richtige Postkorb angesprochen werden kann. |
|
324 |
+ |
|
325 |
+=== Inhalt der Nachricht === |
|
326 |
+ |
|
327 |
+{{figure image="workflow_postkorb_nachricht.png"}} |
|
328 |
+Konfiguration von Betreff, Nachrichteninhalt und Anhängen |
|
329 |
+{{/figure}} |
|
330 |
+ |
|
331 |
+* für **BundID **/ **BayernID**: //PDF//, //HTML//, //Plaintext//, //MS Word//, //JPEG//, //GIF//, //PNG//, //ZIP// |
|
332 |
+* für **ELSTER**: //PDF//, //JPEG//, //PNG//, //XML//, //CSV// |
|
333 |
+ |
|
334 |
+; Betreff (Pflicht) |
|
335 |
+: Nachrichtenbetreff. Es werden Platzhalter unterstützt. |
|
336 |
+; Inhalt (Pflicht) |
|
337 |
+: Nachrichtentext. Es werden Platzhalter unterstützt. |
|
338 |
+; Anhänge |
|
339 |
+: Hier können Dateien als Attachments an die Postkorb-Nachricht gehangen werden. |
|
340 |
+: Die dabei unterstützten Dateiformat unterscheiden sich dabei je nach genutzten Bürger Service: |
|
341 |
+: Zur Auswahl stehen dabei: |
|
342 |
+:; Dateien aus vorherigen Aktionen |
|
343 |
+:: Eine Liste mit Dateien, von Datei-bereitstellenden Aktionen, die der Postkorb-Aktion vorangestellt sind. |
|
344 |
+:; Mandantdateien |
|
345 |
+:: Liefert eine Auswahlliste über alle Datei-Ressourcen am Mandanten |
|
346 |
+:; Formulardateien |
|
347 |
+:: Liefert eine Auswahlliste über alle Datei-Ressourcen, welche am Formular-Projekt hinterlegt sind. |
|
348 |
+:; Externe Ressourcen-URL |
|
349 |
+:: Dateien die über externe Quellen (HTTP-Requests) ermittelt werden können. |
|
350 |
+:; Vorgangsanhänge mittels Dateinamen suchen |
|
351 |
+:: Eine Suche innerhalb von Dateinamen mittels übereinstimmenden Suchbegriffs. Es kann dabei mittels Filter eingegrenzt werden, |
|
352 |
+:: innerhalb welcher Datei-Quellen die Suche ausgeführt wird (Dateien aus Uploads, Datei aus der Statusverarbeitung, Dateien aus dem Posteingang) |
|
353 |
+ |
|
354 |
+== Bedingte Ausführung von Workflow-Aktionen auf Grundlage des Authentifizierungslevels == |
|
355 |
+ |
|
356 |
+{{figure image="workflow_bedingung.png"}} |
|
357 |
+Workflow-Steuerungselement //Authentifizierungslevel prüfen// |
|
358 |
+{{/figure}} |
|
359 |
+ |
|
360 |
+Um eine einfache Prüfung auf Grundlage des Authentifizierungslevels durchzuführen steht das Workflow-Steuerelement //Authentifizierungslevel prüfen// zur Verfügung. |
|
361 |
+Mit diesem Element kann das Vertrauensniveau, auf dessen Grundlage sich ein Nutzer am Formular authentifiziert hat, abgeprüft und für eine unterschiedliche Ausführung von Verarbeitungsketten genutzt werden. |
|
362 |
+ |
|
363 |
+; Prüfung des Authentifizierungslevels |
|
364 |
+: Zur Auswahl stehen die einzelnen Authentifizierungslevel (normal, substanziell und hoch), sowie die Festlegung kein, dass explizit keine Bürger Service Authentifizierung stattgefunden hat. Es wird eine Mehrfachauswahl unterstützt. |
|
365 |
+; Festlegung der zu prüfenden Authentifizierung |
|
366 |
+: Prinzipiell können sich an einem Formular mehrere Nutzer authentifizieren. Um die einzelnen Anmeldungen im Workflow zu unterscheiden und festzulegen welches Vertrauensniveau für die Prüfung herangezogen werden soll, muss der Daten-Suffix angegeben werden. |
|
367 |
+: Die Standardeinstellung ist: //kein Daten-Suffix// |
|
368 |
+ |
|
369 |
+== Versionshistorie == |
|
370 |
+ |
|
371 |
+=== 1.7.9 === |
|
372 |
+ |
|
373 |
+* Wird bei der Postkorb-Aktion ein Upload als zu übertragen angegeben, schlägt diese jetzt nicht mehr fehl, wenn hier keine Datei im Formular ausgewählt wurde (Betrifft BayernID und BundID) |
|
374 |
+* Der Login-Button innerhalb des Formulars wird bei migrierten Anbindungen nicht mehr deaktiviert |
|
375 |
+* Anpassung der Metadaten-Generierung bei BayernID und BundID |
|
376 |
+** Sprach-Tags werden jetzt auf "de-DE" gesetzt |
|
377 |
+** Das Gültigkeitsdatum würde entfernt |
|
378 |
+* Kleine UI-Anpassung, um die nicht vorhandene Notwendigkeit der Ausfüllung der Service Provider Entity-ID bei BayernID und BundID hervorzuheben |
|
379 |
+ |
|
380 |
+=== 1.7.8 === |
|
381 |
+ |
|
382 |
+* Der Mail-Versand als Fallback bei fehlgeschlagenem Postkorb-Versand wird nun bei migrierten Anbindungen nicht standardmäßig aktiviert |
|
383 |
+* Kleinere Fehlerbehebungen |
|
384 |
+ |
|
385 |
+=== 1.7.7 === |
|
386 |
+ |
|
387 |
+* Initialer öffentlicher Release |
