AKDB: Bürgerkonto-Service-Plugin

**Hinweis für Plugin-/{{formcycle/}}-Administratoren:**

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

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)

**Achtung:**

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!

Formularvorlage //AKDB Basisdienste//

Ü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

30

Formular-Element //AKDB Bürgerkonto//

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:

; Schaltflächen Text

: 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

79

Bürgerkonto-Login als Externer Benutzer einrichten. (Schritt 1)

80

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

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.

Bürgerkonto-Login als Externer Benutzer einrichten. (Schritt 2)

92

93

94

Im nächsten Schritt muss über den Button "Konfiguration hinzufügen" eine Konfiguration hinzugefügt werden.

95

96

97

Bürgerkonto-Login als Externer Benutzer einrichten. (Schritt 3)

98

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

116

Bürgerkonto Login als Externer Benutzer am Formular freischalten.

117

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

126

Formularvorlage //AKDB Basisdienste//

127

128

129

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.

130

131

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:

XFC_METADATA.pluginResults.AKDBLoginAnalyzer

136

137

138

Die nachfolgenden Tabelle listet alle Formularfeld-Namen auf, die in einem Formular genutzt werden können, um die Daten vom Bürgerservice-Portal in Formular-Elementen anzuzeigen. Einige Informationen sind über verschiedene Parameter-Namen abrufbar (einen englisch-sprachigen und einen deutsch-sprachigen Namen), in solchen Fällen können beide Benamungen gleichwertig genutzt werden.

139

140

141

Parameter, welche nur bei einer **p**ersonen**b**ezogenen **A**nmeldung vorhanden sind, sind mit **(PBA)** und die die nur bei einer **o**rganisations**b**ezogenen **A**nmeldung vorhanden sind, mit **(OBA)** gekennzeichnet.

142

Ist keine extra Kennzeichnung vorhanden, so ist der Parameter in beiden Bereichen vorhanden.

143

144

**Achtung: **Ab Plugin-Version **2.9.0** sind im Zuge einer Vereinheitlichung der Parameter-Name für **PBA** und **OBA**, bestimmte Parameter, die bisher nur bei **PBA** vorhanden waren auch bei einer **OBA** vorhanden. Im Zuge der Abwärtskompatibilität sind die OBA-spezifischen Parameter zusätzlich noch vorhanden.

145

Die betreffenden Parameter sind in der Tabelle mit **(PBA + OBA)** gekennzeichnet.

**Hinweis für die vom Bürgerservice-Portal zurück gelieferten Daten:**

150

Bei der Authentifizierung mit eIDAS-notifizierten Identifikationsmittel gilt der Mindestdatensatz nach eIDAS-VO, daher kann es zu einem reduzierten Datensatz kommen.

151

**[[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"]]**

|=Parameter|=Beschreibung

156

|BPK|Bereichsspezifisches Personenkennzeichen (in verschlüsselter Form)

157

|BPK_Decoded|Bereichsspezifisches Personenkennzeichen (in entschlüsselter Form)

158

|PostboxId|Postkorb-ID des Nutzers. Muss bei Anbindung des Postkorbs verwendet werden.

159

|(((

160

tfAntragstellerEmail (PBA + OBA)

161

)))|Email-Adresse

162

|Gender|Anrede als numerischer Wert nach ISO 5218:2004

163

|GenderName|Lesbarer Text für Geschlechter-Code aus Attribut „gender“.

164

Mögliche Werte: //männlich//, //weiblich//

165

|(((

166

tfAntragstellerAnrede (PBA + OBA)

167

)))|Anrede, wird mit Hilfe des Geschlechter-Code aus Attribut „gender“ erzeugt.

168

Mögliche Werte: //Herr//, //Frau, Nicht bekannt//

169

|(((

170

tfAntragstellerTitel (PBA + OBA)

171

)))|Akademischer Titel

172

|(((

173

tfAntragstellerVorname (PBA + OBA)

174

)))|Vorname

175

|(((

176

tfAntragstellerName (PBA + OBA)

177

)))|Nachname

178

|(((

179

tfAntragstellerPLZ (PBA + OBA)

180

)))|Postleitzahl

181

|(((

182

tfAntragstellerAdresse (PBA + OBA)

183

)))|Adresse bestehend aus Strasse und Hausnummer

184

|(((

185

tfAntragstellerOrt (PBA + OBA)

186

)))|Ort

187

|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}})

