Plugin Setup

Initiale Installation

Das BürgerService Plugin muss im System Bereich von Xima® Formcycle installiert werden (Menüpunkt: System > Systemplugins).
Es bietet aktuell die Anbindung an folgende Servicekonten:

• BundID
• BayernID
• ELSTER Mein Unternehmenskonto

Migration bestehender Service-Konten-Anbindungen

• Bestehende Anbindungen zu Service-Konten von BundID, BayernID und ELSTER werden bei der Installation des Plugins automatisch auf das neue Plugin umgestellt.
• Die veralteten Plugin-Bundles (jar-Dateien) bleiben dabei auf dem System erhalten, werden aber deaktiviert.
• Alle zuvor konfigurierten Anbindungen werden als Externe Benutzer im jeweiligen Bereich (System oder Mandant) definiert.
• Designer-Vorlagen, die mit den veralteten Plugins in das System gekommen sind, werden entfernt.

Migrations-Beispiel für BayernID Anbindung:

Ausgangspunkt ist ein FORMCYCLE System mit mehreren Mandanten. In zwei Mandanten ist jeweils das AKDB: Bürgerkonto-Service-Plugin (Anbindung an BayernID) installiert.
Einer der BayernID Mandanten hat die Einbindung des Bürgerkonto Logins als Externer Benutzer konfiguriert.

Nachdem das BürgerService Plugin im System Bereich installiert wurde ergibt sich folgendes Bild:

• Die veralteten AKDB: Bürgerkonto-Service-Plugins in den jeweiligen Mandanten sind deaktiviert, aber noch vorhanden.
• In beiden Mandanten mit BayernID Anbindung befindet sich jetzt ein Externer Benutzer, welcher zukünftig die Authentifizierung mit dem BayernID-Portal realisiert.
  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.
• 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.
• Alte Designer-Vorlagen für die Anzeige der Bürgerkonto-Daten wurden durch neue Vorlagen ersetzt.
• 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.

Migration für BundID Anbindungen

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.  

Migration für ELSTER Anbinungen

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.  

Vorüberlegungen zur Anbindung neuer Servicekonten

Neue Anbindungen an Servicekonten müssen im Xima® Formcycle System als Externe Benutzer (auch als Authentikatoren bezeichnet) angelegt werden. Dabei ist es möglich diese im System- als auch im Bereich des Mandanten anzulegen.
Folgende Überlegungen sollten für eine Entscheidung des Bereichs, in welchem die Externen Benutzer angelegt werden, herangezogen werden.

Ist ein Multi-Mandanten Xima® Formcycle System mit unterschiedlichen Host-Adressen für die Ansteuerung der Formulare der einzelnen Mandanten vorhanden? (Meist realisiert über Anbindung mehrerer Frontend-Server)

In diesem Fall sollte jeweils im Mandanten ein Externer Benutzer angelegt werden, welcher die Anbindung an des Servicekonto realisiert.

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 - 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.
Durch das Anlegen eines Externen Benutzers im Bereich des jeweiligen Mandanten kann hier eine saubere Trennung und damit auch Nutzung in den Formularen stattfinden.
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.

Ist ein Multi-Mandanten- oder ein Single-Mandat- Xima® Formcycle System mit einer Host-Adresse für die Ansteuerung der Formulare vorhanden?

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.

Allgemeine Informationen zur Anbindung eines Servicekontos

In diesem Abschnitt werden die Schritte, welche für die Anbindung aller Servicekonten gleichermaßen gelten, erläutert.

Bevor man ein Servicekonto anbindet sollten folgende Voraussetzungen erfüllt sein:

• 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.
• 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.

Die Anbindung eines Servicekontos lässt sich in folgende Schritte gliedern:

1. Anlegen einen neuen Externen Benutzer (Authentikator) unter dem Menüpunkt System > Systemplugins oder Mandant > Plugins.
2. 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.
3. Download und Weiterleitung der festgelegten Konfigurationsdaten (Metadaten), sowie der Vertragsdaten an den jeweiligen Identity Provider (BundID, BayernID) bzw.
   selbst durchzuführende Konfiguration auf Seiten des Identity Providers über ein Self-Service Portal (ELSTER)
4. Freigabe des Authentikators in 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

Details für die Anbindung der BundID

Um das Servicekonto der BundID anzubinden ist ein neuer Externer Benutzer anzulegen und als Authentifizierungstyp BundID auszuwählen. 

Schritt 1: Konfiguration anlegen

• Im 1. Schritt der Konfiguration erscheint eine Eingabeoberfläche, wo folgende Festlegungen getroffen werden müssen:
  • Festlegung, ob Test- oder Live-Umgebung der BundID anzubinden ist.
  • 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 Xima® Formcycle und der BundID.
  • Angaben zum organisatorischen und technischen Ansprechpartner. Diese Informationen werden im Zuge des Registrierungsprozesses an das BundID-Portal innerhalb der generierten SAML-Metadaten weitergegeben. 
