Changes for page Bürgerservice Plugin

From 14.12 to 14.13 From 14.17 to 14.18

From version 14.13

edited by rth
on 09.05.2023, 10:38

Change comment: There is no comment for this version

To version 14.17

edited by rth
on 09.05.2023, 11:52

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -1,9 +1,10 @@
--{{info}}
++(% class="box infomessage" %)
++(((
  **Achtung:**
--Bevor Sie die Bürger Services in ihre Formular-Prozesse einbinden, stellen Sie bitte sicher, dass die konfigurative Anbindung der Dienste durch einen {{formcycle/}}-Administrator erfolgt ist!
--{{/info}}
++Bevor Sie die Bürger Services in ihre Formular-Prozesse einbinden, stellen Sie bitte sicher, dass die konfigurative Anbindung der Dienste durch einen (% class="xm-smallcaps" %)Xima® Formcycle(%%)-Administrator erfolgt ist!
++)))
--Über das kostenpflichtige //Bürger Services Plugin// werden Möglichkeiten zur Einbindung verschiedener Bürger Services in {{formcycle/}} bereitgestellt.
++Über das kostenpflichtige //Bürger Services Plugin// werden Möglichkeiten zur Einbindung verschiedener Bürger Services in (% class="xm-smallcaps" %)Xima® Formcycle(%%) bereitgestellt.
  Dabei kann zwischen den Anbindungen für
  * **BundID**
@@ -14,7 +14,7 @@
  == Einbindung der Bürger Services in Formulare ==
--Für eine Einbindung der Bürger Services in {{formcycle/}} Formulare bestehen grundsätzlich folgende Möglichkeiten:
++Für eine Einbindung der Bürger Services in (% class="xm-smallcaps" %)Xima® Formcycle(%%) Formulare bestehen grundsätzlich folgende Möglichkeiten:
  * Anmeldung über Formular-Zugriffssteuerung: hier erfolgt eine Nutzer-Legitimierung **vor** der Anzeige des Formulars
  * Anmeldung über Login-Button: In diesem Szenario kann eine Nutzer-Legitimierung während der Anzeige des Formulars (zu jedem Zeitpunkt), durchgeführt werden.
@@ -21,11 +21,21 @@
  === Einbindung über Formular-Zugriff ===
--{{figure image="formularZugriff_login.png"}}
++
++(% class="xm-figure xm-float-right xm-clear-h2" data-alt="Konfiguration der Bürger Services als Formularanmeldung" %)
++(((
++(% class="xm-figure-inner" style="width:310px" %)
++(((
++[[~[~[image:attach:formularZugriff_login.png~|~|alt="/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/WebHome/formularZugriff_login.png?rev=1.2" width="300"~]~]>>path:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/WebHome/formularZugriff_login.png?rev=1.2||rel="lightbox[$group]" title="Konfiguration der Bürger Services als Formularanmeldung"]]
++
++(% class="xm-figure-caption" %)
++(((
  Konfiguration der Bürger Services als Formularanmeldung
--{{/figure}}
++)))
++)))
++)))
--Um den Login für einen oder mehrere Bürger Services über einen [[Externen Benutzer>>path:/xwiki/bin/view/Formcycle/UserInterface/UserSettings/ExternalUsers/]] am jeweiligen Formular zu ermöglichen, muss dies als [[Formularanmeldung>>path:/xwiki/bin/view/Formcycle/UserInterface/MyForms/Access]] am Formular hinterlegt sein.
++Um den Login für einen oder mehrere Bürger Services über einen (% class="wikiinternallink" %)[[Externen Benutzer>>path:/xwiki/bin/view/Formcycle/UserInterface/UserSettings/ExternalUsers/]](%%) am jeweiligen Formular zu ermöglichen, muss dies als (% class="wikiinternallink" %)[[Formularanmeldung>>path:/xwiki/bin/view/Formcycle/UserInterface/MyForms/Access]](%%) am Formular hinterlegt sein.
  Die in der Auswahl zur Verfügung stehenden Bürger Services sind abhängig von der Lizenzierung, sowie vom vollständigen Konfigurations-Status der als Externe Benutzer definierten Bürger Service-Anbindungen.
