AKDB: Bürgerkonto-Service-Plugin
Plugin-Download (erfordert Anmeldung)
Inhalt
[
Verbergen
]
Formularvorlage AKDB Basisdienste
Über das kostenpflichtige AKDB Bürgerkonto Service Plugin werden Möglichkeiten zur Einbindung der AKDB Basisdienste Bürgerkonto und Postkorb in Xima® Formcycle bereitgestellt.
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.
Einbindung des Bürgerkonto Logins im Designer
Einstellungen am Formular-Element AKDB Bürgerkonto bis Version 3.6.0+
Einstellungen am Formular-Element AKDB Bürgerkonto ab Version 3.6.0+
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
- Login im Popup
- Wenn aktiviert, wird die Login-Seite des Bürgerservice-Portals in einem Popup geöffnet, ansonst erfolgt die Anzeige in der gleichen Seite.
- Formularseite nach Login
- Hier wird die Formularseite festgelegt, welche angezeigt werden soll, wenn der Login erfolgreich war.
- Formularseite nach abgebrochenen Login
- Hier wird die Formularseite festgelegt, welche angezeigt werden soll, wenn der Login abgebrochen wurde.
- Eingaben prüfen vor Login
- 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.
- Art der Rückgabedaten
- Hier besteht die Auswahl zwischen:
- personenbezogenen Daten
- organisationsbezogenen Daten
- personen- oder organisationsbezogenen Daten
- Mit dieser Einstellung lässt sich die Art der zu erwarteten Rückgabedaten steuern, je nach Anforderung.
- Das heißt, wenn beispielsweise nur Daten einer natürlichen Person im Formularprozess zugelassen sind, ist hier die Auswahl auf personenbezogene Daten einzustellen.
- Bürgerdaten Parameter-Suffix
- Hier kann ein Suffix definiert werden, welches beim Vorbelegen von Formularelementen, mit den ermittelten Bürgerkonto-Daten, Anwendung findet.
Durch das Suffix wird es möglich mehrere Authentifizierungen und Formularelement-Vorbelegungen innerhalb eines Formulars zu realisieren. - Als Suffix sind Buchstaben, Zahlen und der Unterstrich erlaubt.
- Beispiel:
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. gefordertes Authentifizierungsverfahren(Die hier beschriebenen Eigenschaften werden bis zur Version 3.6.0+ unterstützt. Bestehende Konfigurationen werden automatisch in die neue Auswahl Einschränkung der Authentisierungsverfahren übernommen.)- Hier kann das dem Nutzer zur Verfügung stehende Authentifizierungsverfahren eingeschränkt werden.
- Es gibt folgende Auswahlmöglichkeiten:
- keine Einschränkung
- Login mittels Passwort, Authega-Zertifikat oder Personalausweis steht zur Auswahl
- Authega
- Nur die Authentifizierung mittels Authega-Zertifikat steht zur Auswahl
- Authega oder Personalausweis
- Login mittels Authega-Zertifikat oder Personalausweis steht zur Auswahl
- Personalausweis
- nur Authentifizierung mittels Personalausweis steht zur Auswahl
- Einschränkung der Authentisierungsverfahren (Eigenschaft steht ab Version 3.6.0+ zur Verfügung)
- Über diese Checkbox-Auswahl kann das dem Nutzer zur Verfügung stehende Authentifizierungsverfahren eingeschränkt werden.
- Ist nichts ausgewählt, erfolgt keine Einschränkung.
- Benutzername
- Authentifizierung erfolgt über Login / Passwort
- Authega-Zertifikat
- Elster-Zertifikat
- FINK
- Authentifizierung erfolgt über ein Identifikationsmittel aus dem Portfolio des Föderierten Identitätsmanagements Interoperable Nutzerkonten
- eID (Personalausweis)
- eIDAS
- Authentifizierung mittels Identifikationsmittels nach eIDAS-Verordnung (electronic IDentification, Authentication and Trust Services)
- Postkorbversand obligatorisch
- Diese Einstellung ermöglich es die Postkorb-ID als verpflichtendes Rückgabe-Attribut zu kennzeichnen.
- Auf Seiten der AKDB werden dann alle Authentifizierungsarten, die keinen Postkorbversand ermöglichen, für den Nutzer ausgeblendet.
- Einschränkung der angeforderten Eigenschaften (Eigenschaft steht ab Version 3.7.0+ zur Verfügung)
- Über diese Checkbox-Auswahl kann der Nutzer die zurück gelieferten Eigenschaften einer erfolgreichen Authentifizierung einschränken.
- 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,
- so sind nur die entsprechenden Felder in dieser Auswahlliste zu selektieren.
- Ist nichts ausgewählt, erfolgt keine Einschränkung und alle möglichen Eigenschaften werden vom Bürgerservice-Portal angefordert.
Einbindung des Bürgerkonto Logins als Externer Benutzer
Konfiguration eines Externen Benutzers für das Bürgerkonto Login
Bürgerkonto-Login als Externer Benutzer einrichten. (Schritt 1)
Zur Einbindung des Bürgerkonto-Logins über einen Externen Benutzer, muss diese Login Möglichkeit zuvor konfiguriert werden.
Dazu muss im jeweiligen Mandaten in den Konfigurationsbereich Externe Benutzer gewechselt werden. Dort muss mittels der über das Plugin zur Verfügung gestellte AKDB Login ausgewählt werden.
Bürgerkonto-Login als Externer Benutzer einrichten. (Schritt 2)
Im nächsten Schritt muss über den Button "Konfiguration hinzufügen" eine Konfiguration hinzugefügt werden.
Bürgerkonto-Login als Externer Benutzer einrichten. (Schritt 3)
Im letzten Schritt besteht die Möglichkeit die Konfiguration individuell anzupassen.
Dazu können folgende Einstellungen getroffen werden:
- LoginTyp
- Mit dieser Einstellung lassen sich die Arten der zurück gelieferten Daten festlegen.
- Ist als Wert Person definiert, so können nur personenbezogene Daten zurückgeliefert werden.
- 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.
- Ist dieser Parameter nicht konfiguriert, so kann der Nutzer selbst bestimmen, welche Datenart (personen- oder organisationsbezogen) er zurück liefern möchte.
AuthTyp(wird ab Version 3.6.0+ nicht mehr unterstützt)- Über diese Einstellung kann das geforderte Authentisierungsverfahren festgelegt werden.
- Entweder mit Authega-Zertifikat (Wert: Authega) oder Personalausweis (Wert: NPA).
- Ist nichts gesetzt oder das Attribut nicht vorhanden, so werden dem Nutzer alle möglichen Authentisierungsverfahren zur Auswahl angeboten.
- LoginMethod (ersetzt die Eigenschaft AuthTyp ab Version 3.6.0+ )
- Über diese Einstellung kann das geforderte Authentisierungsverfahren eingeschränkt werden.
- 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
- werden alle vom Identity-Provider zur Verfügung gestellten Anmeldeverfahren zur Auswahl angezeigt.
- PflichtElemente (ab Version 3.6.0+ )
- Über diese Eigenschaft können Attribute als verpflichtende Nutzereigenschaften angefordert werden.
- Alle Authentisierungsverfahren, welche die geforderten Attribute nicht erfüllen, werden dadurch ausgeblendet.
- Sofern der Formular-Workflow beispielsweise die Kommunikation mit dem Postkorb zwingend erfordert,
- kann hier der Wert Postkorb angegeben werden, wodurch das Ausblenden der temporären Anmeldung erreicht wird.
- Als Werte können können folgende Begriffe angegeben werden (Bei mehreren Werten sind diese durch Komma zu trennen):
- PIN
- In diesem Fall wird die sektor-spezifische Personen-Identifikations-Nummer (ssPIN) angefordert
- Postkorb
- In diesem Fall wird die Postkorb-Id als verpflichtender Wert angefordert, sodass im Workflow
- die Voraussetzungen für den Versand einer Nachricht an den Postkorb des Nutzers gegeben sind.
- AngeforderteEigenschaften (ab Version 3.7.0+ )
- Diese Eigenschaft dient zum Einschränken der zurück gelieferten Attribute aus einer erfolgreichen Nutzer-Anmeldung.
- In erster Linie ist diese Eigenschaft dazu gedacht dem Grundsatz der Datensparsamkeit aus den Vorgaben der DSGVO (Datenschutz-Grundverordnung) gerecht zu werden.
- Sind keine Werte gesetzt, erfolgt keine Einschränkung und es werden alle vom Identity-Provider zur Verfügung gestellten Nutzer-Eigenschaften zurück geliefert.
- Zu beachten ist, dass die angeforderten Eigenschaften mit dem unter LoginTyp angegebenen Wert korrespondieren. Dies bedeutet, dass beispielsweise bei einer angeforderten Authentifizierungsverfahren als Person, keine Organisations-Eigenschaften zurück geliefert werden können.
- Es können ein oder mehrere Werte aus der nachfolgenden Auflistung (mit Komma getrennt) angegeben werden:
- FIRST_NAME
- Vorname
- LAST_NAME
- Nachname
- ADDRESS_STREET
- Adresse
- ADDRESS_ZIP_CODE
- PLZ
- ADDRESS_CITY
- Ort
- COUNTRY
- Land
- PERSONAL_TITLE
- Titel
- GENDER_TYPE
- Geschlecht
- BIRTHDATE
- Geburtsdatum
- PLACE_OF_BIRTH
- Geburtsort
- BIRTH_NAME
- Geburtsname, nur bei Anmeldung als natürliche Person verfügbar
- NATIONALITY
- Staatsangehörigkeit, nur bei Anmeldung als natürliche Person verfügbar
- DE_MAIL
- DE-Mail-Adresse
- TELEPHONE_NUMBER
- Telefon
- ORGANIZATION_NAME
- Name der Organisation, nur bei Anmeldung als Organisation verfügbar
- ORGANIZATION_ID
- Organisations-Id, nur bei Anmeldung als Organisation verfügbar
- HOUSE_NUMBER
- Hausnummer, nur bei Anmeldung als Organisation verfügbar
- HOUSE_NUMBER_ADDITION
- Hausnummern-Zusatz, nur bei Anmeldung als Organisation verfügbar
- ADDRESS_ADDITION
- Adress-Zusatz, nur bei Anmeldung als Organisation verfügbar
- UK_HANDLE
- Unternehmenskonto-Handle, nur bei Anmeldung als Organisation verfügbar
- REGISTER_LOCATION
- Register(gerichts)-Ort, nur bei Anmeldung als Organisation verfügbar
- REGISTER_NUMBER
- Registernummer, nur bei Anmeldung als Organisation verfügbar
Bürgerkonto Login als Formularanmeldung einrichten
Bürgerkonto Login als Externer Benutzer am Formular freischalten.
Um das Bürgerkonto-Login über einen Externen Benutzer am jeweiligen Formular zu ermöglichen,
muss dieses als Formularanmeldung am Formular hinterlegt sein.
Designer-Element: Bürgerkonto Daten Vorlage
Formularvorlage AKDB Basisdienste
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.
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
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.
| Parameter | Beschreibung |
|---|---|
| BPK | Bereichsspezifisches Personenkennzeichen (in verschlüsselter Form) |
| BPK_Decoded | Bereichsspezifisches Personenkennzeichen (in entschlüsselter Form) |
| PostboxId | Postkorb-ID des Nutzers. Muss bei Anbindung des Postkorbs verwendet werden. |
tfAntragstellerEmail (PBA + OBA) | Email-Adresse |
| Gender | Anrede als numerischer Wert nach ISO 5218:2004 |
| GenderName | Lesbarer Text für Geschlechter-Code aus Attribut „gender“. Mögliche Werte: männlich, weiblich |
tfAntragstellerAnrede (PBA + OBA) | Anrede, wird mit Hilfe des Geschlechter-Code aus Attribut „gender“ erzeugt. Mögliche Werte: Herr, Frau, Nicht bekannt |
tfAntragstellerTitel (PBA + OBA) | Akademischer Titel |
tfAntragstellerVorname (PBA + OBA) | Vorname |
tfAntragstellerName (PBA + OBA) | Nachname |
tfAntragstellerPLZ (PBA + OBA) | Postleitzahl |
tfAntragstellerAdresse (PBA + OBA) | Adresse bestehend aus Strasse und Hausnummer |
tfAntragstellerOrt (PBA + OBA) | Ort |
| tfAntragstellerLand (PBA + OBA) | Land aus dem der Antragsteller kommt oder die Organisation ihren Sitz hat. Als ISO 3166-1 alpha-2 gepflegt. (ab Version 2.16.0+ ) |
tfAntragstellerGeburtsdatum (PBA + OBA) | Geburtsdatum im Format: dd.MM.yyyy |
| tfAntragstellerGeburtsname (PBA + OBA) | Geburtsname (ab Version 2.15.0+ ) |
tfAntragstellerGeburtsort (PBA + OBA) | Geburtsort |
tfAntragstellerTelefon (PBA + OBA) | Telefonnummer |
| tfAntragstellerStaatsangehoerigkeit (PBA + OBA) | Staatsangehörigkeit (ab Version 2.15.0+ ) |
| tfAntragstellerDeMail (PBA + OBA) | De-Mail-Adresse (ab Version 2.15.0+ ) |
| tfAntragstellerEIDASAusstellerLand (PBA) | eIDAS Ausgabeland (ab Version 2.15.0+ ) |
| tfOrgVertreterVorname (OBA) | Vorname der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte. |
| tfOrgVertreterName (OBA) | Nachname der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte. |
| tfOrgVertreterTitel (OBA) | Akademischer Titel der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte. |
tfOrgVertreterAnrede (OBA) | Anrede für die Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte. |
| tfOrgVertreterGeburtsdatum (OBA) | Akademischer Titel der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte. |
| tfOrgVertreterGeburtsort (OBA) | Geburtsort der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte. |
| tfOrgEmail (OBA) | E-Mail Adresse der angemeldeten Person, welche diese im Unternehmen hat. (Kann von der E-Mail Adresse am personenbezogenen Account abweichen.) |
| tfOrgVertreterTelefon (OBA) | Telefonnummer der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte. |
| tfOrgStrasse (OBA) | Strasse |
| tfOrgHausnummer (OBA) | Hausnummer |
| tfOrgHausnummerZusatz (OBA) | Hausnummern Zusatz |
| tfOrgAdressZusatz (OBA) | Adress-Zusatz |
| tfOrgPLZ (OBA) | PLZ |
| tfOrgOrt (OBA) | Ort |
| tfOrgName (OBA) | Name der Organisation (mit Rechtsform) |
| tfOrgID (OBA) | Organisations-ID (abgekündigt, wird zukünftig durch das organisationsspezifische Kennzeichen ersetzt) |
| tfOrgKennzeichen (OBA) | organisationsspezifisches Kennzeichen: ersetzt zukünftig die Organisations-ID. (ab Version 2.16.0+ ) |
| Rechtsform (OBA) | Rechtsform der Organisation |
| tfOrgRegisterOrt (OBA) | Register(gerichts)-Ort |
| tfOrgRegisterNummer (OBA) | Registernummer |
| tfOrgUUID (OBA) | Unternehmenskonto-Handle (ab Version 2.15.0+ ) |
| TrustLevel | Vertrauensniveau, gibt Auskunft über gewählte Authentifizierungsmethode:
|
| IdentitaetsPruefer | Quelle der Identitätsprüfung (ab Version 2.15.0+ ) (Mögliche Werte sind: eIDAS, eID, Smart-eID, Authega, Elster, Benutzername oder FINK) |
| NPA_Address (PBA) | Adresse, wie sie auf dem NPA vermerkt ist (alles in Großbuchstaben) |
| NPA_City (PBA) | Ort, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben) |
| NPA_FirstName | Vorname, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben) |
| NPA_LastName | Nachname, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben) |
| NPA_PersonalTitle | Akademischer Titel, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben) |
| IsIndividualPerson | Liefert den Wert true, wenn es sich bei den Daten aus dem Bürgerkonto um personenbezogene Daten handelt, sonst false. |
| IsOrganization | Liefert den Wert true, wenn es sich bei den Daten aus dem Bürgerkonto um organisationsbezogene Daten handelt, sonst false. |
| authVerifyInfos | (ab Version 3.5.0+ ) 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. |
| bkVorlagenAuswahl | (ab Version 3.7.1+ ) Enthält im Falle einer Anmeldung als natürliche Person den Wert IsIndividualPerson, im Falle der Anmeldung als Organisation den Wert IsOrganization. |
Darstellung des genutzten Authentifizierungsverfahren
Darstellung des verwendeten Vertrauensniveaus an der Bürgerkonto Daten Vorlage
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.
Für die einzelnen Vertrauensniveaus existieren folgende Beschriftungen:
- Level 1 (Authentifizierung mittels Benutzername / Passwort): Standard
- Level 3 (Authentifizierung mittels Authega Zertifikat): Zertifikat
- Level 4 (Authentifizierung mittels nPA): Personalausweis
Wenn keine visuelle Markierung gewünscht ist, so kann dies durch ein zusätzliches Attribut „noRibbon“ am Vorlagen-Fieldset unterbunden werden
Anpassungen der Darstellung aufgrund reduzierter Nutzerdaten
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.
Mit Plugin Version 3.5.0+ 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.
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.
Zusätzlich werden die Felder bei Wiederanzeige durch kleine Icons gekennzeichnet, wodurch auf einem Blick ersichtlich wird, aus welcher Quelle die Anmeldeinformationen entstammen.
Felder mit diesem Icon wurden aus dem Bürgerservice-Portal übermittelt
Felder mit diesem Icon wurden vom Nutzer nachträglich eingegeben und wurden deshalb nicht durch einen Identitätsprüfer verifiziert
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:
- verify_l1: Kennzeichnet ein Element dessen Inhaltswert einen Level 1 Vertrauensniveaus (Authentifizierung mittels Benutzername / Passwort) entspricht.
- verify_l3: Kennzeichnet ein Element dessen Inhaltswert einen Level 3 Vertrauensniveaus (Authentifizierung mittels Zertifikat) entspricht.
- verify_l4: Kennzeichnet ein Element dessen Inhaltswert einen Level 4 Vertrauensniveaus (Authentifizierung mittels nPA oder eIDAS Identifikationsmittel) entspricht.
- 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.
Wenn keine visuelle Markierung der Formularelemente gewünscht ist, so kann dies durch ein zusätzliches Attribut „noVerifyInfo“ am Vorlagen-Fieldset unterbunden werden
AKDB Postkorbanbindung in der Statusverarbeitung
Für die Anbindung zum Versand von Postkorbnachrichten wird das Aktions-Plugin AKDB:Postkorbnachricht senden zur Verfügung gestellt.
Mittels dieser Plugin-Aktion, können ähnlich einer E-Mail Aktion, Nachrichten an den Postkorb der AKDB weitergeleitet werden.
Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt die nachfolgend kurz beschrieben werden.
Einstellungen für Absender und Empfänger
Einstellungen für Absender und Empfänger in V6 Formularen
Einstellungen für Absender und Empfänger in V7 Formularen
- Mandant (ab Version 3.6.0+ kein Pflichtfeld)
- 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.
- Dienst (ab Version 3.6.0+ kein Pflichtfeld)
- 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.
- Absender-Link
- 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.
- Vertrauensniveau der Anmeldung für Zugriff auf Postkorb-Nachricht weiterreichen? (verfügbar ab Version 3.6.0+ im V7 Formular Workflow)
- Über diese Option können Sie festlegen, ob das Vertrauensniveau der Anmeldung (wenn dies ermittelt werden kann)
- für den Zugriff auf die Postkorb-Nachricht weitergereicht werden soll.
- Wenn kein Vertrauensniveau aus den Anmeldedaten ermittelt werden kann, wird das niedrigste Vertrauensniveau gesetzt,
- um einen Zugriff auf die Nachricht im Postfach der AKDB zu ermöglichen.
- Postkorb ID aus den Vorgangsdaten ermitteln?
- 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. Wird bei einem AKDB Bürgerkonto-Login die Postkorb-ID mit übermittelt, so wird diese standardmäßig am Formulareingang hinterlegt. Für den Fall, dass es mehrere konfigurierte Anmeldungen innerhalb eines Formulars gibt, kann hier die Auswahl über den Bürgerdaten Parameter-Suffix eingegrenzt werden. 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.)
Konfiguration des Nachrichteninhalts
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.
- Inhalt (Pflicht)
- Nachrichtentext, es werden Platzhalter unterstützt.
- Anhänge
- Hier können Dateien als Attachments an die Postkorb-Nachricht gehangen werden.
- Unterstützte Dateiformate sind: PDF, HTML, Plaintext, MS Word, JPEG, GIF, PNG, ZIP
- Zur Auswahl stehen dabei:
- (Auswahlmöglichkeiten in V6-Formularen)
- Upload
- bezieht sich auf alle Dateianhänge, die über das Formular hochgeladen wurden
- Workflow
- bezieht sich auf alle Dateianhänge, die über den aktuellen FORMCYCLE Workflow hochgeladen wurden.
- Posteingang
- bezieht sich auf alle Dateianhänge, die über das Postfach hochgeladen wurden.
- (Auswahlmöglichkeiten in V7-Formularen)
- Dateien aus vorherigen Aktionen
- Eine Liste mit Dateien, von Datei-bereitstellenden Aktionen, die der Postkorb-Aktion vorangestellt sind.
- Mandantdateien
- Liefert eine Auswahlliste über alle Datei-Ressourcen am Mandanten
- Formulardateien
- Liefert eine Auswahlliste über alle Datei-Ressourcen, welche am Formular-Projekt hinterlegt sind.
- Externe Ressourcen-URL
- Dateien die über externe Quellen (HTTP-Requests) ermittelt werden können.
- Vorgangsanhänge mittels Dateinamen suchen
- 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)
Bedingte Ausführung der AKDB:Postkorbnachricht senden-Aktion
Konfiguration einer Bedingung für Ausführung der Aktion AKDB:Postkorbnachricht senden
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.
Dies bedeutet aber auch, dass wenn in einem Formularprozess kein zwingender Bürgerkonto-Login erfolgt, die Postkorb-ID nicht in der Statusverarbeitung vorhanden ist.
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.
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.
REGEX([%$POSTKORB_ID%]=^.+$)
Erweitere Bedingungsprüfung bei Verwendung unterschiedlicher Login-Arten (personenbezogenes bzw. organisationsbezogenes Login)
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.
Im Formular müssen dann versteckte Eingabefelder mit den Element-Namen IsIndividualPerson und IsOrganization vorhanden sein.
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%]=^.+$)
Versionshistorie
3.8.4
- Fehlerbehebung: Revisionsdaten können bei Login über Popup nicht erstellt werden. Dies wurde behoben.
3.8.3
- Fehlerbehebung: Automatischer Login im Popup Existenz des Url-Parameters 'xfc-pp-external' wurde wieder entfernt.
Damit hat nur die aktuelle Konfiguration an Login-Button Einfluss einen Aufruf im Popup
3.8.2
- Anpassung für Login innerhalb eines Ajax-Aufrufs: Login wird immer in einem Popup ausgeführt.
3.8.1
- Fehlerbeseitigung der Nichtanzeige der Konfiguration von einschränkenden Attributen am Login-Button
3.8.0
- Einbindung Xima® Formcycle Version 7.4.0+
3.7.5
- Behebung einer Sicherheitslücke
3.7.4
- Fehlerbehebung: JavaScript-Fehler beim Einlesen der zurück gelieferten Anmeldedaten behoben
- Interne Anpassungen beim Abholen von Datei-Ressourcen über die API
3.7.3
- Anpassung AKDB-Setup: bei Vorbelegung der Entity-ID mit der URL vom Mandant wird jetzt Port-Nummer entfernt
- Behebung Anzeigefehler in Datenvorlage: Wenn Anmeldung abgebrochen und anschließend aber erfolgreich durchgeführt wurde, da waren die Felder in der Datenvorlage fehlerhaft markiert (als manuell durch Nutzereingaben vorbelegt). Dies wurde korrigiert.
3.7.2
- Interne Anpassungen zur besseren Fehleranalyse
3.7.1
- Anpassung AKDB-Setup: Erweiterung des Upload-Element für Ausführung eines Viren Scans versehen
- Erweiterung BuergerkontoData-Struktur: Bei einer Anmeldung über BK wird zusätzlich das Feld 'bkVorlagenAuswahl' zurück gegeben.
3.7.0
- Erweiterungen / Anpassungen aufgrund von Schnittstellenanpassungen im Bürgerservice-Portal der AKDB:
- 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 Xima® Formcycle Version 7.0.11+ 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.
- 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:
- Möglichkeit zur Anforderung von Pflicht-Attributen (Postkorb-ID)
- Umstellung der Auswahlmöglichkeiten für das geforderte Authentifizierungsverfahren auf eine weiter reichende Auswahl (+Migration bestehender Konfigurationen am BK-Login-Button)
- Anpassung Postkorb-Aktion: Im Bereich des Absenders sind Dienst und Mandant keine Pflichtfelder mehr. Wenn Sie nicht definiert werden, werden die globalen Einstellungen
aus den Plugin-Properties herangezogen. - 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.
- Anpassung AKDB-Vorlage: Anpassung der Verlage, da im Bereich des Absenders Dienst und Mandant keine Pflichtfelder mehr repräsentieren.
- Anpassung AKDB-Setup: Hinweis auf freizugebende URL's (Firewall-Einstellungen) hinzugefügt, Konfigurationsmöglichkeit für Proxy-Server-Einstellungen
- 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 Xima® Formcycle Version 7.0.11+ steht.
3.5.12
- Erweiterung von Log-Ausgaben innerhalb der Postkorb-Kommunikation zum Zwecke der Fehleranalyse.
3.5.11
- Fehlerbehebung: Im Zusammenspiel mit der Xima® Formcycle Version 7.0.10+ 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)
- 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.
- 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.
- 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.
- Ü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
- Fehlerbehebung: Fehlendes URL-Encoding eines Parameters führte dazu, dass Formular nach AKDB-Login nicht mehr gefunden wurde. Dies wurde behoben.
- 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
- 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 Xima® Formcycle
- 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
- Neues Replacer-Plugin ('LOGIN_PROTOCOL') für eine Ausgabe aller Anmeldedaten, welche am Vorgang hinterlegt sind.
- Fehlerbehebung: Ein Fehler, welcher im Zusammenhang mit dem Einsatz des Bürgerkonto-Login-Buttons bei Benutzung in einem Popup auftrat, wurde behoben.
- 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
das Formular mit den zurückgelieferten Nutzerdaten nicht mehr angezeigt wurde. - 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.
(Hinweis: Formulare die auf den veralteten Vorlagen abbauen werden weiterhin unterstützt) - Erweiterung der Vorlage für personen- und organisationsbezogene Daten um das Attribut 'IdentitaetsPruefer', welches zur Differenzierung der Art der Anmeldung innerhalb eines Vertrauensniveaus dient.
- 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 Xima® Formcycle Version 7.0.1+ oder höher
- 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 Xima® Formcycle Version 7.0.0+ oder höher
- Postkorb-Plugin für V7-Workflow
- Überarbeitung Formular-Vorlage für Nutzung des V7-Workflows