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

Navigation

Copyright 2000-2025