Wiki source code of AKDB: Bürgerkonto-Service-Plugin
Show last authors
author | version | line-number | content |
---|---|---|---|
1 | {{info}} | ||
2 | **Hinweis für Plugin-/{{formcycle/}}-Administratoren:** | ||
3 | Am 13.04.2021 wurde die Testumgebung des Bürgerservice-Portals aktualisiert. Diese ist jetzt unter [[**BayernID - Startseite**>>url:https://infra-pre-bayernid.freistaat.bayern/de/bayern/freistaat||rel="noopener noreferrer" target="_blank"]] erreichbar. Diese Änderung auf Seiten des Bürgerservice-Portals macht Anpassungen bei den Dienst-Anbindungen notwendig. | ||
4 | |||
5 | Bei einer Aktualisierung des Plugins auf mindestens eine Version {{version major="2" minor="15"}}{{/version}} werden die notwendigen Anpassungen automatisch durchgeführt und es sind keine weiteren manuellen Eingriffe durch den Administrator notwendig. | ||
6 | {{/info}} | ||
7 | |||
8 | [[**Plugin-Download**>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/plugin-bundle-akdb-services&fileid=2671||rel="noopener noreferrer" target="_blank"]] (erfordert Anmeldung) | ||
9 | |||
10 | {{content/}} | ||
11 | |||
12 | {{info}} | ||
13 | **Achtung:** | ||
14 | Bevor Sie die AKDB-Basisdienste in ihren Formular-Prozessen einbinden, stellen Sie bitte sicher, dass die konfigurative Anbindung der Dienste durch den {{formcycle/}}-Administrator erfolgt ist! | ||
15 | {{/info}} | ||
16 | |||
17 | {{figure image="formular_vorlage.png"}} | ||
18 | Formularvorlage //AKDB Basisdienste// | ||
19 | {{/figure}} | ||
20 | |||
21 | |||
22 | Über das kostenpflichtige //AKDB Bürgerkonto Service Plugin// werden Möglichkeiten zur Einbindung der AKDB Basisdienste **Bürgerkonto** und **Postkorb** in {{formcycle/}} bereitgestellt. | ||
23 | |||
24 | |||
25 | Um Formulare mit Bürgerkonto- und Postkorb-Anbindung schnell und einfach zu erstellen, gibt es eine Vorlage mit Namen **AKDB Basisdienste**. Diese ist über den Menüpunkt //Meine Formulare// und dann über die Kachel //Neues Formular erstellen// erreichbar. Wird die Vorlage genutzt, dann sind das Bürgerkonto und der Postkorb mit einer funktionierenden Default-Konfiguration eingebunden, die man sofort nutzen kann. | ||
26 | |||
27 | == Einbindung des Bürgerkonto Logins im Designer == | ||
28 | |||
29 | {{figure image="hilfe_bk_button.png"}} | ||
30 | Formular-Element //AKDB Bürgerkonto// | ||
31 | {{/figure}} | ||
32 | |||
33 | Zur vereinfachten Einbindung des Bürgerkontos in Formulare gibt es das Formular-Element //AKDB Bürgerkonto//. Dieses kann per "Drag & Drop" in den Seitenbereich gezogen werden. Der dann vorhandene Absende-Button kann im Bereich **Buergerkonto-Login Einstellungen** konfiguriert werden. Die Einstellungen haben folgende Bedeutung: | ||
34 | |||
35 | |||
36 | ; Schaltflächen Text | ||
37 | : Beschriftung des Login-Buttons | ||
38 | ; Login im Popup | ||
39 | : Wenn aktiviert, wird die Login-Seite des Bürgerservice-Portals in einem Popup geöffnet, ansonst erfolgt die Anzeige in der gleichen Seite. | ||
40 | ; Formularseite nach Login | ||
41 | : Hier wird die Formularseite festgelegt, welche angezeigt werden soll, wenn der Login **erfolgreich **war. | ||
42 | ; Formularseite nach abgebrochenen Login | ||
43 | : Hier wird die Formularseite festgelegt, welche angezeigt werden soll, wenn der Login **abgebrochen** wurde. | ||
44 | ; Eingaben prüfen vor Login | ||
45 | : Wenn aktiviert, werden die bisherigen Formulareingaben validiert. Der Start des Bürgerkonto 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 Bürgerservice-Portal weitergeleitet. | ||
46 | ; Art der Rückgabedaten {{id name="Art_Rueckgabedaten"/}} | ||
47 | : Hier besteht die Auswahl zwischen: | ||
48 | |||
49 | * **personenbezogenen Daten** | ||
50 | * **organisationsbezogenen Daten** | ||
51 | * **personen- oder organisationsbezogenen Daten** | ||
52 | |||
53 | : Mit dieser Einstellung lässt sich die Art der zu erwarteten Rückgabedaten steuern, je nach Anforderung. | ||
54 | : Das heißt, wenn beispielsweise nur Daten einer natürlichen Person im Formularprozess zugelassen sind, ist hier die Auswahl auf //personenbezogene Daten// einzustellen. | ||
55 | ; Bürgerdaten Parameter-Suffix {{id name="BK_Parameter_Suffix"/}} | ||
56 | : Hier kann ein Suffix definiert werden, welches beim Vorbelegen von Formularelementen, mit den ermittelten Bürgerkonto-Daten, Anwendung findet. | ||
57 | Durch das Suffix wird es möglich mehrere Authentifizierungen und Formularelement-Vorbelegungen innerhalb eines Formulars zu realisieren. | ||
58 | : Als Suffix sind Buchstaben, Zahlen und der Unterstrich erlaubt. | ||
59 | : __Beispiel:__ | ||
60 | 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. | ||
61 | ; gefordertes Authentifizierungsverfahren | ||
62 | : Hier kann das dem Nutzer zur Verfügung stehende Authentifizierungsverfahren eingeschränkt werden. | ||
63 | : Es gibt folgende Auswahlmöglichkeiten: | ||
64 | |||
65 | * **keine Einschränkung**: Login mittels Passwort, Authega-Zertifikat oder Personalausweis steht zur Auswahl | ||
66 | * **Authega**: Nur die Authentifizierung mittels Authega-Zertifikat steht zur Auswahl | ||
67 | * **Authega oder Personalausweis**: Login mittels Authega-Zertifikat oder Personalausweis steht zur Auswahl **(Achtung: Diese Auswahl wird momentan nicht mehr vom AKDB Portal unterstützt!)** | ||
68 | * **Personalausweis**: nur Authentifizierung mittels Personalausweis steht zur Auswahl | ||
69 | |||
70 | == Einbindung des Bürgerkonto Logins als Externer Benutzer == | ||
71 | |||
72 | {{version major="6" minor="4" patch="0"/}} Die Option steht in der {{formcycle/}} - Version ab **6.4.0** mit der Plugin - Version ab **2.8.1** zur Verfügung. | ||
73 | |||
74 | === Konfiguration eines Externen Benutzers für das Bürgerkonto Login === | ||
75 | |||
76 | {{figure image="externer_benutzer_akdb.png"}} | ||
77 | Bürgerkonto-Login als Externer Benutzer einrichten. (Schritt 1) | ||
78 | {{/figure}} | ||
79 | |||
80 | Zur Einbindung des Bürgerkonto-Logins über einen [[Externen Benutzer>>doc:Formcycle.UserInterface.UserSettings.ExternalUsers.WebHome||target="_blank"]], muss diese Login Möglichkeit zuvor konfiguriert werden. | ||
81 | |||
82 | Dazu muss im jeweiligen Mandaten in den Konfigurationsbereich Externe Benutzer gewechselt werden. Dort muss mittels {{ficon name="plus-circle-outline"/}} der über das Plugin zur Verfügung gestellte **AKDB Login** ausgewählt werden. | ||
83 | |||
84 | {{info}} | ||
85 | Beachten Sie, dass vor Verwendung des //Bürgerkonto-Login als Externer Benutzer// die konfigurative Anbindung des Dienstes durch den {{formcycle/}}-Administrator stattgefunden hat, da die zur Kommunikation benötigten Zertifikate und Informationen aus den Plugin-Einstellungen entnommen werden. | ||
86 | {{/info}} | ||
87 | |||
88 | {{figure image="externer_benutzer_akdb_s2.png"}} | ||
89 | Bürgerkonto-Login als Externer Benutzer einrichten. (Schritt 2) | ||
90 | {{/figure}} | ||
91 | |||
92 | Im nächsten Schritt muss über den Button "Konfiguration hinzufügen" eine Konfiguration hinzugefügt werden. | ||
93 | |||
94 | {{figure image="externer_benutzer_akdb_s3.png"}} | ||
95 | Bürgerkonto-Login als Externer Benutzer einrichten. (Schritt 3) | ||
96 | {{/figure}} | ||
97 | |||
98 | Im letzten Schritt besteht die Möglichkeit die Konfiguration individuell anzupassen. | ||
99 | Dazu können folgende Einstellungen getroffen werden: | ||
100 | |||
101 | ; LoginTyp | ||
102 | : Mit dieser Einstellung lassen sich die Arten der zurück gelieferten Daten festlegen. | ||
103 | : Ist als Wert **Person** definiert, so können nur personenbezogene Daten zurückgeliefert werden. | ||
104 | : Ist **Organisation** definiert, so ist es nur möglich organisationsbezogene Daten zurückzuliefern. Das heißt ein Login als natürliche Person ist nicht möglich. | ||
105 | : Ist dieser Parameter nicht konfiguriert, so kann der Nutzer selbst bestimmen, welche Datenart (personen- oder organisationsbezogen) er zurück liefern möchte. | ||
106 | ; AuthTyp | ||
107 | : Über diese Einstellung kann das geforderte Authentisierungsverfahren festgelegt werden. | ||
108 | : Entweder mit Authega-Zertifikat (Wert: **Authega**) oder Personalausweis (Wert: **NPA**). | ||
109 | : Ist nichts gesetzt oder das Attribut nicht vorhanden, so werden dem Nutzer alle möglichen Authentisierungsverfahren zur Auswahl angeboten. | ||
110 | |||
111 | === Bürgerkonto Login als Formularanmeldung einrichten === | ||
112 | |||
113 | {{figure image="formular_zugriff.png"}} | ||
114 | Bürgerkonto Login als Externer Benutzer am Formular freischalten. | ||
115 | {{/figure}} | ||
116 | |||
117 | Um das Bürgerkonto-Login über einen [[Externen Benutzer>>doc:Formcycle.UserInterface.UserSettings.ExternalUsers.WebHome||target="_blank"]] am jeweiligen Formular zu ermöglichen, | ||
118 | muss dieses als [[Formularanmeldung>>doc:Formcycle.UserInterface.MyForms.Access||target="_blank"]] am Formular hinterlegt sein. | ||
119 | |||
120 | |||
121 | == Designer-Element: Bürgerkonto Daten Vorlage == | ||
122 | |||
123 | {{figure image="hilfe_bk_vorlagen.png"}} | ||
124 | Formularvorlage //AKDB Basisdienste// | ||
125 | {{/figure}} | ||
126 | |||
127 | Um die Daten aus dem Bürgerservice-Portal im Formular anzuzeigen, existieren zwei Vorlagen //Bürgerkonto personenbezogene Daten// und //Bürgerkonto organisationsbezogene Daten//. Die Felder innerhalb dieser Vorlagen sind so konfiguriert, dass sie eine automatische Zuordnung und damit die Anzeige der zurückgelieferten Daten ermöglichen. Die jeweilige Vorlage ist je nach der eingestellten [[Art der Rückgabedaten>>doc:||anchor="Art_Rueckgabedaten"]] am //AKDB Bürgerkonto//-Button zu wählen. Bei Nutzung der eingangs erwähnten Formular-Templates, sind beide Designer-Vorlagen bereits eingebunden und werden nach anzuzeigender Datenart ein- oder ausgeblendet. | ||
128 | |||
129 | Ab Plugin Version {{version major="2" minor="9"/}} gibt es eine weitere Vorlage, welche die Daten von person- und organisations-bezogenen Daten in einer Vorlage vereint. Das Anzeigeverhalten dieser Vorlage entspricht den eingangs erwähnten Vorlagen. Das heißt, je nach Anmeldetyp, werden die organisations-spezifischen Daten ein- oder ausgeblendet. | ||
130 | |||
131 | Die vom Bürgerservice-Portal zurückgelieferten 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: | ||
132 | |||
133 | |||
134 | {{code language="javascript"}} | ||
135 | XFC_METADATA.pluginResults.AKDBLoginAnalyzer | ||
136 | {{/code}} | ||
137 | |||
138 | Die nachfolgenden Tabelle listet alle Formularfeld-Namen auf, die in einem Formular genutzt werden können, um die Daten vom Bürgerservice-Portal in Formular-Elementen anzuzeigen. Einige Informationen sind über verschiedene Parameter-Namen abrufbar (einen englisch-sprachigen und einen deutsch-sprachigen Namen), in solchen Fällen können beide Benamungen gleichwertig genutzt werden. | ||
139 | |||
140 | {{info}} | ||
141 | Parameter, welche nur bei einer **p**ersonen**b**ezogenen **A**nmeldung vorhanden sind, sind mit **(PBA)** und die die nur bei einer **o**rganisations**b**ezogenen **A**nmeldung vorhanden sind, mit **(OBA)** gekennzeichnet. | ||
142 | Ist keine extra Kennzeichnung vorhanden, so ist der Parameter in beiden Bereichen vorhanden. | ||
143 | |||
144 | **Achtung: **Ab Plugin-Version **2.9.0** sind im Zuge einer Vereinheitlichung der Parameter-Name für **PBA** und **OBA**, bestimmte Parameter, die bisher nur bei **PBA** vorhanden waren auch bei einer **OBA** vorhanden. Im Zuge der Abwärtskompatibilität sind die OBA-spezifischen Parameter zusätzlich noch vorhanden. | ||
145 | Die betreffenden Parameter sind in der Tabelle mit **(PBA + OBA)** gekennzeichnet. | ||
146 | {{/info}} | ||
147 | |||
148 | {{table dataTypeAlpha="0" preSort="0-asc"}} | ||
149 | |=Parameter|=Beschreibung | ||
150 | |BPK|Bereichsspezifisches Personenkennzeichen (in verschlüsselter Form) | ||
151 | |BPK_Decoded|Bereichsspezifisches Personenkennzeichen (in entschlüsselter Form) | ||
152 | |PostboxId|Postkorb-ID des Nutzers. Muss bei Anbindung des Postkorbs verwendet werden. | ||
153 | |((( | ||
154 | Email (PBA) | ||
155 | tfAntragstellerEmail (PBA + OBA) | ||
156 | )))|Email-Adresse | ||
157 | |Gender|Anrede als numerischer Wert nach ISO 5218:2004 | ||
158 | |GenderName|Lesbarer Text für Geschlechter-Code aus Attribut „gender“. | ||
159 | Mögliche Werte: //männlich//, //weiblich// | ||
160 | |((( | ||
161 | Salutation | ||
162 | tfAntragstellerAnrede (PBA + OBA) | ||
163 | selAntragstellerAnrede (PBA) | ||
164 | )))|Anrede, wird mit Hilfe des Geschlechter-Code aus Attribut „gender“ erzeugt. | ||
165 | Mögliche Werte: //Herr//, //Frau, Nicht bekannt// | ||
166 | |((( | ||
167 | PersonalTitle (PBA) | ||
168 | tfAntragstellerTitel (PBA + OBA) | ||
169 | )))|Akademischer Titel | ||
170 | |((( | ||
171 | FirstName | ||
172 | tfAntragstellerVorname (PBA + OBA) | ||
173 | )))|Vorname | ||
174 | |((( | ||
175 | LastName | ||
176 | tfAntragstellerName (PBA + OBA) | ||
177 | )))|Nachname | ||
178 | |((( | ||
179 | ZipCode (PBA) | ||
180 | tfAntragstellerPLZ (PBA + OBA) | ||
181 | )))|Postleitzahl | ||
182 | |((( | ||
183 | Address (PBA) | ||
184 | tfAntragstellerAdresse (PBA + OBA) | ||
185 | )))|Adresse bestehend aus Strasse und Hausnummer | ||
186 | |((( | ||
187 | City (PBA) | ||
188 | tfAntragstellerOrt (PBA + OBA) | ||
189 | )))|Ort | ||
190 | |((( | ||
191 | BirthDate | ||
192 | tfAntragstellerGeburtsdatum (PBA + OBA) | ||
193 | )))|Geburtsdatum im Format: dd.MM.yyyy | ||
194 | |tfAntragstellerGeburtsname (PBA + OBA)|Geburtsname (ab Version {{version major="2" minor="15"}}{{/version}}) | ||
195 | |((( | ||
196 | PlaceOfBirth | ||
197 | tfAntragstellerGeburtsort (PBA + OBA) | ||
198 | )))|Geburtsort | ||
199 | |((( | ||
200 | TelephoneNumber | ||
201 | tfAntragstellerTelefon (PBA + OBA) | ||
202 | )))|Telefonnummer | ||
203 | |tfAntragstellerAusstellenderStaat (PBA + OBA)|Ausstellender Staat (ab Version {{version major="2" minor="15"}}{{/version}}) | ||
204 | |tfAntragstellerStaatsangehoerigkeit (PBA + OBA)|Staatsangehörigkeit (ab Version {{version major="2" minor="15"}}{{/version}}) | ||
205 | |tfAntragstellerDeMail (PBA + OBA)|De-Mail-Adresse (ab Version {{version major="2" minor="15"}}{{/version}}) | ||
206 | |tfAntragstellerEIDASAusstellerLand (PBA)|eIDAS Ausgabeland (ab Version {{version major="2" minor="15"}}{{/version}}) | ||
207 | |tfOrgVertreterVorname (OBA)|Vorname der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte. | ||
208 | |tfOrgVertreterName (OBA)|Nachname der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte. | ||
209 | |tfOrgVertreterTitel (OBA)|Akademischer Titel der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte. | ||
210 | |((( | ||
211 | tfOrgVertreterAnrede (OBA) | ||
212 | selOrgVertreterAnrede (OBA) | ||
213 | )))|((( | ||
214 | Anrede für die Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte. | ||
215 | Anrede, wird mit Hilfe des Geschlechter-Code aus Attribut „gender“ erzeugt. Mögliche Werte: //Herr//, //Frau, Nicht bekannt// | ||
216 | ))) | ||
217 | |tfOrgVertreterGeburtsdatum (OBA)|Akademischer Titel der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte. | ||
218 | |tfOrgVertreterGeburtsort (OBA)|Geburtsort der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte. | ||
219 | |tfOrgEmail (OBA)|E-Mail Adresse der angemeldeten Person, welche diese im Unternehmen hat. (Kann von der E-Mail Adresse am personenbezogenen Account abweichen.) | ||
220 | |tfOrgVertreterTelefon (OBA)|Telefonnummer der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte. | ||
221 | |tfOrgStrasse (OBA)|Strasse | ||
222 | |tfOrgHausnummer (OBA)|Hausnummer | ||
223 | |tfOrgHausnummerZusatz (OBA)|Hausnummern Zusatz | ||
224 | |tfOrgAdressZusatz (OBA)|Adress-Zusatz | ||
225 | |tfOrgPLZ (OBA)|PLZ | ||
226 | |tfOrgOrt (OBA)|Ort | ||
227 | |tfOrgName (OBA)|Name der Organisation (mit Rechtsform) | ||
228 | |tfOrgID (OBA)|Organisations-ID | ||
229 | |Rechtsform (OBA)|Rechtsform der Organisation | ||
230 | |tfOrgRegisterOrt (OBA)|Register(gerichts)-Ort | ||
231 | |tfOrgRegisterNummer (OBA)|Registernummer | ||
232 | |tfOrgUUID (OBA)|Unternehmenskonto-Handle (ab Version {{version major="2" minor="15"}}{{/version}}) | ||
233 | |TrustLevel|((( | ||
234 | Vertrauensniveau, gibt Auskunft über gewählte Authentifizierungsmethode: | ||
235 | * **STORK-QAA-Level-1**: Authentifizierung mittels Benutzername / Passwort | ||
236 | * **STORK-QAA-Level-3:** Authentifizierung mittels Authega Zertifikat | ||
237 | * **STORK-QAA-Level-4**: Authentifizierung mittels nPA | ||
238 | ))) | ||
239 | |IdentitaetsPruefer|Quelle der Identitätsprüfung (ab Version {{version major="2" minor="15"}}{{/version}}) (Mögliche Werte sind: _eIDAS_, _eID_, _Authega_, _Elster_, _Benutzername_ oder _FINK_) | ||
240 | |NPA_Address (PBA)|Adresse, wie sie auf dem NPA vermerkt ist (alles in Großbuchstaben) | ||
241 | |NPA_City (PBA)|Ort, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben) | ||
242 | |NPA_FirstName|Vorname, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben) | ||
243 | |NPA_LastName|Nachname, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben) | ||
244 | |NPA_PersonalTitle|Akademischer Titel, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben) | ||
245 | |IsIndividualPerson|Liefert den Wert **true**, wenn es sich bei den Daten aus dem Bürgerkonto um personenbezogene Daten handelt, sonst **false**. | ||
246 | |IsOrganization|Liefert den Wert **true**, wenn es sich bei den Daten aus dem Bürgerkonto um organisationsbezogene Daten handelt, sonst **false**. | ||
247 | {{/table}} | ||
248 | |||
249 | {{info}} | ||
250 | **Hinweis:** | ||
251 | Wenn am Formular-Element //AKDB Bürgerkonto// ein Bürgerdaten Parameter-Suffix vergeben wurde, so muss dieses an die jeweiligen Formular-Elementnamen angefügt werden, damit eine Vorbelegung erfolgreich durchgeführt werden kann. | ||
252 | \\__Beispiel:__ | ||
253 | Wenn als Suffix "**_Person2**" definiert wurde, so ergibt sich beim Vornamen der Formular-Elementname "tfAntragstellerVorname**_Person2**". | ||
254 | {{/info}} | ||
255 | |||
256 | === Darstellung des genutzten Authentifizierungsverfahren === | ||
257 | |||
258 | {{figure image="hilfe_trustlevel_visualisierung.png"}} | ||
259 | Darstellung des verwendeten Vertrauensniveaus an der Bürgerkonto Daten Vorlage | ||
260 | {{/figure}} | ||
261 | |||
262 | Bei Nutzung der **Bürgerkonto Daten Vorlagen** ist nach dem Absenden des Formulars, bei Wiederanzeige des Formular im Postfach, das durch den Nutzer verwendete Authentifizierungsverfahren anhand einer visuellen Markierung ersichtlich. | ||
263 | |||
264 | Für die einzelnen Vertrauensniveaus existieren folgende Beschriftungen: | ||
265 | |||
266 | * Level 1 (Authentifizierung mittels Benutzername / Passwort): **Standard** | ||
267 | * Level 3 (Authentifizierung mittels Authega Zertifikat): **Authega** | ||
268 | * Level 4 (Authentifizierung mittels nPA): **Personalausweis** | ||
269 | |||
270 | {{figure image="hilfe_trustlevel_keine_visualisierung.png"}} | ||
271 | Wenn keine visuelle Markierung gewünscht ist, so kann dies durch ein zusätzliches Attribut „noRibbon“ am Vorlagen-Fieldset unterbunden werden | ||
272 | {{/figure}} | ||
273 | |||
274 | == AKDB Postkorbanbindung in der Statusverarbeitung == | ||
275 | |||
276 | |||
277 | Für die Anbindung zum Versand von Postkorbnachrichten wird das Aktions-Plugin **AKDB:Postkorbnachricht senden** zur Verfügung gestellt. | ||
278 | Mittels dieser Plugin-Aktion, können ähnlich einer E-Mail Aktion, Nachrichten an den Postkorb der AKDB weitergeleitet werden. | ||
279 | |||
280 | Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt die nachfolgend kurz beschrieben werden. | ||
281 | |||
282 | {{panel title="Einstellungen für Absender und Empfänger" fullwidth="true" initial="visible" triggerable="true"}} | ||
283 | |||
284 | |||
285 | {{figure image="postkorb_absender.png"}} | ||
286 | Einstellungen für Absender und Empfänger | ||
287 | {{/figure}} | ||
288 | |||
289 | ; Dienst (Pflicht) | ||
290 | : Wird als Information in der Postkorb-Ansicht im Bürgerservice-Portal verwendet. | ||
291 | ; Mandant (Pflicht) | ||
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ürgerservice-Portal registriert ist, kann über den //Absender-Link// ein Link mitgegeben werden, mit dem der Mandant bei der Anzeige im AKDB Postkorb verlinkt wird. | ||
295 | ; Postkorb ID aus den Vorgangsdaten ermitteln? | ||
296 | : Diese Angabe dient zur Bestimmung der Postkorb-ID. Über die Postkorb-ID wird das genaue Ziel für den Nachrichtenversand bestimmt, also der Nachrichten-Empfänger. | ||
297 | Bei einem AKDB Bürgerkonto-Login wird die Postkorb-ID immer mit übermittelt und standardmäßig am Formulareingang hinterlegt. | ||
298 | Für den Fall, dass es mehrere konfigurierte Anmeldungen innerhalb eines Formulars gibt, kann hier die Auswahl über den [[Bürgerdaten Parameter-Suffix>>doc:||anchor="BK_Parameter_Suffix"]] eingegrenzt werden. | ||
299 | Darüber hinaus ist es möglich die Postkorb-ID fest oder über einen Platzhalter (**[%$POSTKORB_ID%]**) zu definieren. (Der Platzhalter wird über das Plugin zur Verfügung gestellt und kann in der Statusverarbeitung verwendet werden.) | ||
300 | |||
301 | |||
302 | {{/panel}} | ||
303 | |||
304 | {{panel title="Konfiguration des Nachrichteninhalts" fullwidth="true" initial="visible" triggerable="true"}} | ||
305 | |||
306 | |||
307 | {{figure image="postkorb_nachricht.png"}} | ||
308 | Konfiguration von Betreff, Nachrichteninhalt und Anhängen | ||
309 | {{/figure}} | ||
310 | |||
311 | |||
312 | ; Betreff (Pflicht) | ||
313 | : Nahrichtenbetreff, es werden Platzhalter unterstützt. | ||
314 | ; Inhalt (Pflicht) | ||
315 | : Nachrichtentext, es werden Platzhalter unterstützt. | ||
316 | ; Anhänge | ||
317 | : Hier können Dateien als Attachments an die Postkorb-Nachricht gehangen werden. | ||
318 | : Zur Auswahl stehen dabei: | ||
319 | :; Upload | ||
320 | :: bezieht sich auf alle Dateianhänge, die über das Formular hochgeladen wurden | ||
321 | :; Workflow | ||
322 | :: bezieht sich auf alle Dateianhänge, die über den aktuellen FORMCYCLE Workflow hochgeladen wurden. | ||
323 | :; Posteingang | ||
324 | :: bezieht sich auf alle Dateianhänge, die über das Postfach hochgeladen wurden. | ||
325 | :: Unterstützte Dateiformate sind: PDF, HTML, Plaintext, MS Word, JPEG, GIF, PNG | ||
326 | |||
327 | |||
328 | {{info}} | ||
329 | **Achtung:** | ||
330 | Die Schnittstelle zum Postkorb der AKDB unterstützt dabei maximal 5 Anhänge pro Nachricht mit je 2 MB Maximalgröße. | ||
331 | {{/info}} | ||
332 | |||
333 | {{/panel}} | ||
334 | |||
335 | === Bedingte Ausführung der //AKDB:Postkorbnachricht senden//-Aktion === | ||
336 | |||
337 | {{figure image="postkorb_nachricht_bedingung.png"}} | ||
338 | Konfiguration einer Bedingung für Ausführung der Aktion //AKDB~:Postkorbnachricht senden// | ||
339 | {{/figure}} | ||
340 | |||
341 | Um eine Nachricht an den Postkorb-Schnittstelle der AKDB zu übermitteln ist eine so genannte "//Postkorb-ID//" notwendig. Ähnlich einer E-Mail-Adresse stellt sie ein Merkmal dar, womit das Postfach eines Nutzers eindeutig im System der AKDB identifiziert werden kann. Die Ermittlung der //Postkorb-ID// eines Benutzers erfolgt dabei automatisch beim Login am Bürgerservice-Portal der AKDB, wodurch dieser Identifikator dann im weiteren Formularprozess zur Verfügung steht. | ||
342 | Dies bedeutet aber auch, dass wenn in einem Formularprozess kein zwingender Bürgerkonto-Login erfolgt, die Postkorb-ID **nicht** in der Statusverarbeitung vorhanden ist. | ||
343 | Damit die Statusverarbeitung bei Verwendung der Aktion **AKDB:Postkorbnachricht senden** nicht in einem Fehler resultiert, ist deshalb die Konfiguration einer entsprechenden Ausführungs-Bedingung sinnvoll. | ||
344 | |||
345 | Das nachfolgende Quellcode-Beispiel zeigt das Abprüfen der Postkorb-ID auf das Vorhandensein eines Wertes, durch einen regulären Ausdruck. Die aktuelle Postkorb-ID wird dabei mittels eines System-Platzhalters im Prüfausdruck zur Verfügung gestellt. | ||
346 | |||
347 | {{code language="javascript"}} | ||
348 | REGEX([%$POSTKORB_ID%]=^.+$) | ||
349 | {{/code}} | ||
350 | |||
351 | ==== Erweitere Bedingungsprüfung bei Verwendung unterschiedlicher Login-Arten (personenbezogenes bzw. organisationsbezogenes Login) ==== | ||
352 | |||
353 | |||
354 | Wenn in einem Formular beide Login-Arten (//personenbezogenes// und //organisationsbezogenes// Login) zugelassen sind und man unterschiedliche Nachrichten an den Postkorb senden möchte, so ist dies ebenfalls möglich. | ||
355 | Im Formular müssen dann versteckte Eingabefelder mit den Element-Namen **IsIndividualPerson** und **IsOrganization** vorhanden sein. | ||
356 | (Dies ist automatisch der Fall, wenn die entsprechenden Vorlagen //Bürgerkonto personenbezogene Daten// und //Bürgerkonto organisationsbezogene Daten// verwendet werden). | ||
357 | |||
358 | Die Konfiguration einer Ausführungs-Bedingung an einer Aktion //AKDB:Postkorbnachricht senden// für eine **personenbezogene** Anmeldung wäre dann folgendermaßen: | ||
359 | |||
360 | |||
361 | {{code language="javascript"}} | ||
362 | REGEX([%IsIndividualPerson%]=true) REGEX([%$POSTKORB_ID%]=^.+$) | ||
363 | {{/code}} | ||
364 | |||
365 | |||
366 | Bei Nutzung einer **organisationsbezogenen** Anmeldung ist folgende Bedingung zu konfigurieren: | ||
367 | |||
368 | |||
369 | {{code language="javascript"}} | ||
370 | REGEX([%IsOrganization%]=true) REGEX([%$POSTKORB_ID%]=^.+$) | ||
371 | {{/code}} | ||
372 | |||
373 | {{info}} | ||
374 | Bitte beachten Sie, dass Bedingungen vom Typ "Mehrere Bedinungen" werden immer UND-Verknüpft sind. Somit müssen alle REGEX-Bedingungen erfüllt sein, damit die Aktion ausgeführt wird. | ||
375 | {{/info}} | ||
376 | |||
377 | |||
378 | == Versionshistorie == | ||
379 | |||
380 | === 2.15.0 === | ||
381 | |||
382 | * Änderung Postkorb-Webservice Anbindung: Die Anbindung erfolgt jetzt über die native Schnittstelle und nicht mehr über OK.KOMM. Dadurch erhöht sich die Anzahl der möglichen Anhänge auf 20 mit je 50MB Größe. | ||
383 | * Das Bürgerservice-Portal wurde auf Version 2.0 angehoben. Dadurch ergaben sich folgende Anpassungen, die in dieser Plugin-Version eingearbeitet wurden: | ||
384 | ** Es werden zusätzliche Daten vom Bürgerservice-Portal übermittelt. Die genaue Beschreibung dieser kann der obigen Parameter-Tabelle entnommen werden. | ||
385 | ** Anpassung des Verhaltens bei Abbruch der Authentifizierung durch den Nutzer auf Seiten des Bürgerservice-Portals | ||
386 | ** Aktualisierung der Metadaten des Identity Providers, sowie des Postkorb-Webservice-Endpoints. Jeweils für die Anbindung des Test-Systems. | ||
387 | Die Aktualisierung dieser Eigenschaften bei bestehenden Plugin-Installationen erfolgt automatisch bei Installation dieser Plugin-Version | ||
388 | * Änderung im AKDB-Setup: Überarbeitung der Einrichtungsschritte | ||
389 | |||
390 | === 2.14.2 === | ||
391 | |||
392 | * Fehlerbehebung im Plugin zum Erzeugen der Mandant-spezifischen Ressourcen, welches beim Registrieren des Plugins ausgeführt wird. | ||
393 | |||
394 | === 2.14.1 === | ||
395 | |||
396 | * Erweiterung des Setups zur initiale Einrichtung der AKDB Services: Möglichkeit zum Upload und Freigeben des SSL-Zertifikats für die Postkorb-Kommunikation. | ||
397 | |||
398 | === 2.13.3 === | ||
399 | |||
400 | * Fehlerbehebung bei der Postkorb-Webservice Anbindung: Bei der Kommunikation über einen Proxy-Server, wurde die am Plugin-Bundle hinterlegten Einstellungen nicht verwendet. Dies wurde behoben. | ||
401 | |||
402 | === 2.13.2 === | ||
403 | |||
404 | * Fehlerbehebung: Der Postkorb-Webservice konnte teilweise nicht initialisiert werden, da die zugehörige WSDL-Datei nicht korrekt adressiert wurde. | ||
405 | In einigen Umgebungen kam es zu "Permission denied" Fehlern beim Versuch das Zertifikat für die Https-Webservice-Kommunikation zu laden. Diese Fehler wurden behoben. | ||
406 | * Das JavaScript zur Nutzung der Template-Vorlage für //personen- und organisationsbezogene Daten// wurde erweitert, sodass die Auswahl der Anmeldeart sowohl als Checkbox, als auch als DropDown-Liste konfiguriert werden kann. | ||
407 | |||
408 | === 2.13.1 === | ||
409 | |||
410 | * Fehlerbehebung: Wenn Formular mittels Ajax und Modus 'xfc-rp-inline=true' eingebunden wurde, kam es zu JavaScript-Fehlern und die Anmeldung konnte nicht ausgeführt werden. Dies wurde behoben. | ||
411 | |||
412 | === 2.13.0 === | ||
413 | |||
414 | * **Achtung:** alle neueren Versionen des Plugins benötigen ab dieser Version mindestens {{formcycle/}} Version {{version major="6" minor="6"}}{{/version}} oder höher | ||
415 | * Änderung des eingesetzten Webservice-Frameworks beim Postkorb-Service, um Lauffähigkeit ab OpenJDK Version 14 zu gewährleisten | ||
416 | * Fehlerbehebung: Fehlende Beschriftungen an den Eigenschaften für das Formular-Element //AKDB Bürgerkonto //wurde behoben | ||
417 | |||
418 | === 2.12.0 === | ||
419 | |||
420 | * Feature-Umsetzung: AKDB-Setup kann nur vom SAdmin oder explizit freigegebenen Mandant-Admins ausgeführt werden. Die Steuerung erfolgt über Recht 'AKDB Setup ausführen' an Mandant-Admin-Rolle (Standard-Einstellung: Recht ist deaktiviert) | ||
421 | * Anpassung Wizard für die Metadaten-Generierung: Wizard-Beschreibung im letzten Schritt erweitert; Generierte Dateien für Antrag und ISP-Metadaten, wurden mit einem umgebungsspezifischen Dateinamen-Suffix ausgestattet. | ||
422 | * AKDB-Formular Vorlage angepasst (Statusverarbeitung): Veraltete Elementplatzhalter in Postkorb-Nachricht für Organisation wurden ersetzt | ||
423 | |||
424 | === 2.11.2 === | ||
425 | |||
426 | * Fehlerbehebung: Bei anonymer Wiederanzeige von BK-Daten werden Nachname, Titel und Anrede nicht mehr fälschlicherweise auf Default-Werte zurückgesetzt und damit geleert. | ||
427 | |||
428 | === 2.11.1 === | ||
429 | |||
430 | * Fehlerbehebung: Bei mehreren Plugin-Registrierungen in verschiedenen Mandanten konnte nur im zuletzt Registrierten der Wizard, zum Erzeugen der SAML-Metadaten, aufgerufen werden. Dies wurde behoben. | ||
431 | |||
432 | === 2.11.0 === | ||
433 | |||
434 | * Feature-Umsetzung im BK-Authenticator: Am Authenticator ist jetzt die Auswahl von Authentifizierungsverfahren, die mindestens dem Vertrauens-Level von Authega entsprechen, möglich | ||
435 | * Fehlerbehebung: Ein falsches Leeren des Feldes tfAntragstellerName beim PDF-Druck wurde behoben | ||
436 | |||
437 | === 2.10.0 === | ||
438 | |||
439 | * **Achtung:** alle neueren Versionen des Plugins benötigen ab dieser Version mindestens {{formcycle/}} Version {{version major="6" minor="5"}}{{/version}} oder höher | ||
440 | * Anpassung Wizard für die Metadaten-Generierung: im letzten Schritt kann eine vorbefüllte Beitrittserklärung heruntergeladen werden | ||
441 | * Internes Refactoring | ||
442 | ** Deprecated Klasse //ConfigSAML// wurde entfernt | ||
443 | ** Deprecated Klasse //GenerateIdentityServiceProviderMetadataPlugin //entfernt | ||
444 | * Anpassung am Widget für den Bürgerkonto-Login-Button: Dieser wird jetzt beim PDF-Druck über den Designer standardmäßig ausgeblendet | ||
445 | * Anpassung an der AKDB-Formular Vorlage: Diese verwendet jetzt die Template-Vorlage für //personen- und organisationsbezogene Daten// | ||
446 | |||
447 | === 2.9.2 === | ||
448 | |||
449 | * Erweiterung Template-Vorlage für //personen- und organisationsbezogene Daten//: | ||
450 | ** Auswahlmöglichkeit für ein Eingabe von personen- **oder** organisationsbezogene Daten | ||
451 | ** Eine Anzeige der Auswahlmöglichkeit erfolgt bei folgenden Fällen: | ||
452 | *** es hat KEINE Authentifizierung über das Bürgerkonto stattgefunden | ||
453 | *** es existiert ein "vorgeschaltener" Zugriffschutz (Externe Benutzer) | ||
454 | |||
455 | === 2.9.1 === | ||
456 | |||
457 | * Fehlerbehebung in Anzeige bei Nutzung der Template-Vorlage für //personen- und organisationsbezogene Daten//: | ||
458 | ** die fehlende Anzeige des Authentifizierungsverfahren am Field-Set für die persönlichen Daten wurde beseitigt | ||
459 | ** Nach erfolgter Anmeldung werden die Eingabe-Felder für die persönlichen Daten mit einem Schreibschutz belegt | ||
460 | |||
461 | === 2.9.0 === | ||
462 | |||
463 | * Neue Template-Vorlage für //personen- und organisationsbezogene Daten//: Unterteilt in 2 Fieldsets, wobei //persönliche Daten// bei beiden Anmeldungstypen angezeigt werden und //organisationsbezogene Daten// nur im Fall einer Organisations-Anmeldung. Die Vorlage wird standardmäßig ausgeblendet, wenn keine Anmeldedaten vorliegen. | ||
464 | * Vereinheitlichung der Datenbezeichnungen bei den persönlichen Daten für den Vertreter innerhalb einer Organisations-Anmeldung: die personenbezogenen Daten für den Vertreter werden unter den gleichen Parameter-Namen, wie bei einer reinen personenbezogenen Anmeldung zur Verfügung gestellt. Im Zuge der Abwärtskompatibilität bleiben alte Parameternamen (Präfix **tfOrg**) weiterhin erhalten. | ||
465 | * Vereinheitlichung der Vorlage für Organisationsdaten: Für die personenbezogenen Daten des Organisations-Vertreters werden die geänderten Parameternamen verwendet. | ||
466 | * Anpassung PreRender-Logik bei Nutzung von Authenticatoren: Bei "Ohne Login" werden von Nachname und Titel die Default-Werte gelöscht, damit diese Felder bei Anzeige in der Vorlage leer sind. | ||
467 | * Fehlerbehebung bei Verwendung des BK-Authenticators über Frontend-Server: Initialisierung notwendiger OpenSAML-Klassen bei Aufruf über Frontend-Server hinzugefügt. | ||
468 | |||
469 | === 2.8.2 === | ||
470 | |||
471 | * Ändern BK-Vorlage für //persönliche Daten//: Platzhalter für Authenticator-User-Objekt-Werte gesetzt, soweit wie möglich, um Nutzung für andere Authenticatoren (Google, NTLM, Facebook) prinzipiell zu ermöglichen | ||
472 | * Anpassung PreRender-Logik: Bei Vorhandensein eines User-Profils aus einem Authenticator wird Steuervariable 'IsIndividualPerson' auf "true" gesetzt, damit BK-Vorlage automatisch eingeblendet und genutzt werden kann. | ||
473 | |||
474 | === 2.8.1 === | ||
475 | |||
476 | * Fehlerbehebung bei Verwendung des BK-Logins über Frontend-Server: Factory-Klasse (org.opensaml.core.xml.XMLObjectBuilderFactory) durch pac4j-Implementierung ersetzt, um Fehler bei Kommunikation über den Frontend-Server zu beheben | ||
477 | |||
478 | === 2.8.0 === | ||
479 | |||
480 | * Bereitstellung eines Plugin-Authenticator für AKDB-Login als "Externer Benutzer" | ||
481 | * Hinweis: Log für Authega funktioniert nicht bei Einsatz von Plugin-Authenticator | ||
482 | |||
483 | === 2.7.0 === | ||
484 | |||
485 | * Umstellung intern genutztes SAML-Framework. Dieses wird nicht mehr durch das Plugin selbst, sondern vom {{formcycle/}}-Core zur Verfügung gestellt. | ||
486 | * **Achtung:** alle neueren Versionen des Plugins benötigen mindestens {{formcycle/}} Version {{version major="6" minor="4" patch="0"/}} oder höher | ||
487 | |||
488 | === 2.6.2 === | ||
489 | |||
490 | * Umbenennung Menüpunkt für Metadaten-Generierung für Registrierung bei AKDB, neuer Name: "AKDB Setup" | ||
491 | |||
492 | === 2.6.1 === | ||
493 | |||
494 | * Fehlerbehebung bei Verwendung des BK-Logins über Frontend-Server | ||
495 | |||
496 | === 2.6.0 === | ||
497 | |||
498 | * Einbindung {{formcycle/}} Version 6.2.0 | ||
499 | * Unterstützung Blanko-Druck: | ||
500 | ** Login-Button wird ausgeschlossen | ||
501 | ** Steuerfelder und Trustlevel in den Vorlagen werden standardmäßig vom Druck ausgeschlossen | ||
502 | * Login-Button um Auswahlmöglichkeit für Seitenvalidierung vor Beginn BK-Login erweitert. |