@@ -32,9 +32,19 @@
  === Einbindung im Designer - per Login Button ===
--{{figure image="designer_loginBtn.png"}}
++
++(% class="xm-figure xm-float-right xm-clear-h2" data-alt="Allgemeine Einstellungen am Formular-Element Bürger Services Login" %)
++(((
++(% class="xm-figure-inner" style="width:310px" %)
++(((
++[[~[~[image:attach:designer_loginBtn.png~|~|alt="/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/WebHome/designer_loginBtn.png?rev=1.1" width="300"~]~]>>path:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/WebHome/designer_loginBtn.png?rev=1.1||rel="lightbox[$group]" title="Allgemeine Einstellungen am Formular-Element Bürger Services Login"]]
++
++(% class="xm-figure-caption" %)
++(((
  Allgemeine Einstellungen am Formular-Element //Bürger Services Login//
--{{/figure}}
++)))
++)))
++)))
  Zur vereinfachten Einbindung von einem Bürger Services innerhalb eines Formularprozesses gibt es das Formular-Element //Bürger Services Login//. Dieses kann per "Drag & Drop" in den Seitenbereich gezogen werden. Das dann vorhandene Button-Element kann im Bereich **Bürger Services: Login Einstellungen** konfiguriert werden.
  Die nachfolgenden aufgeführten Einstellungen gelten dabei für alle Bürger Services (BundID, ELSTER etc.) gleichermaßen.
@@ -42,7 +42,7 @@
  ; Bezeichner
  : Beschriftung des Login-Buttons im Formular
  ; Authentikator
--: Hier muss ein konkreter Bürger Services aus den im System konfigurierten [[Externen Benutzern>>path:/xwiki/bin/view/Formcycle/UserInterface/UserSettings/ExternalUsers/]] ausgewählt werden. Zu diesem konkreten Bürger Service (ELSTER, BundID etc.) wird zum Aufrufzeitpunkt weitergeleitet.
++: Hier muss ein konkreter Bürger Services aus den im System konfigurierten (% class="wikiinternallink" %)[[Externen Benutzern>>path:/xwiki/bin/view/Formcycle/UserInterface/UserSettings/ExternalUsers/]](%%) ausgewählt werden. Zu diesem konkreten Bürger Service (ELSTER, BundID etc.) wird zum Aufrufzeitpunkt weitergeleitet.
  ; Seite bei Login
  : Hier wird die Formularseite festgelegt, welche angezeigt werden soll, wenn der Login **erfolgreich **war.
  ; Seite bei Abbruch
@@ -60,9 +60,19 @@
  ==== Zusätzliche Konfigurationsmöglichkeiten für **BundID** / **BayernID** ====
--{{figure image="designer_loginBtn_ext.png"}}
++
++(% class="xm-figure xm-float-right xm-clear-h2" data-alt="Erweiterte Einstellungen am Formular-Element Bürger Services Login für BundID und BayernID" %)
++(((
++(% class="xm-figure-inner" style="width:310px" %)
++(((
++[[~[~[image:attach:designer_loginBtn_ext.png~|~|alt="/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/WebHome/designer_loginBtn_ext.png?rev=1.1" width="300"~]~]>>path:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/WebHome/designer_loginBtn_ext.png?rev=1.1||rel="lightbox[$group]" title="Erweiterte Einstellungen am Formular-Element Bürger Services Login für BundID und BayernID"]]
++
++(% class="xm-figure-caption" %)
++(((
  Erweiterte Einstellungen am Formular-Element //Bürger Services Login// für **BundID** und **BayernID**
--{{/figure}}
++)))
++)))
++)))
  Die nachfolgend beschriebenen Konfigurationsmöglichkeiten stehen nur im Zusammenhang mit den Bürger Services von BundID und BayernID zur Verfügung
  und ermöglichen es die Anmeldemöglichkeiten, sowie die zurück gelieferten Daten aus dem jeweiligen Bürger Service-Portal zu beeinflussen.
