Wiki-Quellcode von Bürger Services Plugin

Zeige letzte Bearbeiter
1 {{info}}
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}}
5
6 Über das kostenpflichtige //Bürger Services Plugin// werden Möglichkeiten zur Einbindung verschiedener Bürger Services in {{formcycle/}} bereitgestellt.
7 Dabei kann zwischen den Anbindungen für
8
9 * **BundID**
10 * **BayernID**
11 * **ELSTER** //Mein Unternehmenskonto//
12
13 gewählt werden.
14
15 == Einbindung der Bürger Services in Formulare ==
16
17 Für eine Einbindung der Bürger Services in {{formcycle/}} Formulare bestehen grundsätzlich folgende Möglichkeiten:
18
19 * Anmeldung über Formular-Zugriffssteuerung: hier erfolgt eine Nutzer-Legitimierung **vor** der Anzeige des Formulars
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
22 === Einbindung über Formular-Zugriff ===
23
24 {{figure image="formularZugriff_login.png"}}
25 Konfiguration der Bürger Services als Formularanmeldung
26 {{/figure}}
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.
29
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
32
33 === Einbindung im Designer - per Login Button ===
34
35 {{figure image="designer_loginBtn.png"}}
36 Allgemeine Einstellungen am Formular-Element //Bürger Services Login//
37 {{/figure}}
38
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 Die nachfolgenden aufgeführten Einstellungen gelten dabei für alle Bürger Services (BundID, ELSTER etc.) gleichermaßen.
41
42 ; Bezeichner
43 : Beschriftung des Login-Buttons im Formular
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.  
46 ; Seite bei Login
47 : Hier wird die Formularseite festgelegt, welche angezeigt werden soll, wenn der Login **erfolgreich **war.
48 ; Seite bei Abbruch
49 : Hier wird die Formularseite festgelegt, welche angezeigt werden soll, wenn der Login **abgebrochen** wurde.
50 ; Element Suffix
51 : Hier kann ein Suffix definiert werden, welches beim Vorbelegen von Formularelementen, mit den ermittelten Daten aus einem Bürger Service, zur Anwendung kommt.
52 Durch das Suffix wird es möglich mehrere Authentifizierungen und Formularelement-Vorbelegungen innerhalb eines Formulars zu realisieren.
53 : Als Suffix sind Buchstaben, Zahlen und der Unterstrich erlaubt.
54 : __Beispiel:__
55 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. 
56 ; Login im Popup
57 : 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.
58 ; Validieren
59 : 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.
60
61 ==== Zusätzliche Konfigurationsmöglichkeiten für **BundID** / **BayernID** ====
62
63 {{figure image="designer_loginBtn_ext.png"}}
64 Erweiterte Einstellungen am Formular-Element //Bürger Services Login// für **BundID** und **BayernID**
65 {{/figure}}
66
67 Die nachfolgend beschriebenen Konfigurationsmöglichkeiten stehen nur im Zusammenhang mit den Bürger Services von BundID und BayernID zur Verfügung
68 und ermöglichen es die Anmeldemöglichkeiten, sowie die zurück gelieferten Daten aus dem jeweiligen Bürger Service-Portal zu beeinflussen.
69
70 ; Vertrauensniveau
71 : Hier kann das dem Nutzer zur Verfügung stehende Authentifizierungsverfahren eingeschränkt werden.
72 : Es gibt folgende Auswahlmöglichkeiten:
73 :; keine Einschränkung
74 :: Login mittels Nutzername / Passwort, Zertifikat oder Personalausweis steht zur Auswahl
75 :; Zertifikat
76 :: Nur die Authentifizierung mittels Zertifikat steht zur Auswahl
77 :; Zertifikat oder Personalausweis
78 :: Login mittels Zertifikat oder Personalausweis stehen zur Auswahl
79 :; Personalausweis
80 :: nur Authentifizierung mittels Personalausweis steht zur Auswahl
81 ; Einschränken auf
82 : Über diese Checkbox-Auswahl kann das dem Nutzer zur Verfügung stehende Authentifizierungsverfahren eingeschränkt werden.
83 : Ist nichts ausgewählt, erfolgt keine Einschränkung.
84 :; Benutzername
85 :: Authentifizierung erfolgt über Login / Passwort
86 :; Authega-Zertifikat
87 :; Elster-Zertifikat
88 :; FINK
89 :: Authentifizierung erfolgt über ein Identifikationsmittel aus dem Portfolio des //Föderierten Identitätsmanagements Interoperable Nutzerkonten//
90 :; Diia
91 :: Authentifizierung erfolgt mittels ukrainischer Digital-App //Diia//
92 :; eID (Personalausweis)
93 :; eIDAS
94 :: Authentifizierung mittels Identifikationsmittels nach eIDAS-Verordnung (//electronic IDentification, Authentication and Trust Services//)
95 ; Einschränkung der angeforderten Eigenschaften
96 : Über diese Checkbox-Auswahl kann der Nutzer die zurück gelieferten Eigenschaften einer erfolgreichen Authentifizierung einschränken.
97 : 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,
98 : so sind nur die entsprechenden Felder in dieser Auswahlliste zu selektieren.
99 : Ist nichts ausgewählt, erfolgt keine Einschränkung und alle möglichen Eigenschaften werden vom jeweiligen Bürger Service-Portal angefordert.
100 ; Nur mit Postkorb
101 : Diese Einstellung ermöglich es die Postkorb-ID als verpflichtendes Rückgabe-Attribut zu kennzeichnen.
102 : Auf Seiten des Bürger Service-Portals werden dann alle Authentifizierungsarten, die keinen Postkorbversand ermöglichen, für den Nutzer ausgeblendet.
103 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.
104
105 == Anzeige der Anmeldedaten im Formular ==
106
107 {{figure image="designer_vorlage.png"}}
108 Elementvorlagen zur Datenanzeige
109 {{/figure}}
110
111 {{figure image="designer_elementkatalog.png"}}
112 Elementkatalog mit allen möglichen Datenelementen
113 {{/figure}}
114
115
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 Für die Erweiterung der Anzeigedaten steht der ebenfalls im Designer eingebundene Elementkatalog //Bürger Services Elemente //zur Verfügung//.//
118
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
121 {{code language="javascript"}}
122 XFC_METADATA.pluginResults.XM_BuergerServicesLoginAnalyzer
123 {{/code}}