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

Navigation

Copyright 2000-2025