Datenschutzhinweis

 

Beim Laden dieses Inhalts werden Nutzungsinformationen an Vimeo übertragen und dort ggf. verarbeitet.

 

             

Bürgerservices-Plugin

Geändert am Do, 18 Jul um 3:34 NACHMITTAGS

Plugin-Download (erfordert Anmeldung)

Achtung:
Bevor Sie die Bürgerservices in ihre Formular-Prozesse einbinden, stellen Sie bitte sicher, dass die konfigurative Anbindung der Dienste durch einen Xima® formcycle - Administrator erfolgt ist!


Inhalt


Über das kostenpflichtige Bürger Services Plugin werden Möglichkeiten zur Einbindung verschiedener Bürgerservices in Xima® formcycle bereitgestellt.
Dabei kann zwischen den Anbindungen für 

  • BundID
  • BayernID
  • ELSTER (Mein Unternehmenskonto)
  • ein Portal mittels der ExtensionAPI (z.B. Kommunalportal.NRW oder OpenR@thaus)

gewählt werden.


Einbindung der Bürgerservices in FormulareBearbeiten

Für eine Einbindung der Bürgerservices in Xima® formcycle Formulare bestehen grundsätzlich folgende Möglichkeiten:

  • Anmeldung über Formular-Zugriffssteuerung: hier erfolgt eine Nutzer-Legitimierung vor der Anzeige des Formulars (nur BundID, BayernID und ELSTER)
  • Anmeldung über Login-Button: In diesem Szenario kann eine Nutzer-Legitimierung während der Anzeige des Formulars (zu jedem Zeitpunkt), durchgeführt werden. (nur BundID, BayernID und ELSTER)
  • Aufruf eines Formulars durch ein externes Portal inkl. der Übermittlung der aktuellen Benutzer-Sitzung (nur ExtensionAPI)

Einbindung über Formular-Zugriff


Konfiguration der Bürgerservices als Formularanmeldung

Um den Login für einen oder mehrere Bürgerservices über einen Externen Benutzer am jeweiligen Formular zu ermöglichen, muss dies als Formularanmeldung am Formular hinterlegt sein.

Die in der Auswahl zur Verfügung stehenden Bürgerservices sind abhängig von der Lizenzierung, sowie vom vollständigen Konfigurations-Status der als Externe Benutzer definierten Bürgerservice-Anbindungen.  
 

Einbindung im Designer - per Login Button


Allgemeine Einstellungen am Formular-Element Bürger Services Login

Zur vereinfachten Einbindung von einem Bürgerservices innerhalb eines Formularprozesses gibt es das Formular-Element Bürger Services Login. Dieses kann per "Drag & Drop" in den Seitenbereich gezogen werden. Das dann vorhandene Button-Element kann im Bereich Bürger Services: Login Einstellungen konfiguriert werden.
Die nachfolgenden aufgeführten Einstellungen gelten dabei für alle Bürgerservices (BundID, ELSTER etc.) gleichermaßen.

Bezeichner
Beschriftung des Login-Buttons im Formular
Authentikator
Hier muss ein konkreter Bürgerservice aus den im System konfigurierten Externen Benutzern ausgewählt werden. Zu diesem Bürgerservice (ELSTER, BundID etc.) wird zum Aufrufzeitpunkt weitergeleitet.   
Seite bei Login
Hier wird die Formularseite festgelegt, welche angezeigt werden soll, wenn der Login erfolgreich war. 
Seite bei Abbruch
Hier wird die Formularseite festgelegt, welche angezeigt werden soll, wenn der Login abgebrochen wurde.
Element Suffix
Hier kann ein Suffix definiert werden, welches beim Vorbelegen von Formularelementen, mit den ermittelten Daten aus einem Bürgerservice, zur Anwendung kommt.
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.  
Login im Popup
Wenn aktiviert, wird die Login-Seite des jeweiligen Bürgerservice-Portals in einem Popup geöffnet, ansonst erfolgt die Anzeige in der gleichen Seite.
Validieren
Wenn aktiviert, werden die bisherigen Formulareingaben validiert. Der Start des 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 jeweiligen Bürgerservice-Portal weitergeleitet.

Zusätzliche Konfigurationsmöglichkeiten für BundID / BayernID


Erweiterte Einstellungen am Formular-Element Bürger Services Login für BundID und BayernID

