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

Verstecke letzte Bearbeiter

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

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

Navigation