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

Navigation

Copyright 2000-2025