optiGov

Geändert am Mi, 16 Okt um 6:35 NACHMITTAGS

Mit diesem Plugin können Formulare mit Daten aus optiGov vorbefüllt sowie Daten aus formcycle Formularen an optiGov übermittelt werden. Dafür stellt das Plugin verschiedene Eingabe-Elemente im Designer zur Verfügung.

Für die Datenübermittlung an optiGov werden Platzhalter bereit gestellt, die eine einfache Anbindung an das optiGov-System ermöglichen.

Inhalt

Voraussetzungen

Um die optiGov Anbindung in formcycle durchführen zu können, sind folgende Plugins erforderlich:

Formularliste-Plugin, um die verfügbaren Formulare im optiGov Backend anzuzeigen
optiGov Plugin, zur Konfiguration der Verbindungsparameter zu optiGov und Bereitstellung der Schnittstellen

Installation

Das Plugin muss als System-Plugin installiert werden.

Konfiguration Plugin

Folgende Konfigurationsparameter sind anzugeben:

optigov.send.inbox.url (Erforderlich)

Standardwert: https://partner.optigov.de/api/. Die API-Url ergibt sich aus der Basis-URL des Kunden, welche Ihnen durch Optigov mitgeteilt wird und dem Postfix ‚/api'. Die URL zur optiGov API ist erforderlich, um Daten an optiGov via HTTP Post senden zu können. Die Konfiguration zum HTTP Request erfolgt dann im Workflow (siehe auch Optigov Formularvorlage).

optigov.prerenderer.url.Encoding (Erforderlich)

Standardwert: UTF-8. Angabe für Encoding der URL-Parameter, bei Aufruf des Formulares.

Konfiguration in optiGov

In Optigov wird die URL zur Formularliste hinterlegt, um Formularlinks im dortigen Portal einzubinden. Folgende Schritte sind für intitale Konfiguration in optoGov erforderlich.

Verwaltung auswählen und Aufruf Reiter Formularserver

Neuen Formularserver hinzufügen oder einen bestehenden Eintrag bearbeiten. Hier ist der formcycle Server einzutragen, wobei das Formularliste und optiGov Plugin installiert wurden. Hierbei reicht die Angabe der Basis-URL von formcylce.

Der Benutzer in der Konfiguration im Backend von optiGov ist der Mandantenname innerhalb von formcycle.

Platzhalter

[%$OPTIGOV_INBOX_URL%]

optiGov Plugin INBOX URL (Basis URL zur Schnittstelle und Token wenn vorhanden)

[%$OPTIGOV_RETURN_URL%]

optiGov Rücksende URL

[%$OPTIGOV_USER_TOKEN%]

optiGov Session Token (Benutzerschlüssel zum abholen von Daten)

[%$OPTIGOV_USER_JSON%]

optiGov Benutzerdaten im JSON Format

Daten aus Formular

tfAntragstellerVorname
tfAntragstellerName
fAntragstellerAdresse
tfAntragstellerPLZ
tfAntragstellerOrt
tfAntragstellerEmail
fAntragstellerGeburtsname
tfAntragstellerGeburtsdatum
tfAntragstellerGeburtsort
tfAntragstellerDoktorgrad
tfAntragstellerAnrede
tfAntragstellerTitel
tfAntragstellerMittelname
tfAntragstellerKuenstlername
tfAntragstellerPseudonym
tfAntragstellerLand
tfAntragstellerNationalitaet
tfAntragstellerAusstellenderStaat
tfAntragstellerDeMail
tfAntragstellerTelefon

Technische Werte aus Formular

AuthLevel	Vertrauensniveau der Authentifizierung nach BSI Norm: low substantial high
TrustLevel	Vertrauensniveau, gibt Auskunft über gewählte Authentifizierungsmethode: STORK-QAA-Level-1: Authentifizierung mittels Benutzername / Passwort STORK-QAA-Level-3: Authentifizierung mittels Authega Zertifikat STORK-QAA-Level-4: Authentifizierung mittels nPA
IdentitaetsPruefer	Quelle der Identitätsprüfung, mögliche Werte: eIDAS, eID, Smart-eID, AUTHEGA, ELSTER, Benutzername oder FINK)
tfAntragstellerErrechneteBenutzerID	Rückgabe der zugewiesenen Benutzer-ID

Verwendung der Formular-Vorlage

Unter Meine Formulare > Neues Formular erstellen > Formularvorlagen (Templates) wird durch das Plugin eine optiGov-Formularvorlage mitgeliefert.

Über Auswählen und durch Bestätigung des Folgedialogs über "Formularimport starten", wird eine Kopie des Formulars unter Meine Formulare angelegt. Das Formular kann dann wie gewohnt im Desginer geöffnet werden.

Im Formulardesigner ist bereits ein Fieldset für Meine Daten vorhanden. Hierbei wurden sich auf die Mindestangaben beschränkt. Für die Erweiterung der Anzeigedaten steht der ebenfalls im Designer eingebundene Elementkatalog optiGov Elemente zur Verfügung.

Konfiguration im Wokflow

Das Plugin stellt lediglich Parameter bereit und übernimmt Nutzerdaten aus optiGov.

Zu Beginn ist zu prüfen, ob der [%$OPTIGOV_USER_TOKEN%] einen Wert hat. Nur dann kann die Anfrage an optiGov erfolgen.

Im nächsten Schritt wird die Aktion für HTTP-Request ausgelöst, welche einen Post-Request an die optoGov API sendet. Hierbei wird die initiale Konfiguration des Plugins verwendet.

Anschließend erfolgt eine Weiterleitung an die [%$OPTIGOV_RETURN_URL%].

Vertrauensniveau für Formular festlegen

Das Vertrauensniveau ist über einem Tag am Formular festzulegen. Dies ist in formcycle unter Meine Formulare, direkt am Formular möglich:

Tag	Beschreibung
TRUSTLEVEL:LOW	niedriges Trustlevel
TRUSTLEVEL:NORMAL	normales Trustlevel
TRUSTLEVEL:HIGH	hohes Trustlevel