188

|(((

189

tfAntragstellerGeburtsdatum (PBA + OBA)

190

)))|Geburtsdatum im Format: dd.MM.yyyy

191

|tfAntragstellerGeburtsname (PBA + OBA)|Geburtsname (ab Version {{version major="2" minor="15"}}{{/version}})

192

|(((

193

tfAntragstellerGeburtsort (PBA + OBA)

194

)))|Geburtsort

195

|(((

196

tfAntragstellerTelefon (PBA + OBA)

197

)))|Telefonnummer

198

|tfAntragstellerStaatsangehoerigkeit (PBA + OBA)|Staatsangehörigkeit (ab Version {{version major="2" minor="15"}}{{/version}})

199

|tfAntragstellerDeMail (PBA + OBA)|De-Mail-Adresse (ab Version {{version major="2" minor="15"}}{{/version}})

200

|tfAntragstellerEIDASAusstellerLand (PBA)|eIDAS Ausgabeland (ab Version {{version major="2" minor="15"}}{{/version}})

201

|tfOrgVertreterVorname (OBA)|Vorname der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.

202

|tfOrgVertreterName (OBA)|Nachname der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.

203

|tfOrgVertreterTitel (OBA)|Akademischer Titel der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.

204

|(((

205

tfOrgVertreterAnrede (OBA)

206

)))|(((

207

Anrede für die Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.

208

Anrede, wird mit Hilfe des Geschlechter-Code aus Attribut „gender“ erzeugt. Mögliche Werte: //Herr//, //Frau, Nicht bekannt//

209

)))

210

|tfOrgVertreterGeburtsdatum (OBA)|Akademischer Titel der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.

211

|tfOrgVertreterGeburtsort (OBA)|Geburtsort der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.

212

|tfOrgEmail (OBA)|E-Mail Adresse der angemeldeten Person, welche diese im Unternehmen hat. (Kann von der E-Mail Adresse am personenbezogenen Account abweichen.)

213

|tfOrgVertreterTelefon (OBA)|Telefonnummer der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.

214

|tfOrgStrasse (OBA)|Strasse

215

|tfOrgHausnummer (OBA)|Hausnummer

216

|tfOrgHausnummerZusatz (OBA)|Hausnummern Zusatz

217

|tfOrgAdressZusatz (OBA)|Adress-Zusatz

218

|tfOrgPLZ (OBA)|PLZ

219

|tfOrgOrt (OBA)|Ort

220

|tfOrgName (OBA)|Name der Organisation (mit Rechtsform)

221

|tfOrgID (OBA)|Organisations-ID (abgekündigt, wird zukünftig durch das organisationsspezifische Kennzeichen ersetzt)

222

|tfOrgKennzeichen (OBA)|organisationsspezifisches Kennzeichen: ersetzt zukünftig die Organisations-ID. (ab Version {{version major="2" minor="16"}}{{/version}})

223

|Rechtsform (OBA)|Rechtsform der Organisation

224

|tfOrgRegisterOrt (OBA)|Register(gerichts)-Ort

225

|tfOrgRegisterNummer (OBA)|Registernummer

226

|tfOrgUUID (OBA)|Unternehmenskonto-Handle (ab Version {{version major="2" minor="15"}}{{/version}})

227

