Wiki source code of AKDB: Bürgerkonto-Service-Plugin
Show last authors
author | version | line-number | content |
---|---|---|---|
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 Plugin - Version ab **2.8.1** zur Verfügung. | ||
66 | |||
67 | === Konfiguration eines Externen Benutzers für das Bürgerkonto Login === | ||
68 | |||
69 | {{figure image="externer_benutzer_akdb.png"}} | ||
70 | Bürgerkonto-Login als Externer Benutzer einrichten. (Schritt 1) | ||
71 | {{/figure}} | ||
72 | |||
73 | 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. | ||
74 | |||
75 | Dazu muss im jeweiligen Mandaten in den Konfigurationsbereich Externe Benutzer gewechselt werden. Dort muss mittels {{ficon name="plus-circle-outline"/}} der über das Plugin zur Verfügung gestellte **AKDB Login** ausgewählt werden. | ||
76 | |||
77 | {{info}} | ||
78 | Beachten Sie, dass vor Verwendung des //Bürgerkonto-Login als Externer Benutzer// die konfigurative Anbindung des Dienstes durch den {{formcycle/}}-Administrator stattgefunden hat, da die zur Kommunikation benötigten Zertifikate und Informationen aus den Plugin-Einstellungen entnommen werden. | ||
79 | {{/info}} | ||
80 | |||
81 | {{figure image="externer_benutzer_akdb_s2.png"}} | ||
82 | Bürgerkonto-Login als Externer Benutzer einrichten. (Schritt 2) | ||
83 | {{/figure}} | ||
84 | |||
85 | Im nächsten Schritt muss über den Button "Konfiguration hinzufügen" eine Konfiguration hinzugefügt werden. | ||
86 | |||
87 | {{figure image="externer_benutzer_akdb_s3.png"}} | ||
88 | Bürgerkonto-Login als Externer Benutzer einrichten. (Schritt 3) | ||
89 | {{/figure}} | ||
90 | |||
91 | Im letzten Schritt besteht die Möglichkeit die Konfiguration individuell anzupassen. | ||
92 | Dazu können folgende Einstellungen getroffen werden: | ||
93 | |||
94 | ; LoginTyp | ||
95 | : Mit dieser Einstellung lassen sich die Arten der zurück gelieferten Daten festlegen. | ||
96 | : Ist als Wert **Person** definiert, so können nur personenbezogene Daten zurückgeliefert werden. | ||
97 | : Ist **Organisation** definiert, so ist es nur möglich organisationsbezogene Daten zurückzuliefern. Das heißt ein Login als natürliche Person ist nicht möglich. | ||
98 | : Ist dieser Parameter nicht konfiguriert, so kann der Nutzer selbst bestimmen, welche Datenart (personen- oder organisationsbezogen) er zurück liefern möchte. | ||
99 | ; AuthTyp | ||
100 | : Über diese Einstellung kann das geforderte Authentisierungsverfahren festgelegt werden. | ||
101 | : Entweder mit Authega-Zertifikat (Wert: **Authega**) oder Personalausweis (Wert: **NPA**). | ||
102 | : Ist nichts gesetzt oder das Attribut nicht vorhanden, so werden dem Nutzer alle möglichen Authentisierungsverfahren zur Auswahl angeboten. | ||
103 | |||
104 | === Bürgerkonto Login als Formularanmeldung einrichten === | ||
105 | |||
106 | {{figure image="formular_zugriff.png"}} | ||
107 | Bürgerkonto Login als Externer Benutzer am Formular freischalten. | ||
108 | {{/figure}} | ||
109 | |||
110 | Um das Bürgerkonto-Login über einen [[Externen Benutzer>>doc:Formcycle.UserInterface.UserSettings.ExternalUsers.WebHome||target="_blank"]] am jeweiligen Formular zu ermöglichen, | ||
111 | muss dieses als [[Formularanmeldung>>doc:Formcycle.UserInterface.MyForms.Access||target="_blank"]] am Formular hinterlegt sein. | ||
112 | |||
113 | |||
114 | == Designer-Element: Bürgerkonto Daten Vorlage == | ||
115 | |||
116 | {{figure image="hilfe_bk_vorlagen.png"}} | ||
117 | Formularvorlage //AKDB Basisdienste// | ||
118 | {{/figure}} | ||
119 | |||
120 | 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. | ||
121 | |||
122 | Ab Plugin Version {{version major="2" minor="9"/}} gibt es eine weitere Vorlage, welche die Daten von person- und organisations-bezogenen Daten in einer Vorlage vereint. Das Anzeigeverhalten dieser Vorlage entspricht den eingangs erwähnten Vorlagen. Das heißt, je nach Anmeldetyp, werden die organisations-spezifischen Daten ein- oder ausgeblendet. | ||
123 | |||
124 | 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: | ||
125 | |||
126 | |||
127 | {{code language="javascript"}} | ||
128 | XFC_METADATA.pluginResults.AKDBLoginAnalyzer | ||
129 | {{/code}} | ||
130 | |||
131 | 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. | ||
132 | |||
133 | {{info}} | ||
134 | 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. | ||
135 | Ist keine extra Kennzeichnung vorhanden, so ist der Parameter in beiden Bereichen vorhanden. | ||
136 | |||
137 | **Achtung: **Ab Plugin-Version **2.9.0** sind im Zuge einer Vereinheitlichung der Parameter-Name für **PBA** und **OBA**, bestimmte Parameter, die bisher nur bei **PBA** vorhanden waren auch bei einer **OBA** vorhanden. Im Zuge der Abwärtskompatibilität sind die OBA-spezifischen Parameter zusätzlich noch vorhanden. | ||
138 | Die betreffenden Parameter sind in der Tabelle mit **(PBA + OBA)** gekennzeichnet. | ||
139 | {{/info}} | ||
140 | |||
141 | {{table dataTypeAlpha="0" preSort="0-asc"}} | ||
142 | |=Parameter|=Beschreibung | ||
143 | |BPK|Bereichsspezifisches Personenkennzeichen (in verschlüsselter Form) | ||
144 | |BPK_Decoded|Bereichsspezifisches Personenkennzeichen (in entschlüsselter Form) | ||
145 | |PostboxId|Postkorb-ID des Nutzers. Muss bei Anbindung des Postkorbs verwendet werden. | ||
146 | |((( | ||
147 | Email (PBA) | ||
148 | tfAntragstellerEmail (PBA + OBA) | ||
149 | )))|Email-Adresse | ||
150 | |Gender|Anrede als numerischer Wert nach ISO 5218:2004 | ||
151 | |GenderName|Lesbarer Text für Geschlechter-Code aus Attribut „gender“. | ||
152 | Mögliche Werte: //männlich//, //weiblich// | ||
153 | |((( | ||
154 | Salutation | ||
155 | tfAntragstellerAnrede (PBA + OBA) | ||
156 | selAntragstellerAnrede (PBA) | ||
157 | )))|Anrede, wird mit Hilfe des Geschlechter-Code aus Attribut „gender“ erzeugt. | ||
158 | Mögliche Werte: //Herr//, //Frau, Nicht bekannt// | ||
159 | |((( | ||
160 | PersonalTitle (PBA) | ||
161 | tfAntragstellerTitel (PBA + OBA) | ||
162 | )))|Akademischer Titel | ||
163 | |((( | ||
164 | FirstName | ||
165 | tfAntragstellerVorname (PBA + OBA) | ||
166 | )))|Vorname | ||
167 | |((( | ||
168 | LastName | ||
169 | tfAntragstellerName (PBA + OBA) | ||
170 | )))|Nachname | ||
171 | |((( | ||
172 | ZipCode (PBA) | ||
173 | tfAntragstellerPLZ (PBA + OBA) | ||
174 | )))|Postleitzahl | ||
175 | |((( | ||
176 | Address (PBA) | ||
177 | tfAntragstellerAdresse (PBA + OBA) | ||
178 | )))|Adresse bestehend aus Strasse und Hausnummer | ||
179 | |((( | ||
180 | City (PBA) | ||
181 | tfAntragstellerOrt (PBA + OBA) | ||
182 | )))|Ort | ||
183 | |((( | ||
184 | BirthDate | ||
185 | tfAntragstellerGeburtsdatum (PBA + OBA) | ||
186 | )))|Geburtsdatum im Format: dd.MM.yyyy | ||
187 | |((( | ||
188 | PlaceOfBirth | ||
189 | tfAntragstellerGeburtsort (PBA + OBA) | ||
190 | )))|Geburtsort | ||
191 | |((( | ||
192 | TelephoneNumber | ||
193 | tfAntragstellerTelefon (PBA + OBA) | ||
194 | )))|Telefonnummer | ||
195 | |tfOrgVertreterVorname (OBA)|Vorname der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte. | ||
196 | |tfOrgVertreterName (OBA)|Nachname der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte. | ||
197 | |tfOrgVertreterTitel (OBA)|Akademischer Titel der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte. | ||
198 | |((( | ||
199 | tfOrgVertreterAnrede (OBA) | ||
200 | selOrgVertreterAnrede (OBA) | ||
201 | )))|((( | ||
202 | Anrede für die Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte. | ||
203 | Anrede, wird mit Hilfe des Geschlechter-Code aus Attribut „gender“ erzeugt. Mögliche Werte: //Herr//, //Frau, Nicht bekannt// | ||
204 | ))) | ||
205 | |tfOrgVertreterGeburtsdatum (OBA)|Akademischer Titel der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte. | ||
206 | |tfOrgVertreterGeburtsort (OBA)|Geburtsort der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte. | ||
207 | |tfOrgEmail (OBA)|E-Mail Adresse der angemeldeten Person, welche diese im Unternehmen hat. (Kann von der E-Mail Adresse am personenbezogenen Account abweichen.) | ||
208 | |tfOrgVertreterTelefon (OBA)|Telefonnummer der Person, welche der hinterlegten Organisation angehört und über deren Account die Anmeldung erfolgte. | ||
209 | |tfOrgStrasse (OBA)|Strasse | ||
210 | |tfOrgHausnummer (OBA)|Hausnummer | ||
211 | |tfOrgHausnummerZusatz (OBA)|Hausnummern Zusatz | ||
212 | |tfOrgAdressZusatz (OBA)|Adress-Zusatz | ||
213 | |tfOrgPLZ (OBA)|PLZ | ||
214 | |tfOrgOrt (OBA)|Ort | ||
215 | |tfOrgName (OBA)|Name der Organisation (mit Rechtsform) | ||
216 | |tfOrgID (OBA)|Organisations-ID | ||
217 | |Rechtsform (OBA)|Rechtsform der Organisation | ||
218 | |tfOrgRegisterOrt (OBA)|Register(gerichts)-Ort | ||
219 | |tfOrgRegisterNummer (OBA)|Registernummer | ||
220 | |TrustLevel|((( | ||
221 | Vertrauensniveau, gibt Auskunft über gewählte Authentifizierungsmethode: | ||
222 | * **STORK-QAA-Level-1**: Authentifizierung mittels Benutzername / Passwort | ||
223 | * **STORK-QAA-Level-3:** Authentifizierung mittels Authega Zertifikat | ||
224 | * **STORK-QAA-Level-4**: Authentifizierung mittels nPA | ||
225 | ))) | ||
226 | |NPA_Address (PBA)|Adresse, wie sie auf dem NPA vermerkt ist (alles in Großbuchstaben) | ||
227 | |NPA_City (PBA)|Ort, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben) | ||
228 | |NPA_FirstName|Vorname, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben) | ||
229 | |NPA_LastName|Nachname, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben) | ||
230 | |NPA_PersonalTitle|Akademischer Titel, wie er auf dem NPA vermerkt ist (alles in Großbuchstaben) | ||
231 | |IsIndividualPerson|Liefert den Wert **true**, wenn es sich bei den Daten aus dem Bürgerkonto um personenbezogene Daten handelt, sonst **false**. | ||
232 | |IsOrganization|Liefert den Wert **true**, wenn es sich bei den Daten aus dem Bürgerkonto um organisationsbezogene Daten handelt, sonst **false**. | ||
233 | {{/table}} | ||
234 | |||
235 | {{info}} | ||
236 | **Hinweis:** | ||
237 | 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. | ||
238 | \\__Beispiel:__ | ||
239 | Wenn als Suffix "**_Person2**" definiert wurde, so ergibt sich beim Vornamen der Formular-Elementname "tfAntragstellerVorname**_Person2**". | ||
240 | {{/info}} | ||
241 | |||
242 | === Darstellung des genutzten Authentifizierungsverfahren === | ||
243 | |||
244 | {{figure image="hilfe_trustlevel_visualisierung.png"}} | ||
245 | Darstellung des verwendeten Vertrauensniveaus an der Bürgerkonto Daten Vorlage | ||
246 | {{/figure}} | ||
247 | |||
248 | 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. | ||
249 | |||
250 | Für die einzelnen Vertrauensniveaus existieren folgende Beschriftungen: | ||
251 | |||
252 | * Level 1 (Authentifizierung mittels Benutzername / Passwort): **Standard** | ||
253 | * Level 3 (Authentifizierung mittels Authega Zertifikat): **Authega** | ||
254 | * Level 4 (Authentifizierung mittels nPA): **Personalausweis** | ||
255 | |||
256 | {{figure image="hilfe_trustlevel_keine_visualisierung.png"}} | ||
257 | Wenn keine visuelle Markierung gewünscht ist, so kann dies durch ein zusätzliches Attribut „noRibbon“ am Vorlagen-Fieldset unterbunden werden | ||
258 | {{/figure}} | ||
259 | |||
260 | == AKDB Postkorbanbindung in der Statusverarbeitung == | ||
261 | |||
262 | |||
263 | Für die Anbindung zum Versand von Postkorbnachrichten wird das Aktions-Plugin **AKDB:Postkorbnachricht senden** zur Verfügung gestellt. | ||
264 | Mittels dieser Plugin-Aktion, können ähnlich einer E-Mail Aktion, Nachrichten an den Postkorb der AKDB weitergeleitet werden. | ||
265 | |||
266 | Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt die nachfolgend kurz beschrieben werden. | ||
267 | |||
268 | {{panel title="Einstellungen für Absender und Empfänger" fullwidth="true" initial="visible" triggerable="true"}} | ||
269 | |||
270 | |||
271 | {{figure image="postkorb_absender.png"}} | ||
272 | Einstellungen für Absender und Empfänger | ||
273 | {{/figure}} | ||
274 | |||
275 | ; Dienst (Pflicht) | ||
276 | : Wird als Information in der Postkorb-Ansicht im Bürgerservice-Portal verwendet. | ||
277 | ; Mandant (Pflicht) | ||
278 | : Wird als Information in der Postkorb-Ansicht im Bürgerservice-Portal verwendet. | ||
279 | ; Absender-Link | ||
280 | : 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. | ||
281 | ; Postkorb ID aus den Vorgangsdaten ermitteln? | ||
282 | : 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. | ||
283 | Bei einem AKDB Bürgerkonto-Login wird die Postkorb-ID immer mit übermittelt und standardmäßig am Formulareingang hinterlegt. | ||
284 | 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. | ||
285 | 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.) | ||
286 | |||
287 | |||
288 | {{/panel}} | ||
289 | |||
290 | {{panel title="Konfiguration des Nachrichteninhalts" fullwidth="true" initial="visible" triggerable="true"}} | ||
291 | |||
292 | |||
293 | {{figure image="postkorb_nachricht.png"}} | ||
294 | Konfiguration von Betreff, Nachrichteninhalt und Anhängen | ||
295 | {{/figure}} | ||
296 | |||
297 | |||
298 | ; Betreff (Pflicht) | ||
299 | : Nahrichtenbetreff, es werden Platzhalter unterstützt. | ||
300 | ; Inhalt (Pflicht) | ||
301 | : Nachrichtentext, es werden Platzhalter unterstützt. | ||
302 | ; Anhänge | ||
303 | : Hier können Dateien als Attachments an die Postkorb-Nachricht gehangen werden. | ||
304 | : Zur Auswahl stehen dabei: | ||
305 | :; Upload | ||
306 | :: bezieht sich auf alle Dateianhänge, die über das Formular hochgeladen wurden | ||
307 | :; Workflow | ||
308 | :: bezieht sich auf alle Dateianhänge, die über den aktuellen FORMCYCLE Workflow hochgeladen wurden. | ||
309 | :; Posteingang | ||
310 | :: bezieht sich auf alle Dateianhänge, die über das Postfach hochgeladen wurden. | ||
311 | :: Unterstützte Dateiformate sind: PDF, HTML, Plaintext, MS Word, JPEG, GIF, PNG | ||
312 | |||
313 | |||
314 | {{info}} | ||
315 | **Achtung:** | ||
316 | Die Schnittstelle zum Postkorb der AKDB unterstützt dabei maximal 5 Anhänge pro Nachricht mit je 2 MB Maximalgröße. | ||
317 | {{/info}} | ||
318 | |||
319 | {{/panel}} | ||
320 | |||
321 | === Bedingte Ausführung der //AKDB:Postkorbnachricht senden//-Aktion === | ||
322 | |||
323 | {{figure image="postkorb_nachricht_bedingung.png"}} | ||
324 | Konfiguration einer Bedingung für Ausführung der Aktion //AKDB~:Postkorbnachricht senden// | ||
325 | {{/figure}} | ||
326 | |||
327 | 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. | ||
328 | Dies bedeutet aber auch, dass wenn in einem Formularprozess kein zwingender Bürgerkonto-Login erfolgt, die Postkorb-ID **nicht** in der Statusverarbeitung vorhanden ist. | ||
329 | 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. | ||
330 | |||
331 | 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. | ||
332 | |||
333 | {{code language="javascript"}} | ||
334 | REGEX([%$POSTKORB_ID%]=^.+$) | ||
335 | {{/code}} | ||
336 | |||
337 | ==== Erweitere Bedingungsprüfung bei Verwendung unterschiedlicher Login-Arten (personenbezogenes bzw. organisationsbezogenes Login) ==== | ||
338 | |||
339 | |||
340 | 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. | ||
341 | Im Formular müssen dann versteckte Eingabefelder mit den Element-Namen **IsIndividualPerson** und **IsOrganization** vorhanden sein. | ||
342 | (Dies ist automatisch der Fall, wenn die entsprechenden Vorlagen //Bürgerkonto personenbezogene Daten// und //Bürgerkonto organisationsbezogene Daten// verwendet werden). | ||
343 | |||
344 | Die Konfiguration einer Ausführungs-Bedingung an einer Aktion //AKDB:Postkorbnachricht senden// für eine **personenbezogene** Anmeldung wäre dann folgendermaßen: | ||
345 | |||
346 | |||
347 | {{code language="javascript"}} | ||
348 | REGEX([%IsIndividualPerson%]=true) REGEX([%$POSTKORB_ID%]=^.+$) | ||
349 | {{/code}} | ||
350 | |||
351 | |||
352 | Bei Nutzung einer **organisationsbezogenen** Anmeldung ist folgende Bedingung zu konfigurieren: | ||
353 | |||
354 | |||
355 | {{code language="javascript"}} | ||
356 | REGEX([%IsOrganization%]=true) REGEX([%$POSTKORB_ID%]=^.+$) | ||
357 | {{/code}} | ||
358 | |||
359 | {{info}} | ||
360 | 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. | ||
361 | {{/info}} | ||
362 | |||
363 | == Versionshistorie == | ||
364 | |||
365 | (% class="wikigeneratedid" %) | ||
366 | === 2.9.1 === | ||
367 | |||
368 | * Fehlerbehebung in Anzeige bei Nutzung der Template-Vorlage für personen- und organisationsbezogene Daten: | ||
369 | ** die fehlende Anzeige des Authentifizierungsverfahren am Field-Set für die persönlichen Daten wurde beseitigt | ||
370 | ** Nach erfolgter Anmeldung werden die Eingabe-Felder für die persönlichen Daten mit einem Schreibschutz belegt | ||
371 | |||
372 | === 2.9.0 === | ||
373 | |||
374 | * Neue Template-Vorlage für personen- und organisationsbezogene Daten: Unterteilt in 2 Fieldsets, wobei //persönliche Daten// bei beiden Anmeldungstypen angezeigt werden und //organisationsbezogene Daten// nur im Fall einer Organisations-Anmeldung. Die Vorlage wird standardmäßig ausgeblendet, wenn keine Anmeldedaten vorliegen. | ||
375 | * Vereinheitlichung der Datenbezeichnungen bei den persönlichen Daten für den Vertreter innerhalb einer Organisations-Anmeldung: die personenbezogenen Daten für den Vertreter werden unter den gleichen Parameter-Namen, wie bei einer reinen personenbezogenen Anmeldung zur Verfügung gestellt. Im Zuge der Abwärtskompatibilität bleiben alte Parameternamen (Präfix **tfOrg**) weiterhin erhalten. | ||
376 | * Vereinheitlichung der Vorlage für Organisationsdaten: Für die personenbezogenen Daten des Organisations-Vertreters werden die geänderten Parameternamen verwendet. | ||
377 | * Anpassung PreRender-Logik bei Nutzung von Authenticatoren: Bei "Ohne Login" werden von Nachname und Titel die Default-Werte gelöscht, damit diese Felder bei Anzeige in der Vorlage leer sind. | ||
378 | * Fehlerbehebung bei Verwendung des BK-Authenticators über Frontend-Server: Initialisierung notwendiger OpenSAML-Klassen bei Aufruf über Frontend-Server hinzugefügt. | ||
379 | |||
380 | === 2.8.2 === | ||
381 | |||
382 | * Ändern BK-Vorlage für natürliche Person: Platzhalter für Authenticator-User-Objekt-Werte gesetzt, soweit wie möglich, um Nutzung für andere Authenticatoren (Google, NTLM, Facebook) prinzipiell zu ermöglichen | ||
383 | * Anpassung PreRender-Logik: Bei Vorhandensein eines User-Profils aus einem Authenticator wird Steuervariable 'IsIndividualPerson' auf "true" gesetzt, damit BK-Vorlage automatisch eingeblendet und genutzt werden kann. | ||
384 | |||
385 | === 2.8.1 === | ||
386 | |||
387 | * Fehlerbehebung bei Verwendung des BK-Logins über Frontend-Server: Factory-Klasse (org.opensaml.core.xml.XMLObjectBuilderFactory) durch pac4j-Implementierung ersetzt, um Fehler bei Kommunikation über den Frontend-Server zu beheben | ||
388 | |||
389 | === 2.8.0 === | ||
390 | |||
391 | * Bereitstellung eines Plugin-Authenticator für AKDB-Login als "Externer Benutzer" | ||
392 | * Hinweis: Log für Authega funktioniert nicht bei Einsatz von Plugin-Authenticator | ||
393 | |||
394 | === 2.7.0 === | ||
395 | |||
396 | * Umstellung intern genutztes SAML-Framework. Dieses wird nicht mehr durch das Plugin selbst, sondern vom {{formcycle/}}-Core zur Verfügung gestellt. | ||
397 | * **Achtung:** alle neueren Versionen des Plugins benötigen mindestens {{formcycle/}} Version {{version major="6" minor="4" patch="0"/}} oder höher | ||
398 | |||
399 | === 2.6.2 === | ||
400 | |||
401 | * Umbenennung Menüpunkt für Metadaten-Generierung für Registrierung bei AKDB, neuer Name: "AKDB Setup" | ||
402 | |||
403 | === 2.6.1 === | ||
404 | |||
405 | * Fehlerbehebung bei Verwendung des BK-Logins über Frontend-Server | ||
406 | |||
407 | === 2.6.0 === | ||
408 | |||
409 | * Einbindung {{formcycle/}} Version 6.2.0 | ||
410 | * Unterstützung Blanko-Druck: | ||
411 | ** Login-Button wird ausgeschlossen | ||
412 | ** Steuerfelder und Trustlevel in den Vorlagen werden standardmäßig vom Druck ausgeschlossen | ||
413 | * Login-Button um Auswahlmöglichkeit für Seitenvalidierung vor Beginn BK-Login erweitert. |