Die nachfolgend beschriebenen Konfigurationsmöglichkeiten stehen nur im Zusammenhang mit den Bürgerservices von BundID und BayernID zur Verfügung
und ermöglichen es die Anmeldemöglichkeiten, sowie die zurück gelieferten Daten aus dem jeweiligen Bürgerservice-Portal zu beeinflussen.

Vertrauensniveau 
Hier kann das dem Nutzer zur Verfügung stehende Authentifizierungsverfahren eingeschränkt werden.
Es gibt folgende Auswahlmöglichkeiten:
keine Einschränkung
Login mittels Nutzername / Passwort, Zertifikat oder Personalausweis steht zur Auswahl
Zertifikat
Nur die Authentifizierung mittels Zertifikat steht zur Auswahl
Zertifikat oder Personalausweis
Login mittels Zertifikat oder Personalausweis stehen zur Auswahl
Personalausweis
nur Authentifizierung mittels Personalausweis steht zur Auswahl
Einschränken auf
Ü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
Diia
Authentifizierung erfolgt mittels ukrainischer Digital-App Diia
eID (Personalausweis)
eIDAS
Authentifizierung mittels Identifikationsmittels nach eIDAS-Verordnung (electronic IDentification, Authentication and Trust Services)
Einschränkung der angeforderten Eigenschaften
Ü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 jeweiligen Bürgerservice-Portal angefordert.
Nur mit Postkorb
Diese Einstellung ermöglich es die Postkorb-ID als verpflichtendes Rückgabe-Attribut zu kennzeichnen. 
Auf Seiten des Bürgerservice-Portals werden dann alle Authentifizierungsarten, die keinen Postkorbversand ermöglichen, für den Nutzer ausgeblendet.
Mit dieser Einstellung wird sichergestellt, dass bei einer erfolgreichen Nutzer-Authentifizierung immer ein nachgeordneter Nachrichtenversand an den Postkorb des Nutzers im jeweiligen Bürgerservice-Portal möglich ist.


Einbindung über Aufruf durch ein externes Portal (nur ExtensionAPI)

In der dritten Einbindungs-Variante werden formcycle-Formulare durch einen externen Dienst aufgerufen. Bei dieser Variante werden etwaige Benutzerinformationen des Portals an den Formular-Aufruf weitergereicht, sodass formcycle diese bereitstellen und evaluieren kann. Um diese Funktionalität zu verwenden ist es hierfür wie in "Einbindung über Formular-Zugriff" ebenso notwendig den entsprechenden Login-Dienst am Formular du aktivieren. Der Unterschied hierbei besteht jedoch darin, dass dieser Login-Dienst beim Aufruf des Formulars direkt versucht wird zu interpretieren und damit auch keine Login-Schaltfläche hierfür angezeigt wird.


Konfiguration der ExtensionAPI als Login-Mechanismus
Hinweis:
Nachdem an einem Formular eine Authentifizierung mittels einem ExtensionAPI-Portals konfiguriert wurde, muss dies dem Portal aktiv mitgeteilt werden. Hierfür können Sie entweder die Funktionalität des Portals verwenden oder die Synchronisation in der Oberfläche des Login-Dienstes ("Portal-Daten aktualisieren") innerhalb von formcycle ausführen.


Anzeige der Anmeldedaten im Formular

Elementvorlagen zur Datenanzeige

Um die Daten aus dem jeweiligen Bürgerservice-Portal im Formular anzuzeigen, existieren unterschiedliche Vorlagen im Designer. Diese Vorlagen sind nach dem Schwerpunkt, ob sie für eine Anzeige von Personen- oder Organisationsdaten eingesetzt werden sollen, gestaltet. Sie enthalten bereits eine Reihe sinnvoller Elemente für die Datenanzeige, können aber mit weiteren Elementen (auch eigens Definierten) erweitert werden.


Für die Erweiterung der Anzeigedaten steht der ebenfalls im Designer eingebundene Elementkatalog Bürger Services Elemente zur Verfügung.


Elementkatalog mit allen Datenelementen, die durch das Bürgerservice-Plugin unterstützt werden

Die aus dem 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.XM_BuergerServicesLoginAnalyzer

Darstellung des genutzten Authentifizierungsverfahren



Darstellung des verwendeten Vertrauensniveaus in einer Datenvorlage