|TrustLevel|(((

228

Vertrauensniveau, gibt Auskunft über gewählte Authentifizierungsmethode:

229

* **STORK-QAA-Level-1**: Authentifizierung mittels Benutzername / Passwort

230

* **STORK-QAA-Level-3:** Authentifizierung mittels Authega Zertifikat

231

* **STORK-QAA-Level-4**: Authentifizierung mittels nPA

232

)))

233

|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**)

234

|NPA_Address (PBA)|Adresse, wie sie auf dem NPA vermerkt ist (alles in Großbuchstaben)

235

|NPA_City (PBA)|Ort, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben)

236

|NPA_FirstName|Vorname, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben)

237

|NPA_LastName|Nachname, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben)

238

|NPA_PersonalTitle|Akademischer Titel, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben)

239

|IsIndividualPerson|Liefert den Wert **true**, wenn es sich bei den Daten aus dem Bürgerkonto um personenbezogene Daten handelt, sonst **false**.

240

|IsOrganization|Liefert den Wert **true**, wenn es sich bei den Daten aus dem Bürgerkonto um organisationsbezogene Daten handelt, sonst **false**.

241

|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.

**Hinweis:**

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.

247

\\__Beispiel:__

248

Wenn als Suffix "**_Person2**" definiert wurde, so ergibt sich beim Vornamen der Formular-Elementname "tfAntragstellerVorname**_Person2**".

249

250

251

=== Darstellung des genutzten Authentifizierungsverfahren ===

252

253

254

Darstellung des verwendeten Vertrauensniveaus an der Bürgerkonto Daten Vorlage

255

256

257

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.

258

259

Für die einzelnen Vertrauensniveaus existieren folgende Beschriftungen:

260

261

* Level 1 (Authentifizierung mittels Benutzername / Passwort): **Standard**

262

* Level 3 (Authentifizierung mittels Authega Zertifikat): **Zertifikat**

263

* Level 4 (Authentifizierung mittels nPA): **Personalausweis**

264

265

266

Wenn keine visuelle Markierung gewünscht ist, so kann dies durch ein zusätzliches Attribut „noRibbon“ am Vorlagen-Fieldset unterbunden werden

267

268

269

==== Anpassungen der Darstellung aufgrund reduzierter Nutzerdaten ====

270

271

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.

272

273

274

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.

275

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.

276

277

Zusätzlich werden die Felder bei Wiederanzeige durch kleine Icons gekennzeichnet, wodurch auf einem Blick ersichtlich wird, aus welcher Quelle die Anmeldeinformationen entstammen.

278

279

