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

Navigation

Copyright 2000-2025