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

Navigation

Copyright 2000-2025