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

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

Navigation