Bei Nutzung der Vorlagen aus dem Designer ist nach dem Absenden des Formulars, sowie bei der Wiederanzeige des Formulars 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, Vertrauensniveau nach BSI: normal): Standard
  • Level 3 (Authentifizierung mittels Zertifikat, Vertrauensniveau nach BSI: substanziell): Zertifikat
  • Level 4 (Authentifizierung mittels Personalausweis (eID) oder vergleichbaren Authentifizierungsmittel (eIDAS), Vertrauensniveau nach BSI: hoch): Personalausweis


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


Darstellung der Nutzerdaten nach Anmeldung


Nach einer Anmeldung am Bürgerservice-Portal sind die Eingabefelder innerhalb der Datenvorlage für eine Bearbeitung gesperrt, welche durch den Authentifizierungsprozess 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 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.


Übersicht Element-Matrix


Die nachfolgenden Tabelle listet alle Formular-Elemente auf, die im Zusammenhang mit den Bürgerservices existieren. Dabei werden nicht alle Elemente durch jeden angebundenen Bürgerservice gleichermaßen befüllt, bzw. die Elementdaten können je nach genutzten Authentifizierungsverfahren, innerhalb des jeweiligen Bürgerservice Portals, zurück oder auch nicht zurück geliefert werden. 


Hinweis: Die Tabelle gibt den aktuell entnommen Stand aus den Dokumentationen der jeweiligen Bürgerservice-Portale (BundID, BayernID und ELSTER) wieder und erhebt deshalb nicht den Anspruch der Vollständigkeit. 

Formular-Elementname
Katalogelement Anzeigename
Bemerkung
ELSTER
BundID / BayernID
BN/PW Basisregistrierung 
eID permanent 
eID temporär 
eIDAS permanent 
eIDAS temporär 
Smart eID 
Smart eID temporär 
ELSTER permantent 
ELSTER temporär 
FINK VN hoch 
FINK VN substanziell 
FINK VN Basisregistrierung 
selPersTyp
Antrag erfolgt als

mögliche Werte:

  • NatPers: (bei Privatperson)
  • NNatPers: (bei Organisation)
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
tfAntragstellerVorname
Vorname
 
Pflichtfeld (IdNr)
Pflichtfeld nicht verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld teilweise verifiziert
optional verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
tfAntragstellerName
Nachname
 
Pflichtfeld (IdNr)
Pflichtfeld nicht verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
tfOrgName
Firmenname
 
Pflichtfeld (StNr)
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
tfAntragstellerEmail
E-Mail
 
nein
Pflichtfeld nicht verifiziert
Pflichtfeld nicht verifiziert
nein
Pflichtfeld nicht verifiziert
nein
Pflichtfeld nicht verifiziert
nein
Pflichtfeld nicht verifiziert
nein
optional nicht verifiziert
optional nicht verifiziert
optional nicht verifiziert
tfAntragstellerAdresse
Adresse
Adresse bestehend aus Straße und Hausnummer
Pflichtfeld
Pflichtfeld nicht verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld teilweise verifiziert
optional verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld teilweise verifiziert
optional verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
tfAntragstellerPLZ
Postleitzahl
 
Pflichtfeld
Pflichtfeld nicht verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld teilweise verifiziert
optional verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld teilweise verifiziert
optional verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
tfAntragstellerOrt
Ort
 
Pflichtfeld
Pflichtfeld nicht verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld teilweise verifiziert
optional verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld teilweise verifiziert
optional verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
tfAntragstellerOrtsteil
Ortsteil
 
optional
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
tfAntragstellerErgaenzung
Ergänzung
 
optional
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
tfAntragstellerLand
Land
 
Pflichtfeld
optional nicht verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
optional verifiziert
optional verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
optional verifiziert
optional verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
tfAntragstellerTitel
Titel / Akademischer Titel
 
optional
optional nicht verifiziert
optional verifiziert
optional verifiziert
optional verifiziert
optional verifiziert
optional verifiziert
optional verifiziert
optional verifiziert
optional verifiziert
optional verifiziert
optional verifiziert
optional verifiziert
selAntragstellerGeschlecht
Geschlecht

Kann folgende Werte annehmen:

  • 0 (für unbekannt)
  • 1 (für männlich)
  • 2 (für weiblich)
  • 9 (für nicht zutreffend)
nein
optional nicht verifiziert
optional nicht verifiziert
nein
optional nicht verifiziert
nein
optional nicht verifiziert
nein
nein
nein
optional nicht verifiziert
optional nicht verifiziert
optional nicht verifiziert
tfAntragstellerAnrede
Anrede
 
