AKDB: Bürgerkonto-Service-Plugin

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

3

4

**Hinweis zur Inbetriebnahme des Plugins:**

5

Im Download-Ordner der jeweilige Plugin-Version befindet sich eine Anleitung zur initialen Inbetriebnahme, sowie zu weiter reichenden Information die den allgemeinen Betrieb dieses Plugins betreffen.

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

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

28

Einstellungen am Formular-Element //AKDB Bürgerkonto// bis Version {{version major="3" minor="6"}}{{/version}}

Einstellungen am Formular-Element //AKDB Bürgerkonto// ab Version {{version major="3" minor="6"}}{{/version}}

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

42

; Login im Popup

43

: Wenn aktiviert, wird die Login-Seite des Bürgerservice-Portals in einem Popup geöffnet, ansonst erfolgt die Anzeige in der gleichen Seite.

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

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.

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

66

: Hier kann das dem Nutzer zur Verfügung stehende Authentifizierungsverfahren eingeschränkt werden.

67

: Es gibt folgende Auswahlmöglichkeiten:

68

:; keine Einschränkung

69

:: Login mittels Passwort, Authega-Zertifikat oder Personalausweis steht zur Auswahl

70

:; Authega

71

:: Nur die Authentifizierung mittels Authega-Zertifikat steht zur Auswahl

72

:; Authega oder Personalausweis

73

:: Login mittels Authega-Zertifikat oder Personalausweis steht zur Auswahl

74

:; Personalausweis

75

:: nur Authentifizierung mittels Personalausweis steht zur Auswahl

76

; Einschränkung der Authentisierungsverfahren (Eigenschaft steht ab Version {{version major="3" minor="6"}}{{/version}} zur Verfügung)

77

: Über diese Checkbox-Auswahl kann das dem Nutzer zur Verfügung stehende Authentifizierungsverfahren eingeschränkt werden.

78

: Ist nichts ausgewählt, erfolgt keine Einschränkung.

79

:; Benutzername

80

:: Authentifizierung erfolgt über Login / Passwort

81

:; Authega-Zertifikat

82

:; Elster-Zertifikat

83

:; FINK

84

:: Authentifizierung erfolgt über ein Identifikationsmittel aus dem Portfolio des //Föderierten Identitätsmanagements Interoperable Nutzerkonten//

85

:; eID (Personalausweis)

86

:; eIDAS

87

:: Authentifizierung mittels Identifikationsmittels nach eIDAS-Verordnung (//electronic IDentification, Authentication and Trust Services//)

88

; Postkorbversand obligatorisch

89

: Diese Einstellung ermöglich es die Postkorb-ID als verpflichtendes Rückgabe-Attribut zu kennzeichnen.

90

: Auf Seiten der AKDB werden dann alle Authentifizierungsarten, die keinen Postkorbversand ermöglichen, für den Nutzer ausgeblendet.

91

; Einschränkung der angeforderten Eigenschaften (Eigenschaft steht ab Version {{version major="3" minor="7"}}{{/version}} zur Verfügung)

92

: Über diese Checkbox-Auswahl kann der Nutzer die zurück gelieferten Eigenschaften einer erfolgreichen Authentifizierung einschränken.

93

: Damit wird dem Grundsatz der Datensparsamkeit der DSGVO (Datenschutz-Grundverordnung) entsprochen. Sind beispielsweise nur der Name und der Vorname einer Person in einem Formularprozess notwendig,

94

: so sind nur die entsprechenden Felder in dieser Auswahlliste zu selektieren.

95

: Ist nichts ausgewählt, erfolgt keine Einschränkung und alle möglichen Eigenschaften werden vom Bürgerservice-Portal angefordert.

96

97

== Einbindung des Bürgerkonto Logins als Externer Benutzer ==

98

99

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

100

101

=== Konfiguration eines Externen Benutzers für das Bürgerkonto Login ===

102

103

104

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

105

106

107

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.

108

109

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.

110

111

112

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)

117

118

119

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

120

121

122

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

123

124

125

