Zeige letzte Bearbeiter
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 {{id name="BK_LoginButton"/}}
34
35 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:
36
37
38 ; Schaltflächen Text
39 : Beschriftung des Login-Buttons
40 ; Login im Popup
41 : Wenn aktiviert, wird die Login-Seite des Bürgerservice-Portals in einem Popup geöffnet, ansonst erfolgt die Anzeige in der gleichen Seite.
42 ; Formularseite nach Login
43 : Hier wird die Formularseite festgelegt, welche angezeigt werden soll, wenn der Login **erfolgreich **war.
44 ; Formularseite nach abgebrochenen Login
45 : Hier wird die Formularseite festgelegt, welche angezeigt werden soll, wenn der Login **abgebrochen** wurde.
46 ; Eingaben prüfen vor Login
47 : 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.
48 ; Art der Rückgabedaten {{id name="Art_Rueckgabedaten"/}}
49 : Hier besteht die Auswahl zwischen:
50
51 * **personenbezogenen Daten**
52 * **organisationsbezogenen Daten**
53 * **personen- oder organisationsbezogenen Daten**
54
55 : Mit dieser Einstellung lässt sich die Art der zu erwarteten Rückgabedaten steuern, je nach Anforderung.
56 : Das heißt, wenn beispielsweise nur Daten einer natürlichen Person im Formularprozess zugelassen sind, ist hier die Auswahl auf //personenbezogene Daten// einzustellen.
57 ; Bürgerdaten Parameter-Suffix {{id name="BK_Parameter_Suffix"/}}
58 : Hier kann ein Suffix definiert werden, welches beim Vorbelegen von Formularelementen, mit den ermittelten Bürgerkonto-Daten, Anwendung findet.
59 Durch das Suffix wird es möglich mehrere Authentifizierungen und Formularelement-Vorbelegungen innerhalb eines Formulars zu realisieren.
60 : Als Suffix sind Buchstaben, Zahlen und der Unterstrich erlaubt.
61 : __Beispiel:__
62 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. 
63 ; gefordertes Authentifizierungsverfahren
64 : Hier kann das dem Nutzer zur Verfügung stehende Authentifizierungsverfahren eingeschränkt werden.
65 : Es gibt folgende Auswahlmöglichkeiten:
66
67 * **keine Einschränkung**: Login mittels Passwort, Authega-Zertifikat oder Personalausweis steht zur Auswahl
68 * **Authega**: Nur die Authentifizierung mittels Authega-Zertifikat steht zur Auswahl
69 * **Authega oder Personalausweis**: Login mittels Authega-Zertifikat oder Personalausweis steht zur Auswahl **(Achtung: Diese Auswahl wird momentan nicht mehr vom AKDB Portal unterstützt!)**
70 * **Personalausweis**: nur Authentifizierung mittels Personalausweis steht zur Auswahl
71
72 == Einbindung des Bürgerkonto Logins als Externer Benutzer ==
73
74 {{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.
75
76 === Konfiguration eines Externen Benutzers für das Bürgerkonto Login ===
77
78 {{figure image="externer_benutzer_akdb.png"}}
79 Bürgerkonto-Login als Externer Benutzer einrichten. (Schritt 1)
80 {{/figure}}
81
82 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.
83
84 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.
85
86 {{info}}
87 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.
88 {{/info}}
89
90 {{figure image="externer_benutzer_akdb_s2.png"}}
91 Bürgerkonto-Login als Externer Benutzer einrichten. (Schritt 2)
92 {{/figure}}
93
94 Im nächsten Schritt muss über den Button "Konfiguration hinzufügen" eine Konfiguration hinzugefügt werden.
95
96 {{figure image="externer_benutzer_akdb_s3.png"}}
97 Bürgerkonto-Login als Externer Benutzer einrichten. (Schritt 3)
98 {{/figure}}
99
100 Im letzten Schritt besteht die Möglichkeit die Konfiguration individuell anzupassen.
101 Dazu können folgende Einstellungen getroffen werden:
102
103 ; LoginTyp
104 : Mit dieser Einstellung lassen sich die Arten der zurück gelieferten Daten festlegen.
105 : Ist als Wert **Person** definiert, so können nur personenbezogene Daten zurückgeliefert werden.
106 : 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.
107 : Ist dieser Parameter nicht konfiguriert, so kann der Nutzer selbst bestimmen, welche Datenart (personen- oder organisationsbezogen) er zurück liefern möchte. 
108 ; AuthTyp
109 : Über diese Einstellung kann das geforderte Authentisierungsverfahren festgelegt werden.
110 : Entweder mit Authega-Zertifikat (Wert: **Authega**) oder Personalausweis (Wert: **NPA**).
111 : Ist nichts gesetzt oder das Attribut nicht vorhanden, so werden dem Nutzer alle möglichen Authentisierungsverfahren zur Auswahl angeboten.
112
113 === Bürgerkonto Login als Formularanmeldung einrichten ===
114
115 {{figure image="formular_zugriff.png"}}
116 Bürgerkonto Login als Externer Benutzer am Formular freischalten.
117 {{/figure}}
118
119 Um das Bürgerkonto-Login über einen [[Externen Benutzer>>doc:Formcycle.UserInterface.UserSettings.ExternalUsers.WebHome||target="_blank"]] am jeweiligen Formular zu ermöglichen,
120 muss dieses als [[Formularanmeldung>>doc:Formcycle.UserInterface.MyForms.Access||target="_blank"]] am Formular hinterlegt sein.
121
122
123 == Designer-Element: Bürgerkonto Daten Vorlage ==
124
125 {{figure image="hilfe_bk_vorlagen.png"}}
126 Formularvorlage //AKDB Basisdienste//
127 {{/figure}}
128
129 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.
130
131 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.
132
133 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:
134
135
136 {{code language="javascript"}}
137 XFC_METADATA.pluginResults.AKDBLoginAnalyzer
138 {{/code}}
139
140 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.
141
142 {{info}}
143 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.
144 Ist keine extra Kennzeichnung vorhanden, so ist der Parameter in beiden Bereichen vorhanden.
145
146 **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.
147 Die betreffenden Parameter sind in der Tabelle mit **(PBA + OBA)** gekennzeichnet.
148 {{/info}}
149
150 {{info}}
151 **Hinweis für die vom Bürgerservice-Portal zurück gelieferten Daten:**
152 Bei der Authentifizierung mit eIDAS-notifizierten Identifikationsmittel gilt der Mindestdatensatz nach eIDAS-VO, daher kann es zu einem
153 reduzierten Datensatz kommen.
154 **[[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"]]**
155 {{/info}}
156
157 {{table dataTypeAlpha="0" preSort="0-asc"}}
158 |=Parameter|=Beschreibung
159 |BPK|Bereichsspezifisches Personenkennzeichen (in verschlüsselter Form)
160 |BPK_Decoded|Bereichsspezifisches Personenkennzeichen (in entschlüsselter Form)
161 |PostboxId|Postkorb-ID des Nutzers. Muss bei Anbindung des Postkorbs verwendet werden.
162 |(((
163 tfAntragstellerEmail (PBA + OBA)
164 )))|Email-Adresse
165 |Gender|Anrede als numerischer Wert nach ISO 5218:2004
166 |GenderName|Lesbarer Text für Geschlechter-Code aus Attribut „gender“.
167 Mögliche Werte: //männlich//, //weiblich//
168 |(((
169 tfAntragstellerAnrede (PBA + OBA)
170 )))|Anrede, wird mit Hilfe des Geschlechter-Code aus Attribut „gender“ erzeugt.
171 Mögliche Werte: //Herr//, //Frau, Nicht bekannt//
172 |(((
173 tfAntragstellerTitel (PBA + OBA)
174 )))|Akademischer Titel
175 |(((
176 tfAntragstellerVorname (PBA + OBA)
177 )))|Vorname
178 |(((
179 tfAntragstellerName (PBA + OBA)
180 )))|Nachname
181 |(((
182 tfAntragstellerPLZ (PBA + OBA)
183 )))|Postleitzahl
184 |(((
185 tfAntragstellerAdresse (PBA + OBA)
186 )))|Adresse bestehend aus Strasse und Hausnummer
187 |(((
188 tfAntragstellerOrt (PBA + OBA)
189 )))|Ort
190 |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}})
191 |(((
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 tfAntragstellerGeburtsort (PBA + OBA)
197 )))|Geburtsort
198 |(((
199 tfAntragstellerTelefon (PBA + OBA)
200 )))|Telefonnummer
201 |tfAntragstellerStaatsangehoerigkeit (PBA + OBA)|Staatsangehörigkeit (ab Version {{version major="2" minor="15"}}{{/version}})
202 |tfAntragstellerDeMail (PBA + OBA)|De-Mail-Adresse (ab Version {{version major="2" minor="15"}}{{/version}})
203 |tfAntragstellerEIDASAusstellerLand (PBA)|eIDAS Ausgabeland (ab Version {{version major="2" minor="15"}}{{/version}})
204 |tfOrgVertreterVorname (OBA)|Vorname der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
205 |tfOrgVertreterName (OBA)|Nachname der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
206 |tfOrgVertreterTitel (OBA)|Akademischer Titel der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
207 |(((
208 tfOrgVertreterAnrede (OBA)
209 )))|(((
210 Anrede für die Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
211 Anrede, wird mit Hilfe des Geschlechter-Code aus Attribut „gender“ erzeugt. Mögliche Werte: //Herr//, //Frau, Nicht bekannt//
212 )))
213 |tfOrgVertreterGeburtsdatum (OBA)|Akademischer Titel der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
214 |tfOrgVertreterGeburtsort (OBA)|Geburtsort der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
215 |tfOrgEmail (OBA)|E-Mail Adresse der angemeldeten Person, welche diese im Unternehmen hat. (Kann von der E-Mail Adresse am personenbezogenen Account abweichen.)
216 |tfOrgVertreterTelefon (OBA)|Telefonnummer der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
217 |tfOrgStrasse (OBA)|Strasse
218 |tfOrgHausnummer (OBA)|Hausnummer
219 |tfOrgHausnummerZusatz (OBA)|Hausnummern Zusatz
220 |tfOrgAdressZusatz (OBA)|Adress-Zusatz
221 |tfOrgPLZ (OBA)|PLZ
222 |tfOrgOrt (OBA)|Ort
223 |tfOrgName (OBA)|Name der Organisation (mit Rechtsform)
224 |tfOrgID (OBA)|Organisations-ID (abgekündigt, wird zukünftig durch das organisationsspezifische Kennzeichen ersetzt)
225 |tfOrgKennzeichen (OBA)|organisationsspezifisches Kennzeichen: ersetzt zukünftig die Organisations-ID. (ab Version {{version major="2" minor="16"}}{{/version}})
226 |Rechtsform (OBA)|Rechtsform der Organisation
227 |tfOrgRegisterOrt (OBA)|Register(gerichts)-Ort
228 |tfOrgRegisterNummer (OBA)|Registernummer
229 |tfOrgUUID (OBA)|Unternehmenskonto-Handle (ab Version {{version major="2" minor="15"}}{{/version}})
230 |TrustLevel|(((
231 Vertrauensniveau, gibt Auskunft über gewählte Authentifizierungsmethode:
232 * **STORK-QAA-Level-1**: Authentifizierung mittels Benutzername / Passwort
233 * **STORK-QAA-Level-3:** Authentifizierung mittels Authega Zertifikat
234 * **STORK-QAA-Level-4**: Authentifizierung mittels nPA
235 )))
236 |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**)
237 |NPA_Address (PBA)|Adresse, wie sie auf dem NPA vermerkt ist (alles in Großbuchstaben)
238 |NPA_City (PBA)|Ort, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben)
239 |NPA_FirstName|Vorname, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben)
240 |NPA_LastName|Nachname, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben)
241 |NPA_PersonalTitle|Akademischer Titel, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben)
242 |IsIndividualPerson|Liefert den Wert **true**, wenn es sich bei den Daten aus dem Bürgerkonto um personenbezogene Daten handelt, sonst **false**.
243 |IsOrganization|Liefert den Wert **true**, wenn es sich bei den Daten aus dem Bürgerkonto um organisationsbezogene Daten handelt, sonst **false**.
244 {{/table}}
245
246 {{info}}
247 **Hinweis:**
248 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.
249 \\__Beispiel:__
250 Wenn als Suffix "**_Person2**" definiert wurde, so ergibt sich beim Vornamen der Formular-Elementname "tfAntragstellerVorname**_Person2**".
251 {{/info}}
252
253 === Darstellung des genutzten Authentifizierungsverfahren ===
254
255 {{figure image="hilfe_trustlevel_visualisierung.png"}}
256 Darstellung des verwendeten Vertrauensniveaus an der Bürgerkonto Daten Vorlage
257 {{/figure}}
258
259 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.
260
261 Für die einzelnen Vertrauensniveaus existieren folgende Beschriftungen:
262
263 * Level 1 (Authentifizierung mittels Benutzername / Passwort): **Standard**
264 * Level 3 (Authentifizierung mittels Authega Zertifikat): **Authega**
265 * Level 4 (Authentifizierung mittels nPA): **Personalausweis**
266
267 {{figure image="hilfe_trustlevel_keine_visualisierung.png"}}
268 Wenn keine visuelle Markierung gewünscht ist, so kann dies durch ein zusätzliches Attribut „noRibbon“ am Vorlagen-Fieldset unterbunden werden
269 {{/figure}}
270
271 == AKDB Postkorbanbindung in der Statusverarbeitung ==
272
273
274 Für die Anbindung zum Versand von Postkorbnachrichten wird das Aktions-Plugin **AKDB:Postkorbnachricht senden** zur Verfügung gestellt.
275 Mittels dieser Plugin-Aktion, können ähnlich einer E-Mail Aktion, Nachrichten an den Postkorb der AKDB weitergeleitet werden.
276
277 Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt die nachfolgend kurz beschrieben werden.
278
279 {{panel title="Einstellungen für Absender und Empfänger" fullwidth="true" initial="visible" triggerable="true"}}
280
281
282 {{figure image="postkorb_absender.png"}}
283 Einstellungen für Absender und Empfänger
284 {{/figure}}
285
286 ; Dienst (Pflicht)
287 : Wird als Information in der Postkorb-Ansicht im Bürgerservice-Portal verwendet.
288 ; Mandant (Pflicht)
289 : Wird als Information in der Postkorb-Ansicht im Bürgerservice-Portal verwendet.
290 ; Absender-Link
291 : 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.
292 ; Postkorb ID aus den Vorgangsdaten ermitteln?
293 : 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.
294 Bei einem AKDB Bürgerkonto-Login wird die Postkorb-ID immer mit übermittelt und standardmäßig am Formulareingang hinterlegt.
295 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.
296 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.)
297
298
299 {{/panel}}
300
301 {{panel title="Konfiguration des Nachrichteninhalts" fullwidth="true" triggerable="true"}}
302
303
304 {{figure image="postkorb_nachricht.png"}}
305 Konfiguration von Betreff, Nachrichteninhalt und Anhängen
306 {{/figure}}
307
308
309 ; Betreff (Pflicht)
310 : Nahrichtenbetreff, es werden Platzhalter unterstützt.
311 ; Inhalt (Pflicht)
312 : Nachrichtentext, es werden Platzhalter unterstützt.
313 ; Anhänge
314 : Hier können Dateien als Attachments an die Postkorb-Nachricht gehangen werden.
315 : Zur Auswahl stehen dabei:
316 :; Upload
317 :: bezieht sich auf alle Dateianhänge, die über das Formular hochgeladen wurden
318 :; Workflow
319 :: bezieht sich auf alle Dateianhänge, die über den aktuellen FORMCYCLE Workflow hochgeladen wurden.
320 :; Posteingang
321 :: bezieht sich auf alle Dateianhänge, die über das Postfach hochgeladen wurden.
322 :: Unterstützte Dateiformate sind: PDF, HTML, Plaintext, MS Word, JPEG, GIF, PNG
323
324
325 {{info}}
326 **Achtung:**
327 Die Schnittstelle zum Postkorb der AKDB unterstützt dabei maximal 20 Anhänge pro Nachricht mit je 50 MByte Maximalgröße.
328 {{/info}}
329
330 {{/panel}}
331
332 === Bedingte Ausführung der //AKDB:Postkorbnachricht senden//-Aktion ===
333
334 {{figure image="postkorb_nachricht_bedingung.png"}}
335 Konfiguration einer Bedingung für Ausführung der Aktion //AKDB~:Postkorbnachricht senden//
336 {{/figure}}
337
338 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.
339 Dies bedeutet aber auch, dass wenn in einem Formularprozess kein zwingender Bürgerkonto-Login erfolgt, die Postkorb-ID **nicht** in der Statusverarbeitung vorhanden ist.
340 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.
341
342 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.
343
344 {{code language="javascript"}}
345 REGEX([%$POSTKORB_ID%]=^.+$)
346 {{/code}}
347
348 ==== Erweitere Bedingungsprüfung bei Verwendung unterschiedlicher Login-Arten (personenbezogenes bzw. organisationsbezogenes Login) ====
349
350
351 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.
352 Im Formular müssen dann versteckte Eingabefelder mit den Element-Namen **IsIndividualPerson** und **IsOrganization** vorhanden sein.
353 (Dies ist automatisch der Fall, wenn die entsprechenden Vorlagen //Bürgerkonto personenbezogene Daten// und //Bürgerkonto organisationsbezogene Daten// verwendet werden).
354
355 Die Konfiguration einer Ausführungs-Bedingung an einer Aktion //AKDB:Postkorbnachricht senden// für eine **personenbezogene** Anmeldung wäre dann folgendermaßen:
356
357
358 {{code language="javascript"}}
359 REGEX([%IsIndividualPerson%]=true) REGEX([%$POSTKORB_ID%]=^.+$)
360 {{/code}}
361
362
363 Bei Nutzung einer **organisationsbezogenen** Anmeldung ist folgende Bedingung zu konfigurieren:
364
365
366 {{code language="javascript"}}
367 REGEX([%IsOrganization%]=true) REGEX([%$POSTKORB_ID%]=^.+$)
368 {{/code}}
369
370 {{info}}
371 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.
372 {{/info}}
373
374
375 == Versionshistorie ==
376
377 === 3.3.0 ===
378
379 * Überarbeitung der Revisionsicherheit und damit Anpassung an Weiterentwicklung in {{formcycle/}}
380 * 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
381 * Neues Replacer-Plugin ('LOGIN_PROTOCOL') für eine Ausgabe aller Anmeldedaten, welche am Vorgang hinterlegt sind.
382 * Fehlerbehebung: Ein Fehler, welcher im Zusammenhang mit dem Einsatz des Bürgerkonto-Login-Buttons bei Benutzung in einem Popup auftrat, wurde behoben.
383 * 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
384
385 === 3.2.1 ===
386
387 * 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.
388
389 === 3.2.0 ===
390
391 * Fehlerbehebung: Es wurde ein Fehler bei der Authentifizierung mittels Plugin-Authenticator behoben, der dazu führte, dass
392 das Formular mit den zurückgelieferten Nutzerdaten nicht mehr angezeigt wurde.
393 * 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.
394 (Hinweis: Formulare die auf den veralteten Vorlagen abbauen werden weiterhin unterstützt)
395 * Erweiterung der Vorlage für //personen- und organisationsbezogene Daten// um das Attribut 'IdentitaetsPruefer', welches zur Differenzierung der Art der Anmeldung innerhalb eines Vertrauensniveaus dient.
396 * Anpassung der Formular-Vorlage auf Grundlage der geänderten Nutzerdaten-Vorlage
397
398 === 3.1.0 ===
399
400 * **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
401 * Anpassung AKDB-Setup: im Bereich des Zertifikatsuploads für die Kommunikation mit dem Postkorb
402
403 === 3.0.0 ===
404
405 * **Achtung:** alle neueren Versionen des Plugins benötigen ab dieser Version mindestens {{formcycle/}} Version {{version major="7" minor="0"}}{{/version}} oder höher
406 * Postkorb-Plugin für V7-Workflow
407 * Überarbeitung Formular-Vorlage für Nutzung des V7-Workflows
408
409 === 2.18.3 ===
410
411 * 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
412 * Fehlerbehebung: Es wurden Fehler bei der Wiederanzeige von zwischengespeicherten Daten bei Kommunikation über FS behoben.
413
414 === 2.18.2 ===
415
416 * Anpassung Postkorb: Umstellung von ID auf UUID bei Dateianhängen
417
418 === 2.18.1 ===
419
420 * Fehlerbehebung: Es wurde ein Fehler, beim Zwischenspeichern von Formulardaten vor der Weiterleitung zum BK-Portal, behoben.
421
422 === 2.18.0 ===
423
424 * Erweiterung AKDB-Setup: Neuer Einrichtungsschritt für die Erhebung von Organisationsdaten für Verwaltungszwecke.
425
426 === 2.17.0 ===
427
428 * Abschließende Anpassungen für Einführung Bürgerservice-Portal 2.0:
429 ** Aktualisierung der Metadaten des Identity Providers, sowie des Postkorb-Webservice-Endpoints für die Anbindung des neuen Live-Systems
430 * Änderung im AKDB-Setup:
431 ** Anpassungen am Layout, da es bei niedrigen Auflösungen dazu kam, dass Navigations-Buttons nicht angezeigt wurden
432 ** Verbesserung der Logik für die Verbindungsprüfung bei Einrichtung der Postkorb-Anbindung
433
434 === 2.16.0 ===
435
436 * Aufnahme zusätzlicher vom Bürgerkonto übermittelter Daten. Die genaue Beschreibung dieser kann der obigen Parameter-Tabelle entnommen werden.
437 * Änderung im AKDB-Setup: Möglichkeit zur Prüfung der Erreichbarkeit des Postkorb-Webservice
438
439 === 2.15.2 ===
440
441 * Fehlerbehebung: Fehler beim Speichern eines Vorgangs, mit mindestens zwei BK-Anmeldungen, wurde behoben
442
443 === 2.15.1 ===
444
445 * Fehlerbehebung bei Kommunikation mit Postkorb-Schnittstelle
446
447 === 2.15.0 ===
448
449 * Ä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.
450 * Das Bürgerservice-Portal wurde auf Version 2.0 angehoben. Dadurch ergaben sich folgende Anpassungen, die in dieser Plugin-Version eingearbeitet wurden:
451 ** Es werden zusätzliche Daten vom Bürgerservice-Portal übermittelt. Die genaue Beschreibung dieser kann der obigen Parameter-Tabelle entnommen werden.
452 ** Anpassung des Verhaltens bei Abbruch der Authentifizierung durch den Nutzer auf Seiten des Bürgerservice-Portals
453 ** Aktualisierung der Metadaten des Identity Providers, sowie des Postkorb-Webservice-Endpoints. Jeweils für die Anbindung des Test-Systems.
454 Die Aktualisierung dieser Eigenschaften bei bestehenden Plugin-Installationen erfolgt automatisch bei Installation dieser Plugin-Version
455 * Änderung im AKDB-Setup: Überarbeitung der Einrichtungsschritte
456
457 === 2.14.2 ===
458
459 * Fehlerbehebung im Plugin zum Erzeugen der Mandant-spezifischen Ressourcen, welches beim Registrieren des Plugins ausgeführt wird.
460
461 === 2.14.1 ===
462
463 * Erweiterung des Setups zur initiale Einrichtung der AKDB Services: Möglichkeit zum Upload und Freigeben des SSL-Zertifikats für die Postkorb-Kommunikation.
464
465 === 2.13.3 ===
466
467 * 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.
468
469 === 2.13.2 ===
470
471 * Fehlerbehebung: Der Postkorb-Webservice konnte teilweise nicht initialisiert werden, da die zugehörige WSDL-Datei nicht korrekt adressiert wurde.
472 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.
473 * 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.
474
475 === 2.13.1 ===
476
477 * 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.
478
479 === 2.13.0 ===
480
481 * **Achtung:** alle neueren Versionen des Plugins benötigen ab dieser Version mindestens {{formcycle/}} Version {{version major="6" minor="6"}}{{/version}} oder höher
482 * Änderung des eingesetzten Webservice-Frameworks beim Postkorb-Service, um Lauffähigkeit ab OpenJDK Version 14 zu gewährleisten
483 * Fehlerbehebung: Fehlende Beschriftungen an den Eigenschaften für das Formular-Element //AKDB Bürgerkonto //wurde behoben
484
485 === 2.12.0 ===
486
487 * 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)
488 * 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.
489 * AKDB-Formular Vorlage angepasst (Statusverarbeitung): Veraltete Elementplatzhalter in Postkorb-Nachricht für Organisation wurden ersetzt
490
491 === 2.11.2 ===
492
493 * Fehlerbehebung: Bei anonymer Wiederanzeige von BK-Daten werden Nachname, Titel und Anrede nicht mehr fälschlicherweise auf Default-Werte zurückgesetzt und damit geleert.
494
495 === 2.11.1 ===
496
497 * 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.
498
499 === 2.11.0 ===
500
501 * Feature-Umsetzung im BK-Authenticator: Am Authenticator ist jetzt die Auswahl von Authentifizierungsverfahren, die mindestens dem Vertrauens-Level von Authega entsprechen, möglich
502 * Fehlerbehebung: Ein falsches Leeren des Feldes tfAntragstellerName beim PDF-Druck wurde behoben
503
504 === 2.10.0 ===
505
506 * **Achtung:** alle neueren Versionen des Plugins benötigen ab dieser Version mindestens {{formcycle/}} Version {{version major="6" minor="5"}}{{/version}} oder höher
507 * Anpassung Wizard für die Metadaten-Generierung: im letzten Schritt kann eine vorbefüllte Beitrittserklärung heruntergeladen werden
508 * Internes Refactoring
509 ** Deprecated Klasse //ConfigSAML// wurde entfernt
510 ** Deprecated Klasse //GenerateIdentityServiceProviderMetadataPlugin //entfernt
511 * Anpassung am Widget für den Bürgerkonto-Login-Button: Dieser wird jetzt beim PDF-Druck über den Designer standardmäßig ausgeblendet
512 * Anpassung an der AKDB-Formular Vorlage: Diese verwendet jetzt die Template-Vorlage für //personen- und organisationsbezogene Daten//
513
514 === 2.9.2 ===
515
516 * Erweiterung Template-Vorlage für //personen- und organisationsbezogene Daten//:
517 ** Auswahlmöglichkeit für ein Eingabe von personen- **oder** organisationsbezogene Daten
518 ** Eine Anzeige der Auswahlmöglichkeit erfolgt bei folgenden Fällen:
519 *** es hat KEINE Authentifizierung über das Bürgerkonto stattgefunden
520 *** es existiert ein "vorgeschaltener" Zugriffschutz (Externe Benutzer)
521
522 === 2.9.1 ===
523
524 * Fehlerbehebung in Anzeige bei Nutzung der Template-Vorlage für //personen- und organisationsbezogene Daten//:
525 ** die fehlende Anzeige des Authentifizierungsverfahren am Field-Set für die persönlichen Daten wurde beseitigt
526 ** Nach erfolgter Anmeldung werden die Eingabe-Felder für die persönlichen Daten mit einem Schreibschutz belegt
527
528 === 2.9.0 ===
529
530 * 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.
531 * 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.
532 * Vereinheitlichung der Vorlage für Organisationsdaten: Für die personenbezogenen Daten des Organisations-Vertreters werden die geänderten Parameternamen verwendet.
533 * 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.
534 * Fehlerbehebung bei Verwendung des BK-Authenticators über Frontend-Server: Initialisierung notwendiger OpenSAML-Klassen bei Aufruf über Frontend-Server hinzugefügt.
535
536 === 2.8.2 ===
537
538 * Ä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
539 * 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.
540
541 === 2.8.1 ===
542
543 * 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
544
545 === 2.8.0 ===
546
547 * Bereitstellung eines Plugin-Authenticator für AKDB-Login als "Externer Benutzer"
548 * Hinweis: Log für Authega funktioniert nicht bei Einsatz von Plugin-Authenticator
549
550 === 2.7.0 ===
551
552 * Umstellung intern genutztes SAML-Framework. Dieses wird nicht mehr durch das Plugin selbst, sondern vom {{formcycle/}}-Core zur Verfügung gestellt.
553 * **Achtung:** alle neueren Versionen des Plugins benötigen mindestens {{formcycle/}} Version {{version major="6" minor="4" patch="0"/}} oder höher
554
555 === 2.6.2 ===
556
557 * Umbenennung Menüpunkt für Metadaten-Generierung für Registrierung bei AKDB, neuer Name: "AKDB Setup"
558
559 === 2.6.1 ===
560
561 * Fehlerbehebung bei Verwendung des BK-Logins über Frontend-Server
562
563 === 2.6.0 ===
564
565 * Einbindung {{formcycle/}} Version 6.2.0
566 * Unterstützung Blanko-Druck:
567 ** Login-Button wird ausgeschlossen
568 ** Steuerfelder und Trustlevel in den Vorlagen werden standardmäßig vom Druck ausgeschlossen
569 * Login-Button um Auswahlmöglichkeit für Seitenvalidierung vor Beginn BK-Login erweitert.