nein
optional nicht verifiziert
optional nicht verifiziert
nein
optional nicht verifiziert
nein
optional nicht verifiziert
nein
nein
nein
optional nicht verifiziert
optional nicht verifiziert
optional nicht verifiziert
tfAntragstellerGeburtsdatum
Geburtsdatum
 
Pflichtfeld (IdNr)
Pflichtfeld nicht verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld teilweise verifiziert
Pflichtfeld teilweise verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
tfAntragstellerGeburtsort
Geburtsort
 
optional
Pflichtfeld nicht verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld teilweise verifiziert
Pflichtfeld teilweise verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld teilweise verifiziert
Pflichtfeld teilweise verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
Pflichtfeld verifiziert
tfAntragstellerGeburtsname
Geburtsname
 
optional
Pflichtfeld (Leerwert erlaubt) nicht verifiziert
Pflichtfeld (Leerwert erlaubt) nicht verifiziert
Pflichtfeld (Leerwert erlaubt) nicht verifiziert
Pflichtfeld (Leerwert erlaubt) nicht verifiziert
Pflichtfeld (Leerwert erlaubt) nicht verifiziert
Pflichtfeld (Leerwert erlaubt) nicht verifiziert
Pflichtfeld (Leerwert erlaubt) nicht verifiziert
Pflichtfeld (Leerwert erlaubt) nicht verifiziert
Pflichtfeld (Leerwert erlaubt) nicht verifiziert
Pflichtfeld (Leerwert erlaubt) nicht verifiziert
Pflichtfeld (Leerwert erlaubt) nicht verifiziert
Pflichtfeld (Leerwert erlaubt) nicht verifiziert
tfAntragstellerStaatsangehörigkeit
 
Staatsangehörigkeit
nein
nein
nein
nein
optional verifiziert
optional verifiziert
nein
nein
nein
nein
optional verifiziert
nein
nein
tfAntragstellerDeMail
De-Mail
De-Mail-Adresse
nein
optional nicht verifiziert
optional nicht verifiziert
nein
optional nicht verifiziert
nein
optional nicht verifiziert
nein
optional nicht verifiziert
nein
nein
nein
nein
tfAntragstellerTelefon
Telefon
 
nein
optional nicht verifiziert
optional nicht verifiziert
nein
optional nicht verifiziert
nein
optional nicht verifiziert
nein
optional nicht verifiziert
nein
nein
nein
nein
tfOrgRechtsform
Rechtsform-Schlüssel
ELSTER-spezifische Nummer; ein Klartext-Begriff zu dieser Nummer wird im Feld Rechtsform übermittelt
Pflichtfeld (StNr, NNatPers)
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
tfOrgRechtsformText
Rechtsform
ELSTER-spezifischer Wert, welcher die Rechtsform einer nicht natürlichen Person angibt, wenn diese Inhaber des zugrunde liegenden Steuerkontos ist.
Pflichtfeld (StNr, NNatPers)
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
tfTaetigkeit
Tätigkeits-Schlüssel
ELSTER-spezifische Nummer; ein Klartext-Begriff zu dieser Nummer wird im Feld Tätigkeit übermittelt
Pflichtfeld (StNr, NatPers)
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
tfTaetigkeitText
Tätigkeit
ELSTER-spezifischer Wert, welcher die Tätigkeit einer natürliche Person angibt, wenn diese Inhaber des zugrunde liegenden Steuerkontos ist.
Pflichtfeld (StNr, NNatPers)
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
tfAntragstellerEIDASAusstellerLand
 
eIDAS Ausgabeland
nein
nein
nein
nein
Pflichtfeld verifiziert
Pflichtfeld verifiziert
nein
nein
nein
nein
nein
nein
nein
tfOrgRegisterNummer
Registernummer
 
optional
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
tfOrgRegistergericht
Registergericht
 
