Wiki source code of Plugin Setup
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/B%C3%BCrgerservice%20Plugin%20(buerger-service)&fileid=52647||rel="noopener noreferrer" target="_blank"]] (erfordert Anmeldung) | ||
2 | |||
3 | (% class="box xm-toc-box" data-content-hide="Verbergen" data-content-show="Anzeigen" style="width:auto;" %) | ||
4 | ((( | ||
5 | Inhalt (% class="xm-toc-toggle" %)[ [[Verbergen>>path:javascript:void||class="xm-toc-togglelink"]] ] | ||
6 | |||
7 | (% class="xm-toc numbered-true" %) | ||
8 | ((( | ||
9 | (% class="wikitoc" %) | ||
10 | * [[Initiale Installation>>path:#HInitialeInstallation]] | ||
11 | * [[Migration bestehender Service-Konten-Anbindungen>>path:#HMigrationbestehenderService-Konten-Anbindungen]] | ||
12 | ** [[Migrations-Beispiel für BayernID Anbindung:>>path:#HMigrations-BeispielfFCrBayernIDAnbindung:]] | ||
13 | ** [[Migration für BundID Anbindungen>>path:#HMigrationfFCrBundIDAnbindungen]] | ||
14 | ** [[Migration für ELSTER Anbinungen>>path:#HMigrationfFCrELSTERAnbinungen]] | ||
15 | * [[Vorüberlegungen zur Anbindung neuer Servicekonten>>path:#HVorFCberlegungenzurAnbindungneuerServicekonten]] | ||
16 | * [[Allgemeine Informationen zur Anbindung eines Servicekontos>>path:#HAllgemeineInformationenzurAnbindungeinesServicekontos]] | ||
17 | * [[Details für die Anbindung der BundID>>path:#HDetailsfFCrdieAnbindungderBundID]] | ||
18 | ** [[Schritt 1: Konfiguration anlegen>>path:#HSchritt1:Konfigurationanlegen]] | ||
19 | ** [[Schritt 2: Metadaten erzeugen und registrieren>>path:#HSchritt2:Metadatenerzeugenundregistrieren]] | ||
20 | ** [[Schritt 3: BundID-Login Aktivierung>>path:#HSchritt3:BundID-LoginAktivierung]] | ||
21 | * [[Details für die Anbindung des ELSTER Mein Unternehmenskontos>>path:#HDetailsfFCrdieAnbindungdesELSTERMeinUnternehmenskontos]] | ||
22 | ** [[FORMCYCLE Schritt 1: Konfiguration anlegen>>path:#HFORMCYCLESchritt1:Konfigurationanlegen]] | ||
23 | ** [[FORMCYCLE Schritt 2: Vorbereitung für Registrierung im MUK Portal>>path:#HFORMCYCLESchritt2:VorbereitungfFCrRegistrierungimMUKPortal]] | ||
24 | ** [[MUK Self Service Portal: Registrierung eines NEZO Vorhabens>>path:#HMUKSelfServicePortal:RegistrierungeinesNEZOVorhabens]] | ||
25 | *** [[MUK Self Service Portal Schritt 1: Anmeldung>>path:#HMUKSelfServicePortalSchritt1:Anmeldung]] | ||
26 | *** [[MUK Self Service Portal Schritt 2: Vorhaben hinzufügen>>path:#HMUKSelfServicePortalSchritt2:VorhabenhinzufFCgen]] | ||
27 | *** [[MUK Self Service Portal Schritt 3: Service-Provider beantragen>>path:#HMUKSelfServicePortalSchritt3:Service-Providerbeantragen]] | ||
28 | ** [[FORMCYCLE Schritt 3: ELSTER-Login Aktivierung>>path:#HFORMCYCLESchritt3:ELSTER-LoginAktivierung]] | ||
29 | * [[Details für die Anbindung der BayernID>>path:#HDetailsfFCrdieAnbindungderBayernID]] | ||
30 | ** [[Schritt 1: Konfiguration anlegen>>path:#HSchritt1:Konfigurationanlegen-1]] | ||
31 | ** [[Schritt 2: Metadaten erzeugen und registrieren>>path:#HSchritt2:Metadatenerzeugenundregistrieren-1]] | ||
32 | ** [[Schritt 3: BayernID-Login Aktivierung>>path:#HSchritt3:BayernID-LoginAktivierung]] | ||
33 | ))) | ||
34 | ))) | ||
35 | |||
36 | == Initiale Installation == | ||
37 | |||
38 | Das **Bürgerservice Plugin** muss im System Bereich von (% class="xm-smallcaps" %)Xima® Formcycle(%%) installiert werden (Menüpunkt: System > [[Systemplugins>>path:/xwiki/bin/view/Formcycle/SystemSettings/UserInterface/SystemPlugins||target="_blank"]]). | ||
39 | Es bietet aktuell die Anbindung an folgende Servicekonten: | ||
40 | |||
41 | * **BundID** | ||
42 | * **BayernID** | ||
43 | * **ELSTER** //Mein Unternehmenskonto// | ||
44 | |||
45 | (% class="box warningmessage" %) | ||
46 | ((( | ||
47 | Beachten Sie bitte, dass die einzelnen Servicekonto-Anbindungen lizenzpflichtig sind. Sollten Sie eine Lizenz für das jeweilige Servicekonto erworben | ||
48 | haben und ihnen wird beim Aufrufversuch der Zugriffs auf die Kontoart verweigert, so prüfen Sie bitte die Aktualität ihrer [[FORMCYCLE-System bzw. Mandant-Lizenz>>path:/xwiki/bin/view/Formcycle/SystemSettings/UserInterface/License||target="_blank"]]. | ||
49 | ))) | ||
50 | |||
51 | == Migration bestehender Service-Konto-Anbindungen == | ||
52 | |||
53 | * Bestehende Anbindungen zu Service-Konten von **BundID**, **BayernID** und **ELSTER** werden bei der Installation des Plugins automatisch auf das neue Plugin umgestellt. | ||
54 | * (% class="box infomessage" %) | ||
55 | ((( | ||
56 | Die veralteten Plugin-Bundles (jar-Dateien) **bleiben **auf dem FORMCYCLE System **erhalten**, werden aber **deaktiviert**. | ||
57 | Folgende Plugins können deshalb auf dem System nach der Installation des **Bürgerservice Plugins** deaktiviert sein: | ||
58 | |||
59 | * //plugin-bundle-bund-id //(veraltetes Plugin für BundID Anbindung) | ||
60 | * //plugin-bundle-akdb-services.jar //(veraltetes Plugin für BayernID Anbindung) | ||
61 | * //fc-plugin-bundle-elster-authentikator.jar// (veraltetes Plugin für ELSTER Anbindung) | ||
62 | ))) | ||
63 | * Alle zuvor konfigurierten Anbindungen werden als Externe Benutzer im jeweiligen Bereich (System oder Mandant) definiert. | ||
64 | * Designer-Vorlagen, die mit den veralteten Plugins in das System gekommen sind, werden entfernt. | ||
65 | |||
66 | === Migrations-Beispiel für BayernID Anbindung: === | ||
67 | |||
68 | Ausgangspunkt ist ein FORMCYCLE System mit mehreren Mandanten. In zwei Mandanten ist jeweils das// AKDB: Bürgerkonto-Service-Plugin //(Anbindung an **BayernID**) installiert. | ||
69 | Einer der **BayernID **Mandanten hat die Einbindung des Bürgerkonto Logins als Externer Benutzer konfiguriert. | ||
70 | |||
71 | Nachdem das** Bürgerservice Plugin** im [[System Bereich>>path:/xwiki/bin/view/Formcycle/SystemSettings/UserInterface/SystemPlugins||target="_blank"]] installiert wurde ergibt sich folgendes Bild: | ||
72 | |||
73 | * Die veralteten //AKDB: Bürgerkonto-Service-Plugins// in den jeweiligen Mandanten sind deaktiviert, aber noch vorhanden.((( | ||
74 | {{warning}} | ||
75 | **Achtung:** | ||
76 | Das veraltete //AKDB: Bürgerkonto-Service-Plugin// darf nach der Migration nicht wieder aktiviert werden. Sollte dies dennoch der Fall sein, so ist das Plugin wieder zu **deaktivieren** und das Systemplugin **Bürgerservice** muss nach der Deaktivierung nochmalig **gespeichert werden**. Das nochmalige Speichern bewirkt die Reinitialisierung eines Servlets, welches für die Entgegenahme und Weiterleitung der BayernID Authentifizierungsdaten zuständig ist. | ||
77 | {{/warning}} | ||
78 | ))) | ||
79 | * In beiden Mandanten mit **BayernID **Anbindung befindet sich jetzt ein Externer Benutzer, welcher zukünftig die Authentifizierung mit dem **BayernID**-Portal realisiert. | ||
80 | In einem Mandanten wurde dazu im Zuge der Migration der Externe Benutzer neu angelegt. In dem Mandanten, wo bereits ein Externer Benutzer bestand, wurde dieser um notwendige Daten (Zertifikate zur Kommunikation, Anbindungsdaten für den Postkorb-Schnittstelle) erweitert, sodass er auch weiterhin in den bereits bestehenden Formularanbindungen genutzt werden kann. | ||
81 | * Der Menüpunkt //AKDB Setup// ist in den Mandanten nicht mehr vorhanden. Die Einstellungen, welche den Postkorb betreffen (z.B.: Zertifikat für Postkorb-Kommunikation) sind jetzt direkt am neu erstellten bzw. migrierten Externen Benutzer zu finden. | ||
82 | * Alte Designer-Vorlagen für die Anzeige der Bürgerkonto-Daten wurden durch neue Vorlagen ersetzt. | ||
83 | * Die Formulare welche bisher die **BayernID** über den Login-Button eingebunden hatten müssen nicht angepasst werden. Bei Nutzung des Login-Buttons, sowie der Postkorb-Aktion im Workflow erfolgt eine automatische Weiterleitung an die durch das **Bürgerservice Plugin** bereitgestellte Funktionalität. | ||
84 | |||
85 | (% class="box infomessage" %) | ||
86 | ((( | ||
87 | Hinweis: Es werden nur fertig konfigurierte **BayernID **Anbindungen migriert. Ist nur das Plugin im Mandaten vorhanden ist, sind aber keine Einstellungen zur Anbindung (Keystore, EntityID etc.) konfiguriert, kann keine Migration in einen [[Externen Benutzer>>path:/xwiki/bin/view/Formcycle/UserInterface/UserSettings/ExternalUsers/||target="_blank"]] erfolgen. | ||
88 | ))) | ||
89 | |||
90 | |||
91 | === Migration für BundID Anbindungen === | ||
92 | |||
93 | Bei bestehenden **BundID** Anbindungen werden die vorhandenen Externen Benutzer mit der neuen Konfigurationseinstellungen erweitert. Vorhandene Formulare mit BundID Anbindung, können ähnlich, wie bei der BayernId ohne Anpassung genutzt werden. | ||
94 | |||
95 | === Migration für ELSTER Anbinungen === | ||
96 | |||
97 | Bei bereits im System existenten **ELSTER** Anbindungen werden die vorhandenen Externen Benutzer mit neuen Konfigurationseinstellungen erweitert. Formulare mit einer Zugriffssteuerung über **ELSTER** können ohne weitere Anpassung genutzt werden. Anbindungen an den** ELSTER-Transfer-Client**, welche über die entsprechende //ELSTER Postkorbnachricht// Workflow-Aktion in den Formularen eingebunden sind, werden automatisch auf die **Bürgerservice Plugin** Funktionalität weitergeleitet. Dadurch ergibt sich auch hier keine notwendige Anpassung der vorhandenen Formulare. | ||
98 | |||
99 | == Vorüberlegungen zur Anbindung neuer Servicekonten == | ||
100 | |||
101 | Neue Anbindungen an Servicekonten müssen im (% class="xm-smallcaps" %)Xima® Formcycle(%%) System als [[Externe Benutzer>>path:/xwiki/bin/view/Formcycle/SystemSettings/UserInterface/ExternalUsers/]] (auch als Authentikatoren bezeichnet) angelegt werden. Dabei ist es möglich diese im System- als auch im Bereich des Mandanten anzulegen. | ||
102 | Folgende Überlegungen sollten für eine Entscheidung des Bereichs, in welchem die Externen Benutzer angelegt werden, herangezogen werden. | ||
103 | |||
104 | **Ist ein Multi-Mandanten (% class="xm-smallcaps" %)Xima® Formcycle(%%) System mit unterschiedlichen Host-Adressen für die Ansteuerung der Formulare der einzelnen Mandanten vorhanden? (Meist realisiert über Anbindung mehrerer Frontend-Server)** | ||
105 | |||
106 | In diesem Fall sollte jeweils im Mandanten ein Externer Benutzer angelegt werden, welcher die Anbindung an des Servicekonto realisiert. | ||
107 | \\Der Grund für dieses empfohlene Vorgehen ist, dass die aktuellen Anbindungen an die **BundID**, die **BayernID, **sowie an das **ELSTER**-Portal alle auf Grundlage des [[SAML 2.0>>url:https://en.wikipedia.org/wiki/SAML_2.0||rel="noopener noreferrer" target="_blank"]] - Protokolls arbeiten. Eine Festlegung bei der Kommunikation über das SAML 2.0 Protokoll ist es, dass im Vorfeld zwischen dem jeweiligen Identity Provider (Servicekonto-Portal) und dem Service Provider (FORMCYCLE) Metadaten ausgetauscht werden müssen. In diesen Metadaten sind die Rücksprungziele in das jeweils andere System (per URL) fest definiert. | ||
108 | Durch das Anlegen eines Externen Benutzers im Bereich des jeweiligen Mandanten kann hier eine saubere Trennung und damit auch Nutzung in den Formularen stattfinden. | ||
109 | Legt man bei dieser Systemkonstellation verschiedene Externe Benutzer im System - Bereich an, so muss der Formularentwickler innerhalb des Formular die für seinen Mandanten korrekte Anbindung auswählen, was eine potenzielle Fehlerquelle sein kann. | ||
110 | |||
111 | **Ist ein Multi-Mandanten- oder ein Single-Mandat- (% class="xm-smallcaps" %)Xima® Formcycle(%%) System mit einer Host-Adresse für die Ansteuerung der Formulare vorhanden?** | ||
112 | |||
113 | Hier sollten alle Externen Benutzer für die Servicekonten-Ansteuerung im System-Bereich angelegt werden. Der Vorteil ist an dieser Stelle, dass alle Anbindungen zentral an einer Stelle vorhanden sind und alle Formular-Benutzer in den verschiedenen Mandanten Zugriff auf diese erhalten. | ||
114 | |||
115 | == Allgemeine Informationen zur Anbindung eines Servicekontos == | ||
116 | |||
117 | |||
118 | (% class="xm-figure xm-float-right xm-clear-h2" data-alt="Auswahl eines Servicekontos" %) | ||
119 | ((( | ||
120 | (% class="xm-figure-inner" style="width:310px" %) | ||
121 | ((( | ||
122 | [[~[~[image:attach:extUser_selection.png~|~|width="300"~]~]>>path:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/Plugin%20Setup/WebHome/extUser_selection.png?rev=1.1||rel="lightbox[$group]" title="Auswahl eines Servicekontos"]] | ||
123 | |||
124 | (% class="xm-figure-caption" %) | ||
125 | ((( | ||
126 | Auswahl eines Servicekontos | ||
127 | ))) | ||
128 | ))) | ||
129 | ))) | ||
130 | |||
131 | In diesem Abschnitt werden die Schritte, welche für die Anbindung aller Servicekonten gleichermaßen gelten, erläutert. | ||
132 | |||
133 | Bevor man ein Servicekonto anbindet sollten folgende Voraussetzungen erfüllt sein: | ||
134 | |||
135 | * Die im Unternehmen verantwortlichen technischen und organisatorischen Ansprechpartner müssen bekannt sein (Namen, E-Mail-Adressen). Diese Informationen werden innerhalb des Registrierungs-Prozesses für die einzelnen Servicekonten an unterschiedlichen Stellen benötigt. | ||
136 | * URLs für die Anbindung des FORMCYCLE-Systems müssen eingerichtet und **von außen erreichbar** sein. Dabei ist zu beachten, dass bei Verwendung eines Frontend-Servers die URL zu diesem verwendet wird. | ||
137 | |||
138 | Die Anbindung eines Servicekontos lässt sich in folgende Schritte gliedern: | ||
139 | |||
140 | 1. Anlegen einen neuen Externen Benutzer (Authentikator) unter dem Menüpunkt System > [[Systemplugins>>path:/xwiki/bin/view/Formcycle/SystemSettings/UserInterface/SystemPlugins||target="_blank"]] oder Mandant > [[Plugins>>path:/xwiki/bin/view/Formcycle/UserInterface/Client/Plugins||target="_blank"]]. | ||
141 | 1. Spezifische Authentikator Konfiguration über die zur Verfügung gestellte Oberfläche ausführen. Die Konfigurationsoberfläche unterscheidet sich je nach ausgewählten Servicekonto. Auf die Unterschiede bei der Anbindung des jeweiligen Servicekonto-Typs wird in den nachfolgenden Abschnitten näher eingegangen. | ||
142 | 1. Download und Weiterleitung der festgelegten Konfigurationsdaten (Metadaten), sowie der Vertragsdaten an den jeweiligen Identity Provider (**BundID**, **BayernID**) bzw. | ||
143 | selbst durchzuführende Konfiguration auf Seiten des Identity Providers über ein Self-Service Portal (ELSTER) | ||
144 | 1. Freigabe des Authentikators in (% class="xm-smallcaps" %)Xima® Formcycle(%%), nach erfolgter Rückmeldung über die erfolgte Registrierung der Metadaten durch den jeweiligen Identity Provider bzw. Freigabe durch Prüfungsinstanz (bei ELSTER Self Service Portal Registrierung) und damit Beginn der Einbindung des Servicekontos in Formulare | ||
145 | |||
146 | == Details für die Anbindung der BundID == | ||
147 | |||
148 | Um das Servicekonto der **BundID** anzubinden ist ein neuer Externer Benutzer anzulegen und als Authentifizierungstyp **BundID** auszuwählen. | ||
149 | |||
150 | === Notwendige Vorarbeiten === | ||
151 | |||
152 | {{warning}} | ||
153 | Bevor mit der Einrichtung der Anbindung begonnen werden kann, muss eine offizielle Anbindungsanfrage an die **BundID **per E-Mail unter **BundID@bmi.bund.de** gestellt werden. | ||
154 | Im Zuge des Onboarding-Prozesses bei der **BundID **erhält man eine Kooperationsvereinbarung und dazugehörige Anlagen, welche auszufüllen sind und zusammen mit den, innerhalb des FORMCYLE Anbindungsprozess entstehenden, **SAML-Metadaten** an die **BundID **übermittelt werden müssen. | ||
155 | {{/warning}} | ||
156 | |||
157 | === Schritt 1: Konfiguration anlegen === | ||
158 | |||
159 | |||
160 | (% class="xm-figure xm-float-right xm-clear-h2" data-alt="Schritt 1: Notwendige Daten für Erzeugung der Service Metadaten festlegen" %) | ||
161 | ((( | ||
162 | (% class="xm-figure-inner" style="width:310px" %) | ||
163 | ((( | ||
164 | [[~[~[image:attach:bundID_config1.png~|~|width="300"~]~]>>path:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/Plugin%20Setup/WebHome/bundID_config1.png?rev=1.1||rel="lightbox[$group]" title="Schritt 1: Notwendige Daten für Erzeugung der Service Metadaten festlegen"]] | ||
165 | |||
166 | (% class="xm-figure-caption" %) | ||
167 | ((( | ||
168 | Schritt 1: Notwendige Daten für Erzeugung der Service Metadaten festlegen | ||
169 | ))) | ||
170 | ))) | ||
171 | ))) | ||
172 | |||
173 | * Im 1. Schritt der Konfiguration erscheint eine Eingabeoberfläche, wo folgende Festlegungen getroffen werden müssen: | ||
174 | ** Festlegung, ob Test- oder Live-Umgebung der **BundID** anzubinden ist. | ||
175 | ** Erhebung von Zertifikatsinformationen, welche anschließend zur Generierung eines privaten und öffentlichen Schlüssels herangezogen werden. Dieses Schlüsselpaar dient zur Ver- und Entschlüsselung der Kommunikation, zwischen (% class="xm-smallcaps" %)Xima® Formcycle(%%) und der **BundID**. | ||
176 | ** Angaben zum organisatorischen und technischen Ansprechpartner. Diese Informationen werden im Zuge des Registrierungsprozesses an das **BundID**-Portal innerhalb der generierten SAML-Metadaten weitergegeben. | ||
177 | * Speichern der Eingaben. Danach gelangt man zum 2. Schritt der Anbindung. | ||
178 | |||
179 | === Schritt 2: Metadaten erzeugen und registrieren === | ||
180 | |||
181 | |||
182 | (% class="xm-figure xm-float-right xm-clear-h2" data-alt="Schritt 2 und 3: Download der erzeugten Metadaten für eine jeweilige Host-Adresse; Aktivierung der BundID Authentifizierung für Formulare" %) | ||
183 | ((( | ||
184 | (% class="xm-figure-inner" style="width:310px" %) | ||
185 | ((( | ||
186 | [[~[~[image:attach:bundID_config2.png~|~|width="300"~]~]>>path:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/Plugin%20Setup/WebHome/bundID_config2.png?rev=1.1||rel="lightbox[$group]" title="Schritt 2 und 3: Download der erzeugten Metadaten für eine jeweilige Host-Adresse; Aktivierung der BundID Authentifizierung für Formulare"]] | ||
187 | |||
188 | (% class="xm-figure-caption" %) | ||
189 | ((( | ||
190 | Schritt 2 und 3: Download der erzeugten Metadaten für eine jeweilige Host-Adresse; Aktivierung der BundID Authentifizierung für Formulare | ||
191 | ))) | ||
192 | ))) | ||
193 | ))) | ||
194 | |||
195 | * In diesem Schritt werden die SAML-Metadaten für die Registrierung auf Seiten der **BundID **erzeugt. Dafür steht in der Oberfläche ein Button mit Auswahlfeld zur Verfügung. Das Auswahlfeld enthält alle im (% class="xm-smallcaps" %)Xima® Formcycle(%%) System gefundenen Host-Adressen, über die das System erreichbar ist. Auf der Grundlage der jeweiligen Host-Adresse werden dann die Metadaten erzeugt und als Download zurück geliefert. Die jeweilige Host-Adresse bildet dabei einen Teil der Rücksprung-URL, welche später vom Identity Provider (BundID Portal) zur Übermittlung der Authentifizierungsdaten genutzt wird.((( | ||
196 | (% class="box infomessage" %) | ||
197 | ((( | ||
198 | Hinweis: Soll der BundID-Login über unterschiedliche Host-Adressen erreichbar sein, | ||
199 | so muss für jeden Host die Metadaten-Datei erzeugt und an das BundID-Portal zur Registrierung übermittelt werden. | ||
200 | ))) | ||
201 | ))) | ||
202 | * **SAML-Metadaten** sind zusammen mit weiteren Vertragsdaten (Kooperationvereinbarung + Anlagen) an das **BundID** Portal (Mail: **bundID@bmi.bund.de**) zu senden, mit der Bitte, um Aufnahme in den Portalverbund. | ||
203 | * Damit ist der 1. Teil der Registrierung abgeschlossen und eine Antwort vom **BundID** Portal muss abgewartet werden. | ||
204 | |||
205 | === Schritt 3: BundID-Login Aktivierung === | ||
206 | |||
207 | |||
208 | (% class="xm-figure xm-float-right xm-clear-h2" data-alt="Globale Konfiguration des Anfrageverhalten sowie der Postkorbanbindung" %) | ||
209 | ((( | ||
210 | (% class="xm-figure-inner" style="width:310px" %) | ||
211 | ((( | ||
212 | [[~[~[image:attach:bundID_config3.png~|~|width="300"~]~]>>path:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/Plugin%20Setup/WebHome/bundID_config3.png?rev=1.1||rel="lightbox[$group]" title="Globale Konfiguration des Anfrageverhalten sowie der Postkorbanbindung"]] | ||
213 | |||
214 | (% class="xm-figure-caption" %) | ||
215 | ((( | ||
216 | Globale Konfiguration des Anfrageverhalten sowie der Postkorbanbindung | ||
217 | ))) | ||
218 | ))) | ||
219 | ))) | ||
220 | |||
221 | * Dieser Schritt sollte erst durchgeführt werden, wenn Sie vom **BundID** Portal Rückmeldung erhalten haben, dass ihre übermittelten Metadaten im Portal registriert und freigegeben sind. Erst mit dem Button //BundId-Login aktivieren// wird der Authentikator im System aktiviert. Er ist damit in den Formularen verfügbar und kann eingebunden werden.((( | ||
222 | (% class="box infomessage" %) | ||
223 | ((( | ||
224 | Hinweis: Wenn Sie den Login **vor** einer positiven Rückmeldung des BundID-Portals aktivieren, | ||
225 | so kann das die **BundID** zwar bereits in den Formularen eingebunden werden, | ||
226 | wird aber beim Aufruf in einem Fehler resultieren, | ||
227 | dass der anfragende Service dem Portal nicht bekannt ist. | ||
228 | ))) | ||
229 | ))) | ||
230 | * Nach Aktivierung des Logins erweitert sich die Konfigurationsoberfläche des Authentikators. | ||
231 | * Unter dem Punkt //Erweiterte Einstellungen// > //Konfiguration Identity Provider Anfrageverhalten// kann das Anfrageverhalten für **alle** Formulare, welche diesen Authentikator später über den Formularzugriff angebunden haben, beeinflusst werden. Dabei sind folgende Einstellungen möglich:((( | ||
232 | ; Vertrauensniveau | ||
233 | : Angaben in dieser Eigenschaft dienen zum Einschränken der Authentisierungsverfahren auf zugelassene Vertrauensniveaus. | ||
234 | Einschränkungen dieser Art werden an referenzierende Identity Provider weitergereicht, wenn dies durch den aufrufenden Identity Provider unterstützt wird. | ||
235 | ; Login Methoden einschränken | ||
236 | : Angaben in dieser Eigenschaft dienen zum Einschränken der Authentisierungsverfahren. Ist kein Wert gesetzt, erfolgt keine Einschränkung und dem Nutzer werden alle, vom Identity-Provider zur Verfügung gestellten, Anmeldeverfahren zur Auswahl angezeigt. | ||
237 | ; Pflichtelemente | ||
238 | : Über diese Eigenschaft können Attribute als verpflichtende Nutzereigenschaften angefordert werden. | ||
239 | Alle Authentisierungsverfahren, welche die geforderten Attribute nicht erfüllen, werden dadurch ausgeblendet. | ||
240 | Sofern der Formular-Workflow beispielsweise die Kommunikation mit dem Postkorb zwingend erfordert, | ||
241 | kann hier der Wert "Postkorb" angegeben werden, wodurch unter anderem das Ausblenden der temporären Anmeldung erreicht wird. | ||
242 | ; Angeforderte Eigenschaften einschränken | ||
243 | : Angaben in dieser Eigenschaft dienen zum Einschränken der zurück gelieferten Eigenschaften aus einer erfolgreichen Nutzer-Anmeldung. | ||
244 | In erster Linie ist diese Eigenschaft dazu gedacht, dem Grundsatz der Datensparsamkeit aus den Vorgaben der DSGVO (Datenschutz-Grundverordnung) gerecht zu werden. | ||
245 | Sind keine Werte gesetzt, erfolgt keine Einschränkung und es werden alle vom Identity-Provider zur Verfügung | ||
246 | gestellten Nutzer-Eigenschaften zurück geliefert. | ||
247 | ))) | ||
248 | * Unter dem Punkt //Erweiterte Einstellungen// > //Konfigurtion BundID Postkorbanbindung// können Sie die Daten für einen Proxy-Server hinterlegen, wenn dieser für die Kommunikation zum BundID Postkorb notwendig sein sollte. | ||
249 | * Über den Button //Postkorb Verbindung prüfen// kann der Zugriff auf den Postkorb-Webservice getestet werden.((( | ||
250 | (% class="box warningmessage" %) | ||
251 | ((( | ||
252 | Folgende URL muss **vom FORMCYCLE Master-Server** **aus erreichbar** sein: | ||
253 | |||
254 | * Testsystem: https:~/~/int.id.bund.de/bspx-postkorb-okkomm-ws/bspservices/postkorbkomm | ||
255 | ODER | ||
256 | * Livesystem: | ||
257 | ** bei Kommunikation über des Netz des Bundes (NdB): | ||
258 | https:~/~/prod.id.bmi.in.bund.de/bspx-postkorb-okkomm-ws/bspservices/postkorbkomm | ||
259 | ** bei Kommunikation über das Verbindungsnetz des Bundes (NdB-VN): | ||
260 | https:~/~/prod.bundid.doi-de.net/bspx-postkorb-okkomm-ws/bspservices/postkorbkomm | ||
261 | ** Achtung: Der Livesystem Postkorb-Webservice ist **nicht** direkt aus dem Internet erreichbar! | ||
262 | ))) | ||
263 | ))) | ||
264 | |||
265 | == Details für die Anbindung des ELSTER //Mein Unternehmenskontos// == | ||
266 | |||
267 | Um das Unternehmenskonto **ELSTER** anzubinden ist ein neuer Externer Benutzer anzulegen und als Authentifizierungstyp **ELSTER Unternehmenskonto** auszuwählen. | ||
268 | |||
269 | === FORMCYCLE Schritt 1: Konfiguration anlegen === | ||
270 | |||
271 | |||
272 | (% class="xm-figure xm-float-right xm-clear-h2" data-alt="Schritt 1: Notwendige Daten für Erzeugung der Service Metadaten festlegen" %) | ||
273 | ((( | ||
274 | (% class="xm-figure-inner" style="width:310px" %) | ||
275 | ((( | ||
276 | [[~[~[image:attach:elster_config1.png~|~|width="300"~]~]>>path:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/Plugin%20Setup/WebHome/elster_config1.png?rev=1.1||rel="lightbox[$group]" title="Schritt 1: Notwendige Daten für Erzeugung der Service Metadaten festlegen"]] | ||
277 | |||
278 | (% class="xm-figure-caption" %) | ||
279 | ((( | ||
280 | Schritt 1: Notwendige Daten für Erzeugung der Service Metadaten festlegen | ||
281 | ))) | ||
282 | ))) | ||
283 | ))) | ||
284 | |||
285 | * Im 1. Schritt der Konfiguration erscheint eine Eingabeoberfläche, wo folgende Festlegungen getroffen werden müssen: | ||
286 | ** Festlegung, ob Test- oder Live-Umgebung des **ELSTER** Portals anzubinden ist. | ||
287 | ** Definition einer eindeutigen ID. Diese ID dient im weiteren Verlauf als //Entity-ID// innerhalb der SAML-Metadatenkonfiguration und wird in einer URL-Notation angegeben. | ||
288 | ** Erhebung von Zertifikatsinformationen, welche anschließend zur Generierung eines privaten und öffentlichen Schlüssels herangezogen werden. Dieses Schlüsselpaar dient zur Ver- und Entschlüsselung der Kommunikation, zwischen (% class="xm-smallcaps" %)Xima® Formcycle(%%) und dem **ELSTER** Portal. | ||
289 | * Speichern der Eingaben. Danach gelangt man zum 2. Schritt der Anbindung. | ||
290 | |||
291 | === FORMCYCLE Schritt 2: Vorbereitung für Registrierung im MUK Portal === | ||
292 | |||
293 | |||
294 | (% class="xm-figure xm-float-right xm-clear-h2" data-alt="Schritt 2 und 3: Anzeige der für die Registrierung im MUK Portal notwendigen Daten; Aktivierung der ELSTER Authentifizierung für Formulare" %) | ||
295 | ((( | ||
296 | (% class="xm-figure-inner" style="width:310px" %) | ||
297 | ((( | ||
298 | [[~[~[image:attach:elster_config2.png~|~|width="300"~]~]>>path:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/Plugin%20Setup/WebHome/elster_config2.png?rev=1.1||rel="lightbox[$group]" title="Schritt 2 und 3: Anzeige der für die Registrierung im MUK Portal notwendigen Daten; Aktivierung der ELSTER Authentifizierung für Formulare"]] | ||
299 | |||
300 | (% class="xm-figure-caption" %) | ||
301 | ((( | ||
302 | Schritt 2 und 3: Anzeige der für die Registrierung im MUK Portal notwendigen Daten; Aktivierung der ELSTER Authentifizierung für Formulare | ||
303 | ))) | ||
304 | ))) | ||
305 | ))) | ||
306 | |||
307 | * In diesem Schritt werden die Daten angezeigt, die für eine Anbindung von FORMCYCLE an das ELSTER **M**ein **U**nternehmens**k**onto (**MUK**) notwendig sind: | ||
308 | ** Entity-ID | ||
309 | ** Assertion Consumer-Service-URLs: Hier werden alle URL's aus dem FORMCYCLE-System aufgeführt (Master-Server-, sowie Frontend-Server- Verbindungen), über die später eine Kommunikation zwischen **ELSTER **und (% class="xm-smallcaps" %)Xima® Formcycle(%%) möglich wäre. | ||
310 | Im **MUK **müssen nur die URL(s) hinterlegt werden, über die am Ende wirklich eine Kommunikation stattfinden soll. | ||
311 | ** Öffentlicher Schlüssel: Dieses Zertifikat ist im **MUK** //Self Service Portal// als Signatur- und Verschlüsselungszertifikat zu hinterlegen | ||
312 | * Damit ist der 1. Teil der Registrierung abgeschlossen und es muss in das **MUK** //Self Service Portal// von **ELSTER** gewechselt werden. | ||
313 | ** Im Portal sind anschießend ein Vorhaben und ein Service-Provider anzulegen.((( | ||
314 | (% class="box warningmessage" %) | ||
315 | ((( | ||
316 | Um sich am //Self Service Portal// zu authentifizieren ist ein Organisationszertifikat notwendig. | ||
317 | Wenn ihre Organisation noch nicht über ein solches verfügt können Sie dieses über folgende [[Website >>url:https://www.elster.de/eportal/unternehmerorientiert/registrierungsprozess||rel="noopener noreferrer" target="_blank"]] beantragen. | ||
318 | ))) | ||
319 | ))) | ||
320 | |||
321 | === MUK Self Service Portal: Registrierung eines NEZO Vorhabens === | ||
322 | |||
323 | ((( | ||
324 | (% class="box infomessage" %) | ||
325 | ((( | ||
326 | Die nachfolgenden Angaben in diesem Abschnitt beziehen sich auf die durchzuführenden Schritte im MUK Self Service Portal, welche außerhalb von (% class="xm-smallcaps" %)Xima® Formcycle(%%) stattfinden. | ||
327 | ))) | ||
328 | ))) | ||
329 | |||
330 | **NEZO** steht für "Nutzung der ELSTER-Zertifikate im Rahmen des **O**nline**z**ugangs**g**esetzes (OZG)". | ||
331 | |||
332 | ==== MUK Self Service Portal Schritt 1: Anmeldung ==== | ||
333 | |||
334 | |||
335 | (% class="xm-figure xm-float-right xm-clear-h2" data-alt="MUK Self Service Portal Schritt 1: Anmeldebildschirm" %) | ||
336 | ((( | ||
337 | (% class="xm-figure-inner" style="width:310px" %) | ||
338 | ((( | ||
339 | [[~[~[image:attach:elsterSsp_MUK_Login.png~|~|width="300"~]~]>>path:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/Plugin%20Setup/WebHome/elsterSsp_MUK_Login.png?rev=1.1||rel="lightbox[$group]" title="MUK Self Service Portal Schritt 1: Anmeldebildschirm"]] | ||
340 | |||
341 | (% class="xm-figure-caption" %) | ||
342 | ((( | ||
343 | MUK Self Service Portal Schritt 1: Anmeldebildschirm | ||
344 | ))) | ||
345 | ))) | ||
346 | ))) | ||
347 | |||
348 | * Das **MUK** //Self Service Portal// von **ELSTER** ist über https://service.mein-unternehmenskonto.de erreichbar. | ||
349 | * Die Anmeldung am **MUK **//Self Service Portal// kann nur mit einen Organisationszertifikat durchgeführt werden. | ||
350 | |||
351 | ==== MUK Self Service Portal Schritt 2: Vorhaben hinzufügen ==== | ||
352 | |||
353 | |||
354 | (% class="xm-figure xm-float-right xm-clear-h2" data-alt="MUK Self Service Portal Schritt 2: Übersicht der NEZO-Vorhaben" %) | ||
355 | ((( | ||
356 | (% class="xm-figure-inner" style="width:310px" %) | ||
357 | ((( | ||
358 | [[~[~[image:attach:elsterSsp_Meine_Vorhaben.png~|~|width="300"~]~]>>path:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/Plugin%20Setup/WebHome/elsterSsp_Meine_Vorhaben.png?rev=1.1||rel="lightbox[$group]" title="MUK Self Service Portal Schritt 2: Übersicht der NEZO-Vorhaben"]] | ||
359 | |||
360 | (% class="xm-figure-caption" %) | ||
361 | ((( | ||
362 | MUK Self Service Portal Schritt 2: Übersicht der NEZO-Vorhaben | ||
363 | ))) | ||
364 | ))) | ||
365 | ))) | ||
366 | |||
367 | |||
368 | (% class="xm-figure xm-float-right xm-clear-h2" data-alt="MUK Self Service Portal Schritt 2: Detailansicht eines NEZO Vorhabens" %) | ||
369 | ((( | ||
370 | (% class="xm-figure-inner" style="width:310px" %) | ||
371 | ((( | ||
372 | [[~[~[image:attach:elsterSsp_Vorhaben_Verantwortlichkeiten_redacted.png~|~|width="300"~]~]>>path:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/Plugin%20Setup/WebHome/elsterSsp_Vorhaben_Verantwortlichkeiten_redacted.png?rev=1.1||rel="lightbox[$group]" title="MUK Self Service Portal Schritt 2: Detailansicht eines NEZO Vorhabens"]] | ||
373 | |||
374 | (% class="xm-figure-caption" %) | ||
375 | ((( | ||
376 | MUK Self Service Portal Schritt 2: Detailansicht eines NEZO Vorhabens | ||
377 | ))) | ||
378 | ))) | ||
379 | ))) | ||
380 | |||
381 | Nach der Anmeldung im **MUK **//Self Service Portal//, muss über dieses Portal ein **NEZO**-Vorhaben beantragt werden. | ||
382 | |||
383 | Mit einem Klick auf "Hinzufügen" unter "Meine Vorhaben" kann ein neues Vorhaben erstellt werden. | ||
384 | Ein **NEZO**-Vorhaben ist die Voraussetzung für die Anbindung des Unternehmenskonto-Logins. Durch einen Klick auf ein Vorhaben auf der Übersichtsseite "Meine Vorhaben" gelangt man auf die Übersichtsseite des Vorhabens, auf welcher anschließend Service-Provider beantragt / bearbeitet werden können. | ||
385 | |||
386 | Für die Beantragung eines NEZO-Vorhaben müssen verschiedene Angaben gemacht werden: | ||
387 | |||
388 | * die konkrete Zeitplanung des Vorhabens | ||
389 | * die voraussichtliche Anzahl der Unternehmenskonto-Logins pro Tag. | ||
390 | * Für die Beantragung das Vorhabens ist ein Dienstleister nötig. Hier muss die **XIMA MEDIA GmbH** angegeben werden (siehe Abbildung rechts) | ||
391 | * Weitere Informationen zum Beantragungsprozess entnehmen Sie bitte direkt der Vorhaben-Erstellungsseite. | ||
392 | |||
393 | Nachdem des **NEZO**-Vorhaben beantragt wurde, kann ein Service-Provider für das Vorhaben eingerichtet werden. Die dafür notwendigen Schritte werden im nächsten Abschnitt beschrieben. | ||
394 | |||
395 | ==== MUK Self Service Portal Schritt 3: Service-Provider beantragen ==== | ||
396 | |||
397 | |||
398 | (% class="xm-figure xm-float-right xm-clear-h2" data-alt="MUK Self Service Portal Schritt 3: Detailansicht Service-Provider" %) | ||
399 | ((( | ||
400 | (% class="xm-figure-inner" style="width:310px" %) | ||
401 | ((( | ||
402 | [[~[~[image:attach:elsterSsp_Serviceprovider.png~|~|width="300"~]~]>>path:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/Plugin%20Setup/WebHome/elsterSsp_Serviceprovider.png?rev=1.1||rel="lightbox[$group]" title="MUK Self Service Portal Schritt 3: Detailansicht Service-Provider"]] | ||
403 | |||
404 | (% class="xm-figure-caption" %) | ||
405 | ((( | ||
406 | MUK Self Service Portal Schritt 3: Detailansicht Service-Provider | ||
407 | ))) | ||
408 | ))) | ||
409 | ))) | ||
410 | |||
411 | In der Übersicht eines Vorhabens kann ein Service-Provider bei **MUK** beantragt werden. | ||
412 | Bei der Beantragung eines Service-Providers müssen verschiedene technische Angaben gemacht werden: | ||
413 | |||
414 | ; Name | ||
415 | : Der Name des Service-Providers. Dieser kann frei vergeben werden, z.B.: FORMCYCLE Unternehmenskonto-Login Produktiv | ||
416 | ; Entity-ID | ||
417 | : Identitfiziert den Service-Provider eindeutig. Muss aus dem zuvor erstellten Authenticator aus FORMCYCLE übernommen werden. | ||
418 | ; Datenkranztyp | ||
419 | : Auswahl ist abhängig vom Rechtsrahmen in dem FORMCYCLE eingesetzt wird und bestimmt die Art der zurück gelieferten Daten. In den meisten Fällen ist hier die Auswahl OZG sinnvoll, da hier alle Daten des Rechtsrahmens im Zusammenhang mit dem Onlinezugangsgesetz geliefert werden. | ||
420 | ; Kontotyp | ||
421 | : Es besteht die Auswahl zwischen Echt- und Testkonten. Im Zweifel sollte immer "Echt" gewählt werden. | ||
422 | ; Zum Login zugelassene(s) Ordnungsmerkmal(e) | ||
423 | : Bestimmt ob sich nur Organisationen (StNr), nur Einzelpersonen (IdNr) oder beide Zertifikats-Typen über diesen Service-Provider in FORMCYLE anmelden können. | ||
424 | ; Portalbeschreibung | ||
425 | : Diese Beschreibung wird im Login-Fenster zu Beginn des Authentifizierungsprozesses angezeigt. Wählen Sie eine zu Ihrer Organisation passende Beschreibung. | ||
426 | ; Portallogo | ||
427 | : Dieses Logo wird im Login-Fenster zu Beginn des Authentifizierungsprozesses angezeigt. Wählen Sie ein Logo Ihrer Organisation. | ||
428 | ; Signaturzertifikat | ||
429 | : Dient dem Identitätsnachweis der übertragenen Daten während des Authentifizierungsprozesses. Die hier notwendige Angabe eines Zertifikats muss aus dem im **FORMCYCLE Schritt 2** erzeugten öffentlichen Schlüssels entnommen werden. Die Zertifikatsdaten dürfen keine Zeilenumbrüche enthalten. | ||
430 | ; Verschlüsselungszertifikat | ||
431 | : Dient der Verschlüsselung der übertragenen Daten während des Authentifizierungsprozesses. Die hier notwendige Angabe eines Zertifikats muss aus dem im **FORMCYCLE Schritt 2** erzeugten öffentlichen Schlüssels entnommen werden. Die Zertifikatsdaten dürfen keine Zeilenumbrüche enthalten. | ||
432 | ; Assertion-Consumer-Service-URLs (ACS-URLs) | ||
433 | : Diese URLs stellen die Endpunkte während des Authentifizierungsprozesses dar. Im Dialog **FORMCYCLE Schritt 2** wird hier eine Liste aller auf dem (% class="xm-smallcaps" %)Xima® Formcycle(%%) System ermittelten Assertion-Consumer-Service-URLs (ACS-URLs) dargestellt. Es müssen nicht alle ACS-URLs in die Service-Provider-Konfiguration im //MUK Self Service Portal// übernommen werden. Übernehmen Sie nur die URLs für die Server auf denen Sie planen einen Unternehmenskonto-Login in Formularen zu ermöglichen. | ||
434 | ; Manage Name ID URLs | ||
435 | : Müssen nicht angegeben werden. | ||
436 | |||
437 | Nach dem Beantragen des Service-Providers ist der Prozess im MUK Self Service Portal abgeschlossen und es muss auf die Freigabe des Service-Provider durch ELSTER gewartet werden. | ||
438 | Danach kann mit **FORMCYCLE Schritt 3** im (% class="xm-smallcaps" %)Xima® Formcycle(%%) System fortgefahren werden. | ||
439 | |||
440 | === FORMCYCLE Schritt 3: ELSTER-Login Aktivierung === | ||
441 | |||
442 | |||
443 | (% class="xm-figure xm-float-right xm-clear-h2" data-alt="Anbindung des ELSTER Postkorbs mittels ELSTER-Transfer-Client" %) | ||
444 | ((( | ||
445 | (% class="xm-figure-inner" style="width:310px" %) | ||
446 | ((( | ||
447 | [[~[~[image:attach:elster_config3.png~|~|width="300"~]~]>>path:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/Plugin%20Setup/WebHome/elster_config3.png?rev=1.1||rel="lightbox[$group]" title="Anbindung des ELSTER Postkorbs mittels ELSTER-Transfer-Client"]] | ||
448 | |||
449 | (% class="xm-figure-caption" %) | ||
450 | ((( | ||
451 | Anbindung des ELSTER Postkorbs mittels ELSTER-Transfer-Client | ||
452 | ))) | ||
453 | ))) | ||
454 | ))) | ||
455 | |||
456 | * Dieser Schritt sollte erst durchgeführt werden, wenn Sie vom **MUK **//Self Service Portal// Rückmeldung erhalten haben, dass ihr beantragtes Vorhaben genehmigt und der konfigurierte Service-Provider freigegeben wurde. Erst mit dem Button //ELSTER Login aktivieren// wird der Authentikator im System aktiviert. Er ist damit in den Formularen verfügbar und kann eingebunden werden.((( | ||
457 | (% class="box infomessage" %) | ||
458 | ((( | ||
459 | Hinweis: Wenn Sie den Login **vor** einer positiven Rückmeldung aus dem **MUK** //Self Service Portal// aktivieren, | ||
460 | kann der **ELSTER** Unternehmenslogin zwar bereits in den Formularen eingebunden werden, | ||
461 | wird aber beim Aufruf in einem Fehler resultieren. | ||
462 | ))) | ||
463 | ))) | ||
464 | * Nach Aktivierung des Logins erweitert sich die Konfigurationsoberfläche des Authentikators. | ||
465 | * Unter dem Punkt //Erweiterte Einstellungen// > //Konfigurtion ELSTER Postkorbanbindung// können Sie die Daten für die Anbindung des ELSTER Transfer Clients hinterlegen. Dieser muss im System extra installiert werden und regelt die Weiterleitung von Nachrichten aus FORMCYCLE an das ELSTER Portal. | ||
466 | Folgende Eigenschaften für die Transfer-Client Anbindung sind konfigurierbar:((( | ||
467 | ; URL ELSTER Transfer-Client | ||
468 | : URL zu dem Transfer-Client, über den die Weiterleitung von Postkorb-Nachrichten an ELSTER erfolgen soll. | ||
469 | ; Proxy Host: | ||
470 | : Host Angabe für einen Proxy-Server, wenn die Kommunikation mit dem Transfer-Client über einen Proxy-Server erfolgen soll. | ||
471 | ; Proxy Port: | ||
472 | : Port-Angabe für einen Proxy-Server, wenn die Kommunikation mit dem Transfer-Client über einen Proxy-Server erfolgen soll. | ||
473 | ))) | ||
474 | * Über den Button //Postkorb Verbindung prüfen// kann der Zugriff auf den angebundenen ELSTER Transfer Client getestet werden. | ||
475 | |||
476 | == Details für die Anbindung der BayernID == | ||
477 | |||
478 | Um das Servicekonto der **BayernID** anzubinden ist ein neuer Externer Benutzer anzulegen und als Authentifizierungstyp **BayernID** auszuwählen. | ||
479 | |||
480 | === Schritt 1: Konfiguration anlegen === | ||
481 | |||
482 | |||
483 | (% class="xm-figure xm-float-right xm-clear-h2" data-alt="Schritt 1: Notwendige Daten für Erzeugung der Service Metadaten festlegen" %) | ||
484 | ((( | ||
485 | (% class="xm-figure-inner" style="width:310px" %) | ||
486 | ((( | ||
487 | [[~[~[image:attach:bayernID_config1.png~|~|width="300"~]~]>>path:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/Plugin%20Setup/WebHome/bayernID_config1.png?rev=1.1||rel="lightbox[$group]" title="Schritt 1: Notwendige Daten für Erzeugung der Service Metadaten festlegen"]] | ||
488 | |||
489 | (% class="xm-figure-caption" %) | ||
490 | ((( | ||
491 | Schritt 1: Notwendige Daten für Erzeugung der Service Metadaten festlegen | ||
492 | ))) | ||
493 | ))) | ||
494 | ))) | ||
495 | |||
496 | * Im 1. Schritt der Konfiguration erscheint eine Eingabeoberfläche, wo folgende Festlegungen getroffen werden müssen: | ||
497 | ** Festlegung, ob Test- oder Live-Umgebung der **BayernID** anzubinden ist. | ||
498 | ** Erhebung von Zertifikatsinformationen, welche anschließend zur Generierung eines privaten und öffentlichen Schlüssels herangezogen werden. Dieses Schlüsselpaar dient zur Ver- und Entschlüsselung der Kommunikation, zwischen (% class="xm-smallcaps" %)Xima® Formcycle(%%) und der **BayernID**. | ||
499 | ** Angaben zum organisatorischen und technischen Ansprechpartner. Diese Informationen werden im Zuge des Registrierungsprozesses an das **BayernID**-Portal weitergegeben. | ||
500 | * Speichern der Eingaben. Danach gelangt man zum 2. Schritt der Anbindung. | ||
501 | |||
502 | === Schritt 2: Metadaten erzeugen und registrieren === | ||
503 | |||
504 | |||
505 | (% class="xm-figure xm-float-right xm-clear-h2" data-alt="Schritt 2 und 3: Download der erzeugten Meta- und vorbefüllten Vertragsdaten für eine jeweiligen Host-Adresse; Aktivierung der BayernID Authentifizierung für Formulare" %) | ||
506 | ((( | ||
507 | (% class="xm-figure-inner" style="width:310px" %) | ||
508 | ((( | ||
509 | [[~[~[image:attach:bayernID_config2.png~|~|width="300"~]~]>>path:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/Plugin%20Setup/WebHome/bayernID_config2.png?rev=1.1||rel="lightbox[$group]" title="Schritt 2 und 3: Download der erzeugten Meta- und vorbefüllten Vertragsdaten für eine jeweiligen Host-Adresse; Aktivierung der BayernID Authentifizierung für Formulare"]] | ||
510 | |||
511 | (% class="xm-figure-caption" %) | ||
512 | ((( | ||
513 | Schritt 2 und 3: Download der erzeugten Meta- und vorbefüllten Vertragsdaten für eine jeweiligen Host-Adresse; Aktivierung der BayernID Authentifizierung für Formulare | ||
514 | ))) | ||
515 | ))) | ||
516 | ))) | ||
517 | |||
518 | * In diesem Schritt werden die SAML-Metadaten für die Registrierung auf Seiten der **BayernID **erzeugt. Dafür steht in der Oberfläche ein Button mit Auswahlfeld zur Verfügung. Das Auswahlfeld enthält alle im (% class="xm-smallcaps" %)Xima® Formcycle(%%) System gefundenen Host-Adressen, über die das System erreichbar ist. Auf der Grundlage der jeweiligen Host-Adresse werden dann die Metadaten erzeugt und als Download zurück geliefert. Die jeweilige Host-Adresse bildet dabei einen Teil der Rücksprung-URL, welche später vom Identity Provider (BayernID Portal) zur Übermittlung der Authentifizierungsdaten genutzt wird.((( | ||
519 | (% class="box infomessage" %) | ||
520 | ((( | ||
521 | Hinweis: Soll der BayernID-Login über unterschiedliche Host-Adressen erreichbar sein, | ||
522 | so muss für jeden Host die Metadaten-Datei erzeugt und an das BayernID-Portal zur Registrierung übermittelt werden. | ||
523 | ))) | ||
524 | ))) | ||
525 | * Weiterhin kann eine vorbefüllte Beitrittserklärung für den jeweiligen Host heruntergeladen werden. Die Beitrittserklärung ist bereits mit den im vorherigen Schritt erhobenen Daten vorbefüllt und muss um die noch fehlenden Daten ergänzt werden. | ||
526 | * **Beitrittserklärung** und **SAML-Metadaten** sind an das **BayernID** Portal (Mail: **BayernID@akdb.de**) zu senden, mit der Bitte, um Aufnahme in den Portalverbund. | ||
527 | * Damit ist der 1. Teil der Registrierung abgeschlossen und eine Antwort vom **BayernID** Portal muss abgewartet werden. | ||
528 | |||
529 | === Schritt 3: BayernID-Login Aktivierung === | ||
530 | |||
531 | |||
532 | (% class="xm-figure xm-float-right xm-clear-h2" data-alt="BayernID Postkorbanbindung konfigurieren" %) | ||
533 | ((( | ||
534 | (% class="xm-figure-inner" style="width:310px" %) | ||
535 | ((( | ||
536 | [[~[~[image:attach:bayernID_config3.png~|~|width="300"~]~]>>path:/xwiki/bin/download/Formcycle/PluginDocumentation/Buerger%20Services-Plugin/Plugin%20Setup/WebHome/bayernID_config3.png?rev=1.1||rel="lightbox[$group]" title="BayernID Postkorbanbindung konfigurieren"]] | ||
537 | |||
538 | (% class="xm-figure-caption" %) | ||
539 | ((( | ||
540 | BayernID Postkorbanbindung konfigurieren | ||
541 | ))) | ||
542 | ))) | ||
543 | ))) | ||
544 | |||
545 | * Dieser Schritt sollte erst durchgeführt werden, wenn Sie vom BayernID Portal Rückmeldung erhalten haben, dass ihre übermittelten Metadaten im Portal registriert und freigegeben sind. Erst mit dem Button //BayernId-Login aktivieren// wird der Authentikator im System aktiviert. Er ist damit in den Formularen verfügbar und kann eingebunden werden.((( | ||
546 | (% class="box infomessage" %) | ||
547 | ((( | ||
548 | Hinweis: Wenn Sie den Login **vor** einer positiven Rückmeldung des BayernID-Portals aktivieren, | ||
549 | so kann das die **BayernID** zwar bereits in den Formularen eingebunden werden, | ||
550 | wird aber beim Aufruf in einem Fehler resultieren. | ||
551 | ))) | ||
552 | ))) | ||
553 | * Nach Aktivierung des Logins erweitert sich die Konfigurationsoberfläche des Authentikators. | ||
554 | * Unter dem Punkt //Erweiterte Einstellungen// > //Konfigurtion BayernID Postkorbanbindung// können Sie das Zertifikat, welches Sie im Zuge der Registrierung ihrer Metadaten vom **BayernID **Portal erhalten haben sollten, hochladen und zusammen mit dem zugehörigen Passwort an der Authentikator-Konfiguration abspeichern. | ||
555 | * ((( | ||
556 | Über den Button //Postkorb Verbindung prüfen// kann der Zugriff auf den Postkorb-Webservice getestet werden. | ||
557 | Der Webservice muss dabei vom (% class="xm-smallcaps" %)Xima® Formcycle(%%) Master-Server aus erreichbar sein (dafür sind im System unter Umständen Firewall Freigaben notwendig). | ||
558 | |||
559 | ((( | ||
560 | (% class="box warningmessage" %) | ||
561 | ((( | ||
562 | Folgende URL muss **vom FORMCYCLE Master-Server** **aus erreichbar** sein: | ||
563 | |||
564 | * Testsystem: https:~/~/infra-pre-bayernid.freistaat.bayern/bspx-postkorb-okkomm-ws/bspservices/postkorbkomm | ||
565 | ODER | ||
566 | * Livesystem: https:~/~/bayernid.freistaat.bayern/bspx-postkorb-okkomm-ws/bspservices/postkorbkomm | ||
567 | ))) | ||
568 | ))) | ||
569 | |||
570 | ((( | ||
571 | (% class="box infomessage" %) | ||
572 | ((( | ||
573 | **Fehlerbehebung, wenn die Prüfung des Postkorbverbindung fehl schlägt:** | ||
574 | |||
575 | Prüfen Sie, ob die Freischaltung in der Firewall erfolgt ist. | ||
576 | Der Postkorb-Webservice nutzt das HTTPS Protokoll für die Kommunikation, welches im Transport-Layer das TCP Protokoll benutzt. Deshalb sollte in ihrer Firewall die IP 193.28.249.234 (für das Livesystem **bayernid.freistaat.bayern**) oder IP 193.28.249.228 (für das Testsystem **infra-pre-bayernid.freistaat.bayern**) als TCP-Verbindungen der Port 443 (das ist der Standard-Https-Port) sowohl für die ausgehende als auch eingehende Kommunikation freigegeben sein. | ||
577 | ))) | ||
578 | ))) | ||
579 | ))) | ||
580 | * Sollte für die Kommunikation ein Proxy-Server notwendig sein, so kann dieser in den Eingabefeldern //Proxy Host //und //Proxy Port// konfiguriert werden. |