Änderungen von Dokument AKDB: Bürgerkonto-Service-Plugin

Von Version < 13.16 >

bearbeitet von rth
am 12.03.2020, 10:04

Auf Version 13.10 >

bearbeitet von rth
am 03.03.2020, 09:15

Änderungskommentar: Imported from XAR

Rohform
Im Layout

Zusammenfassung

Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Inhalt

@@ -1,10
          +1,5 @@
  {{content/}}
--{{info}}
--**Achtung:**
--Bevor Sie die AKDB-Basisdienste in ihren Formular-Prozessen einbinden, stellen Sie bitte sicher, dass die konfigurative Anbindung der Dienste durch den {{formcycle/}}-Administrator erfolgt ist!
--{{/info}}
--
  {{figure image="formular_vorlage.png"}}
  Formularvorlage //AKDB Basisdienste//
  {{/figure}}
@@ -13,7
          +13,7 @@
  Über das //AKDB Bürgerkonto Service Plugin// werden Möglichkeiten zur Einbindung der AKDB Basisdienste **Bürgerkonto** und **Postkorb** in {{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.
++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 ==
@@ -30,35
          +30,35 @@
  ; 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.
++: 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.
++: Formularseite 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 {{id name="Art_Rueckgabedaten"/}}
++; 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.
++:: **personenbezogenen Daten**
++:: **organisationsbezogenen Daten**
++:: **personen- oder organisationsbezogenen Daten**
++: Mit dieser Einstellung lässt sich die Art der zu erwarteten Rückgabedaten, je nach Anforderung, steuern.
++: Das heißt, wenn beispielsweise nur Daten einer natürlichen Person im Formularprozess zulassen 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.
++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. Durch das Suffix wird es möglich mehrere Authentifizierungen und Formularelement-Vorbelegungen innerhalb eines Formulars zu realisieren.
  ; gefordertes Authentifizierungsverfahren
  : Hier kann das dem Nutzer zur Verfügung stehende Authentifizierungsverfahren eingeschränkt werden.
--: Es gibt folgende Auswahlmöglichkeiten:
++Es gibt folgende Auswahlmöglichkeiten:
++:; keine Einschränkung
++:: Login mittels Passwort, Authega-Zertifikat oder Personalausweis steht zur Auswahl
++:; Authega
++:: nur Authentifizierung mittels Authega-Zertifikat steht zur Auswahl
++:; Authega oder Personalausweis
++:: Login mittels Authega-Zertifikat oder Personalausweis steht zur Auswahl **(Achtung: Diese Auswahl wird momentan nicht mehr vom AKDB Portal unterstützt)**
++:; Personalausweis
++:: nur Authentifizierung mittels Personalausweis steht zur Auswahl
--* **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 **(Achtung: Diese Auswahl wird momentan nicht mehr vom AKDB Portal unterstützt!)**
--* **Personalausweis**: nur Authentifizierung mittels Personalausweis steht zur Auswahl
--
  == Designer-Element: Bürgerkonto Daten Vorlage ==
  {{figure image="hilfe_bk_vorlagen.png"}}
@@ -65,7
          +65,7 @@
  Formularvorlage //AKDB Basisdienste//
  {{/figure}}
--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.
++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 Anzeige, der zurückgelieferten Daten ermöglichen.
  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:
@@ -77,8
          +77,7 @@
  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.
  {{info}}
--Parameter, welche nur bei einer **p**ersonen**b**ezogenen **A**nmeldung vorhanden sind, sind mit **(PBA)** und die die nur bei einer **o**rganisations**b**ezogenen **A**nmeldung vorhanden sind, mit **(OBA)** gekennzeichnet.
--Ist keine extra Kennzeichnung vorhanden, so ist der Parameter in beiden Bereichen vorhanden.
++Parameter, welche nur bei einer **p**ersonen**b**ezogenen **A**nmeldung vorhanden sind, sind mit **(PBA)** und die die nur bei einer **o**rganisations**b**ezogenen **A**nmeldung vorhanden sind, mit **(OBA)** gekennzeichnet. Ist keine extra Kennzeichnung vorhanden, so ist der Parameter in beiden Bereichen vorhanden.
  {{/info}}
  {{table dataTypeAlpha="0" preSort="0-asc"}}
@@ -114,7
          +114,7 @@
  |(((
  ZipCode (PBA)
  tfAntragstellerPLZ (PBA)
--)))|Postleitzahl
++)))|PLZ
  |(((
  Address (PBA)
  tfAntragstellerAdresse (PBA)
@@ -162,17
          +162,17 @@
  |tfOrgRegisterNummer (OBA)|Registernummer
  |TrustLevel|(((
  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
++**STORK-QAA-Level-1**: Authentifizierung mittels Benutzername / Passwort
++**STORK-QAA-Level-3:** Authentifizierung mittels Authega Zertifikat
++**STORK-QAA-Level-4**: Authentifizierung mittels nPA
  )))
--|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**.
++|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**.
  {{/table}}
  {{info}}
@@ -222,10
          +222,9 @@
  ; 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.
  ; 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.
--Bei einem AKDB Bürgerkonto-Login wird die Postkorb-ID immer mit übermittelt und standardmäßig am Formulareingang hinterlegt.
--Wenn an dieser Stelle die standardmäßige Einstellung verwendet wird, so wird versucht die Postkorb-ID immer aus den am Formulareingang hinterlegten Daten zu ermitteln.
--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.
++: Diese Angabe dient der Bestimmung zur Ermittlung der Postkorb-ID. Über die Postkorb-ID wird das genaue Ziel für den Nachrichtenversand bestimmt, also der Nachrichten-Empfänger.
++Bei einem AKDB Bürgerkonto-Login wird die Postkorb-ID immer mit übermittelt und standardmäßig am FORMCYCLE Vorgang hinterlegt.
++Standardmäßig wird versucht die notwendige Postkorb-ID aus den am FORMCYCLE Vorgang hinterlegten Daten zu ermitteln. Wenn es mehrere konfigurierte Anmeldungen innerhalb eines Formulars gibt, so ist die Auswahl über den  Bürgerdaten Parameter-Suffix einzugrenzen.
  Darüber hinaus ist es möglich die Postkorb-ID fest oder über einen Platzhalter (**[%$POSTKORB_ID%]**) zu definieren.
@@ -267,8
          +267,7 @@
  Konfiguration einer Bedingung für Ausführung der Aktion //AKDB~:Postkorbnachricht senden//
  {{/figure}}
--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.
++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 durch einen regulären Ausdruck. Die aktuelle Postkorb-ID wird dabei mittels eines System-Platzhalters im Prüfausdruck zur Verfügung gestellt.

Änderungen von Dokument AKDB: Bürgerkonto-Service-Plugin

Zusammenfassung

Details

Navigation