Einen Onlinedienst erstellen oder bearbeiten
Mit dem EFAST Online-Dienst Builder lässt sich ein Online-Dienst erstellen, versionieren und im Marketplace veröffentlichen. In diesem Artikel werden die notwendigen Schritte hierfür erklärt.
Neuen Online-Dienst erstellen
Nach der Anmeldung oder dem Öffnen des EFAST Online-Dienst-Builders sieht man eine Übersicht über die bereits erstellten Online-Dienste. Falls noch kein Online-Dienst erstellt wurde, ist die Liste leer und nur die Begrüßung sichtbar.
Um nun den ersten oder einen neuen Antrag zu erstellen, klickt man einfach auf den Menüpunkt Online-Dienst erstellen rechts oben in der Menüleiste. Darauf öffnet sich der Dialog, mit dem man den Online-Dienst näher beschreiben kann. Ein Dropdown am Ende des Dialoges beschreibt, wie man einen neuen Online-Dienst auf der Basis einer existierenden Vorlage erstellen kann.
Nach einem Klick auf Erstellen öffnet sich die Ansicht für die Bearbeitung des neuen Online-Dienstes. In dieser wird erstmals die Schema-ID des Online-Dienstes angezeigt, mit der dieser Antrag später veröffentlicht wird. In der Navigation am linken Rand wird die Warnung eingeblendet, dass die Struktur dieses Elements leer ist. Sobald eine erste Gruppe oder ein erstes Feld angelegt wird, verschwindet diese Warnung.
Einen bestehenden Online-Dienst öffnen
Nach der Anmeldung oder dem Öffnen des EFAST Online-Dienst-Builders sieht man eine Übersicht über die bereits erstellten Online-Dienste. Falls noch kein Online-Dienst erstellt wurde, ist die Liste leer und nur die Begrüßung sichtbar.
Nach dem Öffnen des Online-Dienstes wird die Übersicht mit den angelegten Elementen in der Navigationsleiste links angezeigt und im zentralen Fenster werden die Details, wie Metadaten, Übersetzungsdateien, Script-Regeln, Versionen und Marktplatz-Veröffentlichung dargestellt.
Einen Online-Dienst bearbeiten
Nur die Arbeitskopie eines Online-Dienstes kann bearbeitet werden, wenn eine versionierte oder veröffentlichte Version des Online-Dienstes geöffnet wird, so muss über die Sektion Versionen die Arbeitskopie mit einem Klick geöffnet werden.
Gruppen und Felder anlegen
Bevor ein Online-Dienst versioniert oder veröffentlicht werden kann, muss mindestens ein Feld zum Online-Dienst hinzugefügt werden. Über die entsprechende Menüfunktion in der Seitenleiste am linken Rand lassen sich Vorhandene Elemente hinzufügen oder Elemente erstellen und hinzufügen.
Wird Element erstellen und hinzufügen angeklickt, so muss als Nächstes zwischen Datenfeldgruppe und Datenfeld gewählt werden. Eine Datenfeldgruppe fasst mehrere Felder zusammen und bildet später im EFAST Bürgerclient diese Gruppe von Datenfeldern auf einer eigenen Seite des Online-Dienstes ab.
Beim Hinzufügen eines Datenfeldes öffnet sich ein Dialog, mit dem man das Datenfeld definiert, indem man die Bezeichnung, die Feldart und den Datentyp festlegt. Es kann festgelegt werden, ob es ein Pflichtfeld oder ein optionales Feld sein soll, wie oft das Feld wiederholt werden kann und wie viele Zeichen erlaubt sind. Je nach Feldart variieren diese Parameter.
Wird eine Datenfeldgruppe angelegt, öffnet sich ein Dialog, in dem die Bezeichnung der Feldgruppe eingegeben werden muss. Die anderen Einstellungen, die festlegen, ob es sich um eine Pflichtgruppe oder eine optionale Gruppe handelt, können angepasst oder übernommen werden.
Die Datenfelder und Datenfeldgruppen werden in der Sektion Struktur in der Menüleiste am linken Seitenrand aufgelistet. Aus Darstellungsgründen sind Datenfeldgruppen zugeklappt und enthaltene Felder erst sichtbar, wenn die entsprechende Gruppe aufgeklappt wird.
Bei einer leeren Datenfeldgruppe erfolgt der Hinweis, dass dieses Element eine leere Struktur enthält und erst noch Felder angelegt werden müssen.
Bei einer optionalen Datenfeldgruppe wird im Antrag eine Checkbox eingeblendet, mit der die Felder der Gruppe im Online-Dienst angezeigt werden oder ausgeblendet bleiben.
Die optionale Datenfeldgruppe ist ausgeblendet, da die Checkbox nicht angehakt wurde.
Die optionale Datenfeldgruppe wird bei angehakter Checkbox eingeblendet, ohne dass eine Regel definiert werden muss.
Ist eine Datenfeldgruppe optional und kann mehrfach hinzugefügt werden, ändert sich die Darstellung. Die Checkbox wird durch einen Button ersetzt, die es erlaubt, eine Kopie der Datenfeldgruppe zum Online-Dienst hinzuzufügen.
Ist eine Datenfeldgruppe optional, so wird die Anzeige der Felder durch eine Checkbox oder einen Button, der das Hinzufügen einer Kopie der Datenfeldgruppe erlaubt, gesteuert. Eine verpflichtende Datenfeldgruppe wird immer mindestens einmal angezeigt und kann, gegebenenfalls mehrfach hinzugefügt werden, falls dies in den erweiterten Einstellungen für die Pflichtgruppe über die Werte für das minimale und maximale Vorkommen so konfiguriert wurde.
Übersicht der Feldtypen
Der EFAST Online-Dienst-Builder unterstützt folgende Feldarten und Datentypen. Für alle Feldarten kann festgelegt werden, ob die Angabe optional ist oder ob sie verpflichtend ist und wie oft die Angabe gemacht werden kann. Zu jedem Feld kann ein Infotext angegeben werden, der im Online-Dienst als zusätzliche Information aufgeklappt werden kann.
Eingabefeld
Für diese Feldart stehen folgende Datentypen zur Auswahl:
Textfeld mit Angabe einer min./max. Zeichenlänge und einem regulären Ausdruck zur Inhaltsprüfung.
Checkbox ohne weitere Spezifikationsmöglichkeiten
Dezimalzahl mit der Definition eines min. und max. Wertes.
Ganzzahl mit der Definition eines min. und max. Wertes.
Geldbetrag mit der Definition eines min. und max. Betrages.
Datum mit der Angabe eines optionalen min. und max. Wert des Datums.
Zeit mit der Angabe einer min. und max. Zeit, zusammen mit einem Vorbelegungswert.
Zeitpunkt mit der Angabe eines min. und max. Zeitpunkts, zusammen mit einem Vorbelegungswert.
Anlage mit der Festlegung einer max. Dateigröße und zulässigen Medientypen (PDF, JPG, PNG, ZIP, sonstiges).
Auswahlfeld
Ein Auswahlfeld hat immer den Datentyp Textfeld, wobei die Liste der Optionen entweder durch eine Werteliste oder eine Codeliste spezifiziert werden muss. Während eine Werteliste in tabellarischer Form als eine Liste von Wertepaaren selbst erstellt wird, wird eine veröffentlichte Codeliste über die Angabe der entsprechneden URN angegeben und die dann die Codeliste dann aus dem XRepository bezogen wird.
Veröffentlichte Codeliste aus dem XRepository können über die Seite https://www.xrepository.de/ gesucht werden. Es können nur veröffentlichte Codelisten genutzt werden, was einfach daran erkannt werden kann, dass es in eine Version der Codeliste den Button Codeliste anzeigen gibt.
Beispiel einer Werteliste:
Beispiel für die Codeliste urn:xoev-de:citkooutdoorerlaubnisantrag:codeliste:natuerlicheperson.anrede_1.0 von der Seite https://www.xrepository.de
Ein Auswahlfeld wird im Online-Dienst als Dropdown dargestellt, aus der ausgewählt werden kann, je nach Einstellung ein oder mehrere Einträge.
Statisches Feld
Mit einem statischen Feld lassen sich Texte in einen Online-Dienst einbauen, die zusätzliche Informationen zu den Erklärungen liefern, die direkt bei den Datenfeldern hinterlegt sind.
Verstecktes Feld
Das Datenfeld vom Typ verstecktes Feld bietet die identischen Datentypen an, wie ein normales Eingabefeld, wird jedoch den Nutzenden beim Ausfüllen nicht angezeigt. Dadurch lassen sich beispielsweise zusätzliche Informationen an Schnittstellen oder Fachverfahren übergeben, ohne dass diese für den Antragsteller sichtbar werden.
Script-Regeln (No/Low-Code)
Der EFAST Online-Dienst-Builder erlaubt es einfach Regeln für das Ein- oder Ausblenden von Datenfeldern oder Datenfeldgruppen zu erstellen. Die Steuerung erfolgt immer durch ein Auswahlfeld oder eine Checkbox und bezieht sich auf ein Datenfeld oder eine Datenfeldgruppe.
Für Datumsfelder lassen sich Regeln erstellt, mit deren Hilfe ein Zeitraum festgelegt werden kann, wann die Eingabe gültig ist. Bisher konnten bei einem Datumsfeld nur absolute Min- und Max-Werte festgelegt werden, mit den Regeln lassen sich auch relative Bereiche festlegen. Dies kann beispielsweise für die Altersprüfung genutzt werden.
Eine Regel wird immer an das Datenfeld oder -gruppe gebunden, die mit der Regel gesteuert wird und nutzt eine Checkbox oder ein Auswahlfeld zur Steuerung. Die Regel wertet den Inhalt oder den Status des Feldes aus, um ein Datefeld oder eine Datenfeldgruppe ein- oder auszublenden.
Wird die Option Scripting-Regel hinzufügen ausgewählt, so öffnet sich ein Dialog, in dem die Regel zum ein- und ausblenden eines Feldes spezifiziert werden kann.
Eine Scripting-Regel kann nur zu einem optionalen Datenfeld oder einer optionalen Datenfeldgruppe hinzugefügt werden.
Als Regelart kann augenblicklich einzig die Regelgruppe einblenden ausgewählt werden.
Damit durch eine Scripting-Regel ein Datenfeld oder eine Datenfeldgruppe ein- und ausgeblendet werden kann, wird ein Feld zur Steuerung benötigt. Es kann in dem Dialog mit dem Stift-Button ein Feld aus der Liste der existierenden Datenfelder ausgewählt werden, das geeignet ist. Derzeit stehen nur Checkboxen und Auswahlfelder für die Steuerung von Scripting-Regeln zur Verfügung.
Bei einer Checkbox stehen angehakt und nicht angehakt zur Wahl, bei Auswahlfeldern, kann man einen Wert aus der Liste wählen.
In einem Online-Dienst sieht man dann die Checkbox oder das Auswahlfeld und kann damit das Ein- und Ausblenden der betreffenden Feldgruppe und des Datenfeldes steuern.
Sobald alle Datenfeldgruppen, Datenfelder und Scripting-Regeln erfasst sind, kann man den Online-Dienst versionieren und anschließend im Marketplace veröffentlichen.
Vorschau eines Online-Dienstes
Um eine Vorschau eines Online-Dienstes während der bearbeitung des Datenmodells zu öffnen, kann in der Navigationsleiste am linken Seitenrand einfach ein Element des Datenmodells angeklickt werden. Es ist hierbei unerheblich, ob ein Datenfeld oder eine Datenfeldgruppe angeklickt wird. Mit einem Klick auf Vorschau anzeigen öffnet sich die Ansicht des Online-Dienstes in einer Preview, die dem EFAST Bürger-Client (BCL) entspricht.
Nach dem Klick auf ein Element der Struktur wird die erste Seite des Online Dienstes geöffnet und er kann ähnlich einem echten Antrag durchgeklickt werden.