optional
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
tfOrgUStId
Umsatzsteuer-Identifikationsnummer
ELSTER-spezifischer Wert; nur bei Anbindung des AO Datenkranzes verfügbar 
optional ( Datenkranz AO)
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
tfOrgGruendungsDatum
Gründungsdatum
ELSTER-spezifischer Wert; nur bei Anbindung des AO Datenkranzes verfügbar
optional ( Datenkranz AO)
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
tfOrgBetriebsbeendigungsdatum
Datum der Unternehmensauflösung
ELSTER-spezifischer Wert; nur bei Anbindung des AO Datenkranzes verfügbar
optional ( Datenkranz AO)
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
BPK2
bereichspezifisches Personenkennzeichen
bereichsspezifisches Personenkennzeichen (in verschlüsselter Form)
nein
Pflichtfeld
Pflichtfeld
nein
Pflichtfeld
nein
Pflichtfeld
nein
Pflichtfeld
nein
Pflichtfeld
Pflichtfeld
Pflichtfeld
TrustLevel
Vertrauensniveau

Vertrauensniveau, gibt Auskunft über gewählte Authentifizierungsmethode:

  • STORK-QAA-Level-1: Authentifizierung mittels Benutzername / Passwort
  • STORK-QAA-Level-3: Authentifizierung mittels Authega Zertifikat
  • STORK-QAA-Level-4: Authentifizierung mittels nPA
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
tfPersTyp
Personentyp

mögliche Werte:

  • NatPers (der Inhaber des Kontos wird als Privatperson angesehen)
  • NNatPers (der Inhaber des Kontos wird als Organisation betrachtet)
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
selOrgPersTyp
Inhabertyp des Steuerkontos

mögliche Werte:

  • NatPers (der Inhaber des Kontos ist eine natürliche Person, z.B.: Einzelunternehmer)
  • NNatPers (bei einer nicht natürlichen Person, z.B.: GmbH)
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
tfAuthentifizierungsLevel
Authentifizierungs Level
Vertrauensniveau der Authentifizierung nach BSI Norm:
  • normal
  • substanziell
  • hoch
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
tfAuthentifizierungsName
Authentifizierungs Name
Name des Authentifizierungs-Mediums (z.B.: Personalausweis)
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
IdentitaetsPruefer
Identitätsprüfer
Quelle der Identitätsprüfung, mögliche Werte: eIDAS, eID, Smart-eID, AUTHEGA, ELSTER, Benutzername oder FINK)
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
Pflichtfeld
PostboxId
Postkorb Id
Postkorb-ID des Nutzers. Wird bei Anbindung des Postkorbs verwendet.
optional
Pflichtfeld
Pflichtfeld
nein
Pflichtfeld
nein
Pflichtfeld
nein
Pflichtfeld
nein
nein
nein
nein
tfDatenkranzTyp
ELSTER DatenkranzTyp

ELSTER-spezifischer Wert. Mögliche Ausprägungen:

  • StNr (bei einem Organisationszertifikat)
  • IdNr (bei einem persönlichen Zertifikat)
Pflichtfeld
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
tfOrgRegisterart
Registerart
ELSTER-spezifischer Wert, der folgende Ausprägungen annehmen kann: HRA, HRB, GR, PR, VR
Pflichtfeld
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
nein
Legende
Pflichtfeld
mandatorisches Datenfeld
Pflichtfeld (IdNr)
mandatorisches Datenfeld, wenn es sich bei dem ELSTER Zertifikat um ein persönliches Zertifikat handelt
Pflichtfeld (StNr)
mandatorisches Datenfeld, wenn es sich bei dem ELSTER Zertifikat um ein Organisationszertifikat handelt
Pflichtfeld (StNr, NatPers)
mandatorisches Datenfeld, wenn es sich bei dem ELSTER Zertifikat um ein Organisationszertifikat handelt und der Inhaber des Steuerkontos eine nicht natürliche Person (z.B. Einzelunternehmer) ist.
Pflichtfeld (StNr, NNatPers)
mandatorisches Datenfeld, wenn es sich bei dem ELSTER Zertifikat um ein Organisationszertifikat handelt und der Inhaber des Steuerkontos eine natürliche Person (z.B. GmbH) ist.
Pflichtfeld verifiziert
mandatorisches Datenfeld, dass durch das Anmeldeverfahren verifiziert ist.
Pflichtfeld nicht verifiziert
mandatorisches Datenfeld, dass NICHT durch das Anmeldeverfahren verifiziert ist.
Pflichtfeld teilweise verifiziert
mandatorisches Datenfeld, welches entweder aus dem Anmeldeverfahren verifiziert übertragen wird oder manuell nacherfasst wurde. In dem Fall ist das Feld nicht verifiziert.
optional
optionales Datenfeld
optional verifiziert
optionales Datenfeld, dass durch das Anmeldeverfahren verifiziert ist.
optional nicht verifiziert
optionales Datenfeld, dass NICHT durch das Anmeldeverfahren verifiziert ist.
optional (Datenkranz AO)
optionales Datenfeld, dass nur ausgeliefert wird, wenn im ELSTER MUK Self Service Portal der Datenkranz für die Abgabenordnung (AO) konfiguriert wurde
nein
Datenfeld wird durch den Dienst nicht geliefert

