Änderungen von Dokument AKDB: Bürgerkonto-Service-Plugin


Von Version 7.13
bearbeitet von rth
am 08.02.2022, 14:16
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 11.13
bearbeitet von rth
am 10.03.2022, 16:26
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -1,5 +1,10 @@
1 1  [[**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)
2 2  
3 +{{info}}
4 +**Hinweis zur Inbetriebnahme des Plugins:**
5 +Im Download-Ordner der jeweilige Plugin-Version befindet sich eine Anleitung zur initialen Inbetriebnahme, sowie zu weiter reichenden Information die den allgemeinen Betrieb dieses Plugins betreffen.
6 +{{/info}}
7 +
3 3  {{content/}}
4 4  
5 5  {{info}}
... ... @@ -20,9 +20,13 @@
20 20  == Einbindung des Bürgerkonto Logins im Designer ==
21 21  
22 22  {{figure image="hilfe_bk_button.png"}}
23 -Formular-Element //AKDB Bürgerkonto//
28 +Einstellungen am Formular-Element //AKDB Bürgerkonto// bis Version {{version major="3" minor="6"}}{{/version}}
24 24  {{/figure}}
25 25  
31 +{{figure image="hilfe_bk_button_v3_6.png"}}
32 +Einstellungen am Formular-Element //AKDB Bürgerkonto// ab Version {{version major="3" minor="6"}}{{/version}}
33 +{{/figure}}
34 +
26 26  {{id name="BK_LoginButton"/}}
27 27  
28 28  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:
... ... @@ -53,15 +53,33 @@
53 53  : Als Suffix sind Buchstaben, Zahlen und der Unterstrich erlaubt.
54 54  : __Beispiel:__
55 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 -; gefordertes Authentifizierungsverfahren
65 +; --gefordertes Authentifizierungsverfahren-- (Die hier beschriebenen Eigenschaften werden bis zur Version {{version major="3" minor="6"}}{{/version}} unterstützt. Bestehende Konfigurationen werden automatisch in die neue Auswahl //Einschränkung der Authentisierungsverfahren// übernommen.)
57 57  : Hier kann das dem Nutzer zur Verfügung stehende Authentifizierungsverfahren eingeschränkt werden.
58 58  : Es gibt folgende Auswahlmöglichkeiten:
68 +:; keine Einschränkung
69 +:: Login mittels Passwort, Authega-Zertifikat oder Personalausweis steht zur Auswahl
70 +:; Authega
71 +:: Nur die Authentifizierung mittels Authega-Zertifikat steht zur Auswahl
72 +:; Authega oder Personalausweis
73 +:: Login mittels Authega-Zertifikat oder Personalausweis steht zur Auswahl
74 +:; Personalausweis
75 +:: nur Authentifizierung mittels Personalausweis steht zur Auswahl
76 +; Einschränkung der Authentisierungsverfahren (Eigenschaft steht ab Version {{version major="3" minor="6"}}{{/version}} zur Verfügung)
77 +: Über diese Checkbox-Auswahl kann das dem Nutzer zur Verfügung stehende Authentifizierungsverfahren eingeschränkt werden.
78 +: Ist nichts ausgewählt, erfolgt keine Einschränkung.
79 +:; Benutzername
80 +:: Authentifizierung erfolgt über Login / Passwort
81 +:; Authega-Zertifikat
82 +:; Elster-Zertifikat
83 +:; FINK
84 +:: Authentifizierung erfolgt über ein Identifikationsmittel aus dem Portfolio des //Föderierten Identitätsmanagements Interoperable Nutzerkonten//
85 +:; eID (Personalausweis)
86 +:; eIDAS
87 +:: Authentifizierung mittels Identifikationsmittels nach eIDAS-Verordnung (//electronic IDentification, Authentication and Trust Services//)
88 +; Postkorbversand obligatorisch
89 +: Diese Einstellung ermöglich es die Postkorb-ID als verpflichtendes Rückgabe-Attribut zu kennzeichnen.
90 +: Auf Seiten der AKDB werden dann alle Authentifizierungsarten, die keinen Postkorbversand ermöglichen, für den Nutzer ausgeblendet.
59 59  
60 -* **keine Einschränkung**: Login mittels Passwort, Authega-Zertifikat oder Personalausweis steht zur Auswahl
61 -* **Authega**: Nur die Authentifizierung mittels Authega-Zertifikat steht zur Auswahl
62 -* **Authega oder Personalausweis**: Login mittels Authega-Zertifikat oder Personalausweis steht zur Auswahl **(Achtung: Diese Auswahl wird momentan nicht mehr vom AKDB Portal unterstützt!)**
63 -* **Personalausweis**: nur Authentifizierung mittels Personalausweis steht zur Auswahl
64 -
65 65  == Einbindung des Bürgerkonto Logins als Externer Benutzer ==
66 66  
67 67  {{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.
... ... @@ -93,25 +93,39 @@
93 93  Im letzten Schritt besteht die Möglichkeit die Konfiguration individuell anzupassen.
94 94  Dazu können folgende Einstellungen getroffen werden:
95 95  
123 +
124 +
96 96  ; LoginTyp
97 97  : Mit dieser Einstellung lassen sich die Arten der zurück gelieferten Daten festlegen.
98 98  : Ist als Wert **Person** definiert, so können nur personenbezogene Daten zurückgeliefert werden.
99 99  : 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.
100 100  : Ist dieser Parameter nicht konfiguriert, so kann der Nutzer selbst bestimmen, welche Datenart (personen- oder organisationsbezogen) er zurück liefern möchte. 
101 -; AuthTyp (wird ab Version nicht mehr unterstützt)
130 +; --AuthTyp-- (wird ab Version {{version major="3" minor="6"}}{{/version}}nicht mehr unterstützt)
102 102  : Über diese Einstellung kann das geforderte Authentisierungsverfahren festgelegt werden.
103 103  : Entweder mit Authega-Zertifikat (Wert: **Authega**) oder Personalausweis (Wert: **NPA**).
104 104  : Ist nichts gesetzt oder das Attribut nicht vorhanden, so werden dem Nutzer alle möglichen Authentisierungsverfahren zur Auswahl angeboten.
105 -; LoginMethod (ersetzt die Eigenschaft AuthTyp ab Version )
134 +; LoginMethod (ersetzt die Eigenschaft AuthTyp ab Version {{version major="3" minor="6"}}{{/version}})
106 106  : Über diese Einstellung kann das geforderte Authentisierungsverfahren eingeschränkt werden.
107 -: Es können dabei ein oder mehrere Werte der folgenden Auflistung angegeben werden:
108 -: * Benutzername
109 -: * Authega
110 -: * Elster
111 -: * FINK
112 -: * eID
113 -: * eIDAS
114 -:
136 +: Es können dabei ein oder mehrere Werte (mit Komma getrennt) der folgenden Auflistung angegeben werden:
137 +:; Benutzername
138 +:; Authega
139 +:; Elster
140 +:; FINK
141 +:; eID
142 +:; eIDAS
143 +: Ist kein Wert gesetzt, erfolgt keine Einschränkung der Authentisierungsverfahren und dem Nutzer
144 +: werden alle vom Identity-Provider zur Verfügung gestellten Anmeldeverfahren zur Auswahl angezeigt.
145 +; PflichtElemente (ab Version {{version major="3" minor="6"}}{{/version}})
146 +: Über diese Eigenschaft können Attribute als verpflichtende Nutzereigenschaften angefordert werden.
147 +: Alle Authentisierungsverfahren, welche die geforderten Attribute nicht erfüllen, werden dadurch ausgeblendet.
148 +: Sofern der Formular-Workflow beispielsweise die Kommunikation mit dem Postkorb zwingend erfordert,
149 +: kann hier der Wert **Postkorb** angegeben werden, wodurch das Ausblenden der temporären Anmeldung erreicht wird.
150 +: Als Werte können können folgende Begriffe angegeben werden (Bei mehreren Werten sind diese durch Komma zu trennen):
151 +:; PIN
152 +:: In diesem Fall wird die sektor-spezifische Personen-Identifikations-Nummer (ssPIN) angefordert
153 +:; Postkorb
154 +:: In diesem Fall wird die Postkorb-Id als verpflichtender Wert angefordert, sodass im Workflow
155 +:: die Voraussetzungen für den Versand einer Nachricht an den Postkorb des Nutzers gegeben sind.
115 115  
116 116  === Bürgerkonto Login als Formularanmeldung einrichten ===
117 117  
... ... @@ -305,15 +305,24 @@
305 305  
306 306  
307 307  {{figure image="postkorb_absender.png"}}
308 -Einstellungen für Absender und Empfänger
349 +Einstellungen für Absender und Empfänger in V6 Formularen
309 309  {{/figure}}
310 310  
311 -; Dienst (Pflicht)
312 -: Wird als Information in der Postkorb-Ansicht im Bürgerservice-Portal verwendet.
313 -; Mandant (Pflicht)
314 -: Wird als Information in der Postkorb-Ansicht im Bürgerservice-Portal verwendet.
352 +{{figure image="postkorb_absender_v3_6_fc_V7.png"}}
353 +Einstellungen für Absender und Empfänger in V7 Formularen
354 +{{/figure}}
355 +
356 +; Mandant (ab Version {{version major="3" minor="6"}}{{/version}} kein Pflichtfeld)
357 +: Wird als Information in der Postkorb-Ansicht im Bürgerservice-Portal verwendet. Ist an dieser Stelle kein Wert konfiguriert, wird die globale Einstellungen aus den Eigenschaften des Plugins verwendet.
358 +; Dienst (ab Version {{version major="3" minor="6"}}{{/version}} kein Pflichtfeld)
359 +: Wird als Information in der Postkorb-Ansicht im Bürgerservice-Portal verwendet. Ist an dieser Stelle kein Wert konfiguriert, wird die globale Einstellungen aus den Eigenschaften des Plugins verwendet.
315 315  ; Absender-Link
316 316  : 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.
362 +; Vertrauensniveau der Anmeldung für Zugriff auf Postkorb-Nachricht weiterreichen? (verfügbar ab Version {{version major="3" minor="6"}}{{/version}} im V7 Formular Workflow)
363 +: Über diese Option können Sie festlegen, ob das Vertrauensniveau der Anmeldung (wenn dies ermittelt werden kann)
364 +: für den Zugriff auf die Postkorb-Nachricht weitergereicht werden soll.
365 +: Wenn kein Vertrauensniveau aus den Anmeldedaten ermittelt werden kann, wird das niedrigste Vertrauensniveau gesetzt,
366 +: um einen Zugriff auf die Nachricht im Postfach der AKDB zu ermöglichen.
317 317  ; Postkorb ID aus den Vorgangsdaten ermitteln?
318 318  : 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.
319 319  Wird bei einem AKDB Bürgerkonto-Login die Postkorb-ID mit übermittelt, so wird diese standardmäßig am Formulareingang hinterlegt.
... ... @@ -327,9 +327,12 @@
327 327  
328 328  
329 329  {{figure image="postkorb_nachricht.png"}}
330 -Konfiguration von Betreff, Nachrichteninhalt und Anhängen
380 +Konfiguration von Betreff, Nachrichteninhalt und Anhängen in V6 Formularen
331 331  {{/figure}}
332 332  
383 +{{figure image="postkorb_nachricht_v3_6_fc_V7.png"}}
384 +Konfiguration von Betreff, Nachrichteninhalt und Anhängen in V7 Formularen
385 +{{/figure}}
333 333  
334 334  ; Betreff (Pflicht)
335 335  : Nahrichtenbetreff, es werden Platzhalter unterstützt.
... ... @@ -337,7 +337,9 @@
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.
393 +: Unterstützte Dateiformate sind: PDF, HTML, Plaintext, MS Word, JPEG, GIF, PNG, ZIP
340 340  : Zur Auswahl stehen dabei:
395 +: (Auswahlmöglichkeiten in V6-Formularen)
341 341  :; Upload
342 342  :: bezieht sich auf alle Dateianhänge, die über das Formular hochgeladen wurden
343 343  :; Workflow
... ... @@ -344,9 +344,18 @@
344 344  :: bezieht sich auf alle Dateianhänge, die über den aktuellen FORMCYCLE Workflow hochgeladen wurden.
345 345  :; Posteingang
346 346  :: bezieht sich auf alle Dateianhänge, die über das Postfach hochgeladen wurden.
347 -:: Unterstützte Dateiformate sind: PDF, HTML, Plaintext, MS Word, JPEG, GIF, PNG
402 +: (Auswahlmöglichkeiten in V7-Formularen)
403 +:; Dateien aus vorherigen Aktionen
404 +:: Eine Liste mit Dateien, von Datei-bereitstellenden Aktionen, die der Postkorb-Aktion vorangestellt sind.
405 +:; Mandantdateien
406 +:: Liefert eine Auswahlliste über alle Datei-Ressourcen am Mandanten
407 +:; Formulardateien
408 +:: Liefert eine Auswahlliste über alle Datei-Ressourcen, welche am Formular-Projekt hinterlegt sind.
409 +:; Externe Ressourcen-URL
410 +:: Dateien die über externe Quellen (HTTP-Requests) ermittelt werden können.
411 +:; Vorgangsanhänge mittels Dateinamen suchen
412 +:: Eine Suche innerhalb von Dateinamen mittels übereinstimmenden Suchbegriffs. Es kann dabei mittels Filter eingegrenzt werden, innerhalb welcher Datei-Quellen die Suche ausgeführt wird (Dateien aus Uploads, Datei aus der Statusverarbeitung, Dateien aus dem Posteingang)
348 348  
349 -
350 350  {{info}}
351 351  **Achtung:**
352 352  Die Schnittstelle zum Postkorb der AKDB unterstützt dabei maximal 20 Anhänge pro Nachricht mit je 50 MByte Maximalgröße.
... ... @@ -400,14 +400,39 @@
400 400  
401 401  == Versionshistorie ==
402 402  
403 -=== 3.6.0 ===
467 +=== 3.6.0 - Bereitstellung erfolgt nach offiziellen Release der AKDB ===
404 404  
405 405  * Erweiterungen / Anpassungen aufgrund von Schnittstellenanpassungen im Bürgerservice-Portal der AKDB:
406 406  ** Möglichkeit zur Anforderung von Pflicht-Attributen (Postkorb-ID)
407 407  ** Umstellung der Auswahlmöglichkeiten für das geforderte Authentifizierungsverfahren auf eine weiter reichende Auswahl (+Migration bestehender Konfigurationen am BK-Login-Button)
408 -* Anpassung AKDB-Setup: Hinweis auf freizugebende URL's (Firewall-Einstellungen) hinzugefügt
472 +* Anpassung Postkorb-Aktion: Im Bereich des Absenders sind //Dienst //und //Mandant //keine Pflichtfelder mehr. Wenn Sie nicht definiert werden, werden die globalen Einstellungen
473 +aus den Plugin-Properties herangezogen.
474 +* Erweiterung Postkorb-Aktion: Im Bereich des Empfängers kann jetzt konfiguriert werden, dass das Vertrauensniveau der Anmeldung für den Zugriff auf die Nachricht im AKDB-Postfach mitgegeben wird.
475 +* Anpassung AKDB-Vorlage: Anpassung der Verlage, da im Bereich des Absenders Dienst und Mandant keine Pflichtfelder mehr repräsentieren.
476 +* Anpassung AKDB-Setup: Hinweis auf freizugebende URL's (Firewall-Einstellungen) hinzugefügt, Konfigurationsmöglichkeit für Proxy-Server-Einstellungen
409 409  * Fehlerbehebung: Fehlerbehandlung im Plugin-Action-Servlet 'AKDBLogin' angepasst
410 410  
479 +(% class="wikigeneratedid" %)
480 +=== 3.5.12 ===
481 +
482 +* Erweiterung von Log-Ausgaben innerhalb der Postkorb-Kommunikation zum Zwecke der Fehleranalyse.
483 +
484 +=== 3.5.11 ===
485 +
486 +* Fehlerbehebung: Im Zusammenspiel mit der {{formcycle/}} Version {{version major="7" patch="10"}}{{/version}}konnten Zertifikatsdateien nicht über das AKDB Setup hochgeladen werden. Dieser Fehler wurde behoben.
487 +
488 +=== 3.5.10 ===
489 +
490 +* Fehlerbehebung: JavaScript für Datenvorlage wurde angepasst um eine zusätzliche Validierungsroutine für die Elemente innerhalb der Vorlage. Diese Validierung wird ausgeführt, wenn die Auswahl 'Privatperson / Organisation' geändert wurde. 
491 +
492 +=== 3.5.9 ===
493 +
494 +* Fehlerbehebung: JavaScript für Datenvorlage wurde angepasst, sodass sich ein Ändern der Steuerfelder 'IsOrganization' und 'IsIndividualPerson' auf alle Elemente innerhalb der Vorlage auswirken kann, wenn diese entsprechend Bedingungen ausweisen.
495 +
496 +=== 3.5.8 ===
497 +
498 +* Fehlerbehebung: JavaScript für Datenvorlage wurde angepasst, sodass bei Ausblenden von Organisationsdaten, diese geleert werden, wenn dies im Designer konfiguriert ist.
499 +
411 411  === 3.5.7 ===
412 412  
413 413  * Erweiterung Postkorb-Aktion: Als Anhang werden jetzt Zip-Dateien unterstützt. (Bitte beachten Sie, dass die Postkorb-Schnittstelle nur das Zip-Format und KEIN GZip-Format (Dateiendung ".gz") unterstützt)
... ... @@ -487,34 +487,4 @@
487 487  * Postkorb-Plugin für V7-Workflow
488 488  * Überarbeitung Formular-Vorlage für Nutzung des V7-Workflows
489 489  
490 -=== 2.18.3 ===
491 -
492 -* Anpassung JS für Anzeige-Steuerung der BK-Vorlagen: Steuerparameter 'TrustLevel', 'IsOrganization' und 'IsIndividualPerson' können jetzt auch außerhalb des Vorlagen-Containers verwendet werden
493 -* Fehlerbehebung: Es wurden Fehler bei der Wiederanzeige von zwischengespeicherten Daten bei Kommunikation über FS behoben.
494 -
495 -=== 2.18.2 ===
496 -
497 -* Anpassung Postkorb: Umstellung von ID auf UUID bei Dateianhängen
498 -
499 -=== 2.18.1 ===
500 -
501 -* Fehlerbehebung: Es wurde ein Fehler, beim Zwischenspeichern von Formulardaten vor der Weiterleitung zum BK-Portal, behoben.
502 -
503 -=== 2.18.0 ===
504 -
505 -* Erweiterung AKDB-Setup: Neuer Einrichtungsschritt für die Erhebung von Organisationsdaten für Verwaltungszwecke.
506 -
507 -=== 2.17.0 ===
508 -
509 -* Abschließende Anpassungen für Einführung Bürgerservice-Portal 2.0:
510 -** Aktualisierung der Metadaten des Identity Providers, sowie des Postkorb-Webservice-Endpoints für die Anbindung des neuen Live-Systems
511 -* Änderung im AKDB-Setup:
512 -** Anpassungen am Layout, da es bei niedrigen Auflösungen dazu kam, dass Navigations-Buttons nicht angezeigt wurden
513 -** Verbesserung der Logik für die Verbindungsprüfung bei Einrichtung der Postkorb-Anbindung
514 -
515 -=== 2.16.0 ===
516 -
517 -* Aufnahme zusätzlicher vom Bürgerkonto übermittelter Daten. Die genaue Beschreibung dieser kann der obigen Parameter-Tabelle entnommen werden.
518 -* Änderung im AKDB-Setup: Möglichkeit zur Prüfung der Erreichbarkeit des Postkorb-Webservice
519 -
520 520  === ===
hilfe_bk_button_v3_6.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.rth
Größe
... ... @@ -1,0 +1,1 @@
1 +117.4 KB
Inhalt
postkorb_absender_v3_6_fc_V7.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.rth
Größe
... ... @@ -1,0 +1,1 @@
1 +20.8 KB
Inhalt
postkorb_nachricht_v3_6_fc_V7.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.rth
Größe
... ... @@ -1,0 +1,1 @@
1 +27.1 KB
Inhalt