Verstecke letzte Bearbeiter
rth 13.30 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)
awa 13.27 2
rth 13.10 3 {{content/}}
4
rth 13.11 5 {{info}}
6 **Achtung:**
rth 13.12 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!
rth 13.11 8 {{/info}}
9
rth 13.10 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
rth 13.12 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.
rth 13.10 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
rth 13.12 34 : Hier wird die Formularseite festgelegt, welche angezeigt werden soll, wenn der Login **erfolgreich **war.
rth 13.10 35 ; Formularseite nach abgebrochenen Login
rth 13.12 36 : Hier wird die Formularseite festgelegt, welche angezeigt werden soll, wenn der Login **abgebrochen** wurde.
rth 13.10 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.
rth 13.13 39 ; Art der Rückgabedaten {{id name="Art_Rueckgabedaten"/}}
rth 13.10 40 : Hier besteht die Auswahl zwischen:
rth 13.12 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.
rth 13.17 48 ; Bürgerdaten Parameter-Suffix {{id name="BK_Parameter_Suffix"/}}
rth 13.10 49 : Hier kann ein Suffix definiert werden, welches beim Vorbelegen von Formularelementen, mit den ermittelten Bürgerkonto-Daten, Anwendung findet.
rth 13.12 50 Durch das Suffix wird es möglich mehrere Authentifizierungen und Formularelement-Vorbelegungen innerhalb eines Formulars zu realisieren.
rth 13.10 51 : Als Suffix sind Buchstaben, Zahlen und der Unterstrich erlaubt.
52 : __Beispiel:__
rth 13.15 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. 
rth 13.10 54 ; gefordertes Authentifizierungsverfahren
55 : Hier kann das dem Nutzer zur Verfügung stehende Authentifizierungsverfahren eingeschränkt werden.
rth 13.12 56 : Es gibt folgende Auswahlmöglichkeiten:
rth 13.10 57
rth 13.12 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
rth 13.30 63 == Einbindung des Bürgerkonto Logins als Externer Benutzer ==
64
rth 13.31 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.
rth 13.30 66
rth 14.2 67 {{figure image="externer_benutzer_akdb.png"}}
68 Bürgerkonto-Login als Externer Benutzer einrichten. (Schritt 1)
69 {{/figure}}
rth 13.30 70
rth 14.2 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.
rth 13.30 72
rth 14.3 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.
rth 14.2 74
rth 13.10 75 == Designer-Element: Bürgerkonto Daten Vorlage ==
76
77 {{figure image="hilfe_bk_vorlagen.png"}}
78 Formularvorlage //AKDB Basisdienste//
79 {{/figure}}
80
rth 13.15 81 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.
rth 13.10 82
83 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:
84
85
86 {{code language="javascript"}}
87 XFC_METADATA.pluginResults.AKDBLoginAnalyzer
88 {{/code}}
89
90 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.
91
92 {{info}}
rth 13.15 93 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.
94 Ist keine extra Kennzeichnung vorhanden, so ist der Parameter in beiden Bereichen vorhanden.
rth 13.10 95 {{/info}}
96
97 {{table dataTypeAlpha="0" preSort="0-asc"}}
98 |=Parameter|=Beschreibung
99 |BPK|Bereichsspezifisches Personenkennzeichen (in verschlüsselter Form)
100 |BPK_Decoded|Bereichsspezifisches Personenkennzeichen (in entschlüsselter Form)
101 |PostboxId|Postkorb-ID des Nutzers. Muss bei Anbindung des Postkorbs verwendet werden.
102 |(((
103 Email (PBA)
104 tfAntragstellerEmail (PBA)
105 )))|Email-Adresse
106 |Gender|Anrede als numerischer Wert nach ISO 5218:2004
107 |GenderName|Lesbarer Text für Geschlechter-Code aus Attribut „gender“.
108 Mögliche Werte: //männlich//, //weiblich//
109 |(((
110 Salutation
111 tfAntragstellerAnrede (PBA)
112 selAntragstellerAnrede (PBA)
113 )))|Anrede, wird mit Hilfe des Geschlechter-Code aus Attribut „gender“ erzeugt.
114 Mögliche Werte: //Herr//, //Frau, Nicht bekannt//
115 |(((
116 PersonalTitle (PBA)
117 tfAntragstellerTitel (PBA)
118 )))|Akademischer Titel
119 |(((
120 FirstName
121 tfAntragstellerVorname (PBA)
122 )))|Vorname
123 |(((
124 LastName
125 tfAntragstellerName (PBA)
126 )))|Nachname
127 |(((
128 ZipCode (PBA)
129 tfAntragstellerPLZ (PBA)
rth 13.15 130 )))|Postleitzahl
rth 13.10 131 |(((
132 Address (PBA)
133 tfAntragstellerAdresse (PBA)
134 )))|Adresse bestehend aus Strasse und Hausnummer
135 |(((
136 City (PBA)
137 tfAntragstellerOrt (PBA)
138 )))|Ort
139 |(((
140 BirthDate
141 tfAntragstellerGeburtsdatum (PBA)
142 )))|Geburtsdatum im Format: dd.MM.yyyy
143 |(((
144 PlaceOfBirth
145 tfAntragstellerGeburtsort (PBA)
146 )))|Geburtsort
147 |(((
148 TelephoneNumber
149 tfAntragstellerTelefon (PBA)
150 )))|Telefonnummer
151 |tfOrgVertreterVorname (OBA)|Vorname der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
152 |tfOrgVertreterName (OBA)|Nachname der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
153 |tfOrgVertreterTitel (OBA)|Akademischer Titel der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
154 |(((
155 tfOrgVertreterAnrede (OBA)
156 selOrgVertreterAnrede (OBA)
157 )))|(((
158 Anrede für die Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
159 Anrede, wird mit Hilfe des Geschlechter-Code aus Attribut „gender“ erzeugt. Mögliche Werte: //Herr//, //Frau, Nicht bekannt//
160 )))
161 |tfOrgVertreterGeburtsdatum (OBA)|Akademischer Titel der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
162 |tfOrgVertreterGeburtsort (OBA)|Geburtsort der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
163 |tfOrgEmail (OBA)|E-Mail Adresse der angemeldeten Person, welche diese im Unternehmen hat. (Kann von der E-Mail Adresse am personenbezogenen Account abweichen.)
164 |tfOrgVertreterTelefon (OBA)|Telefonnummer der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte.
165 |tfOrgStrasse (OBA)|Strasse
166 |tfOrgHausnummer (OBA)|Hausnummer
167 |tfOrgHausnummerZusatz (OBA)|Hausnummern Zusatz
168 |tfOrgAdressZusatz (OBA)|Adress-Zusatz
169 |tfOrgPLZ (OBA)|PLZ
170 |tfOrgOrt (OBA)|Ort
171 |tfOrgName (OBA)|Name der Organisation (mit Rechtsform)
172 |tfOrgID (OBA)|Organisations-ID
173 |Rechtsform (OBA)|Rechtsform der Organisation
174 |tfOrgRegisterOrt (OBA)|Register(gerichts)-Ort
175 |tfOrgRegisterNummer (OBA)|Registernummer
176 |TrustLevel|(((
177 Vertrauensniveau, gibt Auskunft über gewählte Authentifizierungsmethode:
rth 13.15 178 * **STORK-QAA-Level-1**: Authentifizierung mittels Benutzername / Passwort
179 * **STORK-QAA-Level-3:** Authentifizierung mittels Authega Zertifikat
180 * **STORK-QAA-Level-4**: Authentifizierung mittels nPA
rth 13.10 181 )))
rth 13.15 182 |NPA_Address (PBA)|Adresse, wie sie auf dem NPA vermerkt ist (alles in Großbuchstaben)
183 |NPA_City (PBA)|Ort, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben)
184 |NPA_FirstName|Vorname, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben)
185 |NPA_LastName|Nachname, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben)
186 |NPA_PersonalTitle|Akademischer Titel, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben)
187 |IsIndividualPerson|Liefert den Wert **true**, wenn es sich bei den Daten aus dem Bürgerkonto um personenbezogene Daten handelt, sonst **false**.
188 |IsOrganization|Liefert den Wert **true**, wenn es sich bei den Daten aus dem Bürgerkonto um organisationsbezogene Daten handelt, sonst **false**.
rth 13.10 189 {{/table}}
190
191 {{info}}
192 **Hinweis:**
193 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.
194 \\__Beispiel:__
195 Wenn als Suffix "**_Person2**" definiert wurde, so ergibt sich beim Vornamen der Formular-Elementname "tfAntragstellerVorname**_Person2**".
196 {{/info}}
197
198 === Darstellung des genutzten Authentifizierungsverfahren ===
199
200 {{figure image="hilfe_trustlevel_visualisierung.png"}}
201 Darstellung des verwendeten Vertrauensniveaus an der Bürgerkonto Daten Vorlage
202 {{/figure}}
203
204 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.
205
206 Für die einzelnen Vertrauensniveaus existieren folgende Beschriftungen:
207
208 * Level 1 (Authentifizierung mittels Benutzername / Passwort): **Standard**
209 * Level 3 (Authentifizierung mittels Authega Zertifikat): **Authega**
210 * Level 4 (Authentifizierung mittels nPA): **Personalausweis**
211
212 {{figure image="hilfe_trustlevel_keine_visualisierung.png"}}
213 Wenn keine visuelle Markierung gewünscht ist, so kann dies durch ein zusätzliches Attribut „noRibbon“ am Vorlagen-Fieldset unterbunden werden
214 {{/figure}}
215
216 == AKDB Postkorbanbindung in der Statusverarbeitung ==
217
218
219 Für die Anbindung zum Versand von Postkorbnachrichten wird das Aktions-Plugin **AKDB:Postkorbnachricht senden** zur Verfügung gestellt.
220 Mittels dieser Plugin-Aktion, können ähnlich einer E-Mail Aktion, Nachrichten an den Postkorb der AKDB weitergeleitet werden.
221
222 Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt die nachfolgend kurz beschrieben werden.
223
rth 13.23 224 {{panel title="Einstellungen für Absender und Empfänger" fullwidth="true" initial="visible" triggerable="true"}}
rth 13.10 225
226
227 {{figure image="postkorb_absender.png"}}
228 Einstellungen für Absender und Empfänger
229 {{/figure}}
230
231 ; Dienst (Pflicht)
232 : Wird als Information in der Postkorb-Ansicht im Bürgerservice-Portal verwendet.
233 ; Mandant (Pflicht)
234 : Wird als Information in der Postkorb-Ansicht im Bürgerservice-Portal verwendet.
235 ; Absender-Link
236 : 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.
237 ; Postkorb ID aus den Vorgangsdaten ermitteln?
rth 13.16 238 : 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.
239 Bei einem AKDB Bürgerkonto-Login wird die Postkorb-ID immer mit übermittelt und standardmäßig am Formulareingang hinterlegt.
rth 13.17 240 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.
241 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.)
rth 13.10 242
243
244 {{/panel}}
245
rth 13.23 246 {{panel title="Konfiguration des Nachrichteninhalts" fullwidth="true" initial="visible" triggerable="true"}}
rth 13.10 247
248
249 {{figure image="postkorb_nachricht.png"}}
250 Konfiguration von Betreff, Nachrichteninhalt und Anhängen
251 {{/figure}}
252
253
254 ; Betreff (Pflicht)
255 : Nahrichtenbetreff, es werden Platzhalter unterstützt.
256 ; Inhalt (Pflicht)
257 : Nachrichtentext, es werden Platzhalter unterstützt.
258 ; Anhänge
259 : Hier können Dateien als Attachments an die Postkorb-Nachricht gehangen werden.
260 : Zur Auswahl stehen dabei:
261 :; Upload
262 :: bezieht sich auf alle Dateianhänge, die über das Formular hochgeladen wurden
263 :; Workflow
264 :: bezieht sich auf alle Dateianhänge, die über den aktuellen FORMCYCLE Workflow hochgeladen wurden.
265 :; Posteingang
266 :: bezieht sich auf alle Dateianhänge, die über das Postfach hochgeladen wurden.
267 :: Unterstützte Dateiformate sind: PDF, HTML, Plaintext, MS Word, JPEG, GIF, PNG
268
269
270 {{info}}
rth 13.20 271 **Achtung:**
rth 13.10 272 Die Schnittstelle zum Postkorb der AKDB unterstützt dabei maximal 5 Anhänge pro Nachricht mit je 2 MB Maximalgröße.
273 {{/info}}
274
275 {{/panel}}
276
277 === Bedingte Ausführung der //AKDB:Postkorbnachricht senden//-Aktion ===
278
279 {{figure image="postkorb_nachricht_bedingung.png"}}
280 Konfiguration einer Bedingung für Ausführung der Aktion //AKDB~:Postkorbnachricht senden//
281 {{/figure}}
282
rth 13.16 283 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.
284 Dies bedeutet aber auch, dass wenn in einem Formularprozess kein zwingender Bürgerkonto-Login erfolgt, die Postkorb-ID **nicht** in der Statusverarbeitung vorhanden ist.
rth 13.10 285 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.
286
rth 13.21 287 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.
rth 13.10 288
289 {{code language="javascript"}}
290 REGEX([%$POSTKORB_ID%]=^.+$)
291 {{/code}}
292
293 ==== Erweitere Bedingungsprüfung bei Verwendung unterschiedlicher Login-Arten (personenbezogenes bzw. organisationsbezogenes Login) ====
294
295
296 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.
297 Im Formular müssen dann versteckte Eingabefelder mit den Element-Namen **IsIndividualPerson** und **IsOrganization** vorhanden sein.
298 (Dies ist automatisch der Fall, wenn die entsprechenden Vorlagen //Bürgerkonto personenbezogene Daten// und //Bürgerkonto organisationsbezogene Daten// verwendet werden).
299
300 Die Konfiguration einer Ausführungs-Bedingung an einer Aktion //AKDB:Postkorbnachricht senden// für eine **personenbezogene** Anmeldung wäre dann folgendermaßen:
301
302
303 {{code language="javascript"}}
rth 13.21 304 REGEX([%IsIndividualPerson%]=true) REGEX([%$POSTKORB_ID%]=^.+$)
rth 13.10 305 {{/code}}
306
307
308 Bei Nutzung einer **organisationsbezogenen** Anmeldung ist folgende Bedingung zu konfigurieren:
309
310
311 {{code language="javascript"}}
rth 13.21 312 REGEX([%IsOrganization%]=true) REGEX([%$POSTKORB_ID%]=^.+$)
rth 13.10 313 {{/code}}
rth 13.21 314
315 {{info}}
316 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.
rth 13.22 317 {{/info}}

Navigation

Copyright 2000-2025