@@ -104,13 +104,33 @@
  == Anzeige der Anmeldedaten im Formular ==
--{{figure image="designer_vorlage.png"}}
++
++(% class="xm-figure xm-float-right xm-clear-h2" data-alt="Elementvorlagen zur Datenanzeige" %)
++(((
++(% class="xm-figure-inner" style="width:310px" %)
++(((
++[[~[~[image:attach:designer_vorlage.png~|~|alt="/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/WebHome/designer_vorlage.png?rev=1.1" width="300"~]~]>>path:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/WebHome/designer_vorlage.png?rev=1.1||rel="lightbox[$group]" title="Elementvorlagen zur Datenanzeige"]]
++
++(% class="xm-figure-caption" %)
++(((
  Elementvorlagen zur Datenanzeige
--{{/figure}}
++)))
++)))
++)))
--{{figure image="designer_elementkatalog.png"}}
++
++(% class="xm-figure xm-float-right xm-clear-h2" data-alt="Elementkatalog mit allen möglichen Datenelementen" %)
++(((
++(% class="xm-figure-inner" style="width:310px" %)
++(((
++[[~[~[image:attach:designer_elementkatalog.png~|~|alt="/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/WebHome/designer_elementkatalog.png?rev=1.1" width="300"~]~]>>path:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/WebHome/designer_elementkatalog.png?rev=1.1||rel="lightbox[$group]" title="Elementkatalog mit allen möglichen Datenelementen"]]
++
++(% class="xm-figure-caption" %)
++(((
  Elementkatalog mit allen möglichen Datenelementen
--{{/figure}}
++)))
++)))
++)))
  Um die Daten aus dem jeweiligen Bürger Service-Portal im Formular anzuzeigen, existieren unterschiedliche Vorlagen im Designer. Diese Vorlagen sind nach dem Schwerpunkt, ob sie für eine Anzeige von Personen- oder Organisationsdaten eingesetzt werden sollen, gestaltet. Sie enthalten bereits eine Reihe sinnvoller Elemente für die Datenanzeige, können aber mit weiteren Elementen (auch eigens Definierten) erweitert werden.
@@ -119,15 +119,29 @@
  Die aus dem Bürger Service-Portal zurück gelieferten 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:
--{{code language="javascript"}}
++(% class="box" %)
++(((
++(% class="code" %)
++(((
  XFC_METADATA.pluginResults.XM_BuergerServicesLoginAnalyzer
--{{/code}}
++)))
++)))
  === Darstellung des genutzten Authentifizierungsverfahren ===
--{{figure image="formular_trustlevel_visualisierung.png"}}
++
++(% class="xm-figure xm-float-right xm-clear-h2" data-alt="Darstellung des verwendeten Vertrauensniveaus in einer Datenvorlage" %)
++(((
++(% class="xm-figure-inner" style="width:310px" %)
++(((
++[[~[~[image:attach:formular_trustlevel_visualisierung.png~|~|alt="/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/WebHome/formular_trustlevel_visualisierung.png?rev=1.1" width="300"~]~]>>path:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/WebHome/formular_trustlevel_visualisierung.png?rev=1.1||rel="lightbox[$group]" title="Darstellung des verwendeten Vertrauensniveaus in einer Datenvorlage"]]
++
++(% class="xm-figure-caption" %)
++(((
  Darstellung des verwendeten Vertrauensniveaus in einer Datenvorlage
--{{/figure}}
++)))
++)))
++)))
  Bei Nutzung der Vorlagen aus dem Designer ist nach dem Absenden des Formulars, sowie bei der Wiederanzeige des Formulars im Postfach, das durch den Nutzer verwendete Authentifizierungsverfahren anhand einer visuellen Markierung ersichtlich.
