Zum Inhalt springen
Verstecke letzte Bearbeiter
rth 1.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
rth 9.2 3 {{info}}
4 **Hinweis zur Inbetriebnahme des Plugins:**
5 Im Download-Ordner der jeweilige Plugin-Version befindet sich eine Anleitung zur initialen Installation, sowie zu weiter reichenden Information die den allgemeinen Betrieb dieses Plugins betreffen.
6 {{/info}}
7
rth 1.1 8 {{content/}}
9
10 {{info}}
11 **Achtung:**
12 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!
13 {{/info}}
14
15 {{figure image="formular_vorlage.png"}}
16 Formularvorlage //AKDB Basisdienste//
17 {{/figure}}
18
19
gru 3.2 20 Über das kostenpflichtige //AKDB Bürgerkonto Service Plugin// werden Möglichkeiten zur Einbindung der AKDB Basisdienste **Bürgerkonto** und **Postkorb** in {{formcycle/}} bereitgestellt.
rth 1.1 21
22
23 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.
24
25 == Einbindung des Bürgerkonto Logins im Designer ==
26
27 {{figure image="hilfe_bk_button.png"}}
rth 8.2 28 Einstellungen am Formular-Element //AKDB Bürgerkonto// bis Version {{version major="3" minor="6"}}{{/version}}
rth 1.1 29 {{/figure}}
30
rth 8.2 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
gru 3.2 35 {{id name="BK_LoginButton"/}}
36
rth 1.1 37 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:
38
39
40 ; Schaltflächen Text
41 : Beschriftung des Login-Buttons
42 ; Login im Popup
gru 3.2 43 : Wenn aktiviert, wird die Login-Seite des Bürgerservice-Portals in einem Popup geöffnet, ansonst erfolgt die Anzeige in der gleichen Seite.
rth 1.1 44 ; Formularseite nach Login
45 : Hier wird die Formularseite festgelegt, welche angezeigt werden soll, wenn der Login **erfolgreich **war.
46 ; Formularseite nach abgebrochenen Login
47 : Hier wird die Formularseite festgelegt, welche angezeigt werden soll, wenn der Login **abgebrochen** wurde.
48 ; Eingaben prüfen vor Login
49 : 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.
50 ; Art der Rückgabedaten {{id name="Art_Rueckgabedaten"/}}
51 : Hier besteht die Auswahl zwischen:
52
53 * **personenbezogenen Daten**
54 * **organisationsbezogenen Daten**
55 * **personen- oder organisationsbezogenen Daten**
56
57 : Mit dieser Einstellung lässt sich die Art der zu erwarteten Rückgabedaten steuern, je nach Anforderung.
58 : Das heißt, wenn beispielsweise nur Daten einer natürlichen Person im Formularprozess zugelassen sind, ist hier die Auswahl auf //personenbezogene Daten// einzustellen.
59 ; Bürgerdaten Parameter-Suffix {{id name="BK_Parameter_Suffix"/}}
60 : Hier kann ein Suffix definiert werden, welches beim Vorbelegen von Formularelementen, mit den ermittelten Bürgerkonto-Daten, Anwendung findet.
61 Durch das Suffix wird es möglich mehrere Authentifizierungen und Formularelement-Vorbelegungen innerhalb eines Formulars zu realisieren.
62 : Als Suffix sind Buchstaben, Zahlen und der Unterstrich erlaubt.
63 : __Beispiel:__
rth 3.3 64 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. 
rth 8.4 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.)
rth 1.1 66 : Hier kann das dem Nutzer zur Verfügung stehende Authentifizierungsverfahren eingeschränkt werden.
67 : Es gibt folgende Auswahlmöglichkeiten:
rth 8.3 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
rth 8.4 84 :: Authentifizierung erfolgt über ein Identifikationsmittel aus dem Portfolio des //Föderierten Identitätsmanagements Interoperable Nutzerkonten//
rth 8.3 85 :; eID (Personalausweis)
86 :; eIDAS
rth 8.4 87 :: Authentifizierung mittels Identifikationsmittels nach eIDAS-Verordnung (//electronic IDentification, Authentication and Trust Services//)
rth 8.5 88 ; Postkorbversand obligatorisch
rth 8.4 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.
rth 1.1 91
92 == Einbindung des Bürgerkonto Logins als Externer Benutzer ==
93
gru 3.2 94 {{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.
rth 1.1 95
96 === Konfiguration eines Externen Benutzers für das Bürgerkonto Login ===
97
98 {{figure image="externer_benutzer_akdb.png"}}
99 Bürgerkonto-Login als Externer Benutzer einrichten. (Schritt 1)
100 {{/figure}}
101
102 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.
103
104 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.
105
106 {{info}}
107 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.
108 {{/info}}
109
110 {{figure image="externer_benutzer_akdb_s2.png"}}
111 Bürgerkonto-Login als Externer Benutzer einrichten. (Schritt 2)
112 {{/figure}}
113
114 Im nächsten Schritt muss über den Button "Konfiguration hinzufügen" eine Konfiguration hinzugefügt werden.
115
116 {{figure image="externer_benutzer_akdb_s3.png"}}
117 Bürgerkonto-Login als Externer Benutzer einrichten. (Schritt 3)
118 {{/figure}}
119
120 Im letzten Schritt besteht die Möglichkeit die Konfiguration individuell anzupassen.
121 Dazu können folgende Einstellungen getroffen werden:
122
rth 7.14 123
124
rth 1.1 125 ; LoginTyp
126 : Mit dieser Einstellung lassen sich die Arten der zurück gelieferten Daten festlegen.
127 : Ist als Wert **Person** definiert, so können nur personenbezogene Daten zurückgeliefert werden.
128 : 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.
rth 3.3 129 : Ist dieser Parameter nicht konfiguriert, so kann der Nutzer selbst bestimmen, welche Datenart (personen- oder organisationsbezogen) er zurück liefern möchte. 
rth 7.14 130 ; --AuthTyp-- (wird ab Version {{version major="3" minor="6"}}{{/version}}nicht mehr unterstützt)
rth 1.1 131 : Über diese Einstellung kann das geforderte Authentisierungsverfahren festgelegt werden.
132 : Entweder mit Authega-Zertifikat (Wert: **Authega**) oder Personalausweis (Wert: **NPA**).
133 : Ist nichts gesetzt oder das Attribut nicht vorhanden, so werden dem Nutzer alle möglichen Authentisierungsverfahren zur Auswahl angeboten.
rth 7.14 134 ; LoginMethod (ersetzt die Eigenschaft AuthTyp ab Version {{version major="3" minor="6"}}{{/version}})
rth 7.13 135 : Über diese Einstellung kann das geforderte Authentisierungsverfahren eingeschränkt werden.
rth 7.14 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
rth 7.15 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.
rth 7.14 145 ; PflichtElemente (ab Version {{version major="3" minor="6"}}{{/version}})
rth 7.15 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.
rth 7.14 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.
rth 1.1 156
157 === Bürgerkonto Login als Formularanmeldung einrichten ===
158
159 {{figure image="formular_zugriff.png"}}
160 Bürgerkonto Login als Externer Benutzer am Formular freischalten.
161 {{/figure}}
162
163 Um das Bürgerkonto-Login über einen [[Externen Benutzer>>doc:Formcycle.UserInterface.UserSettings.ExternalUsers.WebHome||target="_blank"]] am jeweiligen Formular zu ermöglichen,
164 muss dieses als [[Formularanmeldung>>doc:Formcycle.UserInterface.MyForms.Access||target="_blank"]] am Formular hinterlegt sein.
165
166
167 == Designer-Element: Bürgerkonto Daten Vorlage ==
168
169 {{figure image="hilfe_bk_vorlagen.png"}}
170 Formularvorlage //AKDB Basisdienste//
171 {{/figure}}
172
rth 3.13 173 Um die Daten aus dem Bürgerservice-Portal im Formular anzuzeigen, existiert die Vorlage //Bürgerkonto personen- und organisationsbezogene Daten.// Die Felder innerhalb dieser Vorlage sind so konfiguriert, dass sie eine automatische Zuordnung und damit die Anzeige der zurück gelieferten Daten ermöglichen. Bei Nutzung des eingangs erwähnten Formular-Templates, ist die Designer-Vorlage bereits eingebunden und je nach Anmeldetyp, werden die organisations-spezifischen Daten automatisch ein- oder ausgeblendet.
rth 1.1 174
rth 3.11 175 Die vom 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:
rth 1.1 176
177
178 {{code language="javascript"}}
179 XFC_METADATA.pluginResults.AKDBLoginAnalyzer
180 {{/code}}
181
gru 3.2 182 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.
rth 1.1 183
184 {{info}}
185 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.
186 Ist keine extra Kennzeichnung vorhanden, so ist der Parameter in beiden Bereichen vorhanden.
187
rth 3.3 188 **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.
rth 1.1 189 Die betreffenden Parameter sind in der Tabelle mit **(PBA + OBA)** gekennzeichnet.
190 {{/info}}
191
gru 3.2 192 {{info}}
193 **Hinweis für die vom Bürgerservice-Portal zurück gelieferten Daten:**
rth 3.11 194 Bei der Authentifizierung mit eIDAS-notifizierten Identifikationsmittel gilt der Mindestdatensatz nach eIDAS-VO, daher kann es zu einem reduzierten Datensatz kommen.
gru 3.2 195 **[[Attribute im eID Schema>>url:https://ec.europa.eu/cefdigital/wiki/display/EIDCOMMUNITY/Overview+of+available+attributes+of+pre-notified+and+notified+eID+schemes||rel="noopener noreferrer" target="_blank"]]**
196 {{/info}}
197
rth 1.1 198 {{table dataTypeAlpha="0" preSort="0-asc"}}
199 |=Parameter|=Beschreibung
200 |BPK|Bereichsspezifisches Personenkennzeichen (in verschlüsselter Form)
201 |BPK_Decoded|Bereichsspezifisches Personenkennzeichen (in entschlüsselter Form)
202 |PostboxId|Postkorb-ID des Nutzers. Muss bei Anbindung des Postkorbs verwendet werden.
203 |(((
204 tfAntragstellerEmail (PBA + OBA)
205 )))|Email-Adresse
206 |Gender|Anrede als numerischer Wert nach ISO 5218:2004
207 |GenderName|Lesbarer Text für Geschlechter-Code aus Attribut „gender“.
208 Mögliche Werte: //männlich//, //weiblich//
209 |(((
210 tfAntragstellerAnrede (PBA + OBA)
211 )))|Anrede, wird mit Hilfe des Geschlechter-Code aus Attribut „gender“ erzeugt.
212 Mögliche Werte: //Herr//, //Frau, Nicht bekannt//
213 |(((
214 tfAntragstellerTitel (PBA + OBA)
215 )))|Akademischer Titel
216 |(((
217 tfAntragstellerVorname (PBA + OBA)
218 )))|Vorname
219 |(((
220 tfAntragstellerName (PBA + OBA)
221 )))|Nachname
222 |(((
223 tfAntragstellerPLZ (PBA + OBA)
224 )))|Postleitzahl
225 |(((
226 tfAntragstellerAdresse (PBA + OBA)
227 )))|Adresse bestehend aus Strasse und Hausnummer
228 |(((
229 tfAntragstellerOrt (PBA + OBA)
230 )))|Ort
gru 3.2 231 |tfAntragstellerLand (PBA + OBA)|Land aus dem der Antragsteller kommt oder die Organisation ihren Sitz hat. Als ISO 3166-1 alpha-2 gepflegt. (ab Version {{version major="2" minor="16"}}{{/version}})
rth 1.1 232 |(((
233 tfAntragstellerGeburtsdatum (PBA + OBA)
234 )))|Geburtsdatum im Format: dd.MM.yyyy
gru 3.2 235 |tfAntragstellerGeburtsname (PBA + OBA)|Geburtsname (ab Version {{version major="2" minor="15"}}{{/version}})
rth 1.1 236 |(((
237 tfAntragstellerGeburtsort (PBA + OBA)
238 )))|Geburtsort
239 |(((
240 tfAntragstellerTelefon (PBA + OBA)
241 )))|Telefonnummer
gru 3.2 242 |tfAntragstellerStaatsangehoerigkeit (PBA + OBA)|Staatsangehörigkeit (ab Version {{version major="2" minor="15"}}{{/version}})
243 |tfAntragstellerDeMail (PBA + OBA)|De-Mail-Adresse (ab Version {{version major="2" minor="15"}}{{/version}})
244 |tfAntragstellerEIDASAusstellerLand (PBA)|eIDAS Ausgabeland (ab Version {{version major="2" minor="15"}}{{/version}})
rth 1.1 245 |tfOrgVertreterVorname (OBA)|Vorname der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
246 |tfOrgVertreterName (OBA)|Nachname der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
247 |tfOrgVertreterTitel (OBA)|Akademischer Titel der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
248 |(((
249 tfOrgVertreterAnrede (OBA)
250 )))|(((
251 Anrede für die Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
252 Anrede, wird mit Hilfe des Geschlechter-Code aus Attribut „gender“ erzeugt. Mögliche Werte: //Herr//, //Frau, Nicht bekannt//
253 )))
254 |tfOrgVertreterGeburtsdatum (OBA)|Akademischer Titel der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
255 |tfOrgVertreterGeburtsort (OBA)|Geburtsort der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
256 |tfOrgEmail (OBA)|E-Mail Adresse der angemeldeten Person, welche diese im Unternehmen hat. (Kann von der E-Mail Adresse am personenbezogenen Account abweichen.)
257 |tfOrgVertreterTelefon (OBA)|Telefonnummer der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
258 |tfOrgStrasse (OBA)|Strasse
259 |tfOrgHausnummer (OBA)|Hausnummer
260 |tfOrgHausnummerZusatz (OBA)|Hausnummern Zusatz
261 |tfOrgAdressZusatz (OBA)|Adress-Zusatz
262 |tfOrgPLZ (OBA)|PLZ
263 |tfOrgOrt (OBA)|Ort
264 |tfOrgName (OBA)|Name der Organisation (mit Rechtsform)
gru 3.2 265 |tfOrgID (OBA)|Organisations-ID (abgekündigt, wird zukünftig durch das organisationsspezifische Kennzeichen ersetzt)
266 |tfOrgKennzeichen (OBA)|organisationsspezifisches Kennzeichen: ersetzt zukünftig die Organisations-ID. (ab Version {{version major="2" minor="16"}}{{/version}})
rth 1.1 267 |Rechtsform (OBA)|Rechtsform der Organisation
268 |tfOrgRegisterOrt (OBA)|Register(gerichts)-Ort
269 |tfOrgRegisterNummer (OBA)|Registernummer
gru 3.2 270 |tfOrgUUID (OBA)|Unternehmenskonto-Handle (ab Version {{version major="2" minor="15"}}{{/version}})
rth 1.1 271 |TrustLevel|(((
272 Vertrauensniveau, gibt Auskunft über gewählte Authentifizierungsmethode:
273 * **STORK-QAA-Level-1**: Authentifizierung mittels Benutzername / Passwort
274 * **STORK-QAA-Level-3:** Authentifizierung mittels Authega Zertifikat
275 * **STORK-QAA-Level-4**: Authentifizierung mittels nPA
276 )))
gru 3.2 277 |IdentitaetsPruefer|Quelle der Identitätsprüfung (ab Version {{version major="2" minor="15"}}{{/version}}) (Mögliche Werte sind: **eIDAS**, **eID**, **Smart-eID**, **Authega**, **Elster**, **Benutzername** oder **FINK**)
rth 1.1 278 |NPA_Address (PBA)|Adresse, wie sie auf dem NPA vermerkt ist (alles in Großbuchstaben)
279 |NPA_City (PBA)|Ort, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben)
280 |NPA_FirstName|Vorname, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben)
281 |NPA_LastName|Nachname, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben)
282 |NPA_PersonalTitle|Akademischer Titel, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben)
283 |IsIndividualPerson|Liefert den Wert **true**, wenn es sich bei den Daten aus dem Bürgerkonto um personenbezogene Daten handelt, sonst **false**.
284 |IsOrganization|Liefert den Wert **true**, wenn es sich bei den Daten aus dem Bürgerkonto um organisationsbezogene Daten handelt, sonst **false**.
rth 3.11 285 |authVerifyInfos|(ab Version {{version major="3" minor="5"}}{{/version}}) Enthält als Wert ein JSON Objekt mit zusammenfassenden Verifikationsinformationen zur durchgeführten Authentifizierung, separiert nach NpaDaten-Suffix. Die Informationen bestehen aus einer Liste aller Element-Namen, welche durch die Authentifizierung befüllt wurden, dem genutzten Identitäts-Prüfer, sowie dem Trust-Level. Die **authVerifyInfos** sind in den XFC_METADATA-Objekt auch dann vorhanden, wenn keine explizite Anmeldung über das Bürgerservice-Portal stattgefunden hat, sondern beispielsweise eine Wiederanzeige des Vorgangsdaten über einen Prozess-Link.
rth 1.1 286 {{/table}}
287
288 {{info}}
289 **Hinweis:**
gru 3.2 290 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.
rth 1.1 291 \\__Beispiel:__
292 Wenn als Suffix "**_Person2**" definiert wurde, so ergibt sich beim Vornamen der Formular-Elementname "tfAntragstellerVorname**_Person2**".
293 {{/info}}
294
295 === Darstellung des genutzten Authentifizierungsverfahren ===
296
297 {{figure image="hilfe_trustlevel_visualisierung.png"}}
298 Darstellung des verwendeten Vertrauensniveaus an der Bürgerkonto Daten Vorlage
299 {{/figure}}
300
301 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.
302
303 Für die einzelnen Vertrauensniveaus existieren folgende Beschriftungen:
304
305 * Level 1 (Authentifizierung mittels Benutzername / Passwort): **Standard**
rth 3.12 306 * Level 3 (Authentifizierung mittels Authega Zertifikat): **Zertifikat**
rth 1.1 307 * Level 4 (Authentifizierung mittels nPA): **Personalausweis**
308
309 {{figure image="hilfe_trustlevel_keine_visualisierung.png"}}
310 Wenn keine visuelle Markierung gewünscht ist, so kann dies durch ein zusätzliches Attribut „noRibbon“ am Vorlagen-Fieldset unterbunden werden
311 {{/figure}}
312
rth 3.13 313 ==== Anpassungen der Darstellung aufgrund reduzierter Nutzerdaten ====
314
rth 7.2 315 Mit dem Update des Bürgerservice-Portals (**Release 3.2** vom **18.11.2021**) kann es bei Anmelde-Prozessen zur Übermittlung von reduzierten Nutzerdaten kommen (z.B. Authentifizierung mit eIDAS-notifizierten Identifikationsmittel). Dies äußert sich beispielsweise darin, dass nach der Anmeldung keine Adressdaten vom Nutzer in der Vorlage erscheinen.
316
317
318 Mit Plugin Version {{version major="3" minor="5"}}{{/version}} werden nach einer Anmeldung am Bürgerservice-Portal nur noch die Eingabefelder innerhalb der Datenvorlage für eine Bearbeitung gesperrt, welche durch den Authentifizierungsprozess am Bürgerservice-Portal befüllt wurden.
rth 3.14 319 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.
rth 3.13 320
rth 6.2 321 Zusätzlich werden die Felder bei Wiederanzeige durch kleine Icons gekennzeichnet, wodurch auf einem Blick ersichtlich wird, aus welcher Quelle die Anmeldeinformationen entstammen.
rth 5.2 322
323 * [[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
324 * [[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
325
rth 6.2 326 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:
327
328 * //verify_l1//: Kennzeichnet ein Element dessen Inhaltswert einen Level 1 Vertrauensniveaus (Authentifizierung mittels Benutzername / Passwort) entspricht.
329 * //verify_l3//: Kennzeichnet ein Element dessen Inhaltswert einen Level 3 Vertrauensniveaus (Authentifizierung mittels Zertifikat) entspricht.
330 * //verify_l4//: Kennzeichnet ein Element dessen Inhaltswert einen Level 4 Vertrauensniveaus (Authentifizierung mittels nPA oder eIDAS Identifikationsmittel) entspricht.
rth 6.3 331 * //no_verify//: Kennzeichnet ein Element dessen Inhaltswert durch einen Nutzer frei eingegeben wurde und damit durch keinen Identitätsprüfer aus dem Umfeld des Bürgerservice-Portals geprüft wurde. 
rth 6.2 332
rth 5.3 333 {{figure image="noVerifyInfo.png"}}
334 Wenn keine visuelle Markierung der Formularelemente gewünscht ist, so kann dies durch ein zusätzliches Attribut „noVerifyInfo“ am Vorlagen-Fieldset unterbunden werden
335 {{/figure}}
336
rth 1.1 337 == AKDB Postkorbanbindung in der Statusverarbeitung ==
338
339
340 Für die Anbindung zum Versand von Postkorbnachrichten wird das Aktions-Plugin **AKDB:Postkorbnachricht senden** zur Verfügung gestellt.
341 Mittels dieser Plugin-Aktion, können ähnlich einer E-Mail Aktion, Nachrichten an den Postkorb der AKDB weitergeleitet werden.
342
343 Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt die nachfolgend kurz beschrieben werden.
344
rth 7.5 345 {{panel title="Einstellungen für Absender und Empfänger" fullwidth="true" triggerable="true"}}
rth 1.1 346
347
348 {{figure image="postkorb_absender.png"}}
349 Einstellungen für Absender und Empfänger
350 {{/figure}}
351
352 ; Dienst (Pflicht)
353 : Wird als Information in der Postkorb-Ansicht im Bürgerservice-Portal verwendet.
354 ; Mandant (Pflicht)
355 : Wird als Information in der Postkorb-Ansicht im Bürgerservice-Portal verwendet.
356 ; Absender-Link
357 : 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.
358 ; Postkorb ID aus den Vorgangsdaten ermitteln?
359 : 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.
rth 7.5 360 Wird bei einem AKDB Bürgerkonto-Login die Postkorb-ID mit übermittelt, so wird diese standardmäßig am Formulareingang hinterlegt.
rth 1.1 361 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.
362 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.)
363
364
365 {{/panel}}
366
gru 3.2 367 {{panel title="Konfiguration des Nachrichteninhalts" fullwidth="true" triggerable="true"}}
rth 1.1 368
369
370 {{figure image="postkorb_nachricht.png"}}
371 Konfiguration von Betreff, Nachrichteninhalt und Anhängen
372 {{/figure}}
373
374
375 ; Betreff (Pflicht)
376 : Nahrichtenbetreff, es werden Platzhalter unterstützt.
377 ; Inhalt (Pflicht)
378 : Nachrichtentext, es werden Platzhalter unterstützt.
379 ; Anhänge
380 : Hier können Dateien als Attachments an die Postkorb-Nachricht gehangen werden.
381 : Zur Auswahl stehen dabei:
382 :; Upload
383 :: bezieht sich auf alle Dateianhänge, die über das Formular hochgeladen wurden
384 :; Workflow
385 :: bezieht sich auf alle Dateianhänge, die über den aktuellen FORMCYCLE Workflow hochgeladen wurden.
386 :; Posteingang
387 :: bezieht sich auf alle Dateianhänge, die über das Postfach hochgeladen wurden.
388 :: Unterstützte Dateiformate sind: PDF, HTML, Plaintext, MS Word, JPEG, GIF, PNG
389
390
391 {{info}}
392 **Achtung:**
gru 3.2 393 Die Schnittstelle zum Postkorb der AKDB unterstützt dabei maximal 20 Anhänge pro Nachricht mit je 50 MByte Maximalgröße.
rth 7.7 394
395 Anhänge im Zip-Format werden momentan von der Postkorb-Schnittstelle auf Seite der AKDB nicht unterstützt. Nachrichten mit Zip-Datei Anhängen werden vom System komplett verworfen, weshalb Zip-Dateien aktuell bereits im FORMCYCLE-System herausgefiltert werden, sodass die eigentliche Nachricht trotzdem den Postkorb erreichen kann. Beachten Sie dies bitte innerhalb des jeweiligen Workflows.
rth 1.1 396 {{/info}}
397
398 {{/panel}}
399
400 === Bedingte Ausführung der //AKDB:Postkorbnachricht senden//-Aktion ===
401
402 {{figure image="postkorb_nachricht_bedingung.png"}}
403 Konfiguration einer Bedingung für Ausführung der Aktion //AKDB~:Postkorbnachricht senden//
404 {{/figure}}
405
406 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.
407 Dies bedeutet aber auch, dass wenn in einem Formularprozess kein zwingender Bürgerkonto-Login erfolgt, die Postkorb-ID **nicht** in der Statusverarbeitung vorhanden ist.
408 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.
409
410 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.
411
412 {{code language="javascript"}}
413 REGEX([%$POSTKORB_ID%]=^.+$)
414 {{/code}}
415
416 ==== Erweitere Bedingungsprüfung bei Verwendung unterschiedlicher Login-Arten (personenbezogenes bzw. organisationsbezogenes Login) ====
417
418
419 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.
420 Im Formular müssen dann versteckte Eingabefelder mit den Element-Namen **IsIndividualPerson** und **IsOrganization** vorhanden sein.
421
422 Die Konfiguration einer Ausführungs-Bedingung an einer Aktion //AKDB:Postkorbnachricht senden// für eine **personenbezogene** Anmeldung wäre dann folgendermaßen:
423
424
425 {{code language="javascript"}}
426 REGEX([%IsIndividualPerson%]=true) REGEX([%$POSTKORB_ID%]=^.+$)
427 {{/code}}
428
429
430 Bei Nutzung einer **organisationsbezogenen** Anmeldung ist folgende Bedingung zu konfigurieren:
431
432
433 {{code language="javascript"}}
434 REGEX([%IsOrganization%]=true) REGEX([%$POSTKORB_ID%]=^.+$)
435 {{/code}}
436
437 {{info}}
438 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.
439 {{/info}}
440
441
442 == Versionshistorie ==
443
sas 9.1 444 === 3.6.0 - Bereitstellung erfolgt nach offiziellen Release der AKDB ===
rth 7.12 445
446 * Erweiterungen / Anpassungen aufgrund von Schnittstellenanpassungen im Bürgerservice-Portal der AKDB:
447 ** Möglichkeit zur Anforderung von Pflicht-Attributen (Postkorb-ID)
448 ** Umstellung der Auswahlmöglichkeiten für das geforderte Authentifizierungsverfahren auf eine weiter reichende Auswahl (+Migration bestehender Konfigurationen am BK-Login-Button)
449 * Anpassung AKDB-Setup: Hinweis auf freizugebende URL's (Firewall-Einstellungen) hinzugefügt
450 * Fehlerbehebung: Fehlerbehandlung im Plugin-Action-Servlet 'AKDBLogin' angepasst
451
rth 7.9 452 === 3.5.7 ===
453
454 * 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)
455 * Erweiterung Postkorb-Aktion: Die Prüfroutine für die Postkorb-Webservice-Kommunikation wurde um eine Zertifikats-Validierung erweitert, in deren Erfolgsmeldung das Ablaufdatum für die Gültigkeit des Zertifikats vermerkt ist. 
456
457 === 3.5.6 ===
458
459 * Fehlerbehebung: Es wurde ein Fehler behoben, welcher bei der Wiederanzeige von Organisations-Adressdaten aufgetreten ist. Teilweise waren die Adressdaten unvollständig.
460
rth 7.8 461 === 3.5.5 ===
462
463 * Fehlerbehebung: Es wurde ein JS-Fehler behoben, der entstand, wenn das "TrustLevel"-Feld außerhalb der Daten-Vorlage verwendet wurde.
464 * Fehlerbehebung: Bei einer NPA-Anmeldung fehlten die RAW-Daten für die Adresse und die Stadt in den XFC_METADATEN. Dies wurde behoben.
465
rth 7.6 466 === 3.5.4 ===
467
468 * Erweiterung Postkorb-Aktion: Prüfroutine für Postkorb-Webservice-Kommunikation in Konfigurationsoberfläche hinzugefügt.
469
rth 7.4 470 === 3.5.3 ===
471
472 * Fehlerbehebung: Es wurde ein Sicherheitsproblem behoben, welches bei Laden von zwischengespeicherten Formulardaten auftreten kann.
473
rth 7.3 474 === 3.5.2 ===
475
476 * Fehlerbehebung: Bei Rückleitung aus dem Bürgerservice-Portal und wenn Kommunikation nicht über Frontend-Server stattgefunden hat, wurde teilweise die Seite "Formular nicht gefunden" ausgeliefert. Dies wurde behoben.
477 * Fehlerbehebung: Bei Verwendung mehrerer Anmeldungen innerhalb eines Formulars und damit unterschiedlichen Bürgerdaten-Suffix, kam es zu falschen Formatierungen der Datenfelder. Dies wurde behoben.
478
rth 3.12 479 === 3.5.1 ===
480
481 * Fehlerbehebung: Bei Rückleitung aus dem Bürgerservice-Portal und wenn Kommunikation nicht über Frontend-Server stattgefunden hat, wurde teilweise die Seite "Formular nicht gefunden" ausgeliefert. Dies wurde behoben.
482
rth 3.10 483 === 3.5.0 ===
484
485 * Erweiterung der zurück gelieferten Authentifizierungsdaten: Das JSON-Objekt //authVerifyInfos// enthält die Namen der Elemente aus den Bürgerkontodaten, welche über die Authentifizierung am Bürgerservice-Portal übermittelt wurden.
486 * Überarbeitung JS und CSS für Vorlagen: die Felder innerhalb der Vorlage werden jetzt per ICON so aufbereitet, dass ersichtlich wird, woher die Daten stammen bzw. wer der Identitätsprüfer war
487 * Fehlerbehebung: Fehlendes URL-Encoding eines Parameters führte dazu, dass Formular nach AKDB-Login nicht mehr gefunden wurde. Dies wurde behoben.
488 * Anpassung AKDB-Setup: beim Prüfung der Postkorb-Verbindung werden jetzt separat Zertifikat und Passwort auf Korrektheit geprüft und im Fehlerfall extra ausgewiesen.
489
rth 3.9 490 === 3.4.0 ===
491
492 * Konfigurative Möglichkeit eines URL-Rewritings am Login-Button auf die Assertion Consumer Service URL aus der Bürgerservice-Portal-Registrierung
493 * Fehlerbehebung: Das eigenständige Overlay am Login-Button wurde entfernt und durch den System-Standard ersetzt. Dadurch wird beim Übersteuern des Standard-Overlay-Logos auch das Overlay-Logo am Login-Button mit übersteuert.
494
rth 3.8 495 === 3.3.1 ===
496
497 * Fehlerbehebung: Beim Login mittels Login-Button verhinderte der Popup-Blocker, welcher in vielen Browsern aktiv ist, ein Öffnen des Popups für die Login-Auswahl. Dies wurde behoben.
498
rth 3.6 499 === 3.3.0 ===
rth 3.3 500
rth 3.6 501 * Überarbeitung der Revisionsicherheit und damit Anpassung an Weiterentwicklung in {{formcycle/}}
502 * Erweiterung Plugin-Authenticator: Es gibt nun die Möglichkeit am Plugin-Authenticator (ähnlich wie am Bürgerkonto-Login-Button) ein //Bürgerdaten Parameter-Suffix// zu konfigurieren
503 * Neues Replacer-Plugin ('LOGIN_PROTOCOL') für eine Ausgabe aller Anmeldedaten, welche am Vorgang hinterlegt sind.
504 * Fehlerbehebung: Ein Fehler, welcher im Zusammenhang mit dem Einsatz des Bürgerkonto-Login-Buttons bei Benutzung in einem Popup auftrat, wurde behoben.
505 * Fehlerbehebung: Ein Fehler der im Zusammenhang mit dem Postkorb-Versand (fehlende Postkorb-ID), bei vorheriger Anmeldung mittels Plugin-Authentictors über einen Frontend-Server auftrat, wurde behoben
506
rth 3.4 507 === 3.2.1 ===
508
509 * Fehlerbehebung: In der Vorlage für //personen- und organisationsbezogene Daten// waren Elemente falsch benannt, sodass sie bei Anzeige nicht mit den Nutzer-Daten befüllt waren. Dies wurde behoben.
510
rth 3.3 511 === 3.2.0 ===
512
513 * Fehlerbehebung: Es wurde ein Fehler bei der Authentifizierung mittels Plugin-Authenticator behoben, der dazu führte, dass
514 das Formular mit den zurückgelieferten Nutzerdaten nicht mehr angezeigt wurde.
515 * die (veralteten) BK-Vorlagen für //persönliche Daten// und //organisationsbezogenen Daten// wurden aus dem Designer entfernt, sodass nur noch die Vorlage für //personen- und organisationsbezogene Daten// zur Auswahl steht, welche alle Anmeldefälle abdeckt.
516 (Hinweis: Formulare die auf den veralteten Vorlagen abbauen werden weiterhin unterstützt)
517 * Erweiterung der Vorlage für //personen- und organisationsbezogene Daten// um das Attribut 'IdentitaetsPruefer', welches zur Differenzierung der Art der Anmeldung innerhalb eines Vertrauensniveaus dient.
518 * Anpassung der Formular-Vorlage auf Grundlage der geänderten Nutzerdaten-Vorlage
519
520 === 3.1.0 ===
521
522 * **Achtung:** alle neueren Versionen des Plugins benötigen ab dieser Version mindestens {{formcycle/}} Version {{version major="7" minor="0" patch="1"}}{{/version}} oder höher
523 * Anpassung AKDB-Setup: im Bereich des Zertifikatsuploads für die Kommunikation mit dem Postkorb
524
525 === 3.0.0 ===
526
527 * **Achtung:** alle neueren Versionen des Plugins benötigen ab dieser Version mindestens {{formcycle/}} Version {{version major="7" minor="0"}}{{/version}} oder höher
528 * Postkorb-Plugin für V7-Workflow
529 * Überarbeitung Formular-Vorlage für Nutzung des V7-Workflows
530
gru 3.2 531 === 2.18.3 ===
532
533 * 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
534 * Fehlerbehebung: Es wurden Fehler bei der Wiederanzeige von zwischengespeicherten Daten bei Kommunikation über FS behoben.
535
536 === 2.18.2 ===
537
538 * Anpassung Postkorb: Umstellung von ID auf UUID bei Dateianhängen
539
540 === 2.18.1 ===
541
542 * Fehlerbehebung: Es wurde ein Fehler, beim Zwischenspeichern von Formulardaten vor der Weiterleitung zum BK-Portal, behoben.
543
544 === 2.18.0 ===
545
546 * Erweiterung AKDB-Setup: Neuer Einrichtungsschritt für die Erhebung von Organisationsdaten für Verwaltungszwecke.
547
548 === 2.17.0 ===
549
550 * Abschließende Anpassungen für Einführung Bürgerservice-Portal 2.0:
551 ** Aktualisierung der Metadaten des Identity Providers, sowie des Postkorb-Webservice-Endpoints für die Anbindung des neuen Live-Systems
rth 3.3 552 * Änderung im AKDB-Setup:
gru 3.2 553 ** Anpassungen am Layout, da es bei niedrigen Auflösungen dazu kam, dass Navigations-Buttons nicht angezeigt wurden
554 ** Verbesserung der Logik für die Verbindungsprüfung bei Einrichtung der Postkorb-Anbindung
555
556 === 2.16.0 ===
557
558 * Aufnahme zusätzlicher vom Bürgerkonto übermittelter Daten. Die genaue Beschreibung dieser kann der obigen Parameter-Tabelle entnommen werden.
559 * Änderung im AKDB-Setup: Möglichkeit zur Prüfung der Erreichbarkeit des Postkorb-Webservice
560
rth 7.10 561 === ===