Konfiguration
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. Die verfügbaren möglichen Werte werden in einem späteren Abschnitt genauer erläutert. | 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 |
data-process
Das Feld data-process ist notwendig. Es wird dazu genutzt, den richtigen Online-Dienst auszuwählen. Die Kennung des Online-Dienstes nennen wir auch Prozesskennung. Die Prozesskennung der jeweiligen Online-Dienste finden Sie in den Beschreibungen zu den Online-Diensten.
Die Prozesskennung ist eindeutig vergeben. Sie können bisher noch nicht mehrere Prozesskennungen auf einer Seite einsetzen. Dies kann zu Seiteneffekten in der Bedienung führen.
Sollten Sie keine oder eine ungültige Prozesskennung aufrufen, wird der HTML-Container nicht gerendert und eine Fehlermeldung in der Console zu Debugging-Zwecken erzeugt. Der Nutzer kann in diesem Fall keine weitere Interaktion mit dem HTML-Container durchführen, bis Sie wieder eine gültige Prozesskennung vergeben.
Es gibt nicht nur einzelne Online-Dienste, die eine Prozesskennung besitzen, sondern auch andere Seiten, wie beispielsweise Bündelungsseiten, Prozessgruppenseiten, Vorschaltseiten und Hilfsseiten. Relevante Prozesskennungen finden Sie in den Zusatzbeschreibungen der entsprechenden Onlinedienste.
Das Ändern des Data-Attributs wird durch einen Observer live überwacht. Die eingebundenen Online-Dienste reagieren dadurch auf Änderungen der Prozesskennung, sodass ein Hotswapping und ein Wechseln oder Zusammenführen mehrerer Online-Dienste durch Sie möglich sind. Beim Hotswapping gehen ungesicherte Benutzereingaben verloren. Per Autosave gesicherte Benutzereingaben werden beim Hotswapping möglichst weit wiederhergestellt, sodass der Benutzer dort weitermachen kann, wo eine Eingabe benötigt wird.
data-customer-id
Um den Online-Dienst mit der Konfiguration der Kommune zu verbinden, können Sie das Data-Attribut data-customer-id mit der UUID der Kommune oder des Dienstleisters vergeben. Sie erhalten Ihre UUID über die Lizenzierung von der GovConnect GmbH und können diese jederzeit in den Konfigurationsoberflächen einsehen.
<div class="pmo-process" data-process="fischereischein"
data-customer-id="978b85ea-ed36-4027-a806-162354ef12fb"
></div>
Die Übergabe der CustomerId ermöglicht es dem Online-Dienst, die kommunenspezifische Konfiguration früher zu laden, sodass Nutzer einfacher durch den Antragsprozess auf Ihrer Seite geleitet werden können. Ist keine CustomerId vorhanden, wird der Online-Dienst automatisch die zuständige Stelle anhand von Benutzerangaben ermitteln. Während des Ausfüllens durch den Nutzer wird die passende Konfiguration automatisch nachgeladen und die Ansicht entsprechend für die kommunenspezifische Konfiguration aufbereitet. Die automatische Erkennung der CustomerId/Konfiguration erfolgt anhand verschiedener Kriterien der eingebetteten Seite und den Angaben des Nutzers. Sollte die CustomerId unbekannt sein, wird keine Fehlermeldung dargestellt, sondern die automatische Erkennung zur selbstständigen Korrektur aktiv.
Es kann passieren, dass aufgrund von speziellen Benutzereingaben erkannt werden kann, dass die zuständige Stelle eine andere Kommune ist, die GovForms einsetzt. Die CustomerId wird zugunsten der tatsächlich zuständigen Kommune in dem Fall verarbeitet, weil der Vorgang nicht durch Sie abschließend bearbeitet werden könnte. In diesen Fällen erhalten Sie den Vorgang nicht, sondern die zuständige Kommune, und der Vorgang wird nicht zu Ihrem Kontingent hinzugezählt, sodass keine Kosten für Sie entstehen. Die Kosten trägt in diesem Fall die zuständige Stelle. Um dieses Verhalten einzuschränken, nutzen Sie filternde Properties, wie im Abschnitt data-property-id beschrieben.
data-hide-header
Um den Header abzuschalten, z.B. weil Sie in Ihrer einbettenden Seite bereits einen eigenen Header darstellen, können Sie das Data-Attribut data-hide-header übergeben.
Erlaubte Werte sind true und false. Ist das Data-Attribut nicht vorhanden, wird false als Default gewählt.
Durch das Abschalten des Headers wird der gesamte Headerbereich ausgeblendet. Es wird ausschließlich der prozessrelevante Inhaltsbereich angezeigt.
data-language
Die Sprachauswahl wird automatisch in den Online-Diensten angeboten, sofern entsprechende Übersetzungen vorliegen. Um die Anzeige bestimmter Sprachen einzuschränken, kann mithilfe data-language eine Liste erlaubter Sprachoptionen übergeben werden.
Der Wert muss als kommagetrennte Liste von ISO-639-1 Codes übergeben werden (Liste der verfügbaren Sprachen).
Sobald die gewünschte Sprache übersetzt vorliegt, wird diese auch als Option angezeigt.
Die Reihenfolge der Werte hat keine Bedeutung für die Priorisierung oder Darstellung. Die Sprachauswahl reagiert aber auf die Anzahl der erlaubten bzw. verfügbaren Sprachen automatisch und kann sich je nach Menge einfacher oder komplexer gestalten. Sind mehr als 6 Sprachen verfügbar, werden außerdem die meistgenutzten Sprachen für die Benutzerauswahl optimiert dargestellt.
Werden ungültige oder doppelte Sprachen übergeben, so werden diese ignoriert, die anderen Sprachen werden weiterhin beachtet. Beachten Sie, dass dies dazu führen kann, dass die übergebene Liste effektiv als leer interpretiert werden kann.
Die Sprache Deutsch kann nicht abgeschaltet werden und ist in allen denkbaren Konstellationen immer verfügbar.
Sollte nur eine einzelne Sprache verfügbar sein, wird die Sprachauswahl gar nicht dargestellt. In dem Fall wird der Benutzer auf die Anzeige in dieser Sprache forciert.
data-prefill
Zur Vorbefüllung von Formularinhalten aus Nutzer- oder Verwaltungssicht wird die Flag data-prefill verwendet.
Der Wert wird als serialisierter JSON-String übergeben.
Die möglichen Werte im JSON-String sind entsprechend der Request-Objekte der Schema-Beschreibungen möglich. In allen Online-Diensten haben wir darauf geachtet, dass wiederkehrende Antragsdaten, z.B. Antragsteller-Daten stets in allen Schemata gleich definiert und genutzt werden. Damit ist die Übergabe von gleichen Daten auch in mehreren Online-Diensten immer gleich. Es können auch prozessspezifische Inhalte zur Vorbefüllung übergeben werden.
Beispielsweise könnten Sie zur Baumfällgenehmigung (BaumfaellgenehmigungRequest) den partiellen Vorbefüllungsdatensatz übergeben, da Sie bereits vorab diese Informationen eingeholt haben:
{
"applicant": {
"firstname": "Erika",
"surname": "Mustermann",
"birthdate": "1964-08-12",
"isOrganization": false,
"address": {
"street": "Teststraße",
"houseNumber": "1A",
"postalCode": "30161",
"city": "Hannover"
}
},
"applicationPermission": "OWNER",
"plants": [
{
"type": "TREE",
"amount": 1,
"imminentDanger": false,
}
]
}
In dem gezeigten Fall muss der Nutzer die fehlenden Informationen eintragen: Hier könnte er Detailinformationen zur Adresse ergänzen, die hier beispielhaft nicht vorbefüllt wurden. Anschließend füllt er die weiteren prozessspezifischen Felder aus und reicht den Vorgang nach der Bezahlung ein.
Wie Sie gut erkennen können, sind Antragstellerdaten (applicant) für alle Online-Dienste gleich. Analog sind auch andere typisch auftretende Datenfelder und Datengruppen standardisiert nutzbar.
Übergeben Sie das JSON-Objekt als String im Data-Attribut. Beachten Sie, dass Mehrzeilen im HTML dazu führen können, dass der Browser des Clients den Wert korrumpiert. Daher empfehlen wir Ihnen den Wert als serialisierten JSON-Minified-String zu übergeben.
Der Nutzer kann die vorbefüllten Eingaben analog zu eigenen Eingaben nachträglich verändern, um Korrekturen vorzunehmen.
Bestimmte Felder, z.B. Uploads, können seitens des Online-Dienstes für die Vorbefüllung abgelehnt werden. Die Beschreibung zu diesen Ausnahmen finden Sie in den entsprechenden Online-Diensten.
Übergeben Sie Daten, zu denen kein Feldmatching vorliegt, da Sie beispielsweise nicht im Schema definiert sind, werden diese Teildatensätze ignoriert. Es wird keine Fehlermeldung angezeigt.
Der gleichzeitige Einsatz der Vorbefüllung und des Servicekontos ist möglich. Hoch verifizierte Datensätze, wie die des Servicekontos, erhalten Priorität vor den weniger hoch verifizierten Datensätzen, sollten beide Datensätze dieselben Eingabefelder vorbefüllen wollen.
Sie brauchen keine zwischengespeicherten Datensätze zur Vorbefüllung übergeben, da dies über die integrierte Autosave-Funktion automatisch für jeden Vorgang des Nutzers übernommen wird. Die Vorbefüllung unterliegt allerdings der Bedingung, dass der Nutzer mit der Verwendung der Autosave-Funktion einverstanden ist.
data-prevent-default-css
Um das Styling in der einbettenden Seite komplett selbstständig zu übernehmen, um z.B. durch Ihre Agentur ein komplettes Theme umzusetzen, können Sie die Auslieferung und das Nachladen des Standarddesigns abschalten.
<div class="pmo-process" data-process="fischereischein"
data-prevent-default-css="true"
></div>
Die Folge dieser Flag ist, dass ausschließlich die HTML- und JavaScript-Ressourcen geladen werden. Daher wird der Online-Dienst ohne jegliches Styling ausgeliefert. Sollte Ihre Agentur Sie bitten, diese Flag zu setzen, empfehlen wir sie auf die Anleitung zum Styling hinzuweisen.
Wir übernehmen keine Gewährleistung der korrekten Darstellung oder Benutzerführung durch den Online-Dienst bei Anpassungen am Styling, die durch Sie durchgeführt wurden.
data-property-id
In den Online-Diensten wird automatisch erkannt, um welche zuständige und verantwortliche Stelle es sich im gegebenen Vorgang handelt. Zusätzlich gibt es das Property-Konzept.
Geben Sie die gewünschte Property-ID im Data-Attribut data-property-id mit. Die Property-ID ist nicht geheim und sicherheitstechnisch und datenschutzrechtlich unbedenklich.
Wir empfehlen Ihnen, die Property-ID mitzugeben, sofern Sie mindestens eine Property konfiguriert haben.
<div class="pmo-process" data-process="fischereischein"
data-property-id="PMO-12345678"
></div>
Der Einsatz einer Property-ID sorgt dafür, dass zum Vorgang die entsprechende Property verknüpft wird. Sie können eine oder mehrere Properties eingerichtet haben. In Ihrem Konfigurationsbackend ermöglicht die Zuordnung zu einer Property es Ihnen, Statistiken zu den Online-Diensten und Ihren Properties einzusehen.
Filternde Properties sind Properties, die die Einbettung in bestimmte URLs erlauben und alle anderen verhindern. Damit können Sie sicherstellen, dass eine Property-ID nur auf den von Ihnen konfigurierten URLs und Domains verwendet werden kann.
Änderungen an der Property-ID werden nicht live überwacht und daher muss dieser Parameter vor dem ersten Aufruf bereits übergeben werden.
Wird keine Property-ID übergeben, wird anhand der Zuständigkeitsermittlung und den weiteren Konfigurationsdaten sowie der einbettenden URL eine Zuweisung zu einer Property nachträglich automatisiert vorgenommen.
data-servicekonto
Damit Benutzerdaten aus dem Servicekonto des Landes übernommen werden und nicht durch den Nutzer selbst eingegeben werden müssen, können Sie mit dem Data-Attribut data-servicekonto die Anmeldung über das Servicekonto forcieren. Dies ist beispielsweise hilfreich, wenn Sie bereits einen angemeldeten Servicekonto-Benutzer vorliegen haben.
Die erlaubten Werte sind false, true und auto. Wird kein Wert übergeben, wird auto gewählt.
Bei false wird die Nutzung des Servicekontos verhindert, auch wenn ein Benutzer die Möglichkeit einer Anmeldung gehabt hätte.
Bei true wird die Nutzung des Servicekontos forciert, auch wenn der Benutzer zuvor noch keine Registrierung im Servicekonto durchgeführt hat. Dies kann dazu führen, dass der Nutzer auf die Seite des Servicekontos umgeleitet wird. Erst nach erfolgreicher Anmeldung gelangt der Nutzer zurück zu Ihrer Seite und der Vorgang wird fortgeführt. Der Online-Dienst erkennt den Anmeldestatus automatisch und reagiert eigenständig darauf.
Bei auto wird die Nutzung des Servicekontos in der Darstellung angeboten, sodass Servicekonto-Daten aus der aktiven Session des Nutzers übernommen und vorausgefüllt werden können. Ein Nutzer kann sich auch entscheiden, eine Anmeldung am Servicekonto durchzuführen oder auch eine aktive Session zu beenden. Der Nutzer ist nicht gezwungen, mit einer Anmeldung über das Servicekonto weiterzumachen, sofern dies der Online-Dienst nicht aus fachlichen Gründen vorsieht. Die Entscheidung des Nutzers wird durch den Online-Dienst respektiert und eine andere Datenübernahme oder Erfassungsmaske angeboten, um den Vorgang fortzuführen.
Vorbefüllte Daten des Servicekontos werden in Formularfelder ggf. angezeigt und können nicht durch den Nutzer verändert werden. Die Prüfung hoher Verifizierungsdaten erfolgt vorgangsbezogen beim Einreichen ohne das Zutun des Nutzers, sodass die hoch verifizierten Inhalte stets Priorität vor den durch den Nutzer eingetragenen Inhalten haben.
data-terminal
Bei der Einbettung in Terminals, beispielsweise Selbstbedienungsterminals und Kiosksysteme, das heißt in öffentlich bereitgestellten Systemen, die üblicherweise von vielen verschiedenen Menschen genutzt werden, sind manche Optionen und Funktionen nicht sinnvoll nutzbar. Sollten Sie eine Einbettung in ein solches System vornehmen, setzen Sie bitte diese Flag.
Die erlaubten Werte sind false und true. Wird kein Wert übergeben, wird false gewählt.
Im Terminal-Modus werden bestimmte Nutzerkomfortoptionen abgeschaltet. Das sind die Verwendung von Cookies, die lokale Speicherung und Funktionen, welche nur auf persönlichen Endgeräten sinnvoll sind, wie das Herunterladen von Antragsdokumenten oder das Setzen von Einstellungen zur Personalisierung. Auch die Autosave-Funktion steht im Terminal-Modus nicht zur Verfügung. Sie kann durch den Nutzer nicht aktiviert werden.
Außerdem wird im Terminal-Modus davon ausgegangen, dass jederzeit eine Person das Terminal verlässt und eine andere Person einen neuen Vorgang starten möchte. Daher wird eine aktive Nutzersession im Vergleich zur Nutzung an einem persönlichen Gerät verkürzt.