Zeige letzte Bearbeiter
1 {{content/}}
2
3 {{info}}
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.
6 {{/info}}
7
8 {{figure image="formular_vorlage.png"}}
9 Formularvorlage //AKDB Basisdienste//
10 {{/figure}}
11
12
13 Über das //AKDB Bürgerkonto Service Plugin// werden Möglichkeiten zur Einbindung der AKDB Basisdienste **Bürgerkonto** und **Postkorb** in {{formcycle/}} bereitgestellt.
14
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.
17
18
19 == Einbindung des Bürgerkonto Logins im Designer ==
20
21 {{figure image="hilfe_bk_button.png"}}
22 Formular-Element //AKDB Bürgerkonto//
23 {{/figure}}
24
25 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:
26
27
28 ; Schaltflächen Text
29 : Beschriftung des Login-Buttons
30 ; Login im Popup
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 ; Formularseite nach Login
33 : Hier wird die Formularseite festgelegt, welche angezeigt werden soll, wenn der Login erfolgreich war.
34 ; Formularseite nach abgebrochenen Login
35 : Formularseite welche angezeigt werden soll, wenn der Login abgebrochen wurde.
36 ; Eingaben prüfen vor Login
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
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.
45 ; Bürgerdaten Parameter-Suffix
46 : Hier kann ein Suffix definiert werden, welches beim Vorbelegen von Formularelementen, mit den ermittelten Bürgerkonto-Daten, Anwendung findet.
47 : Als Suffix sind Buchstaben, Zahlen und der Unterstrich erlaubt.
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.
50 ; gefordertes Authentifizierungsverfahren
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
61
62 == Designer-Element: Bürgerkonto Daten Vorlage ==
63
64 {{figure image="hilfe_bk_vorlagen.png"}}
65 Formularvorlage //AKDB Basisdienste//
66 {{/figure}}
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.
69
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
72
73 {{code language="javascript"}}
74 XFC_METADATA.pluginResults.AKDBLoginAnalyzer
75 {{/code}}
76
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
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.
81 {{/info}}
82
83 {{table dataTypeAlpha="0" preSort="0-asc"}}
84 |=Parameter|=Beschreibung
85 |BPK|Bereichsspezifisches Personenkennzeichen (in verschlüsselter Form)
86 |BPK_Decoded|Bereichsspezifisches Personenkennzeichen (in entschlüsselter Form)
87 |PostboxId|Postkorb-ID des Nutzers. Muss bei Anbindung des Postkorbs verwendet werden.
88 |(((
89 Email (PBA)
90 tfAntragstellerEmail (PBA)
91 )))|Email-Adresse
92 |Gender|Anrede als numerischer Wert nach ISO 5218:2004
93 |GenderName|Lesbarer Text für Geschlechter-Code aus Attribut „gender“.
94 Mögliche Werte: //männlich//, //weiblich//
95 |(((
96 Salutation
97 tfAntragstellerAnrede (PBA)
98 selAntragstellerAnrede (PBA)
99 )))|Anrede, wird mit Hilfe des Geschlechter-Code aus Attribut „gender“ erzeugt.
100 Mögliche Werte: //Herr//, //Frau, Nicht bekannt//
101 |(((
102 PersonalTitle (PBA)
103 tfAntragstellerTitel (PBA)
104 )))|Akademischer Titel
105 |(((
106 FirstName
107 tfAntragstellerVorname (PBA)
108 )))|Vorname
109 |(((
110 LastName
111 tfAntragstellerName (PBA)
112 )))|Nachname
113 |(((
114 ZipCode (PBA)
115 tfAntragstellerPLZ (PBA)
116 )))|PLZ
117 |(((
118 Address (PBA)
119 tfAntragstellerAdresse (PBA)
120 )))|Adresse bestehend aus Strasse und Hausnummer
121 |(((
122 City (PBA)
123 tfAntragstellerOrt (PBA)
124 )))|Ort
125 |(((
126 BirthDate
127 tfAntragstellerGeburtsdatum (PBA)
128 )))|Geburtsdatum im Format: dd.MM.yyyy
129 |(((
130 PlaceOfBirth
131 tfAntragstellerGeburtsort (PBA)
132 )))|Geburtsort
133 |(((
134 TelephoneNumber
135 tfAntragstellerTelefon (PBA)
136 )))|Telefonnummer
137 |tfOrgVertreterVorname (OBA)|Vorname der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
138 |tfOrgVertreterName (OBA)|Nachname der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
139 |tfOrgVertreterTitel (OBA)|Akademischer Titel der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
140 |(((
141 tfOrgVertreterAnrede (OBA)
142 selOrgVertreterAnrede (OBA)
143 )))|(((
144 Anrede für die Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
145 Anrede, wird mit Hilfe des Geschlechter-Code aus Attribut „gender“ erzeugt. Mögliche Werte: //Herr//, //Frau, Nicht bekannt//
146 )))
147 |tfOrgVertreterGeburtsdatum (OBA)|Akademischer Titel der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
148 |tfOrgVertreterGeburtsort (OBA)|Geburtsort der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
149 |tfOrgEmail (OBA)|E-Mail Adresse der angemeldeten Person, welche diese im Unternehmen hat. (Kann von der E-Mail Adresse am personenbezogenen Account abweichen.)
150 |tfOrgVertreterTelefon (OBA)|Telefonnummer der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
151 |tfOrgStrasse (OBA)|Strasse
152 |tfOrgHausnummer (OBA)|Hausnummer
153 |tfOrgHausnummerZusatz (OBA)|Hausnummern Zusatz
154 |tfOrgAdressZusatz (OBA)|Adress-Zusatz
155 |tfOrgPLZ (OBA)|PLZ
156 |tfOrgOrt (OBA)|Ort
157 |tfOrgName (OBA)|Name der Organisation (mit Rechtsform)
158 |tfOrgID (OBA)|Organisations-ID
159 |Rechtsform (OBA)|Rechtsform der Organisation
160 |tfOrgRegisterOrt (OBA)|Register(gerichts)-Ort
161 |tfOrgRegisterNummer (OBA)|Registernummer
162 |TrustLevel|(((
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
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**.
175 {{/table}}
176
177 {{info}}
178 **Hinweis:**
179 Wenn am Formular-Element //AKDB Bürgerkonto// ein Bürgerdaten Parameter-Suffix vergeben wurde, so muss dieses an die jeweiligen Formular-Elementnamen angefügt werden, damit eine Vorbelegung erfolgreich durchgeführt werden kann.
180 \\__Beispiel:__
181 Wenn als Suffix "**_Person2**" definiert wurde, so ergibt sich beim Vornamen der Formular-Elementname "tfAntragstellerVorname**_Person2**".
182 {{/info}}
183
184 === Darstellung des genutzten Authentifizierungsverfahren ===
185
186 {{figure image="hilfe_trustlevel_visualisierung.png"}}
187 Darstellung des verwendeten Vertrauensniveaus an der Bürgerkonto Daten Vorlage
188 {{/figure}}
189
190 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.
191
192 Für die einzelnen Vertrauensniveaus existieren folgende Beschriftungen:
193
194 * Level 1 (Authentifizierung mittels Benutzername / Passwort): **Standard**
195 * Level 3 (Authentifizierung mittels Authega Zertifikat): **Authega**
196 * Level 4 (Authentifizierung mittels nPA): **Personalausweis**
197
198 {{figure image="hilfe_trustlevel_keine_visualisierung.png"}}
199 Wenn keine visuelle Markierung gewünscht ist, so kann dies durch ein zusätzliches Attribut „noRibbon“ am Vorlagen-Fieldset unterbunden werden
200 {{/figure}}
201
202 == AKDB Postkorbanbindung in der Statusverarbeitung ==
203
204
205 Für die Anbindung zum Versand von Postkorbnachrichten wird das Aktions-Plugin **AKDB:Postkorbnachricht senden** zur Verfügung gestellt.
206 Mittels dieser Plugin-Aktion, können ähnlich einer E-Mail Aktion, Nachrichten an den Postkorb der AKDB weitergeleitet werden.
207
208 Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt die nachfolgend kurz beschrieben werden.
209
210 {{panel title="Einstellungen für Absender und Empfänger" fullwidth="true" initial="hidden" triggerable="true"}}
211
212
213 {{figure image="postkorb_absender.png"}}
214 Einstellungen für Absender und Empfänger
215 {{/figure}}
216
217 ; Dienst (Pflicht)
218 : Wird als Information in der Postkorb-Ansicht im Bürgerservice-Portal verwendet.
219 ; Mandant (Pflicht)
220 : Wird als Information in der Postkorb-Ansicht im Bürgerservice-Portal verwendet.
221 ; Absender-Link
222 : 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.
223 ; Postkorb ID aus den Vorgangsdaten ermitteln?
224 : 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.
225 Bei einem AKDB Bürgerkonto-Login wird die Postkorb-ID immer mit übermittelt und standardmäßig am FORMCYCLE Vorgang hinterlegt.
226 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.
227 Darüber hinaus ist es möglich die Postkorb-ID fest oder über einen Platzhalter (**[%$POSTKORB_ID%]**) zu definieren.
228
229
230 {{/panel}}
231
232 {{panel title="Konfiguration des Nachrichteninhalts" fullwidth="true" initial="hidden" triggerable="true"}}
233
234
235 {{figure image="postkorb_nachricht.png"}}
236 Konfiguration von Betreff, Nachrichteninhalt und Anhängen
237 {{/figure}}
238
239
240 ; Betreff (Pflicht)
241 : Nahrichtenbetreff, es werden Platzhalter unterstützt.
242 ; Inhalt (Pflicht)
243 : Nachrichtentext, es werden Platzhalter unterstützt.
244 ; Anhänge
245 : Hier können Dateien als Attachments an die Postkorb-Nachricht gehangen werden.
246 : Zur Auswahl stehen dabei:
247 :; Upload
248 :: bezieht sich auf alle Dateianhänge, die über das Formular hochgeladen wurden
249 :; Workflow
250 :: bezieht sich auf alle Dateianhänge, die über den aktuellen FORMCYCLE Workflow hochgeladen wurden.
251 :; Posteingang
252 :: bezieht sich auf alle Dateianhänge, die über das Postfach hochgeladen wurden.
253 :: Unterstützte Dateiformate sind: PDF, HTML, Plaintext, MS Word, JPEG, GIF, PNG
254
255
256 {{info}}
257 Die Schnittstelle zum Postkorb der AKDB unterstützt dabei maximal 5 Anhänge pro Nachricht mit je 2 MB Maximalgröße.
258 {{/info}}
259
260 {{/panel}}
261
262 === Bedingte Ausführung der //AKDB:Postkorbnachricht senden//-Aktion ===
263
264 {{figure image="postkorb_nachricht_bedingung.png"}}
265 Konfiguration einer Bedingung für Ausführung der Aktion //AKDB~:Postkorbnachricht senden//
266 {{/figure}}
267
268 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.
269 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.
270
271 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.
272
273 {{code language="javascript"}}
274 REGEX([%$POSTKORB_ID%]=^.+$)
275 {{/code}}
276
277 ==== Erweitere Bedingungsprüfung bei Verwendung unterschiedlicher Login-Arten (personenbezogenes bzw. organisationsbezogenes Login) ====
278
279
280 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.
281 Im Formular müssen dann versteckte Eingabefelder mit den Element-Namen **IsIndividualPerson** und **IsOrganization** vorhanden sein.
282 (Dies ist automatisch der Fall, wenn die entsprechenden Vorlagen //Bürgerkonto personenbezogene Daten// und //Bürgerkonto organisationsbezogene Daten// verwendet werden).
283
284 Die Konfiguration einer Ausführungs-Bedingung an einer Aktion //AKDB:Postkorbnachricht senden// für eine **personenbezogene** Anmeldung wäre dann folgendermaßen:
285
286
287 {{code language="javascript"}}
288 REGEX([%IsIndividualPerson%]=^(true)$) REGEX([%$POSTKORB_ID%]=^.+$)
289 {{/code}}
290
291
292 Bei Nutzung einer **organisationsbezogenen** Anmeldung ist folgende Bedingung zu konfigurieren:
293
294
295 {{code language="javascript"}}
296 REGEX([%IsOrganization%]=^(true)$) REGEX([%$POSTKORB_ID%]=^.+$)
297 {{/code}}

Navigation

Copyright 2000-2025