@@ -137,9 +137,18 @@
  * Level 3 (Authentifizierung mittels Zertifikat, Vertrauensniveau nach BSI: //substanziell//): **Zertifikat**
  * Level 4 (Authentifizierung mittels Personalausweis (eID) oder vergleichbaren Authentifizierungsmittel (eIDAS), Vertrauensniveau nach BSI: //hoch//): **Personalausweis**
--{{figure image="formular_trustlevel_keine_visualisierung.png"}}
++(% class="xm-figure xm-float-right xm-clear-h2" data-alt="Wenn keine visuelle Markierung gewünscht ist, so kann dies durch ein zusätzliches Attribut „noRibbon“ am Vorlagen-Fieldset unterbunden werden" %)
++(((
++(% class="xm-figure-inner" style="width:310px" %)
++(((
++[[~[~[image:attach:formular_trustlevel_keine_visualisierung.png~|~|alt="/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/WebHome/formular_trustlevel_keine_visualisierung.png?rev=1.1" width="300"~]~]>>path:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/WebHome/formular_trustlevel_keine_visualisierung.png?rev=1.1||rel="lightbox[$group]" title="Wenn keine visuelle Markierung gewünscht ist, so kann dies durch ein zusätzliches Attribut „noRibbon“ am Vorlagen-Fieldset unterbunden werden"]]
++
++(% class="xm-figure-caption" %)
++(((
  Wenn keine visuelle Markierung gewünscht ist, so kann dies durch ein zusätzliches Attribut „noRibbon“ am Vorlagen-Fieldset unterbunden werden
--{{/figure}}
++)))
++)))
++)))
  ==== Darstellung der Nutzerdaten nach Anmeldung ====
@@ -148,8 +148,8 @@
  Zusätzlich werden die Felder bei Wiederanzeige durch kleine Icons gekennzeichnet, wodurch ersichtlich wird aus welcher Quelle die Anmeldeinformationen entstammen.
--* [[image:verified.png||alt="Icon für Informationen aus Bürgerservice-Portal" height="22" width="21"]] Felder mit diesem Icon wurden aus dem Bürgerservice-Portal übermittelt
--* [[image:none_verified.png||alt="Icon für Informationen die der Nutzer nachträglich eingegeben hat" height="20" width="23"]] Felder mit diesem Icon wurden vom Nutzer nachträglich eingegeben und wurden deshalb nicht durch einen Identitätsprüfer verifiziert
++* [[image:attach:verified.png||alt="Icon für Informationen aus Bürgerservice-Portal" height="22" width="21"]] Felder mit diesem Icon wurden aus dem Bürgerservice-Portal übermittelt
++* [[image:attach:none_verified.png||alt="Icon für Informationen die der Nutzer nachträglich eingegeben hat" height="20" width="23"]] Felder mit diesem Icon wurden vom Nutzer nachträglich eingegeben und wurden deshalb **nicht **durch einen Identitätsprüfer verifiziert
  Die Feld-Icons werden mittels CSS-Klassen an den Eingabe-Elementen hinzugefügt und können dadurch mittels eigenem CSS Definitionen übersteuert werden. Die dafür notwendigen Klassen haben folgende Namen:
@@ -260,6 +260,54 @@
  == Anbindung Postkorb im Workflow ==
  Für die Anbindung zum Versand Nachrichten an den Postkorb des jeweiligen Bürger Service steht die Workflow-Aktion _Postkorbnachricht senden_ zur Verfügung.
--Mittels dieser Aktion, können ähnlich einer E-Mail Aktion, Nachrichten weitergeleitet werden, wenn zum Ausführungszeitpunkt eine Postkorb-ID ermittelt werden kann.
++Mittels dieser Aktion, können ähnlich einer E-Mail Aktion, Nachrichten weitergeleitet werden, wenn zum Ausführungszeitpunkt eine Postkorb ID ermittelt werden kann.
  Die Konfigurationsoberfläche der Aktion ist in einzelne Bereiche unterteilt die nachfolgend kurz beschrieben werden.
++
++=== Absender ===
++
++; Mandant / Absender
++: Wird als Information in der Postkorb-Ansicht im Bürgerservice-Portal verwendet.
++; Dienst
++: Wird als Information in der Postkorb-Ansicht im Bürgerservice-Portal verwendet.
++; Absender-Link
++: Falls sich die Angabe im Feld Mandant auf einen Mandanten bezieht, der nicht im Bürger Service-Portal registriert ist, kann über den Absender-Link ein Link mitgegeben werden,
++: mit dem der Mandant bei der Anzeige im Postkorb der **BundID **oder **BayernID **verlinkt wird.
++
++=== Empfänger ===
++
++; Postkorb ID aus einer Anmeldung innerhalb der Vorgangsdaten ermitteln?
++: Diese Angabe dient zur Bestimmung der Postkorb ID. Über diese ID wird das genaue Ziel für den Nachrichtenversand bestimmt, also der Nachrichten-Empfänger.
++: Wird bei einem Bürger Service-Login die Postkorb ID übermittelt, so wird diese standardmäßig am Formulareingang hinterlegt. Für den Fall, dass es mehrere konfigurierte Anmeldungen
++: innerhalb eines Formulars gibt, kann die Auswahl über den Daten-Suffix eingegrenzt werden.
++: Darüber hinaus ist es möglich die Postkorb-ID fest oder über einen Platzhalter **[%$POSTKORB%]** zu definieren. (Diese Platzhalter wird über das Plugin zur Verfügung gestellt.)
++; Vertrauensniveau der Anmeldung für Zugriff auf Postkorb-Nachricht weiterreichen?
++: Diese Option steht nur im BundID und BayernID Portal zur Verfügung.
++: Hier können Sie festlegen, ob das Vertrauensniveau der Anmeldung (wenn dies ermittelt werden kann) für den Zugriff auf die Postkorb-Nachricht weitergereicht werden soll.
++: Wenn kein Vertrauensniveau aus den Anmeldedaten ermittelt werden kann, wird das niedrigste Vertrauensniveau für den Zugriff auf die Nachricht gesetzt.
++; E-Mailversand als Alternative?
++: Über diese Option können Sie festlegen, dass als alternative Versandmöglichkeit der Versand mittels E-Mail verwendet wird. Diese Alternative kommt dann zur Anwendung, wenn keine Postkorb ID ermittelt werden konnte, oder die Übermittlung der Postkorb-Nachricht mit Fehlern beendet wurde. Voraussetzungen für dem E-Mailversand ist die Verfügbarkeit einer E-Mail-Adresse (im Feld //tfAntragstellerEmail//) in den verwendeten Anmeldedaten, sowie die Erreichbarkeit eines konfigurierten E-Mail-Servers.
++
++=== Inhalt der Nachricht ===
++
++; Betreff (Pflicht)
++: Nachrichtenbetreff. Es werden Platzhalter unterstützt.
++; Inhalt (Pflicht)
++: Nachrichtentext. Es werden Platzhalter unterstützt.
++; Anhänge
++: Hier können Dateien als Attachments an die Postkorb-Nachricht gehangen werden.
++: Die dabei unterstützten Dateiformat unterscheiden sich dabei je nach genutzten Bürger Service:
++: * für BundID / BayernID: PDF, HTML, Plaintext, MS Word, JPEG, GIF, PNG, ZIP
++: * für ELSTER: PDF, JPEG, PNG, XML, CSV
++: Zur Auswahl stehen dabei:
++:; Dateien aus vorherigen Aktionen
++:: Eine Liste mit Dateien, von Datei-bereitstellenden Aktionen, die der Postkorb-Aktion vorangestellt sind.
++:; Mandantdateien
++:: Liefert eine Auswahlliste über alle Datei-Ressourcen am Mandanten
++:; Formulardateien
++:: Liefert eine Auswahlliste über alle Datei-Ressourcen, welche am Formular-Projekt hinterlegt sind.
++:; Externe Ressourcen-URL
++:: Dateien die über externe Quellen (HTTP-Requests) ermittelt werden können.
++:; Vorgangsanhänge mittels Dateinamen suchen
++:: Eine Suche innerhalb von Dateinamen mittels übereinstimmenden Suchbegriffs. Es kann dabei mittels Filter eingegrenzt werden,
++:: innerhalb welcher Datei-Quellen die Suche ausgeführt wird (Dateien aus Uploads, Datei aus der Statusverarbeitung, Dateien aus dem Posteingang)