Im letzten Schritt besteht die Möglichkeit die Konfiguration individuell anzupassen.

126

Dazu können folgende Einstellungen getroffen werden:

; LoginTyp

: Mit dieser Einstellung lassen sich die Arten der zurück gelieferten Daten festlegen.

132

: Ist als Wert **Person** definiert, so können nur personenbezogene Daten zurückgeliefert werden.

133

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

134

: Ist dieser Parameter nicht konfiguriert, so kann der Nutzer selbst bestimmen, welche Datenart (personen- oder organisationsbezogen) er zurück liefern möchte.

135

; --AuthTyp-- (wird ab Version {{version major="3" minor="6"}}{{/version}}nicht mehr unterstützt)

136

: Über diese Einstellung kann das geforderte Authentisierungsverfahren festgelegt werden.

137

: Entweder mit Authega-Zertifikat (Wert: **Authega**) oder Personalausweis (Wert: **NPA**).

138

: Ist nichts gesetzt oder das Attribut nicht vorhanden, so werden dem Nutzer alle möglichen Authentisierungsverfahren zur Auswahl angeboten.

139

; LoginMethod (ersetzt die Eigenschaft AuthTyp ab Version {{version major="3" minor="6"}}{{/version}})

140

: Über diese Einstellung kann das geforderte Authentisierungsverfahren eingeschränkt werden.

141

: Es können dabei ein oder mehrere Werte (mit Komma getrennt) der folgenden Auflistung angegeben werden:

:; Benutzername

:; Authega

:; Elster

:; FINK

:; eID

:; eIDAS

: Ist kein Wert gesetzt, erfolgt keine Einschränkung der Authentisierungsverfahren und dem Nutzer

149

: werden alle vom Identity-Provider zur Verfügung gestellten Anmeldeverfahren zur Auswahl angezeigt.

150

; PflichtElemente (ab Version {{version major="3" minor="6"}}{{/version}})

151

: Über diese Eigenschaft können Attribute als verpflichtende Nutzereigenschaften angefordert werden.

152

: Alle Authentisierungsverfahren, welche die geforderten Attribute nicht erfüllen, werden dadurch ausgeblendet.

153

: Sofern der Formular-Workflow beispielsweise die Kommunikation mit dem Postkorb zwingend erfordert,

154

: kann hier der Wert **Postkorb** angegeben werden, wodurch das Ausblenden der temporären Anmeldung erreicht wird.

155

: Als Werte können können folgende Begriffe angegeben werden (Bei mehreren Werten sind diese durch Komma zu trennen):

156

:; PIN

157

:: In diesem Fall wird die sektor-spezifische Personen-Identifikations-Nummer (ssPIN) angefordert

158

:; Postkorb

159

:: In diesem Fall wird die Postkorb-Id als verpflichtender Wert angefordert, sodass im Workflow

160

:: die Voraussetzungen für den Versand einer Nachricht an den Postkorb des Nutzers gegeben sind.

161

162

=== Bürgerkonto Login als Formularanmeldung einrichten ===

163

164

165

Bürgerkonto Login als Externer Benutzer am Formular freischalten.

166

167

168

Um das Bürgerkonto-Login über einen [[Externen Benutzer>>doc:Formcycle.UserInterface.UserSettings.ExternalUsers.WebHome||target="_blank"]] am jeweiligen Formular zu ermöglichen,

169

muss dieses als [[Formularanmeldung>>doc:Formcycle.UserInterface.MyForms.Access||target="_blank"]] am Formular hinterlegt sein.

170

171

172

== Designer-Element: Bürgerkonto Daten Vorlage ==

173

174

175

Formularvorlage //AKDB Basisdienste//

176

177

178

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.

179

180

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

185

186

187

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.

188

189

190

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.

191

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

192

193

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

194

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

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

199

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

200

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

205

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

206

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

207

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

208

|(((

209

tfAntragstellerEmail (PBA + OBA)

210

)))|Email-Adresse

211

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

212

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

213

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

214