• Speichern der Eingaben. Danach gelangt man zum 2. Schritt der Anbindung.

Schritt 2: Metadaten erzeugen und registrieren

• 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 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.

  Hinweis: Soll der BundID-Login über unterschiedliche Host-Adressen erreichbar sein,
  so muss für jeden Host die Metadaten-Datei erzeugt und an das BundID-Portal zur Registrierung übermittelt werden.

• SAML-Metadaten sind zusammen mit weiteren Vertragsdaten an das BundID Portal (Mail: bundID@bmi.bund.de) zu senden, mit der Bitte, um Aufnahme in den Portalverbund.
• Damit ist der 1. Teil der Registrierung abgeschlossen und eine Antwort vom BundID Portal muss abgewartet werden.

Schritt 3: BundID-Login Aktivierung

• 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.

  Hinweis: Wenn Sie den Login vor einer positiven Rückmeldung des BundID-Portals aktivieren,
  so kann das die BundID zwar bereits in den Formularen eingebunden werden,
  wird aber beim Aufruf in einem Fehler resultieren,
  dass der anfragende Service dem Portal nicht bekannt ist. 

• Nach Aktivierung des Logins erweitert sich die Konfigurationsoberfläche des Authentikators.
  • 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 
  • 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.
  • Über den Button Postkorb Verbindung prüfen kann der Zugriff auf den Postkorb-Webservice getestet werden.
    Der Webservice muss dabei vom Xima® Formcycle Master-Server aus erreichbar sein (dafür sind im System unter Umständen Firewall Freigaben notwendig).

    Fehlerbehebung, wenn die Prüfung des Postkorbverbindung fehl schlägt:

Details für die Anbindung des ELSTER Mein Unternehmenskontos

Details für die Anbindung der BayernID

Um das Servicekonto der BayernID anzubinden ist ein neuer Externer Benutzer anzulegen und als Authentifizierungstyp BayernID auszuwählen. 

Schritt 1: Konfiguration anlegen

• Im 1. Schritt der Konfiguration erscheint eine Eingabeoberfläche, wo folgende Festlegungen getroffen werden müssen:
  • Festlegung, ob Test- oder Live-Umgebung der BayernID anzubinden ist.
  • 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 Xima® Formcycle und der BayernID.
  • Angaben zum organisatorischen und technischen Ansprechpartner. Diese Informationen werden im Zuge des Registrierungsprozesses an das BayernID-Portal weitergegeben. 
• Speichern der Eingaben. Danach gelangt man zum 2. Schritt der Anbindung.

Schritt 2: Metadaten erzeugen und registrieren

• 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 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.

  Hinweis: Soll der BayernID-Login über unterschiedliche Host-Adressen erreichbar sein,
  so muss für jeden Host die Metadaten-Datei erzeugt und an das BayernID-Portal zur Registrierung übermittelt werden.

• 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.
• Beitrittserklärung und SAML-Metadaten sind an das BayernID Portal (Mail: BayernID@akdb.de) zu senden, mit der Bitte, um Aufnahme in den Portalverbund.
• Damit ist der 1. Teil der Registrierung abgeschlossen und eine Antwort vom BayernID Portal muss abgewartet werden.

Schritt 3: BayernID-Login Aktivierung

• 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.

  Hinweis: Wenn Sie den Login vor einer positiven Rückmeldung des BayernID-Portals aktivieren,
  so kann das die BayernID zwar bereits in den Formularen eingebunden werden,
  wird aber beim Aufruf in einem Fehler resultieren,
  dass der anfragende Service dem Portal nicht bekannt ist. 

• Nach Aktivierung des Logins erweitert sich die Konfigurationsoberfläche des Authentikators.* 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.

  • Über den Button Postkorb Verbindung prüfen kann der Zugriff auf den Postkorb-Webservice getestet werden.
    Der Webservice muss dabei vom Xima® Formcycle Master-Server aus erreichbar sein (dafür sind im System unter Umständen Firewall Freigaben notwendig).

    Folgende URL muss vom FORMCYCLE Master-Server aus erreichbar sein:

    • Testsystem: https://infra-pre-bayernid.freistaat.bayern/bspx-postkorb-okkomm-ws/bspservices/postkorbkomm
      ODER
    • Livesystem: https://bayernid.freistaat.bayern/bspx-postkorb-okkomm-ws/bspservices/postkorbkomm

    Fehlerbehebung, wenn die Prüfung des Postkorbverbindung fehl schlägt:

    Prüfen Sie, ob die Freischaltung in der Firewall erfolgt ist.
    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.

  • Sollte für die Kommunikation ein Proxy-Server notwendig sein, so kann dieser in den Eingabefeldern Proxy Host und Proxy Port konfiguriert werden.