* [[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

280

* [[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

281

282

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:

283

284

* //verify_l1//: Kennzeichnet ein Element dessen Inhaltswert einen Level 1 Vertrauensniveaus (Authentifizierung mittels Benutzername / Passwort) entspricht.

285

* //verify_l3//: Kennzeichnet ein Element dessen Inhaltswert einen Level 3 Vertrauensniveaus (Authentifizierung mittels Zertifikat) entspricht.

286

* //verify_l4//: Kennzeichnet ein Element dessen Inhaltswert einen Level 4 Vertrauensniveaus (Authentifizierung mittels nPA oder eIDAS Identifikationsmittel) entspricht.

287

* //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.

288

289

290

Wenn keine visuelle Markierung der Formularelemente gewünscht ist, so kann dies durch ein zusätzliches Attribut „noVerifyInfo“ am Vorlagen-Fieldset unterbunden werden

291

292

293

== AKDB Postkorbanbindung in der Statusverarbeitung ==

294

295

296

Für die Anbindung zum Versand von Postkorbnachrichten wird das Aktions-Plugin **AKDB:Postkorbnachricht senden** zur Verfügung gestellt.

297

Mittels dieser Plugin-Aktion, können ähnlich einer E-Mail Aktion, Nachrichten an den Postkorb der AKDB weitergeleitet werden.

298

299

Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt die nachfolgend kurz beschrieben werden.

300

301

{{panel title="Einstellungen für Absender und Empfänger" fullwidth="true" initial="visible" triggerable="true"}}

Einstellungen für Absender und Empfänger

; Dienst (Pflicht)

: Wird als Information in der Postkorb-Ansicht im Bürgerservice-Portal verwendet.

310

; Mandant (Pflicht)

311

: Wird als Information in der Postkorb-Ansicht im Bürgerservice-Portal verwendet.

312

; Absender-Link

313

: 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.

314

; Postkorb ID aus den Vorgangsdaten ermitteln?

315

: 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.

316

Bei einem AKDB Bürgerkonto-Login wird die Postkorb-ID immer mit übermittelt und standardmäßig am Formulareingang hinterlegt.

317

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.

318

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.)

{{panel title="Konfiguration des Nachrichteninhalts" fullwidth="true" triggerable="true"}}

Konfiguration von Betreff, Nachrichteninhalt und Anhängen

; Betreff (Pflicht)

: Nahrichtenbetreff, es werden Platzhalter unterstützt.

333

; Inhalt (Pflicht)

334

: Nachrichtentext, es werden Platzhalter unterstützt.

335

; Anhänge

336

: Hier können Dateien als Attachments an die Postkorb-Nachricht gehangen werden.

337

: Zur Auswahl stehen dabei:

338

:; Upload

339

:: bezieht sich auf alle Dateianhänge, die über das Formular hochgeladen wurden

340

:; Workflow

341

:: bezieht sich auf alle Dateianhänge, die über den aktuellen FORMCYCLE Workflow hochgeladen wurden.

342

:; Posteingang

343

:: bezieht sich auf alle Dateianhänge, die über das Postfach hochgeladen wurden.

344

:: Unterstützte Dateiformate sind: PDF, HTML, Plaintext, MS Word, JPEG, GIF, PNG

**Achtung:**

Die Schnittstelle zum Postkorb der AKDB unterstützt dabei maximal 20 Anhänge pro Nachricht mit je 50 MByte Maximalgröße.

=== Bedingte Ausführung der //AKDB:Postkorbnachricht senden//-Aktion ===

355

356

357

Konfiguration einer Bedingung für Ausführung der Aktion //AKDB~:Postkorbnachricht senden//

358

359

360

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.

361

Dies bedeutet aber auch, dass wenn in einem Formularprozess kein zwingender Bürgerkonto-Login erfolgt, die Postkorb-ID **nicht** in der Statusverarbeitung vorhanden ist.

362

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.

363

364

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.

365

366

367

REGEX([%$POSTKORB_ID%]=^.+$)

368

369

370

==== Erweitere Bedingungsprüfung bei Verwendung unterschiedlicher Login-Arten (personenbezogenes bzw. organisationsbezogenes Login) ====

371

372

373

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.

374

Im Formular müssen dann versteckte Eingabefelder mit den Element-Namen **IsIndividualPerson** und **IsOrganization** vorhanden sein.

375

376

Die Konfiguration einer Ausführungs-Bedingung an einer Aktion //AKDB:Postkorbnachricht senden// für eine **personenbezogene** Anmeldung wäre dann folgendermaßen:

REGEX([%IsIndividualPerson%]=true) REGEX([%$POSTKORB_ID%]=^.+$)

Bei Nutzung einer **organisationsbezogenen** Anmeldung ist folgende Bedingung zu konfigurieren:

REGEX([%IsOrganization%]=true) REGEX([%$POSTKORB_ID%]=^.+$)

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.

== Versionshistorie ==

397

398

(% class="wikigeneratedid" %)

399

=== 3.5.3 ===

400

401

* Fehlerbehebung: Es wurde ein Sicherheitsproblem behoben, welches bei Laden von zwischengespeicherten Formulardaten auftreten kann.

=== 3.5.2 ===

* 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.

406

* Fehlerbehebung: Bei Verwendung mehrerer Anmeldungen innerhalb eines Formulars und damit unterschiedlichen Bürgerdaten-Suffix, kam es zu falschen Formatierungen der Datenfelder. Dies wurde behoben.

=== 3.5.1 ===

* 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.

=== 3.5.0 ===

* 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.

415

* Ü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

416

* Fehlerbehebung: Fehlendes URL-Encoding eines Parameters führte dazu, dass Formular nach AKDB-Login nicht mehr gefunden wurde. Dies wurde behoben.

417

* Anpassung AKDB-Setup: beim Prüfung der Postkorb-Verbindung werden jetzt separat Zertifikat und Passwort auf Korrektheit geprüft und im Fehlerfall extra ausgewiesen.

=== 3.4.0 ===

* Konfigurative Möglichkeit eines URL-Rewritings am Login-Button auf die Assertion Consumer Service URL aus der Bürgerservice-Portal-Registrierung

422

* 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.

=== 3.3.1 ===

* 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.

=== 3.3.0 ===

* Überarbeitung der Revisionsicherheit und damit Anpassung an Weiterentwicklung in {{formcycle/}}

431

* 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

432

* Neues Replacer-Plugin ('LOGIN_PROTOCOL') für eine Ausgabe aller Anmeldedaten, welche am Vorgang hinterlegt sind.

433

* Fehlerbehebung: Ein Fehler, welcher im Zusammenhang mit dem Einsatz des Bürgerkonto-Login-Buttons bei Benutzung in einem Popup auftrat, wurde behoben.

434

* 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

=== 3.2.1 ===

* 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.

=== 3.2.0 ===

* Fehlerbehebung: Es wurde ein Fehler bei der Authentifizierung mittels Plugin-Authenticator behoben, der dazu führte, dass

443

das Formular mit den zurückgelieferten Nutzerdaten nicht mehr angezeigt wurde.

444

* 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.

445

(Hinweis: Formulare die auf den veralteten Vorlagen abbauen werden weiterhin unterstützt)

446

* Erweiterung der Vorlage für //personen- und organisationsbezogene Daten// um das Attribut 'IdentitaetsPruefer', welches zur Differenzierung der Art der Anmeldung innerhalb eines Vertrauensniveaus dient.

447

* Anpassung der Formular-Vorlage auf Grundlage der geänderten Nutzerdaten-Vorlage

=== 3.1.0 ===

* **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

452

* Anpassung AKDB-Setup: im Bereich des Zertifikatsuploads für die Kommunikation mit dem Postkorb

=== 3.0.0 ===

* **Achtung:** alle neueren Versionen des Plugins benötigen ab dieser Version mindestens {{formcycle/}} Version {{version major="7" minor="0"}}{{/version}} oder höher

457

* Postkorb-Plugin für V7-Workflow

458

* Überarbeitung Formular-Vorlage für Nutzung des V7-Workflows

=== 2.18.3 ===

* 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

463

* Fehlerbehebung: Es wurden Fehler bei der Wiederanzeige von zwischengespeicherten Daten bei Kommunikation über FS behoben.

=== 2.18.2 ===

* Anpassung Postkorb: Umstellung von ID auf UUID bei Dateianhängen

=== 2.18.1 ===

* Fehlerbehebung: Es wurde ein Fehler, beim Zwischenspeichern von Formulardaten vor der Weiterleitung zum BK-Portal, behoben.

=== 2.18.0 ===

* Erweiterung AKDB-Setup: Neuer Einrichtungsschritt für die Erhebung von Organisationsdaten für Verwaltungszwecke.

=== 2.17.0 ===

* Abschließende Anpassungen für Einführung Bürgerservice-Portal 2.0:

480

** Aktualisierung der Metadaten des Identity Providers, sowie des Postkorb-Webservice-Endpoints für die Anbindung des neuen Live-Systems

481

* Änderung im AKDB-Setup:

482

** Anpassungen am Layout, da es bei niedrigen Auflösungen dazu kam, dass Navigations-Buttons nicht angezeigt wurden

483

** Verbesserung der Logik für die Verbindungsprüfung bei Einrichtung der Postkorb-Anbindung

=== 2.16.0 ===

* Aufnahme zusätzlicher vom Bürgerkonto übermittelter Daten. Die genaue Beschreibung dieser kann der obigen Parameter-Tabelle entnommen werden.

488

* Änderung im AKDB-Setup: Möglichkeit zur Prüfung der Erreichbarkeit des Postkorb-Webservice

=== 2.15.2 ===

* Fehlerbehebung: Fehler beim Speichern eines Vorgangs, mit mindestens zwei BK-Anmeldungen, wurde behoben

=== 2.15.1 ===

* Fehlerbehebung bei Kommunikation mit Postkorb-Schnittstelle

=== 2.15.0 ===

* Ä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.

501

* Das Bürgerservice-Portal wurde auf Version 2.0 angehoben. Dadurch ergaben sich folgende Anpassungen, die in dieser Plugin-Version eingearbeitet wurden:

502

** Es werden zusätzliche Daten vom Bürgerservice-Portal übermittelt. Die genaue Beschreibung dieser kann der obigen Parameter-Tabelle entnommen werden.

503

** Anpassung des Verhaltens bei Abbruch der Authentifizierung durch den Nutzer auf Seiten des Bürgerservice-Portals

504

** Aktualisierung der Metadaten des Identity Providers, sowie des Postkorb-Webservice-Endpoints. Jeweils für die Anbindung des Test-Systems.

505

Die Aktualisierung dieser Eigenschaften bei bestehenden Plugin-Installationen erfolgt automatisch bei Installation dieser Plugin-Version

506

* Änderung im AKDB-Setup: Überarbeitung der Einrichtungsschritte

=== 2.14.2 ===

* Fehlerbehebung im Plugin zum Erzeugen der Mandant-spezifischen Ressourcen, welches beim Registrieren des Plugins ausgeführt wird.

=== 2.14.1 ===

* Erweiterung des Setups zur initiale Einrichtung der AKDB Services: Möglichkeit zum Upload und Freigeben des SSL-Zertifikats für die Postkorb-Kommunikation.

=== 2.13.3 ===

* 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.

=== 2.13.2 ===

* Fehlerbehebung: Der Postkorb-Webservice konnte teilweise nicht initialisiert werden, da die zugehörige WSDL-Datei nicht korrekt adressiert wurde.

523

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.

524

* 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.

=== 2.13.1 ===

* 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.

=== 2.13.0 ===

* **Achtung:** alle neueren Versionen des Plugins benötigen ab dieser Version mindestens {{formcycle/}} Version {{version major="6" minor="6"}}{{/version}} oder höher

533

* Änderung des eingesetzten Webservice-Frameworks beim Postkorb-Service, um Lauffähigkeit ab OpenJDK Version 14 zu gewährleisten

534

* Fehlerbehebung: Fehlende Beschriftungen an den Eigenschaften für das Formular-Element //AKDB Bürgerkonto //wurde behoben

=== 2.12.0 ===

* 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)

539

* 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.

540

* AKDB-Formular Vorlage angepasst (Statusverarbeitung): Veraltete Elementplatzhalter in Postkorb-Nachricht für Organisation wurden ersetzt

=== 2.11.2 ===

* Fehlerbehebung: Bei anonymer Wiederanzeige von BK-Daten werden Nachname, Titel und Anrede nicht mehr fälschlicherweise auf Default-Werte zurückgesetzt und damit geleert.

=== 2.11.1 ===

* 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.

=== 2.11.0 ===

* Feature-Umsetzung im BK-Authenticator: Am Authenticator ist jetzt die Auswahl von Authentifizierungsverfahren, die mindestens dem Vertrauens-Level von Authega entsprechen, möglich

553

* Fehlerbehebung: Ein falsches Leeren des Feldes tfAntragstellerName beim PDF-Druck wurde behoben

=== 2.10.0 ===

* **Achtung:** alle neueren Versionen des Plugins benötigen ab dieser Version mindestens {{formcycle/}} Version {{version major="6" minor="5"}}{{/version}} oder höher

558

* Anpassung Wizard für die Metadaten-Generierung: im letzten Schritt kann eine vorbefüllte Beitrittserklärung heruntergeladen werden

559

* Internes Refactoring

560

** Deprecated Klasse //ConfigSAML// wurde entfernt

561

** Deprecated Klasse //GenerateIdentityServiceProviderMetadataPlugin //entfernt

562

* Anpassung am Widget für den Bürgerkonto-Login-Button: Dieser wird jetzt beim PDF-Druck über den Designer standardmäßig ausgeblendet

563

* Anpassung an der AKDB-Formular Vorlage: Diese verwendet jetzt die Template-Vorlage für //personen- und organisationsbezogene Daten//

=== 2.9.2 ===

* Erweiterung Template-Vorlage für //personen- und organisationsbezogene Daten//:

568

** Auswahlmöglichkeit für ein Eingabe von personen- **oder** organisationsbezogene Daten

569

** Eine Anzeige der Auswahlmöglichkeit erfolgt bei folgenden Fällen:

570

*** es hat KEINE Authentifizierung über das Bürgerkonto stattgefunden

571

*** es existiert ein "vorgeschaltener" Zugriffschutz (Externe Benutzer)

=== 2.9.1 ===

* Fehlerbehebung in Anzeige bei Nutzung der Template-Vorlage für //personen- und organisationsbezogene Daten//:

576

** die fehlende Anzeige des Authentifizierungsverfahren am Field-Set für die persönlichen Daten wurde beseitigt

577

** Nach erfolgter Anmeldung werden die Eingabe-Felder für die persönlichen Daten mit einem Schreibschutz belegt

=== 2.9.0 ===

* 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.

582

* 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.

583

* Vereinheitlichung der Vorlage für Organisationsdaten: Für die personenbezogenen Daten des Organisations-Vertreters werden die geänderten Parameternamen verwendet.

584

* 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.

585

* Fehlerbehebung bei Verwendung des BK-Authenticators über Frontend-Server: Initialisierung notwendiger OpenSAML-Klassen bei Aufruf über Frontend-Server hinzugefügt.

=== 2.8.2 ===

* Ä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

590

* 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.

=== 2.8.1 ===

* 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

=== 2.8.0 ===

* Bereitstellung eines Plugin-Authenticator für AKDB-Login als "Externer Benutzer"

599

* Hinweis: Log für Authega funktioniert nicht bei Einsatz von Plugin-Authenticator

=== 2.7.0 ===

* Umstellung intern genutztes SAML-Framework. Dieses wird nicht mehr durch das Plugin selbst, sondern vom {{formcycle/}}-Core zur Verfügung gestellt.

604

* **Achtung:** alle neueren Versionen des Plugins benötigen mindestens {{formcycle/}} Version {{version major="6" minor="4" patch="0"/}} oder höher

=== 2.6.2 ===

* Umbenennung Menüpunkt für Metadaten-Generierung für Registrierung bei AKDB, neuer Name: "AKDB Setup"

=== 2.6.1 ===

* Fehlerbehebung bei Verwendung des BK-Logins über Frontend-Server

=== 2.6.0 ===

* Einbindung {{formcycle/}} Version 6.2.0

617

* Unterstützung Blanko-Druck:

618

** Login-Button wird ausgeschlossen

619

** Steuerfelder und Trustlevel in den Vorlagen werden standardmäßig vom Druck ausgeschlossen

620

* Login-Button um Auswahlmöglichkeit für Seitenvalidierung vor Beginn BK-Login erweitert.

Wiki-Quellcode von AKDB: Bürgerkonto-Service-Plugin