|(((

215

tfAntragstellerAnrede (PBA + OBA)

216

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

217

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

218

|(((

219

tfAntragstellerTitel (PBA + OBA)

220

)))|Akademischer Titel

221

|(((

222

tfAntragstellerVorname (PBA + OBA)

223

)))|Vorname

224

|(((

225

tfAntragstellerName (PBA + OBA)

226

)))|Nachname

227

|(((

228

tfAntragstellerPLZ (PBA + OBA)

229

)))|Postleitzahl

230

|(((

231

tfAntragstellerAdresse (PBA + OBA)

232

)))|Adresse bestehend aus Strasse und Hausnummer

233

|(((

234

tfAntragstellerOrt (PBA + OBA)

235

)))|Ort

236

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

237

|(((

238

tfAntragstellerGeburtsdatum (PBA + OBA)

239

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

240

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

241

|(((

242

tfAntragstellerGeburtsort (PBA + OBA)

243

)))|Geburtsort

244

|(((

245

tfAntragstellerTelefon (PBA + OBA)

246

)))|Telefonnummer

247

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

248

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

249

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

250

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

251

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

252

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

253

|(((

254

tfOrgVertreterAnrede (OBA)

255

)))|(((

256

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

257

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

258

)))

259

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

260

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

261

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

262

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

263

|tfOrgStrasse (OBA)|Strasse

264

|tfOrgHausnummer (OBA)|Hausnummer

265

|tfOrgHausnummerZusatz (OBA)|Hausnummern Zusatz

266

|tfOrgAdressZusatz (OBA)|Adress-Zusatz

267

|tfOrgPLZ (OBA)|PLZ

268

|tfOrgOrt (OBA)|Ort

269

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

270

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

271

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

272

|Rechtsform (OBA)|Rechtsform der Organisation

273

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

274

|tfOrgRegisterNummer (OBA)|Registernummer

275

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

276

|TrustLevel|(((

277

Vertrauensniveau, gibt Auskunft über gewählte Authentifizierungsmethode:

278

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

279

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

280

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

281

)))

282

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

283

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

284

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

285

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

286

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

287

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

288

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

289

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

290

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

296

\\__Beispiel:__

297

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

298

299

300

=== Darstellung des genutzten Authentifizierungsverfahren ===

301

302

303

Darstellung des verwendeten Vertrauensniveaus an der Bürgerkonto Daten Vorlage

304

305

306

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.

307

308

Für die einzelnen Vertrauensniveaus existieren folgende Beschriftungen:

309

310

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

311

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

312

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

313

314

315

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

316

317

318

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

319

320

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.

321

322

323

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.

324

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.

325

326

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

327

328

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

329

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

330

331

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:

332

333

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

334

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

335

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

336

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

337

338

339

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

340

341

342

== AKDB Postkorbanbindung in der Statusverarbeitung ==

343

344

345

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

346

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

347

348

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

349

350

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

Einstellungen für Absender und Empfänger in V6 Formularen

Einstellungen für Absender und Empfänger in V7 Formularen

359

360

361

; Mandant (ab Version {{version major="3" minor="6"}}{{/version}} kein Pflichtfeld)

362

: Wird als Information in der Postkorb-Ansicht im Bürgerservice-Portal verwendet. Ist an dieser Stelle kein Wert konfiguriert, wird die globale Einstellungen aus den Eigenschaften des Plugins verwendet.

363

; Dienst (ab Version {{version major="3" minor="6"}}{{/version}} kein Pflichtfeld)

364

: Wird als Information in der Postkorb-Ansicht im Bürgerservice-Portal verwendet. Ist an dieser Stelle kein Wert konfiguriert, wird die globale Einstellungen aus den Eigenschaften des Plugins verwendet.

365

; Absender-Link

366

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

367

; Vertrauensniveau der Anmeldung für Zugriff auf Postkorb-Nachricht weiterreichen? (verfügbar ab Version {{version major="3" minor="6"}}{{/version}} im V7 Formular Workflow)

368

: Über diese Option können Sie festlegen, ob das Vertrauensniveau der Anmeldung (wenn dies ermittelt werden kann)

369

: für den Zugriff auf die Postkorb-Nachricht weitergereicht werden soll.

370

: Wenn kein Vertrauensniveau aus den Anmeldedaten ermittelt werden kann, wird das niedrigste Vertrauensniveau gesetzt,

371

: um einen Zugriff auf die Nachricht im Postfach der AKDB zu ermöglichen.

372

; Postkorb ID aus den Vorgangsdaten ermitteln?

373

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

374

Wird bei einem AKDB Bürgerkonto-Login die Postkorb-ID mit übermittelt, so wird diese standardmäßig am Formulareingang hinterlegt.

375

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.

376

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 in V6 Formularen

Konfiguration von Betreff, Nachrichteninhalt und Anhängen in V7 Formularen

; Betreff (Pflicht)

: Nahrichtenbetreff, es werden Platzhalter unterstützt.

394

; Inhalt (Pflicht)

395

: Nachrichtentext, es werden Platzhalter unterstützt.

396

; Anhänge

397

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

398

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

399

: Zur Auswahl stehen dabei:

400

: (Auswahlmöglichkeiten in V6-Formularen)

401

:; Upload

402

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

403

:; Workflow

404

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

405

:; Posteingang

406

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

407

: (Auswahlmöglichkeiten in V7-Formularen)

408

:; Dateien aus vorherigen Aktionen

409

:: Eine Liste mit Dateien, von Datei-bereitstellenden Aktionen, die der Postkorb-Aktion vorangestellt sind.

410

:; Mandantdateien

411

:: Liefert eine Auswahlliste über alle Datei-Ressourcen am Mandanten

412

:; Formulardateien

413

:: Liefert eine Auswahlliste über alle Datei-Ressourcen, welche am Formular-Projekt hinterlegt sind.

414

:; Externe Ressourcen-URL

415

:: Dateien die über externe Quellen (HTTP-Requests) ermittelt werden können.

416

:; Vorgangsanhänge mittels Dateinamen suchen

417

:: Eine Suche innerhalb von Dateinamen mittels übereinstimmenden Suchbegriffs. Es kann dabei mittels Filter eingegrenzt werden, innerhalb welcher Datei-Quellen die Suche ausgeführt wird (Dateien aus Uploads, Datei aus der Statusverarbeitung, Dateien aus dem Posteingang)

**Achtung:**

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

422

423

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.

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

429

430

431

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

432

433

434

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.

435

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

436

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.

437

438

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.

439

440

441

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

442

443

444

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

445

446

447

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.

448

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

449

450

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

=== 3.7.0 ===

* Erweiterungen / Anpassungen aufgrund von Schnittstellenanpassungen im Bürgerservice-Portal der AKDB:

475

** Möglichkeit zur Einschränkung der angeforderten Nutzerdaten am BK-Login-Button, sowie in der Plugin-Authenticator Konfiguration.

=== 3.6.2 ===

* Fehlerbehebung: Bei Verwendung der Datenvorlage für //personen- und organisationsbezogene Daten // im Designer wurde nur das erste Element im Container angezeigt. Dies wurde behoben. Der Fehler tritt ab {{formcycle/}} Version {{version major="7" patch="11"}}{{/version}}auf.

=== 3.6.1 ===

* Fehlerbehebung: Beim Drucken eines Formulars mit Anmeldinformationen über den Print-Service erfolgte keine Darstellung des genutzten Authentifizierungsverfahren im erzeugten PDF. Dies wurde behoben.

484

* Fehlerbehebung: URL-Rewriting am Login-Button wurde nicht angewendet, wenn hinterlegte Mandant-BaseURL der URL in der SAML-Konfiguration entsprach, obwohl Formular aufgrund eines verwendeten Proxy-Servers über abweichenden Aufruf-URL verwies. Dies wurde angepasst.

=== 3.6.0 ===

* Erweiterungen / Anpassungen aufgrund von Schnittstellenanpassungen im Bürgerservice-Portal der AKDB:

489

** Möglichkeit zur Anforderung von Pflicht-Attributen (Postkorb-ID)

490

** Umstellung der Auswahlmöglichkeiten für das geforderte Authentifizierungsverfahren auf eine weiter reichende Auswahl (+Migration bestehender Konfigurationen am BK-Login-Button)

491

* Anpassung Postkorb-Aktion: Im Bereich des Absenders sind //Dienst //und //Mandant //keine Pflichtfelder mehr. Wenn Sie nicht definiert werden, werden die globalen Einstellungen

492

aus den Plugin-Properties herangezogen.

493

* Erweiterung Postkorb-Aktion: Im Bereich des Empfängers kann jetzt konfiguriert werden, dass das Vertrauensniveau der Anmeldung für den Zugriff auf die Nachricht im AKDB-Postfach mitgegeben wird.

494

* Anpassung AKDB-Vorlage: Anpassung der Verlage, da im Bereich des Absenders Dienst und Mandant keine Pflichtfelder mehr repräsentieren.

495

* Anpassung AKDB-Setup: Hinweis auf freizugebende URL's (Firewall-Einstellungen) hinzugefügt, Konfigurationsmöglichkeit für Proxy-Server-Einstellungen

496

* Fehlerbehebung: Fehlerbehandlung im Plugin-Action-Servlet 'AKDBLogin' angepasst

=== 3.5.13 ===

* Fehlerbehebung: Behebt einen Fehler, welcher im Zusammenhang mit Ajax-Uploads und dem Absenden eines Formulars ab {{formcycle/}} Version {{version major="7" patch="11"}}{{/version}} steht.

=== 3.5.12 ===

* Erweiterung von Log-Ausgaben innerhalb der Postkorb-Kommunikation zum Zwecke der Fehleranalyse.

=== 3.5.11 ===

* Fehlerbehebung: Im Zusammenspiel mit der {{formcycle/}} Version {{version major="7" patch="10"}}{{/version}}konnten Zertifikatsdateien nicht über das AKDB Setup hochgeladen werden. Dieser Fehler wurde behoben.

=== 3.5.10 ===

* Fehlerbehebung: JavaScript für Datenvorlage wurde angepasst um eine zusätzliche Validierungsroutine für die Elemente innerhalb der Vorlage. Diese Validierung wird ausgeführt, wenn die Auswahl 'Privatperson / Organisation' geändert wurde.

=== 3.5.9 ===

* Fehlerbehebung: JavaScript für Datenvorlage wurde angepasst, sodass sich ein Ändern der Steuerfelder 'IsOrganization' und 'IsIndividualPerson' auf alle Elemente innerhalb der Vorlage auswirken kann, wenn diese entsprechend Bedingungen ausweisen.

=== 3.5.8 ===

* Fehlerbehebung: JavaScript für Datenvorlage wurde angepasst, sodass bei Ausblenden von Organisationsdaten, diese geleert werden, wenn dies im Designer konfiguriert ist.

=== 3.5.7 ===

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

525

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

=== 3.5.6 ===

* Fehlerbehebung: Es wurde ein Fehler behoben, welcher bei der Wiederanzeige von Organisations-Adressdaten aufgetreten ist. Teilweise waren die Adressdaten unvollständig.

=== 3.5.5 ===

* Fehlerbehebung: Es wurde ein JS-Fehler behoben, der entstand, wenn das "TrustLevel"-Feld außerhalb der Daten-Vorlage verwendet wurde.

534

* Fehlerbehebung: Bei einer NPA-Anmeldung fehlten die RAW-Daten für die Adresse und die Stadt in den XFC_METADATEN. Dies wurde behoben.

=== 3.5.4 ===

* Erweiterung Postkorb-Aktion: Prüfroutine für Postkorb-Webservice-Kommunikation in Konfigurationsoberfläche hinzugefügt.

=== 3.5.3 ===

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

547

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

556

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

557

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

558

* 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

563

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

572

* 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

573

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

574

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

575

* 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

584

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

585

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

586

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

587

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

588

* 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

593

* 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

598

* Postkorb-Plugin für V7-Workflow

599

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

600

601

=== ===

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

Navigation