Änderungen von Dokument Bürgerservice Plugin


Von Version 14.13
bearbeitet von rth
am 09.05.2023, 10:38
Änderungskommentar: Es gibt keinen Kommentar für diese Version
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
... ... @@ -1,9 +1,10 @@
1 -{{info}}
1 +(% class="box infomessage" %)
2 +(((
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}}
4 +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!
5 +)))
5 5  
6 -Über das kostenpflichtige //Bürger Services Plugin// werden Möglichkeiten zur Einbindung verschiedener Bürger Services in {{formcycle/}} bereitgestellt.
7 +Ü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:
18 +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. 
... ... @@ -21,11 +21,21 @@
21 21  
22 22  === Einbindung über Formular-Zugriff ===
23 23  
24 -{{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 +(((
25 25  Konfiguration der Bürger Services als Formularanmeldung
26 -{{/figure}}
35 +)))
36 +)))
37 +)))
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.
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.
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  
... ... @@ -32,9 +32,19 @@
32 32  
33 33  === Einbindung im Designer - per Login Button ===
34 34  
35 -{{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 +(((
36 36  Allgemeine Einstellungen am Formular-Element //Bürger Services Login//
37 -{{/figure}}
56 +)))
57 +)))
58 +)))
38 38  
39 39  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.
40 40  Die nachfolgenden aufgeführten Einstellungen gelten dabei für alle Bürger Services (BundID, ELSTER etc.) gleichermaßen.
... ... @@ -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.  
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.  
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
... ... @@ -60,9 +60,19 @@
60 60  
61 61  ==== Zusätzliche Konfigurationsmöglichkeiten für **BundID** / **BayernID** ====
62 62  
63 -{{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 +(((
64 64  Erweiterte Einstellungen am Formular-Element //Bürger Services Login// für **BundID** und **BayernID**
65 -{{/figure}}
94 +)))
95 +)))
96 +)))
66 66  
67 67  Die nachfolgend beschriebenen Konfigurationsmöglichkeiten stehen nur im Zusammenhang mit den Bürger Services von BundID und BayernID zur Verfügung
68 68  und ermöglichen es die Anmeldemöglichkeiten, sowie die zurück gelieferten Daten aus dem jeweiligen Bürger Service-Portal zu beeinflussen.
... ... @@ -104,13 +104,33 @@
104 104  
105 105  == Anzeige der Anmeldedaten im Formular ==
106 106  
107 -{{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 +(((
108 108  Elementvorlagen zur Datenanzeige
109 -{{/figure}}
148 +)))
149 +)))
150 +)))
110 110  
111 -{{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 +(((
112 112  Elementkatalog mit allen möglichen Datenelementen
113 -{{/figure}}
162 +)))
163 +)))
164 +)))
114 114  
115 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.
... ... @@ -119,15 +119,29 @@
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"}}
173 +(% class="box" %)
174 +(((
175 +(% class="code" %)
176 +(((
123 123  XFC_METADATA.pluginResults.XM_BuergerServicesLoginAnalyzer
124 -{{/code}}
178 +)))
179 +)))
125 125  
126 126  === Darstellung des genutzten Authentifizierungsverfahren ===
127 127  
128 -{{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 +(((
129 129  Darstellung des verwendeten Vertrauensniveaus in einer Datenvorlage
130 -{{/figure}}
193 +)))
194 +)))
195 +)))
131 131  
132 132  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.
133 133  
... ... @@ -137,9 +137,19 @@
137 137  * Level 3 (Authentifizierung mittels Zertifikat, Vertrauensniveau nach BSI: //substanziell//): **Zertifikat**
138 138  * Level 4 (Authentifizierung mittels Personalausweis (eID) oder vergleichbaren Authentifizierungsmittel (eIDAS), Vertrauensniveau nach BSI: //hoch//): **Personalausweis**
139 139  
140 -{{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 +(((
141 141  Wenn keine visuelle Markierung gewünscht ist, so kann dies durch ein zusätzliches Attribut „noRibbon“ am Vorlagen-Fieldset unterbunden werden
142 -{{/figure}}
215 +)))
216 +)))
217 +)))
143 143  
144 144  ==== Darstellung der Nutzerdaten nach Anmeldung ====
145 145  
... ... @@ -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
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
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