Anbindung Postkorb im Workflow


Workflow mit Bedingung für Prüfung des Authentifikationslevels und einer Postkorb Nachricht versenden Aktion

Für die Anbindung zum Versand Nachrichten an den Postkorb des jeweiligen Bürgerservice steht die Workflow-Aktion Postkorbnachricht senden zur Verfügung.
Mittels dieser Workflow-Aktion können (ähnlich einer E-Mail Aktion) Nachrichten weitergeleitet werden, wenn zum Ausführungszeitpunkt eine Postkorb ID ermittelt werden kann.

Die Konfigurationsoberfläche der Aktion ist in einzelne Bereiche unterteilt die nachfolgend kurz beschrieben werden.

Absender


Einstellungen für den Absender einer Postkorb Nachricht
Mandant / Absender
Wird als Information in der Postkorb-Ansicht im Bürgerservice-Portal verwendet. 
Dienst 
Wird als Information in der Postkorb-Ansicht im Bürgerservice-Portal 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 Postkorb der BundID oder BayernID verlinkt wird.
TransferId-Referenz
Diese Eigenschaft findet nur in Zusammenhang mit der Postkorbanbindung von ELSTER Verwendung.
An dieser Stelle kann ein eindeutige Kennung (ELSTER-TransferTicket) angegeben werden, um mit der aktuell versendeten (Antwort-)Nachricht einen Bezug zu einer vorhergehenden Nachricht herzustellen

Empfänger


Einstellungen für den Empfänger einer Postkorb Nachricht
Postkorb ID aus einer Anmeldung innerhalb der Vorgangsdaten ermitteln?
Diese Angabe dient zur Bestimmung der Postkorb ID. Über diese ID wird das genaue Ziel für den Nachrichtenversand bestimmt, also der Nachrichten-Empfänger.
Wird bei einem Bürgerservice-Login die Postkorb ID übermittelt, so wird diese standardmäßig am Formulareingang hinterlegt. Für den Fall, dass es mehrere konfigurierte Anmeldungen
innerhalb eines Formulars gibt, kann die Auswahl über den Daten-Suffix eingegrenzt werden.
Darüber hinaus ist es möglich die Postkorb-ID fest oder über einen Platzhalter [%$POSTKORB%] zu definieren. (Diese Platzhalter wird über das Plugin zur Verfügung gestellt.)
Wird an dieser Stelle die standardmäßig ausgewählte Einstellung entfernt, so werden andere Konfigurationseigenschaften sichtbar, welche das direkte Festlegen einer Postkorb ID ermöglichen:
Postkorb ID (Pflichtfeld)
Hier ist die Angabe einer konkreten Postkorb ID erforderlich. Diese muss zur Laufzeit mit dem in Feld Webservice Umgebung definierten Authentikator korrespondieren. 
Webservice Umgebung
Hier werden alle registrierten Bürgerservice Authentikatoren zur Auswahl aufgeführt. Es muss  darauf geachtet werden, dass der gewählte Authenticator den angebundenen Bürgerservice widerspiegelt, in dessen Kontext zur Laufzeit die Postkorb ID verortet ist.
Vertrauensniveau der Anmeldung für Zugriff auf Postkorb-Nachricht weiterreichen?
Diese Option steht nur im BundID und BayernID Portal zur Verfügung.  
Hier 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 für den Zugriff auf die Nachricht gesetzt.
E-Mailversand als Alternative?
Über diese Option können Sie festlegen, dass als alternative Versandmöglichkeit der Versand mittels E-Mail verwendet wird. Diese Alternative kommt dann zur Anwendung, wenn keine Postkorb ID ermittelt werden konnte, oder die Übermittlung der Postkorb-Nachricht mit Fehlern beendet wurde. Voraussetzungen für dem E-Mailversand ist die Verfügbarkeit einer E-Mail-Adresse (im Feld tfAntragstellerEmail) in den verwendeten Anmeldedaten, sowie die Erreichbarkeit eines konfigurierten E-Mail-Servers.
Bitte wählen oder geben Sie ggf. einen abweichend Daten-Suffix an, aus welchem die Postkorb ID für die Übermittlung der Nachricht bezogen werden soll:
Die Angabe eines Daten-Suffixes ist immer dann notwendig, wenn innerhalb des Formularprozesses mehrere unterschiedliche Authentifizierungen stattgefunden haben. Die Angabe stellt sicher, dass zur Laufzeit die richtigen Anmeldedaten und damit der richtige Postkorb angesprochen werden kann.

