Anleitung

Der Online-Dienst kann entweder als eingebetteter Dienst oder als Standalone-Variante eingesetzt werden. Wir empfehlen für die beste Nutzererfahrung die Einbindung in die eigene Webseite bzw. das Serviceportal.

Minimale Konfiguration

Die Einbindung ist sehr einfach und erfordert lediglich die folgenden 2 Schritte.

Online-Dienst einbinden

<!DOCTYPE html>
<html lang="de">
  <head>
    [...]
    <script type="module" crossorigin src="https://govforms.demo.govconnect.de/assets/pmo.js"></script>
  </head>
  <body>
    <div class="pmo-process" data-process="fischereischein"></div>
  </body>
</html>

1. Legen Sie einen Container fest und binden eine JavaScript-Datei auf Ihrer Webseite ein. Der Container muss die Klasse pmo-process und mindestens eine gültige Prozesskennung im Data-Attribut data-process enthalten.

Binden Sie die Datei pmo.js vom Demo- bzw. Produktionsserver ein. Der Produktionsserver ist für den produktiven Einsatz ausgelegt. Der Demo-Server liefert Ressourcen für Testzwecke aus. Über den Demo-Server können keine echten Anträge gestellt werden.

Achten Sie darauf, dass das Laden von der eingebundenen Ressourcen-Domains auf Ihrer Webseite erlaubt wird, z.B. bei Content-Security-Policy (CSP).

Neben der Einbindung mit der minimalen Konfiguration haben Sie weitere Konfigurationsmöglichkeiten, die in den nächsten Abschnitten erläutert werden.

Ressourcen

Prod-Server: https://govforms.govconnect.de/assets/pmo.js
Demo-Server: https://govforms.demo.govconnect.de/assets/pmo.js

Liste der Online-Dienste

Standalone-Variante

Auch in Umgebungen, in denen Sie keinen Einfluss auf das ausgelieferte HTML haben, können Sie jeden Online-Dienst verlinken. In der Standalone-Variante sind alle für Sie relevanten Prozess-Konfigurationen genauso wie in der eingebetteten Variante hinterlegt. Beim Ausfüllen wird Ihre zuständige Stelle automatisch erkannt und der Vorgang mit Ihrer Konfiguration und Ihren Darstellungsoptionen fortgeführt.

Beispiellink: https://govforms.demo.govconnect.de/forms/fischereischein.html

Das Übergeben von Konfigurationsoptionen zur Darstellung ist in der Standalone-Variante nicht verfügbar.

In der Standalone-Variante wird die Ressourcen-URL beim Nutzer in der Adresszeile sichtbar. Eine eigene Domain ist durch den Betrieb in dieser Variante nicht möglich.
Aufgrund des Einsatzes in vielen Kommunen ist der Einstieg in die Standalone-Variante für Bürgerinnen und Bürger visuell standardisiert. Das bedeutet, dass keine Logos und Stylings von Ihnen oder uns sichtbar sind, bis die Prozesserkennung eindeutige Merkmale zur zuständigen Stelle erkannt hat. Konnte die zuständige Stelle identifiziert werden, werdem dem Nutzer die passenden Logos und Stylings angezeigt.

Den passenden Link finden Sie in der Beschreibung des jeweiligen Onlinedienstes (Liste der Online-Dienste).

Konfigurationsoptionen

Data-Attribut	Beschreibung	Pflichtfeld	Beispiel	Standard
data-process	Kennung des Online-Dienstes	Ja	`fischereischein`	-
data-customer-id	Kennung des zuständigen Kunden	Nein	`978b85ea-ed36-4027-a806-162354ef12fb`	Wird beim Ausfüllen automatisch ermittelt.
data-hide-header	Headerbereich abschalten und ausschließlich den Formular-Bereich rendern.	Nein	`true`	`false`
data-language	Verfügbare Sprachen als Liste der ISO-639-1-Codes, zwischen denen ein Nutzer wählen kann.	Nein	`de,en,fr,es,ua`	Alle verfügbaren übersetzten Sprachen aus 180 Sprachen weltweit.
data-prefill	Daten zur Vorbefüllung durch den Nutzer als JSON-String.	Nein	`{applicant:{firstname:'Erika',surname:'Mustermann'}}`	`{}`
data-prevent-default-css	Abschalten des Standard-Stylings, sodass ausschließlich Prozesslogik und kein CSS nachgeladen wird.	Nein	`true`	`false`
data-property-id	UUID der konfigurierten Kommunen-Property.	Nein	`3153f43b-65a5-4cee-ba16-f4278d27541d`	Wird automatisch erkannt.
data-servicekonto	Datenübernahme aus dem Servicekonto Niedersachsen forcieren	Nein	`true`	Wird automatisch beim Nutzer ermöglicht, aber nicht forciert.
data-terminal	Im Terminal-Modus werden Nutzer-Komfortoptionen abgeschaltet, die auf öffentlichen Geräten, z.B. Terminals oder gemeinschaftlich genutzten PCs, nicht genutzt werden können.	Nein	`true`	`false`

Details zu den einzelnen Konfigurationsoptionen finden Sie unter Konfiguration.

Kontakt

Bei Fragen, Problemen oder Rückmeldungen wenden Sie sich bitte an den folgenden Kontakt: pmonline@govconnect.de