Änderungen von Dokument Bürgerservice Plugin

Von Version 19.1
bearbeitet von rth
am 09.05.2023, 16:08
Änderungskommentar: Neues Bild workflow_postkorb_empfaenger.png hochladen
Auf Version 14.14
bearbeitet von rth
am 09.05.2023, 10:39
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -22,11 +22,21 @@
22 22  
23 23  === Einbindung über Formular-Zugriff ===
24 24  
25 -{{figure image="formularZugriff_login.png"}}
25 +
26 +(% class="xm-figure xm-float-right xm-clear-h2" data-alt="Konfiguration der Bürger Services als Formularanmeldung" %)
27 +(((
28 +(% class="xm-figure-inner" style="width:310px" %)
29 +(((
30 +[[~[~[image:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/WebHome/formularZugriff_login.png?rev=1.2~|~|width="300"~]~]>>path:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/WebHome/formularZugriff_login.png?rev=1.2||rel="lightbox[$group]" title="Konfiguration der Bürger Services als Formularanmeldung"]]
31 +
32 +(% class="xm-figure-caption" %)
33 +(((
26 26  Konfiguration der Bürger Services als Formularanmeldung
27 -{{/figure}}
35 +)))
36 +)))
37 +)))
28 28  
29 -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.
39 +Um den Login für einen oder mehrere Bürger Services über einen (% class="wikiinternallink" %)[[Externen Benutzer>>path:/xwiki/bin/view/Formcycle/UserInterface/UserSettings/ExternalUsers/]](%%) am jeweiligen Formular zu ermöglichen, muss dies als (% class="wikiinternallink" %)[[Formularanmeldung>>path:/xwiki/bin/view/Formcycle/UserInterface/MyForms/Access]](%%) am Formular hinterlegt sein.
30 30  
31 31  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.
32 32  
... ... @@ -33,9 +33,19 @@
33 33  
34 34  === Einbindung im Designer - per Login Button ===
35 35  
36 -{{figure image="designer_loginBtn.png"}}
46 +
47 +(% class="xm-figure xm-float-right xm-clear-h2" data-alt="Allgemeine Einstellungen am Formular-Element Bürger Services Login" %)
48 +(((
49 +(% class="xm-figure-inner" style="width:310px" %)
50 +(((
51 +[[~[~[image:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/WebHome/designer_loginBtn.png?rev=1.1~|~|width="300"~]~]>>path:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/WebHome/designer_loginBtn.png?rev=1.1||rel="lightbox[$group]" title="Allgemeine Einstellungen am Formular-Element Bürger Services Login"]]
52 +
53 +(% class="xm-figure-caption" %)
54 +(((
37 37  Allgemeine Einstellungen am Formular-Element //Bürger Services Login//
38 -{{/figure}}
56 +)))
57 +)))
58 +)))
39 39  
40 40  Zur vereinfachten Einbindung von einem Bürger Services innerhalb eines Formularprozesses gibt es das Formular-Element //Bürger Services Login//. Dieses kann per "Drag & Drop" in den Seitenbereich gezogen werden. Das dann vorhandene Button-Element kann im Bereich **Bürger Services: Login Einstellungen** konfiguriert werden.
41 41  Die nachfolgenden aufgeführten Einstellungen gelten dabei für alle Bürger Services (BundID, ELSTER etc.) gleichermaßen.
... ... @@ -43,7 +43,7 @@
43 43  ; Bezeichner
44 44  : Beschriftung des Login-Buttons im Formular
45 45  ; Authentikator
46 -: 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.  
66 +: Hier muss ein konkreter Bürger Services aus den im System konfigurierten (% class="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.  
47 47  ; Seite bei Login
48 48  : Hier wird die Formularseite festgelegt, welche angezeigt werden soll, wenn der Login **erfolgreich **war.
49 49  ; Seite bei Abbruch
... ... @@ -61,9 +61,19 @@
61 61  
62 62  ==== Zusätzliche Konfigurationsmöglichkeiten für **BundID** / **BayernID** ====
63 63  
64 -{{figure image="designer_loginBtn_ext.png"}}
84 +
85 +(% class="xm-figure xm-float-right xm-clear-h2" data-alt="Erweiterte Einstellungen am Formular-Element Bürger Services Login für BundID und BayernID" %)
86 +(((
87 +(% class="xm-figure-inner" style="width:310px" %)
88 +(((
89 +[[~[~[image:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/WebHome/designer_loginBtn_ext.png?rev=1.1~|~|width="300"~]~]>>path:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/WebHome/designer_loginBtn_ext.png?rev=1.1||rel="lightbox[$group]" title="Erweiterte Einstellungen am Formular-Element Bürger Services Login für BundID und BayernID"]]
90 +
91 +(% class="xm-figure-caption" %)
92 +(((
65 65  Erweiterte Einstellungen am Formular-Element //Bürger Services Login// für **BundID** und **BayernID**
66 -{{/figure}}
94 +)))
95 +)))
96 +)))
67 67  
68 68  Die nachfolgend beschriebenen Konfigurationsmöglichkeiten stehen nur im Zusammenhang mit den Bürger Services von BundID und BayernID zur Verfügung
69 69  und ermöglichen es die Anmeldemöglichkeiten, sowie die zurück gelieferten Daten aus dem jeweiligen Bürger Service-Portal zu beeinflussen.
... ... @@ -105,14 +105,35 @@
105 105  
106 106  == Anzeige der Anmeldedaten im Formular ==
107 107  
108 -{{figure image="designer_vorlage.png"}}
138 +
139 +(% class="xm-figure xm-float-right xm-clear-h2" data-alt="Elementvorlagen zur Datenanzeige" %)
140 +(((
141 +(% class="xm-figure-inner" style="width:310px" %)
142 +(((
143 +[[~[~[image:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/WebHome/designer_vorlage.png?rev=1.1~|~|width="300"~]~]>>path:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/WebHome/designer_vorlage.png?rev=1.1||rel="lightbox[$group]" title="Elementvorlagen zur Datenanzeige"]]
144 +
145 +(% class="xm-figure-caption" %)
146 +(((
109 109  Elementvorlagen zur Datenanzeige
110 -{{/figure}}
148 +)))
149 +)))
150 +)))
111 111  
112 -{{figure image="designer_elementkatalog.png"}}
152 +
153 +(% class="xm-figure xm-float-right xm-clear-h2" data-alt="Elementkatalog mit allen möglichen Datenelementen" %)
154 +(((
155 +(% class="xm-figure-inner" style="width:310px" %)
156 +(((
157 +[[~[~[image:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/WebHome/designer_elementkatalog.png?rev=1.1~|~|width="300"~]~]>>path:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/WebHome/designer_elementkatalog.png?rev=1.1||rel="lightbox[$group]" title="Elementkatalog mit allen möglichen Datenelementen"]]
158 +
159 +(% class="xm-figure-caption" %)
160 +(((
113 113  Elementkatalog mit allen möglichen Datenelementen
114 -{{/figure}}
162 +)))
163 +)))
164 +)))
115 115  
166 +
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  
... ... @@ -129,9 +129,19 @@
129 129  
130 130  === Darstellung des genutzten Authentifizierungsverfahren ===
131 131  
132 -{{figure image="formular_trustlevel_visualisierung.png"}}
183 +
184 +(% class="xm-figure xm-float-right xm-clear-h2" data-alt="Darstellung des verwendeten Vertrauensniveaus in einer Datenvorlage" %)
185 +(((
186 +(% class="xm-figure-inner" style="width:310px" %)
187 +(((
188 +[[~[~[image:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/WebHome/formular_trustlevel_visualisierung.png?rev=1.1~|~|width="300"~]~]>>path:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/WebHome/formular_trustlevel_visualisierung.png?rev=1.1||rel="lightbox[$group]" title="Darstellung des verwendeten Vertrauensniveaus in einer Datenvorlage"]]
189 +
190 +(% class="xm-figure-caption" %)
191 +(((
133 133  Darstellung des verwendeten Vertrauensniveaus in einer Datenvorlage
134 -{{/figure}}
193 +)))
194 +)))
195 +)))
135 135  
136 136  Bei Nutzung der Vorlagen aus dem Designer ist nach dem Absenden des Formulars, sowie bei der Wiederanzeige des Formulars im Postfach, das durch den Nutzer verwendete Authentifizierungsverfahren anhand einer visuellen Markierung ersichtlich.
137 137  
... ... @@ -141,9 +141,19 @@
141 141  * Level 3 (Authentifizierung mittels Zertifikat, Vertrauensniveau nach BSI: //substanziell//): **Zertifikat**
142 142  * Level 4 (Authentifizierung mittels Personalausweis (eID) oder vergleichbaren Authentifizierungsmittel (eIDAS), Vertrauensniveau nach BSI: //hoch//): **Personalausweis**
143 143  
144 -{{figure image="formular_trustlevel_keine_visualisierung.png"}}
205 +
206 +(% class="xm-figure xm-float-right xm-clear-h2" data-alt="Wenn keine visuelle Markierung gewünscht ist, so kann dies durch ein zusätzliches Attribut „noRibbon“ am Vorlagen-Fieldset unterbunden werden" %)
207 +(((
208 +(% class="xm-figure-inner" style="width:310px" %)
209 +(((
210 +[[~[~[image:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/WebHome/formular_trustlevel_keine_visualisierung.png?rev=1.1~|~|width="300"~]~]>>path:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/WebHome/formular_trustlevel_keine_visualisierung.png?rev=1.1||rel="lightbox[$group]" title="Wenn keine visuelle Markierung gewünscht ist, so kann dies durch ein zusätzliches Attribut „noRibbon“ am Vorlagen-Fieldset unterbunden werden"]]
211 +
212 +(% class="xm-figure-caption" %)
213 +(((
145 145  Wenn keine visuelle Markierung gewünscht ist, so kann dies durch ein zusätzliches Attribut „noRibbon“ am Vorlagen-Fieldset unterbunden werden
146 -{{/figure}}
215 +)))
216 +)))
217 +)))
147 147  
148 148  ==== Darstellung der Nutzerdaten nach Anmeldung ====
149 149  
... ... @@ -152,8 +152,8 @@
152 152  
153 153  Zusätzlich werden die Felder bei Wiederanzeige durch kleine Icons gekennzeichnet, wodurch ersichtlich wird aus welcher Quelle die Anmeldeinformationen entstammen.
154 154  
155 -* [[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
156 -* [[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
226 +* [[image:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/WebHome/verified.png?width=21&height=22&rev=1.1||alt="Icon für Informationen aus Bürgerservice-Portal" height="22" width="21"]] Felder mit diesem Icon wurden aus dem Bürgerservice-Portal übermittelt
227 +* [[image:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/WebHome/none_verified.png?width=23&height=20&rev=1.1||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 157  
158 158  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:
159 159  
... ... @@ -263,77 +263,7 @@
263 263  
264 264  == Anbindung Postkorb im Workflow ==
265 265  
266 -Für die Anbindung zum Versand Nachrichten an den Postkorb des jeweiligen Bürger Service steht die Workflow-Aktion //Postkorbnachricht senden// zur Verfügung.
267 -Mittels dieser Workflow-Aktion können (ähnlich einer E-Mail Aktion) Nachrichten weitergeleitet werden, wenn zum Ausführungszeitpunkt eine Postkorb ID ermittelt werden kann.
337 +Für die Anbindung zum Versand Nachrichten an den Postkorb des jeweiligen Bürger Service steht die Workflow-Aktion _Postkorbnachricht senden_ zur Verfügung.
338 +Mittels dieser Aktion, können ähnlich einer E-Mail Aktion, Nachrichten weitergeleitet werden, wenn zum Ausführungszeitpunkt eine Postkorb-ID ermittelt werden kann.
268 268  
269 269  Die Konfigurationsoberfläche der Aktion ist in einzelne Bereiche unterteilt die nachfolgend kurz beschrieben werden.
270 -
271 -=== Absender ===
272 -
273 -{{figure image="workflow_postkorb_absender.png"}}
274 -Einstellungen für den Absender einer Postkorb Nachricht
275 -{{/figure}}
276 -
277 -; Mandant / Absender
278 -: Wird als Information in der Postkorb-Ansicht im Bürgerservice-Portal verwendet.
279 -; Dienst
280 -: Wird als Information in der Postkorb-Ansicht im Bürgerservice-Portal verwendet.
281 -; Absender-Link
282 -: 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,
283 -: mit dem der Mandant bei der Anzeige im Postkorb der **BundID **oder **BayernID **verlinkt wird.
284 -; TransferId-Referenz
285 -: Diese Eigenschaft findet nur in Zusammenhang mit der Postkorbanbindung von **ELSTER** Verwendung.
286 -: 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
287 -
288 -=== Empfänger ===
289 -
290 -{{figure image="workflow_postkorb_empfaenger.png"}}
291 -Einstellungen für den Empfänger einer Postkorb Nachricht
292 -{{/figure}}
293 -
294 -; Postkorb ID aus einer Anmeldung innerhalb der Vorgangsdaten ermitteln?
295 -: 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.
296 -: 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
297 -: innerhalb eines Formulars gibt, kann die Auswahl über den Daten-Suffix eingegrenzt werden.
298 -: 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.)
299 -: 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:
300 -:; Postkorb ID (Pflichtfeld)
301 -:: Hier ist die Angabe einer konkreten Postkorb ID erforderlich. Diese muss zur Laufzeit mit dem in Feld //Webservice Umgebung// definierten Authentikator korrespondieren.
302 -:; Webservice Umgebung
303 -:: 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.
304 -; Vertrauensniveau der Anmeldung für Zugriff auf Postkorb-Nachricht weiterreichen?
305 -: Diese Option steht nur im BundID und BayernID Portal zur Verfügung. 
306 -: 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.
307 -: Wenn kein Vertrauensniveau aus den Anmeldedaten ermittelt werden kann, wird das niedrigste Vertrauensniveau für den Zugriff auf die Nachricht gesetzt.
308 -; E-Mailversand als Alternative?
309 -: Ü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.
310 -; 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:
311 -: 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.
312 -
313 -=== Inhalt der Nachricht ===
314 -
315 -{{figure image="workflow_postkorb_nachricht.png"}}
316 -Konfiguration von Betreff, Nachrichteninhalt und Anhängen
317 -{{/figure}}
318 -
319 -; Betreff (Pflicht)
320 -: Nachrichtenbetreff. Es werden Platzhalter unterstützt.
321 -; Inhalt (Pflicht)
322 -: Nachrichtentext. Es werden Platzhalter unterstützt.
323 -; Anhänge
324 -: Hier können Dateien als Attachments an die Postkorb-Nachricht gehangen werden.
325 -: Die dabei unterstützten Dateiformat unterscheiden sich dabei je nach genutzten Bürger Service:
326 -: * für BundID / BayernID: PDF, HTML, Plaintext, MS Word, JPEG, GIF, PNG, ZIP
327 -: * für ELSTER: PDF, JPEG, PNG, XML, CSV
328 -: Zur Auswahl stehen dabei:
329 -:; Dateien aus vorherigen Aktionen
330 -:: Eine Liste mit Dateien, von Datei-bereitstellenden Aktionen, die der Postkorb-Aktion vorangestellt sind.
331 -:; Mandantdateien
332 -:: Liefert eine Auswahlliste über alle Datei-Ressourcen am Mandanten
333 -:; Formulardateien
334 -:: Liefert eine Auswahlliste über alle Datei-Ressourcen, welche am Formular-Projekt hinterlegt sind.
335 -:; Externe Ressourcen-URL
336 -:: Dateien die über externe Quellen (HTTP-Requests) ermittelt werden können.
337 -:; Vorgangsanhänge mittels Dateinamen suchen
338 -:: Eine Suche innerhalb von Dateinamen mittels übereinstimmenden Suchbegriffs. Es kann dabei mittels Filter eingegrenzt werden,
339 -:: innerhalb welcher Datei-Quellen die Suche ausgeführt wird (Dateien aus Uploads, Datei aus der Statusverarbeitung, Dateien aus dem Posteingang)
workflow_postkorb_absender.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.rth
Größe
... ... @@ -1,1 +1,0 @@
1 -18.5 KB
Inhalt
workflow_postkorb_empfaenger.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.rth
Größe
... ... @@ -1,1 +1,0 @@
1 -36.5 KB
Inhalt