Inhalt der Nachricht


Konfiguration von Betreff, Nachrichteninhalt und Anhängen
  • für BundID / BayernID: PDF, HTML, Plaintext, MS Word, JPEG, GIF, PNG, ZIP
  • für ELSTER: PDF, JPEG, PNG, XML, CSV
Betreff (Pflicht)
Nachrichtenbetreff. 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.
Die dabei unterstützten Dateiformat unterscheiden sich dabei je nach genutzten Bürgerservice:
Zur Auswahl stehen dabei:
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 von Workflow-Aktionen auf Grundlage des Authentifizierungslevels


Workflow-Steuerungselement Authentifizierungslevel prüfen

Um eine einfache Prüfung auf Grundlage des Authentifizierungslevels durchzuführen steht das Workflow-Steuerelement Authentifizierungslevel prüfen zur Verfügung.
Mit diesem Element kann das Vertrauensniveau, auf dessen Grundlage sich ein Nutzer am Formular authentifiziert hat, abgeprüft und für eine unterschiedliche Ausführung von Verarbeitungsketten genutzt werden.

Prüfung des Authentifizierungslevels
Zur Auswahl stehen die einzelnen Authentifizierungslevel (normal, substanziell und hoch), sowie die Festlegung kein, dass explizit keine Bürgerservice Authentifizierung stattgefunden hat. Es wird eine Mehrfachauswahl unterstützt. 
Festlegung der zu prüfenden Authentifizierung
Prinzipiell können sich an einem Formular mehrere Nutzer authentifizieren. Um die einzelnen Anmeldungen im Workflow zu unterscheiden und festzulegen welches Vertrauensniveau für die Prüfung herangezogen werden soll, muss der Daten-Suffix angegeben werden.
Die Standardeinstellung ist: kein Daten-Suffix


ExtensionAPI-spezifische Konfigurationen und Funktionen

Zugriffssteuerung

Da die Sichtbarkeiten von Formularen innerhalb eines Portals via ExtensionAPI konfiguriert werden kann, bietet formcycle die entsprechende Möglichkeit für die Angabe dieser Informationen an. Dies ist hierbei mittels Formular-Tags realisiert. Hier steht folgende Werte zur Verfügung:


  • Öffentlich wenn das Formular öffentlich im Portal sichtbar sein soll. (Standardmäßig nicht öffentlich)
  • Auth-Level:Keins wenn keine Authentifizierung notwendig sein soll. (Standard)
  • Auth-Level:Niedrig wenn das Authentifizierungs-Level mindestens 'niedrig' sein soll.
  • Auth-Level:Hoch wenn das Authentifizierungs-Level mindestens 'hoch' sein soll.
  • Auth-Level:Substantiell wenn das Authentifizierungs-Level mindestens 'substantiell' sein soll.


Wurden mehrere Auth-Level am Formular hinterlegt, greift immer das höchste Authentifizierungslevel. 
Beispiel: Wurde am Formular Auth-Level:Niedrig und Auth-Level:Hoch angegeben, so wird der ExtensionAPI das Auth-Level Hoch mitgeteilt.


Achtung:
Nach erfolgter Konfiguration der Sichtbarkeiten eines Formulars muss dieses dem Portal über die ExtensionAPI aktiv mitgeteilt werden. Hierfür können Sie entweder die Funktionalität des Portals verwenden oder die Synchronisation in der Oberfläche des Login-Dienstes innerhalb von formcycle ausführen.


Biespielhafte Konfiguration der Sichtbarkeit eines Formulars


Statusverarbeitung

Bei Verwendung der Anbindung eines ExtensionAPI-Portals stellt formcycle innerhalb der Statusverarbeitung weitere Funktionalitäten für die Interaktion mit dem Portal zur Verfügung.


Erweitere ExtensionAPI Funktionalitäten


Datei ausliefern

Auswahl von Dateien zur Übertragung an ein Portal mittles ExtensionAPI


