Zeige letzte Bearbeiter
1 [[**Plugin-Download**>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/plugin-bundle-akdb-services&fileid=2671||rel="noopener noreferrer" target="_blank"]] (erfordert Anmeldung)
2
3 {{content/}}
4
5 {{info}}
6 **Achtung:**
7 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!
8 {{/info}}
9
10 {{figure image="formular_vorlage.png"}}
11 Formularvorlage //AKDB Basisdienste//
12 {{/figure}}
13
14
15 Über das //AKDB Bürgerkonto Service Plugin// werden Möglichkeiten zur Einbindung der AKDB Basisdienste **Bürgerkonto** und **Postkorb** in {{formcycle/}} bereitgestellt.
16
17
18 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.
19
20 == Einbindung des Bürgerkonto Logins im Designer ==
21
22 {{figure image="hilfe_bk_button.png"}}
23 Formular-Element //AKDB Bürgerkonto//
24 {{/figure}}
25
26 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:
27
28
29 ; Schaltflächen Text
30 : Beschriftung des Login-Buttons
31 ; Login im Popup
32 : Wenn aktiviert, wird die Login-Seite des Bürgerservice-Portals in einem Popup geöffnet, ansonst erfolgt die Anzeige in der gleichen Seite.
33 ; Formularseite nach Login
34 : Hier wird die Formularseite festgelegt, welche angezeigt werden soll, wenn der Login **erfolgreich **war.
35 ; Formularseite nach abgebrochenen Login
36 : Hier wird die Formularseite festgelegt, welche angezeigt werden soll, wenn der Login **abgebrochen** wurde.
37 ; Eingaben prüfen vor Login
38 : 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.
39 ; Art der Rückgabedaten {{id name="Art_Rueckgabedaten"/}}
40 : Hier besteht die Auswahl zwischen:
41
42 * **personenbezogenen Daten**
43 * **organisationsbezogenen Daten**
44 * **personen- oder organisationsbezogenen Daten**
45
46 : Mit dieser Einstellung lässt sich die Art der zu erwarteten Rückgabedaten steuern, je nach Anforderung.
47 : Das heißt, wenn beispielsweise nur Daten einer natürlichen Person im Formularprozess zugelassen sind, ist hier die Auswahl auf //personenbezogene Daten// einzustellen.
48 ; Bürgerdaten Parameter-Suffix {{id name="BK_Parameter_Suffix"/}}
49 : Hier kann ein Suffix definiert werden, welches beim Vorbelegen von Formularelementen, mit den ermittelten Bürgerkonto-Daten, Anwendung findet.
50 Durch das Suffix wird es möglich mehrere Authentifizierungen und Formularelement-Vorbelegungen innerhalb eines Formulars zu realisieren.
51 : Als Suffix sind Buchstaben, Zahlen und der Unterstrich erlaubt.
52 : __Beispiel:__
53 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. 
54 ; gefordertes Authentifizierungsverfahren
55 : Hier kann das dem Nutzer zur Verfügung stehende Authentifizierungsverfahren eingeschränkt werden.
56 : Es gibt folgende Auswahlmöglichkeiten:
57
58 * **keine Einschränkung**: Login mittels Passwort, Authega-Zertifikat oder Personalausweis steht zur Auswahl
59 * **Authega**: Nur die Authentifizierung mittels Authega-Zertifikat steht zur Auswahl
60 * **Authega oder Personalausweis**: Login mittels Authega-Zertifikat oder Personalausweis steht zur Auswahl **(Achtung: Diese Auswahl wird momentan nicht mehr vom AKDB Portal unterstützt!)**
61 * **Personalausweis**: nur Authentifizierung mittels Personalausweis steht zur Auswahl
62
63 == Einbindung des Bürgerkonto Logins als Externer Benutzer ==
64
65 {{version major="6" minor="4" patch="0"/}} Die Option steht in der {{formcycle/}} - Version ab 6.4.0 mit der einer Plugin - Version ab 2.8.0 zur Verfügung.
66
67 {{figure image="externer_benutzer_akdb.png"}}
68 Bürgerkonto-Login als Externer Benutzer einrichten. (Schritt 1)
69 {{/figure}}
70
71 Zur Einbindung des Bürgerkonto-Logins über einen [[Externen Benutzer>>doc:Formcycle.UserInterface.UserSettings.ExternalUsers.WebHome||target="_blank"]], muss diese Login Möglichkeit zuvor konfiguriert werden.
72
73 Dazu muss im jeweiligen Mandaten in den Konfigurationsbereich Externe Benutzer gewechselt werden. Dort muss mittels {{ficon name="plus-circle-outline"/}} der über das Plugin zur Verfügung gestellte **AKDB Login** ausgewählt werden.
74
75 {{figure image="externer_benutzer_akdb_s2.png"}}
76 Bürgerkonto-Login als Externer Benutzer einrichten. (Schritt 2)
77 {{/figure}}
78
79 {{figure image="externer_benutzer_akdb_s3.png"}}
80 Bürgerkonto-Login als Externer Benutzer einrichten. (Schritt 3)
81 {{/figure}}
82
83
84 == Designer-Element: Bürgerkonto Daten Vorlage ==
85
86 {{figure image="hilfe_bk_vorlagen.png"}}
87 Formularvorlage //AKDB Basisdienste//
88 {{/figure}}
89
90 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.
91
92 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:
93
94
95 {{code language="javascript"}}
96 XFC_METADATA.pluginResults.AKDBLoginAnalyzer
97 {{/code}}
98
99 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.
100
101 {{info}}
102 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.
103 Ist keine extra Kennzeichnung vorhanden, so ist der Parameter in beiden Bereichen vorhanden.
104 {{/info}}
105
106 {{table dataTypeAlpha="0" preSort="0-asc"}}
107 |=Parameter|=Beschreibung
108 |BPK|Bereichsspezifisches Personenkennzeichen (in verschlüsselter Form)
109 |BPK_Decoded|Bereichsspezifisches Personenkennzeichen (in entschlüsselter Form)
110 |PostboxId|Postkorb-ID des Nutzers. Muss bei Anbindung des Postkorbs verwendet werden.
111 |(((
112 Email (PBA)
113 tfAntragstellerEmail (PBA)
114 )))|Email-Adresse
115 |Gender|Anrede als numerischer Wert nach ISO 5218:2004
116 |GenderName|Lesbarer Text für Geschlechter-Code aus Attribut „gender“.
117 Mögliche Werte: //männlich//, //weiblich//
118 |(((
119 Salutation
120 tfAntragstellerAnrede (PBA)
121 selAntragstellerAnrede (PBA)
122 )))|Anrede, wird mit Hilfe des Geschlechter-Code aus Attribut „gender“ erzeugt.
123 Mögliche Werte: //Herr//, //Frau, Nicht bekannt//
124 |(((
125 PersonalTitle (PBA)
126 tfAntragstellerTitel (PBA)
127 )))|Akademischer Titel
128 |(((
129 FirstName
130 tfAntragstellerVorname (PBA)
131 )))|Vorname
132 |(((
133 LastName
134 tfAntragstellerName (PBA)
135 )))|Nachname
136 |(((
137 ZipCode (PBA)
138 tfAntragstellerPLZ (PBA)
139 )))|Postleitzahl
140 |(((
141 Address (PBA)
142 tfAntragstellerAdresse (PBA)
143 )))|Adresse bestehend aus Strasse und Hausnummer
144 |(((
145 City (PBA)
146 tfAntragstellerOrt (PBA)
147 )))|Ort
148 |(((
149 BirthDate
150 tfAntragstellerGeburtsdatum (PBA)
151 )))|Geburtsdatum im Format: dd.MM.yyyy
152 |(((
153 PlaceOfBirth
154 tfAntragstellerGeburtsort (PBA)
155 )))|Geburtsort
156 |(((
157 TelephoneNumber
158 tfAntragstellerTelefon (PBA)
159 )))|Telefonnummer
160 |tfOrgVertreterVorname (OBA)|Vorname der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
161 |tfOrgVertreterName (OBA)|Nachname der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
162 |tfOrgVertreterTitel (OBA)|Akademischer Titel der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
163 |(((
164 tfOrgVertreterAnrede (OBA)
165 selOrgVertreterAnrede (OBA)
166 )))|(((
167 Anrede für die Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
168 Anrede, wird mit Hilfe des Geschlechter-Code aus Attribut „gender“ erzeugt. Mögliche Werte: //Herr//, //Frau, Nicht bekannt//
169 )))
170 |tfOrgVertreterGeburtsdatum (OBA)|Akademischer Titel der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
171 |tfOrgVertreterGeburtsort (OBA)|Geburtsort der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
172 |tfOrgEmail (OBA)|E-Mail Adresse der angemeldeten Person, welche diese im Unternehmen hat. (Kann von der E-Mail Adresse am personenbezogenen Account abweichen.)
173 |tfOrgVertreterTelefon (OBA)|Telefonnummer der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
174 |tfOrgStrasse (OBA)|Strasse
175 |tfOrgHausnummer (OBA)|Hausnummer
176 |tfOrgHausnummerZusatz (OBA)|Hausnummern Zusatz
177 |tfOrgAdressZusatz (OBA)|Adress-Zusatz
178 |tfOrgPLZ (OBA)|PLZ
179 |tfOrgOrt (OBA)|Ort
180 |tfOrgName (OBA)|Name der Organisation (mit Rechtsform)
181 |tfOrgID (OBA)|Organisations-ID
182 |Rechtsform (OBA)|Rechtsform der Organisation
183 |tfOrgRegisterOrt (OBA)|Register(gerichts)-Ort
184 |tfOrgRegisterNummer (OBA)|Registernummer
185 |TrustLevel|(((
186 Vertrauensniveau, gibt Auskunft über gewählte Authentifizierungsmethode:
187 * **STORK-QAA-Level-1**: Authentifizierung mittels Benutzername / Passwort
188 * **STORK-QAA-Level-3:** Authentifizierung mittels Authega Zertifikat
189 * **STORK-QAA-Level-4**: Authentifizierung mittels nPA
190 )))
191 |NPA_Address (PBA)|Adresse, wie sie auf dem NPA vermerkt ist (alles in Großbuchstaben)
192 |NPA_City (PBA)|Ort, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben)
193 |NPA_FirstName|Vorname, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben)
194 |NPA_LastName|Nachname, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben)
195 |NPA_PersonalTitle|Akademischer Titel, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben)
196 |IsIndividualPerson|Liefert den Wert **true**, wenn es sich bei den Daten aus dem Bürgerkonto um personenbezogene Daten handelt, sonst **false**.
197 |IsOrganization|Liefert den Wert **true**, wenn es sich bei den Daten aus dem Bürgerkonto um organisationsbezogene Daten handelt, sonst **false**.
198 {{/table}}
199
200 {{info}}
201 **Hinweis:**
202 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.
203 \\__Beispiel:__
204 Wenn als Suffix "**_Person2**" definiert wurde, so ergibt sich beim Vornamen der Formular-Elementname "tfAntragstellerVorname**_Person2**".
205 {{/info}}
206
207 === Darstellung des genutzten Authentifizierungsverfahren ===
208
209 {{figure image="hilfe_trustlevel_visualisierung.png"}}
210 Darstellung des verwendeten Vertrauensniveaus an der Bürgerkonto Daten Vorlage
211 {{/figure}}
212
213 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.
214
215 Für die einzelnen Vertrauensniveaus existieren folgende Beschriftungen:
216
217 * Level 1 (Authentifizierung mittels Benutzername / Passwort): **Standard**
218 * Level 3 (Authentifizierung mittels Authega Zertifikat): **Authega**
219 * Level 4 (Authentifizierung mittels nPA): **Personalausweis**
220
221 {{figure image="hilfe_trustlevel_keine_visualisierung.png"}}
222 Wenn keine visuelle Markierung gewünscht ist, so kann dies durch ein zusätzliches Attribut „noRibbon“ am Vorlagen-Fieldset unterbunden werden
223 {{/figure}}
224
225 == AKDB Postkorbanbindung in der Statusverarbeitung ==
226
227
228 Für die Anbindung zum Versand von Postkorbnachrichten wird das Aktions-Plugin **AKDB:Postkorbnachricht senden** zur Verfügung gestellt.
229 Mittels dieser Plugin-Aktion, können ähnlich einer E-Mail Aktion, Nachrichten an den Postkorb der AKDB weitergeleitet werden.
230
231 Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt die nachfolgend kurz beschrieben werden.
232
233 {{panel title="Einstellungen für Absender und Empfänger" fullwidth="true" initial="visible" triggerable="true"}}
234
235
236 {{figure image="postkorb_absender.png"}}
237 Einstellungen für Absender und Empfänger
238 {{/figure}}
239
240 ; Dienst (Pflicht)
241 : Wird als Information in der Postkorb-Ansicht im Bürgerservice-Portal verwendet.
242 ; Mandant (Pflicht)
243 : Wird als Information in der Postkorb-Ansicht im Bürgerservice-Portal verwendet.
244 ; Absender-Link
245 : 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.
246 ; Postkorb ID aus den Vorgangsdaten ermitteln?
247 : 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.
248 Bei einem AKDB Bürgerkonto-Login wird die Postkorb-ID immer mit übermittelt und standardmäßig am Formulareingang hinterlegt.
249 Für den Fall, dass es mehrere konfigurierte Anmeldungen innerhalb eines Formulars gibt, kann hier die Auswahl über den [[Bürgerdaten Parameter-Suffix>>doc:||anchor="BK_Parameter_Suffix"]] eingegrenzt werden.
250 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.)
251
252
253 {{/panel}}
254
255 {{panel title="Konfiguration des Nachrichteninhalts" fullwidth="true" initial="visible" triggerable="true"}}
256
257
258 {{figure image="postkorb_nachricht.png"}}
259 Konfiguration von Betreff, Nachrichteninhalt und Anhängen
260 {{/figure}}
261
262
263 ; Betreff (Pflicht)
264 : Nahrichtenbetreff, es werden Platzhalter unterstützt.
265 ; Inhalt (Pflicht)
266 : Nachrichtentext, es werden Platzhalter unterstützt.
267 ; Anhänge
268 : Hier können Dateien als Attachments an die Postkorb-Nachricht gehangen werden.
269 : Zur Auswahl stehen dabei:
270 :; Upload
271 :: bezieht sich auf alle Dateianhänge, die über das Formular hochgeladen wurden
272 :; Workflow
273 :: bezieht sich auf alle Dateianhänge, die über den aktuellen FORMCYCLE Workflow hochgeladen wurden.
274 :; Posteingang
275 :: bezieht sich auf alle Dateianhänge, die über das Postfach hochgeladen wurden.
276 :: Unterstützte Dateiformate sind: PDF, HTML, Plaintext, MS Word, JPEG, GIF, PNG
277
278
279 {{info}}
280 **Achtung:**
281 Die Schnittstelle zum Postkorb der AKDB unterstützt dabei maximal 5 Anhänge pro Nachricht mit je 2 MB Maximalgröße.
282 {{/info}}
283
284 {{/panel}}
285
286 === Bedingte Ausführung der //AKDB:Postkorbnachricht senden//-Aktion ===
287
288 {{figure image="postkorb_nachricht_bedingung.png"}}
289 Konfiguration einer Bedingung für Ausführung der Aktion //AKDB~:Postkorbnachricht senden//
290 {{/figure}}
291
292 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.
293 Dies bedeutet aber auch, dass wenn in einem Formularprozess kein zwingender Bürgerkonto-Login erfolgt, die Postkorb-ID **nicht** in der Statusverarbeitung vorhanden ist.
294 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.
295
296 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.
297
298 {{code language="javascript"}}
299 REGEX([%$POSTKORB_ID%]=^.+$)
300 {{/code}}
301
302 ==== Erweitere Bedingungsprüfung bei Verwendung unterschiedlicher Login-Arten (personenbezogenes bzw. organisationsbezogenes Login) ====
303
304
305 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.
306 Im Formular müssen dann versteckte Eingabefelder mit den Element-Namen **IsIndividualPerson** und **IsOrganization** vorhanden sein.
307 (Dies ist automatisch der Fall, wenn die entsprechenden Vorlagen //Bürgerkonto personenbezogene Daten// und //Bürgerkonto organisationsbezogene Daten// verwendet werden).
308
309 Die Konfiguration einer Ausführungs-Bedingung an einer Aktion //AKDB:Postkorbnachricht senden// für eine **personenbezogene** Anmeldung wäre dann folgendermaßen:
310
311
312 {{code language="javascript"}}
313 REGEX([%IsIndividualPerson%]=true) REGEX([%$POSTKORB_ID%]=^.+$)
314 {{/code}}
315
316
317 Bei Nutzung einer **organisationsbezogenen** Anmeldung ist folgende Bedingung zu konfigurieren:
318
319
320 {{code language="javascript"}}
321 REGEX([%IsOrganization%]=true) REGEX([%$POSTKORB_ID%]=^.+$)
322 {{/code}}
323
324 {{info}}
325 Bitte beachten Sie, dass Bedingungen vom Typ "Mehrere Bedinungen" werden immer UND-Verknüpft sind. Somit müssen alle REGEX-Bedingungen erfüllt sein, damit die Aktion ausgeführt wird.
326 {{/info}}

Navigation

Copyright 2000-2025