Änderungen von Dokument Bürgerservice Plugin


Von Version 24.5
bearbeitet von MKO
am 08.06.2023, 10:30
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 24.6
bearbeitet von rth
am 12.06.2023, 16:59
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Titel
... ... @@ -1,1 +1,1 @@
1 -Bürger Services Plugin
1 +Bürgerservice Plugin
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.mko
1 +XWiki.rth
Inhalt
... ... @@ -3,10 +3,10 @@
3 3  (% class="box infomessage" %)
4 4  (((
5 5  **Achtung:**
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!
6 +Bevor Sie die Bürgerservices 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 7  )))
8 8  
9 -Über das kostenpflichtige //Bürger Services Plugin// werden Möglichkeiten zur Einbindung verschiedener Bürger Services in (% class="xm-smallcaps" %)Xima® Formcycle(%%) bereitgestellt.
9 +Über das kostenpflichtige //Bürger Services Plugin// werden Möglichkeiten zur Einbindung verschiedener Bürgerservices in (% class="xm-smallcaps" %)Xima® Formcycle(%%) bereitgestellt.
10 10  Dabei kann zwischen den Anbindungen für
11 11  
12 12  * **BundID**
... ... @@ -15,9 +15,9 @@
15 15  
16 16  gewählt werden.
17 17  
18 -== Einbindung der Bürger Services in Formulare ==
18 +== Einbindung der Bürgerservices in Formulare ==
19 19  
20 -Für eine Einbindung der Bürger Services in (% class="xm-smallcaps" %)Xima® Formcycle(%%) Formulare bestehen grundsätzlich folgende Möglichkeiten:
20 +Für eine Einbindung der Bürgerservices in (% class="xm-smallcaps" %)Xima® Formcycle(%%) Formulare bestehen grundsätzlich folgende Möglichkeiten:
21 21  
22 22  * Anmeldung über Formular-Zugriffssteuerung: hier erfolgt eine Nutzer-Legitimierung **vor** der Anzeige des Formulars
23 23  * Anmeldung über Login-Button: In diesem Szenario kann eine Nutzer-Legitimierung während der Anzeige des Formulars (zu jedem Zeitpunkt), durchgeführt werden. 
... ... @@ -25,12 +25,12 @@
25 25  === Einbindung über Formular-Zugriff ===
26 26  
27 27  {{figure image="formularZugriff_login.png"}}
28 -Konfiguration der Bürger Services als Formularanmeldung
28 +Konfiguration der Bürgerservices als Formularanmeldung
29 29  {{/figure}}
30 30  
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.
31 +Um den Login für einen oder mehrere Bürgerservices ü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.
32 32  
33 -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.
33 +Die in der Auswahl zur Verfügung stehenden Bürgerservices sind abhängig von der Lizenzierung, sowie vom vollständigen Konfigurations-Status der als Externe Benutzer definierten Bürgerservice-Anbindungen.
34 34  
35 35  
36 36  === Einbindung im Designer - per Login Button ===
... ... @@ -39,27 +39,27 @@
39 39  Allgemeine Einstellungen am Formular-Element //Bürger Services Login//
40 40  {{/figure}}
41 41  
42 -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.
42 +Zur vereinfachten Einbindung von einem Bürgerservices 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.
43 43  Die nachfolgenden aufgeführten Einstellungen gelten dabei für alle Bürger Services (BundID, ELSTER etc.) gleichermaßen.
44 44  
45 45  ; Bezeichner
46 46  : Beschriftung des Login-Buttons im Formular
47 47  ; Authentikator
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.  
48 +: Hier muss ein konkreter Bürgerservice 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ürgerservice (ELSTER, BundID etc.) wird zum Aufrufzeitpunkt weitergeleitet.  
49 49  ; Seite bei Login
50 50  : Hier wird die Formularseite festgelegt, welche angezeigt werden soll, wenn der Login **erfolgreich **war.
51 51  ; Seite bei Abbruch
52 52  : Hier wird die Formularseite festgelegt, welche angezeigt werden soll, wenn der Login **abgebrochen** wurde.
53 53  ; Element Suffix
54 -: Hier kann ein Suffix definiert werden, welches beim Vorbelegen von Formularelementen, mit den ermittelten Daten aus einem Bürger Service, zur Anwendung kommt.
54 +: Hier kann ein Suffix definiert werden, welches beim Vorbelegen von Formularelementen, mit den ermittelten Daten aus einem Bürgerservice, zur Anwendung kommt.
55 55  Durch das Suffix wird es möglich mehrere Authentifizierungen und Formularelement-Vorbelegungen innerhalb eines Formulars zu realisieren.
56 56  : Als Suffix sind Buchstaben, Zahlen und der Unterstrich erlaubt.
57 57  : __Beispiel:__
58 58  Wenn als Suffix "**_1**" definiert wurde, muss das Formularfeld für die Adresse mit dem Namen "tfAntragstellerAdresse**_1**" benannt werden, damit eine Vorbelegung erfolgreich stattfinden kann. 
59 59  ; Login im Popup
60 -: Wenn aktiviert, wird die Login-Seite des jeweiligen Bürger Service-Portals in einem Popup geöffnet, ansonst erfolgt die Anzeige in der gleichen Seite.
60 +: Wenn aktiviert, wird die Login-Seite des jeweiligen Bürgerservice-Portals in einem Popup geöffnet, ansonst erfolgt die Anzeige in der gleichen Seite.
61 61  ; Validieren
62 -: Wenn aktiviert, werden die bisherigen Formulareingaben validiert. Der Start des Login-Prozesses ist dann erst möglich, wenn alle Nutzereingaben auf der Seite valide sind. Wenn deaktiviert, findet keine Überprüfung der bisherigen Formulareingaben statt und es wird sofort zum jeweiligen Bürger Service-Portal weitergeleitet.
62 +: Wenn aktiviert, werden die bisherigen Formulareingaben validiert. Der Start des Login-Prozesses ist dann erst möglich, wenn alle Nutzereingaben auf der Seite valide sind. Wenn deaktiviert, findet keine Überprüfung der bisherigen Formulareingaben statt und es wird sofort zum jeweiligen Bürgerservice-Portal weitergeleitet.
63 63  
64 64  ==== Zusätzliche Konfigurationsmöglichkeiten für **BundID** / **BayernID** ====
65 65  
... ... @@ -67,8 +67,8 @@
67 67  Erweiterte Einstellungen am Formular-Element //Bürger Services Login// für **BundID** und **BayernID**
68 68  {{/figure}}
69 69  
70 -Die nachfolgend beschriebenen Konfigurationsmöglichkeiten stehen nur im Zusammenhang mit den Bürger Services von BundID und BayernID zur Verfügung
71 -und ermöglichen es die Anmeldemöglichkeiten, sowie die zurück gelieferten Daten aus dem jeweiligen Bürger Service-Portal zu beeinflussen.
70 +Die nachfolgend beschriebenen Konfigurationsmöglichkeiten stehen nur im Zusammenhang mit den Bürgerservices von BundID und BayernID zur Verfügung
71 +und ermöglichen es die Anmeldemöglichkeiten, sowie die zurück gelieferten Daten aus dem jeweiligen Bürgerservice-Portal zu beeinflussen.
72 72  
73 73  ; Vertrauensniveau
74 74  : Hier kann das dem Nutzer zur Verfügung stehende Authentifizierungsverfahren eingeschränkt werden.
... ... @@ -99,11 +99,11 @@
99 99  : Über diese Checkbox-Auswahl kann der Nutzer die zurück gelieferten Eigenschaften einer erfolgreichen Authentifizierung einschränken.
100 100  : Damit wird dem Grundsatz der Datensparsamkeit der DSGVO (Datenschutz-Grundverordnung) entsprochen. Sind beispielsweise nur der Name und der Vorname einer Person in einem Formularprozess notwendig,
101 101  : so sind nur die entsprechenden Felder in dieser Auswahlliste zu selektieren.
102 -: Ist nichts ausgewählt, erfolgt keine Einschränkung und alle möglichen Eigenschaften werden vom jeweiligen Bürger Service-Portal angefordert.
102 +: Ist nichts ausgewählt, erfolgt keine Einschränkung und alle möglichen Eigenschaften werden vom jeweiligen Bürgerservice-Portal angefordert.
103 103  ; Nur mit Postkorb
104 104  : Diese Einstellung ermöglich es die Postkorb-ID als verpflichtendes Rückgabe-Attribut zu kennzeichnen.
105 -: Auf Seiten des Bürger Service-Portals werden dann alle Authentifizierungsarten, die keinen Postkorbversand ermöglichen, für den Nutzer ausgeblendet.
106 -Mit dieser Einstellung wird sichergestellt, dass bei einer erfolgreichen Nutzer-Authentifizierung immer ein nachgeordneter Nachrichtenversand an den Postkorb des Nutzers im jeweiligen Bürger Service-Portal möglich ist.
105 +: Auf Seiten des Bürgerservice-Portals werden dann alle Authentifizierungsarten, die keinen Postkorbversand ermöglichen, für den Nutzer ausgeblendet.
106 +Mit dieser Einstellung wird sichergestellt, dass bei einer erfolgreichen Nutzer-Authentifizierung immer ein nachgeordneter Nachrichtenversand an den Postkorb des Nutzers im jeweiligen Bürgerservice-Portal möglich ist.
107 107  
108 108  == Anzeige der Anmeldedaten im Formular ==
109 109  
... ... @@ -115,10 +115,10 @@
115 115  Elementkatalog mit allen möglichen Datenelementen
116 116  {{/figure}}
117 117  
118 -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.
118 +Um die Daten aus dem jeweiligen Bürgerservice-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.
119 119  Für die Erweiterung der Anzeigedaten steht der ebenfalls im Designer eingebundene Elementkatalog //Bürger Services Elemente //zur Verfügung//.//
120 120  
121 -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:
121 +Die aus dem Bürgerservice-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:
122 122  
123 123  
124 124  (% class="box" %)
... ... @@ -149,7 +149,7 @@
149 149  
150 150  ==== Darstellung der Nutzerdaten nach Anmeldung ====
151 151  
152 -Nach einer Anmeldung am Bürger Service-Portal sind die Eingabefelder innerhalb der Datenvorlage für eine Bearbeitung gesperrt, welche durch den Authentifizierungsprozess befüllt wurden.
152 +Nach einer Anmeldung am Bürgerservice-Portal sind die Eingabefelder innerhalb der Datenvorlage für eine Bearbeitung gesperrt, welche durch den Authentifizierungsprozess befüllt wurden.
153 153  Alle übrigen Felder innerhalb der Vorlage, können dann standardmäßig durch den angemeldeten Benutzer bearbeitet werden, wenn im Designer für diese Felder nichts gegenteiliges festgelegt wurde.
154 154  
155 155  Zusätzlich werden die Felder bei Wiederanzeige durch kleine Icons gekennzeichnet, wodurch ersichtlich wird aus welcher Quelle die Anmeldeinformationen entstammen.
... ... @@ -166,9 +166,9 @@
166 166  
167 167  == Übersicht Element-Matrix ==
168 168  
169 -Die nachfolgenden Tabelle listet alle Formular-Elemente auf, die im Zusammenhang mit den Bürger Services existieren. Dabei werden nicht alle Elemente durch jeden angebundenen Bürger Service gleichermaßen befüllt, bzw. die Elementdaten können je nach genutzten Authentifizierungsverfahren innerhalb des jeweiligen Bürger Service Portal zurück oder auch nicht zurück geliefert werden.
169 +Die nachfolgenden Tabelle listet alle Formular-Elemente auf, die im Zusammenhang mit den Bürgerservices existieren. Dabei werden nicht alle Elemente durch jeden angebundenen Bürgerservice gleichermaßen befüllt, bzw. die Elementdaten können je nach genutzten Authentifizierungsverfahren innerhalb des jeweiligen Bürgerservice Portal zurück oder auch nicht zurück geliefert werden.
170 170  
171 -Hinweis: Die Tabelle gibt den aktuell entnommen Stand aus den Dokumentationen der jeweiligen Bürger Service-Portale (BundID, BayernID und ELSTER) wieder und erhebt deshalb nicht den Anspruch der Vollständigkeit.
171 +Hinweis: Die Tabelle gibt den aktuell entnommen Stand aus den Dokumentationen der jeweiligen Bürgerservice-Portale (BundID, BayernID und ELSTER) wieder und erhebt deshalb nicht den Anspruch der Vollständigkeit.
172 172  
173 173  
174 174  (% style="margin-right:auto" %)
... ... @@ -275,7 +275,7 @@
275 275  Workflow mit Bedingung für Prüfung des Authentifikationslevels und einer Postkorb Nachricht versenden Aktion
276 276  {{/figure}}
277 277  
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.
278 +Für die Anbindung zum Versand Nachrichten an den Postkorb des jeweiligen Bürgerservice steht die Workflow-Aktion //Postkorbnachricht senden// zur Verfügung.
279 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 280  
281 281  Die Konfigurationsoberfläche der Aktion ist in einzelne Bereiche unterteilt die nachfolgend kurz beschrieben werden.
... ... @@ -291,7 +291,7 @@
291 291  ; Dienst
292 292  : Wird als Information in der Postkorb-Ansicht im Bürgerservice-Portal verwendet.
293 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,
294 +: Falls sich die Angabe im Feld Mandant auf einen Mandanten bezieht, der nicht im Bürgerservice-Portal registriert ist, kann über den Absender-Link ein Link mitgegeben werden,
295 295  : mit dem der Mandant bei der Anzeige im Postkorb der **BundID **oder **BayernID **verlinkt wird.
296 296  ; TransferId-Referenz
297 297  : Diese Eigenschaft findet nur in Zusammenhang mit der Postkorbanbindung von **ELSTER** Verwendung.
... ... @@ -305,7 +305,7 @@
305 305  
306 306  ; Postkorb ID aus einer Anmeldung innerhalb der Vorgangsdaten ermitteln?
307 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
308 +: Wird bei einem Bürgerservice-Login die Postkorb ID übermittelt, so wird diese standardmäßig am Formulareingang hinterlegt. Für den Fall, dass es mehrere konfigurierte Anmeldungen
309 309  : innerhalb eines Formulars gibt, kann die Auswahl über den Daten-Suffix eingegrenzt werden.
310 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 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,7 +312,7 @@
312 312  :; Postkorb ID (Pflichtfeld)
313 313  :: Hier ist die Angabe einer konkreten Postkorb ID erforderlich. Diese muss zur Laufzeit mit dem in Feld //Webservice Umgebung// definierten Authentikator korrespondieren.
314 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.
315 +:: Hier werden alle registrierten Bürgerservice Authentikatoren zur Auswahl aufgeführt. Es muss darauf geachtet werden, dass der gewählte Authenticator den angebundenen Bürgerservice widerspiegelt, in dessen Kontext zur Laufzeit die Postkorb ID verortet ist.
316 316  ; Vertrauensniveau der Anmeldung für Zugriff auf Postkorb-Nachricht weiterreichen?
317 317  : Diese Option steht nur im BundID und BayernID Portal zur Verfügung. 
318 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.
... ... @@ -337,7 +337,7 @@
337 337  : Nachrichtentext. Es werden Platzhalter unterstützt.
338 338  ; Anhänge
339 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:
340 +: Die dabei unterstützten Dateiformat unterscheiden sich dabei je nach genutzten Bürgerservice:
341 341  : Zur Auswahl stehen dabei:
342 342  :; Dateien aus vorherigen Aktionen
343 343  :: Eine Liste mit Dateien, von Datei-bereitstellenden Aktionen, die der Postkorb-Aktion vorangestellt sind.
... ... @@ -361,7 +361,7 @@
361 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 362  
363 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.
364 +: Zur Auswahl stehen die einzelnen Authentifizierungslevel (normal, substanziell und hoch), sowie die Festlegung kein, dass explizit keine Bürgerservice Authentifizierung stattgefunden hat. Es wird eine Mehrfachauswahl unterstützt.
365 365  ; Festlegung der zu prüfenden Authentifizierung
366 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 367  : Die Standardeinstellung ist: //kein Daten-Suffix//