Mittels dieser Aktion ist es möglich Dateien aus formcycle an den Datensatz innerhalb des ExtensionAPI-Portals anzuhängen. Die Quelle dieser Dateien spiel hierbei keine Rolle, sodass z.B. neben Formular-Uploads auch innerhalb der Statusverarbeitung erzeugte Dokumente verwendet werden können.


Rückleitung

Angabe einer Nachricht für die Anzeige im ExtensionAPI-Portal 
nach einer erfolgten Rückleitung


Mit dieser Aktion ist es möglich innerhalb der Statusverarbeitung eines Formulars einen Rücksprung in das Portal der ExtensionAPI auszulösen. Dieser wird nach Beendigung der Statusverarbeitung durchgeführt und überträgt zusätzlich die konfigurierte Nachricht. Abhängig von der Implementierung kommt diese anschließend in der Oberfläche des Portals zur Anzeige.


Status ändern

Auswahl des Status in dem der Datensatz im Portal der ExtensionAPI 
geändert werden soll


Diese Aktion erlaubt es den Status eines Datensatzes innerhalb des ExtensionAPI-Portals zu ändern. Abhängig von der Umsetzung und Konfiguration innerhalb des Portals hat dies z.B. Effekte auf die Sichtbarkeit der Datensätze.


Bezahlung starten

Auswahl des Bezahl-Projekts und Konfiguration der Daten des Bezahl-Prozesses


In dieser Aktion kann ein Bezahl-Prozess über die ExtensionAPI angestoßen werden. Hierfür werden neben der Auswahl eines über die ExtensionAPI bereitgestellten Bezahl-Projektes auch die entsprechenden Metadaten der Bezahlung konfiguriert. Nach dem Ausführen der Aktion stehen folgende Platzhalter zur Verfügung:


[%$<Aktionsname>.RESULT.amount%]

Der fällige Betrag des Bezahl-Vorgangs wie er an die ExtensionAPI übermittelt wurde (z.B. 1234 entspricht 12,34).


[%$<Aktionsname>.RESULT.decimalAmount%]

Der fällige Betrag des Bezahl-Vorgangs in einer Komma-separierten Form ohne Währung (z.B. 12,34).


[%$<Aktionsname>.RESULT.cashReference%]

Die Kassenreferenz des Bezahl-Vorgangs.


[%$<Aktionsname>.RESULT.currency%]

Die Währung des Bezahl-Vorgangs.


[%$<Aktionsname>.RESULT.paymentId%]

Die ID des angelegten Bezahl-Vorgangs.


[%$<Aktionsname>.RESULT.projectId%]

Die ID des Bezahl-Projekts, mit welchem der Bezahl-Vorgang gestartet wurde.


[%$<Aktionsname>.RESULT.tempDataId%]

Die ID des TempData-Eintrags, mit welchem der Bezahl-Vorgang gestartet wurde.


Bezahlung verarbeiten

Auswahl des Status des Bezahl-Vorgangs auf den reagiert werden soll


Bei diesem Ereignis handelt es sich um die Möglichkeit auf die Statusänderung eines Bezahl-Prozesses zu reagieren. Hierbei kann zwischen den Status Erfolgreich abgeschlossen, Durch den Benutzer abgebrochen und Fehlerhaft abgebrochen unterschieden werden. Sollten die entsprechenden Ereignisse nicht explizit konfiguriert sein oder keine Rückgabe einer Abschlussseite o.ä. definiert sein, kommt es zur Ausgabe eines Status-spezifischen Standard-Templates. Nachdem dieses Ereignis ausgelöst wurde, stehen folgende Platzhalter zur Verfügung:


[%$TRIGGER.paymentId%]

Die ID des Bezahl-Vorgangs.


[%$TRIGGER.paymentStatus%]

Der Status des Bezahl-Vorgangs.


[%$TRIGGER.tempDataId%] 

Die ID des TempData-Eintrags, mit welchem der Bezahl-Vorgang verknüpft ist.

War dieser Artikel hilfreich?

Das ist großartig!

Vielen Dank für das Feedback

Leider konnten wir nicht helfen

Vielen Dank für das Feedback

Wie können wir diesen Artikel verbessern?

Wählen Sie wenigstens einen der Gründe aus
CAPTCHA-Verifikation ist erforderlich.

Feedback gesendet

Wir wissen Ihre Bemühungen zu schätzen und werden versuchen, den Artikel zu korrigieren