... |
... |
@@ -2,7
+2,7 @@ |
2 |
2 |
|
3 |
3 |
{{info}} |
4 |
4 |
**Achtung:** |
5 |
|
-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. |
|
5 |
+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! |
6 |
6 |
{{/info}} |
7 |
7 |
|
8 |
8 |
{{figure image="formular_vorlage.png"}} |
... |
... |
@@ -13,7
+13,7 @@ |
13 |
13 |
Über das //AKDB Bürgerkonto Service Plugin// werden Möglichkeiten zur Einbindung der AKDB Basisdienste **Bürgerkonto** und **Postkorb** in {{formcycle/}} bereitgestellt. |
14 |
14 |
|
15 |
15 |
|
16 |
|
-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. |
|
16 |
+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. |
17 |
17 |
|
18 |
18 |
|
19 |
19 |
== Einbindung des Bürgerkonto Logins im Designer == |
... |
... |
@@ -30,35
+30,35 @@ |
30 |
30 |
; Login im Popup |
31 |
31 |
: Wenn aktiviert, wird die Login-Seite des Bürgerservice-Portals in einem Popup geöffnet, ansonst erfolgt die Anzeige in der gleichen Seite. |
32 |
32 |
; Formularseite nach Login |
33 |
|
-: Hier wird die Formularseite festgelegt, welche angezeigt werden soll, wenn der Login erfolgreich war. |
|
33 |
+: Hier wird die Formularseite festgelegt, welche angezeigt werden soll, wenn der Login **erfolgreich **war. |
34 |
34 |
; Formularseite nach abgebrochenen Login |
35 |
|
-: Formularseite welche angezeigt werden soll, wenn der Login abgebrochen wurde. |
|
35 |
+: Hier wird die Formularseite festgelegt, welche angezeigt werden soll, wenn der Login **abgebrochen** wurde. |
36 |
36 |
; Eingaben prüfen vor Login |
37 |
37 |
: 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. |
38 |
|
-; Art der Rückgabedaten |
|
38 |
+; Art der Rückgabedaten {{id name="Art_Rueckgabedaten"/}} |
39 |
39 |
: Hier besteht die Auswahl zwischen: |
40 |
|
-:: **personenbezogenen Daten** |
41 |
|
-:: **organisationsbezogenen Daten** |
42 |
|
-:: **personen- oder organisationsbezogenen Daten** |
43 |
|
-: Mit dieser Einstellung lässt sich die Art der zu erwarteten Rückgabedaten, je nach Anforderung, steuern. |
44 |
|
-: Das heißt, wenn beispielsweise nur Daten einer natürlichen Person im Formularprozess zulassen sind, ist hier die Auswahl auf //personenbezogene Daten// einzustellen. |
|
40 |
+ |
|
41 |
+* **personenbezogenen Daten** |
|
42 |
+* **organisationsbezogenen Daten** |
|
43 |
+* **personen- oder organisationsbezogenen Daten** |
|
44 |
+ |
|
45 |
+: Mit dieser Einstellung lässt sich die Art der zu erwarteten Rückgabedaten steuern, je nach Anforderung. |
|
46 |
+: Das heißt, wenn beispielsweise nur Daten einer natürlichen Person im Formularprozess zugelassen sind, ist hier die Auswahl auf //personenbezogene Daten// einzustellen. |
45 |
45 |
; Bürgerdaten Parameter-Suffix |
46 |
46 |
: Hier kann ein Suffix definiert werden, welches beim Vorbelegen von Formularelementen, mit den ermittelten Bürgerkonto-Daten, Anwendung findet. |
|
49 |
+Durch das Suffix wird es möglich mehrere Authentifizierungen und Formularelement-Vorbelegungen innerhalb eines Formulars zu realisieren. |
47 |
47 |
: Als Suffix sind Buchstaben, Zahlen und der Unterstrich erlaubt. |
48 |
48 |
: __Beispiel:__ |
49 |
|
-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. |
|
52 |
+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. |
50 |
50 |
; gefordertes Authentifizierungsverfahren |
51 |
51 |
: Hier kann das dem Nutzer zur Verfügung stehende Authentifizierungsverfahren eingeschränkt werden. |
52 |
|
-Es gibt folgende Auswahlmöglichkeiten: |
53 |
|
-:; keine Einschränkung |
54 |
|
-:: Login mittels Passwort, Authega-Zertifikat oder Personalausweis steht zur Auswahl |
55 |
|
-:; Authega |
56 |
|
-:: nur Authentifizierung mittels Authega-Zertifikat steht zur Auswahl |
57 |
|
-:; Authega oder Personalausweis |
58 |
|
-:: Login mittels Authega-Zertifikat oder Personalausweis steht zur Auswahl **(Achtung: Diese Auswahl wird momentan nicht mehr vom AKDB Portal unterstützt)** |
59 |
|
-:; Personalausweis |
60 |
|
-:: nur Authentifizierung mittels Personalausweis steht zur Auswahl |
|
55 |
+: Es gibt folgende Auswahlmöglichkeiten: |
61 |
61 |
|
|
57 |
+* **keine Einschränkung**: Login mittels Passwort, Authega-Zertifikat oder Personalausweis steht zur Auswahl |
|
58 |
+* **Authega**: Nur die Authentifizierung mittels Authega-Zertifikat steht zur Auswahl |
|
59 |
+* **Authega oder Personalausweis**: Login mittels Authega-Zertifikat oder Personalausweis steht zur Auswahl **(Achtung: Diese Auswahl wird momentan nicht mehr vom AKDB Portal unterstützt!)** |
|
60 |
+* **Personalausweis**: nur Authentifizierung mittels Personalausweis steht zur Auswahl |
|
61 |
+ |
62 |
62 |
== Designer-Element: Bürgerkonto Daten Vorlage == |
63 |
63 |
|
64 |
64 |
{{figure image="hilfe_bk_vorlagen.png"}} |
... |
... |
@@ -65,7
+65,7 @@ |
65 |
65 |
Formularvorlage //AKDB Basisdienste// |
66 |
66 |
{{/figure}} |
67 |
67 |
|
68 |
|
-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. |
|
68 |
+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. |
69 |
69 |
|
70 |
70 |
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: |
71 |
71 |
|
... |
... |
@@ -77,7
+77,8 @@ |
77 |
77 |
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. |
78 |
78 |
|
79 |
79 |
{{info}} |
80 |
|
-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. |
|
80 |
+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. |
|
81 |
+Ist keine extra Kennzeichnung vorhanden, so ist der Parameter in beiden Bereichen vorhanden. |
81 |
81 |
{{/info}} |
82 |
82 |
|
83 |
83 |
{{table dataTypeAlpha="0" preSort="0-asc"}} |
... |
... |
@@ -113,7
+113,7 @@ |
113 |
113 |
|((( |
114 |
114 |
ZipCode (PBA) |
115 |
115 |
tfAntragstellerPLZ (PBA) |
116 |
|
-)))|PLZ |
|
117 |
+)))|Postleitzahl |
117 |
117 |
|((( |
118 |
118 |
Address (PBA) |
119 |
119 |
tfAntragstellerAdresse (PBA) |
... |
... |
@@ -161,17
+161,17 @@ |
161 |
161 |
|tfOrgRegisterNummer (OBA)|Registernummer |
162 |
162 |
|TrustLevel|((( |
163 |
163 |
Vertrauensniveau, gibt Auskunft über gewählte Authentifizierungsmethode: |
164 |
|
-**STORK-QAA-Level-1**: Authentifizierung mittels Benutzername / Passwort |
165 |
|
-**STORK-QAA-Level-3:** Authentifizierung mittels Authega Zertifikat |
166 |
|
-**STORK-QAA-Level-4**: Authentifizierung mittels nPA |
|
165 |
+* **STORK-QAA-Level-1**: Authentifizierung mittels Benutzername / Passwort |
|
166 |
+* **STORK-QAA-Level-3:** Authentifizierung mittels Authega Zertifikat |
|
167 |
+* **STORK-QAA-Level-4**: Authentifizierung mittels nPA |
167 |
167 |
))) |
168 |
|
-|NPA_Address (PBA)|Adresse, wie sie auf dem NPA vermerkt ist (Alles in Großbuchstaben) |
169 |
|
-|NPA_City (PBA)|Ort, wie er auf dem NPA vermerkt ist (Alles in Großbuchstaben) |
170 |
|
-|NPA_FirstName|Vorname, wie er auf dem NPA vermerkt ist (Alles in Großbuchstaben) |
171 |
|
-|NPA_LastName|Nachname, wie er auf dem NPA vermerkt ist (Alles in Großbuchstaben) |
172 |
|
-|NPA_PersonalTitle|Akademischer Titel, wie er auf dem NPA vermerkt ist (Alles in Großbuchstaben) |
173 |
|
-|IsIndividualPerson|Liefert den Wert **true** wenn es sich bei den Daten aus dem Bürgerkonto um personenbezogene Daten handelt, sonst **false**. |
174 |
|
-|IsOrganization|Liefert den Wert **true** wenn es sich bei den Daten aus dem Bürgerkonto um organisationsbezogene Daten handelt, sonst **false**. |
|
169 |
+|NPA_Address (PBA)|Adresse, wie sie auf dem NPA vermerkt ist (alles in Großbuchstaben) |
|
170 |
+|NPA_City (PBA)|Ort, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben) |
|
171 |
+|NPA_FirstName|Vorname, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben) |
|
172 |
+|NPA_LastName|Nachname, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben) |
|
173 |
+|NPA_PersonalTitle|Akademischer Titel, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben) |
|
174 |
+|IsIndividualPerson|Liefert den Wert **true**, wenn es sich bei den Daten aus dem Bürgerkonto um personenbezogene Daten handelt, sonst **false**. |
|
175 |
+|IsOrganization|Liefert den Wert **true**, wenn es sich bei den Daten aus dem Bürgerkonto um organisationsbezogene Daten handelt, sonst **false**. |
175 |
175 |
{{/table}} |
176 |
176 |
|
177 |
177 |
{{info}} |