XÖV-Suite

Diese Hilfe befindet sich derzeit noch im Aufbau und wird in den nächsten Versionen erweitert. Derzeit sind noch nicht alle Bereiche der Anwendung vollständig beschrieben.
Inhalt

1. Startseite

Sie befinden sich auf der Startseite der Anwendung XÖV-Suite. Sie öffnet sich automatisch, sobald Sie die Anwendung über folgende URL öffnen: suite.xoev.de Per Klick auf das XÖV-Logo in der oberen linken Ecke des Bildschirms gelangen Sie jederzeit zurück auf die Startseite.

Von hier aus können Sie folgende Dinge tun: - Die Profilierung eines Standards vornehmen - Eine Beispielnachricht anlegen

2. Basisfunktionen

2.1. Speichern

Speichern-Button
Figure 1. Speichern-Button

Im oberen rechten Bildschirmbereich ist der Speichern-Button zu finden. Dieser startet den Download der Profilierungsdatei im .zip-Format. Der Button ist ausgegraut, wenn Validierungsfehler vorliegen. Ein Download ist erst möglichen, wenn die Validierungsfehler behoben wurden. Das Icon links neben dem Speichernbutton liefert weitere Informationen zum Validierungsergebnis.

2.2. Validierung

positive Validierung
Figure 2. positive Validierung

Über das Icon links neben dem Speichern-Button, im oberen rechten Bildschrimbereich, lassen sich mögliche Profilierungsfehler einsehen. Bei einem grünen Haken liegen keine Validierungsfehler vor. Wird ein rotes !-Icon angezeigt so liegen Validierungsfehler vor und ein Speichern der Profilierung ist erst nach Behebung der Fehler wieder möglich. Per Klick auf das Icon lassen sich die Validierungsergebnisse anzeigen. Die aufgelisteten Fehler sind klickbar und ermöglichen eine Navigation dirket zu den betreffenden Feldern.

2.3. Zurück/Vorwärts

Zurück/Vorwärts-Button
Figure 3. Zurück/Vorwärts-Button

Neben dem Speichern-Button im oberen rechten Bildschirmbereich gibt es die vor- und zurück-Pfeile. Sie ermöglichen ein rückgängig machen der letzten Änderungen. Sie funktionieren auch Bereichsübergreifend. Das bedeutet, das ich eine Eingabe im Bereich Datentypen wiederrufen kann, obwohl ich gerade in den Bereich Nachrichtenstrukturen gesprungen bin.

2.4. Navigationszeile

In der hell blauen Navigationszeile wird der Navigationspfad der Anwendung angezeigt. Dieser ist klickbar und ermöglicht eine Navigation zu anderen Teilen der Anwendung.

2.5. Fehlerhandling

Fehlerhandling
Figure 4. Fehlerhandling

Die Eingaben in viele Felder der Anwendung werden von der Anwendung validiert. Sollten Eingaben nicht mit dem erwarteten Wert übereinstimmen, so wird unterhalb des Feldes mit Roter Schrift ein Hinweis gegeben. Gleichzeitig wird der Speichernbuton ausgegraut und der Fehler wird über den Validierungsbutton einsehbar.

2.6. i-Icon / ?-Icon

Info-Icon
Figure 5. Info-Icon

In der Anwendung werden i- und ?-Icons verwendet. Indem Sie mit der Maus über das Icon fahren erhalten Sie weitere Informationen zum Vorgang neben dem das Icon gesetzt ist.

2.7. Autokorrektur-Icon

Autokorrektur-Icon
Figure 6. Autokorrektur-Icon

Per Klick auf das Autokorrektur-Icon können fehlerhafte Einträge automatisch berichtigt werden.

3. Profilierung eines Standards

XÖV-Standards beschreiben im allgemeinen die nachrichtenbasierte Datenübermittlung zwischen zwei Behörden. Einzelne XÖV-Standards wie beispielsweise XMeld beschreiben den Kontext, in dem diese Übermittlung stattfinden kann und die in diesem Kontext zu übermittelnden Daten explizit und abschließend.

Beispiel: XMeld-Nachricht rueckmeldung.anmeldunginland.0201

Mit der XMeld-Nachricht rueckmeldung.anmeldunginland.0201 informiert die Zuzugsmeldebehörde, in der die Anmeldung einer Person erfolgt ist, die Wegzugsmeldebehörde über die Tatsache und die Details zum Zuzug der betroffenen Personen. Rechtsgrundlage und die semantische Bestimmung der zu übermittelnden Inhalte sind mit § 33 Abs. 1 und 2 BMG, § 6 1. BMeldDÜV und dem Datensatz für das Meldewesen - Einheitlicher Bundesteil (DSMeld) abschließend geregelt.

Demgegenüber stehen eine Reihe von XÖV-Standards, die den Kontext ihrer Verwendung weniger strikt einschränken. Beispielhaft sei hier der Standard xdomea genannt, dessen Nachrichten zur Übermittlung von Schriftgutobjekten (Akten, Vorgänge und Dokumente) in unterschiedlichsten Kontexten verwendet werden können. Zu den einzelnen Nachrichten des Standards sind der Übermittlungskontext, -umfang und die Kommunikationspartner nur generisch beschrieben. Dieser Ansatz eröffnet die Möglichkeit, den Standard in Verwaltungsbereichen mit unterschiedlichen Anforderungsprofilen oder Rahmenbedingungen einzusetzen. Gleichzeitig erfordert dieser Ansatz aber auch, dass eine Konkretisierung des Übermittlungskontextes bei der Umsetzung, beispielsweise in einem konkreten Informationsverbund erfolgt. Eine solche Konkretisierung muss in der Regel auf rechtlicher, organisatorischer, semantischer und technischer Ebene erfolgen.

Wird die Konkretisierung der Verwendung des Standards auf den unterschiedlichen Ebenen dermaßen betrieben, dass die bestehenden Freiheitsgrade ausschließlich eingeschränkt und nicht erweitert werden, so kann die Konkretisierung als Profilierung des Standards bezeichnet werden.

3.1. Ansatz der Profilierung

Die Profilierung eines Standards kann aus methodischer Sicht vereinfacht als eine Einschränkung der Gestaltungsmöglichkeiten bei der Erzeugung von Nachrichten verstanden werden. Vorgaben zur Gestaltung von Nachrichten werden durch einen (XÖV-)Standard in Form von Beschreibungen prozessualer oder semantischer Aspekte (Spezifikationsdokument), expliziten Geschäftsregeln (Spezifikationsdokument und Schematron) und technischer Ausgestaltung (XML Schemata und Codelisten) gegeben.

Vereinfacht formuliert kann eine Profilierung die Freiheitsgrade bei der Nachrichtenerzeugung in allen genannten Bereichen einschränken. Einzige Bedingung dabei ist, dass alle zum jeweiligen Profil konformen Nachrichten gleichzeitig konform zu den Vorgaben des zugrundeliegenden Standards sind.

3.2. Projekt öffnen

Um einen Standard mit Hilfe der XÖV-Suite zu profilieren muss zunächst ein Projekt geöffnet werden. Sie haben die Möglichkeit ein neues Profil zu erstellen oder ein bereits vorhandenes Profil in die Anwendung zu laden um es weiter zu bearbeiten.

3.3. Neues Profil erstellen

Mit der Auswahl der Option "Neues Profil erstellen" auf der Startseite der Anwendung (suite.xoev.de/), haben Sie die Möglichkeit ein neues Profil anzulegen. Es öffnet sich eine Eingabemaske "Profilierungsprojekt anlegen".

3.3.1. Profilierungsprojekt anlegen

Hier wählen Sie einen Standard für die Profilierung aus und geben die Metadaten der Profilierung an. Die Felder mit einem * in der Feldbezeichnung sind Pflichtfelder. Die Kennung wird automatisch auf Basis Ihrer Eingaben aus den übrigen Feldern generiert. Sie ist nicht direkt editierbar. Sind alle Felder befüllt, bestätigen Sie den Vorgang mit dem anlegen-Button.

Das Projekt lässt sich erst anlegen, wenn alle Pflichtfelder befüllt sind.

3.4. Profil laden

Mit der Auswahl der Option "Profil laden" auf der Startseite der Anwendung (suite.xoev.de/), haben Sie die Möglichkeit ein bereits vorhandenes Profil von Ihrem Gerät in die Anwendung zu laden. Es öffnet sich ein Dialogfenster "Profilierungsprojekt öffnen".

3.4.1. Profilierungsprojekt öffnen

Sie haben die Möglichkeit ein Projekt aus Ihrem Dateiexplorer in der Anwendung hochzuladen. Dafür können Sie in das graue Feld klicken und im sich öffnenden Dateiexplorer die hochzuladende Datei auswählen. Alternativ können Sie per Drag & Drop die Datei in das graue Feld ziehen. Ist eine Datei erfolgreich hochgeladen worden, bestätigen Sie den Vorgang mit dem öffnen-Button.

Bitte beachten Sie, dass nur Dateien im ZIP-Format hochgeladen werden können.

3.5. Projekt Metadaten

Hier können Sie die Metadaten eines Projektes einsehen und bearbeiten. Eine Änderung des ausgewählten Standards nach der initialen Anlage des Profilierungsprojekts, ist in der XÖV-Suite nicht vorgesehen.

3.6. Projekt Eigene Eigenschaften

In diesem Bereich können nutzerspezifische Eigenschaften definiert werden, die im weiteren Verlauf der Anwendung Elementen zugeordnet werden können. Sie dienen als Ergänzug zu den bereits vorhandenen Attributen aus dem Standard. Nach dem befüllen der Eingabefelder, kann die Eigenschaft über das + Icon hinzugefügt werden. Über das Stift-Icon kann die Eigenschaft editiert werden. Durch betätigen des Mülleimer-Icons wird die Eigenschaft entfernt.

Ergänzung um weitere Regeln: Mit der Einführung weiterer Geschäftsregeln zur Verwendung von Informationselementen, können zusätzliche Einschränkung für den zulässigen Inhalt einer Nachricht formuliert werden. Die Geschäftsregeln einer Profilierung dürfen dabei nicht im Konflikt zu des Geschäftsregeln des zugrundeliegenden Standards stehen.
Konkretisierung einer bestehenden Geschäftsregel: Die Konkretisierung einer bestehenden Geschäftsregel führt zu einer Einschränkung der zu übermittelnden Inhalte einer Nachricht.

4. Datentypen

4.1. Datentypen suchen, filtern und aufrufen

Über den Navigationsbereich auf der linken Bildschirmseite können Sie Datentypen auswählen. Das Suchfeld im oberen Bereich erleichtert die Ergebnissuche. Der Bearbeitungsbereich auf der rechten Seite präsentiert den Standarddatentyp und die Einschränkung des ausgewählten Datentyps.

4.2. Standarddatentypen anzeigen und aufrufen

Über die Verlinkung auf den Standarddatentypen im Bearbeitungsbereich, auf der rechten Seite, lässt sich die Definition des Standards im read-only-Modus anzeigen.

4.3. Datentypprofile anzeigen und anlegen

Unter dem Punkt "Einschränkungen" lassen sich neue Datentypprofile des ausgewählten Standardtypen anzeigen und anlegen. Durch die Vergabe eines Namens, einer Beschreibung, und dem Klick auf das Disketten-Icon, wird eine neue Einschränkung eines Datentyps angelegt.

4.4. Datentypprofile aufrufen, beschreiben und zuweisen

Einschränkungen eines Datentyps können über das Stift-Icon bearbeitet und über das Mülleimer-Icon gelöscht werden. Bei Klick auf das Stift-Icon öffnet sich der Bearbeitungsbereich der Einschränkung. Hier, im Wurzelknoten der Navigation, können der Name, die Beschreibung, sowie der Umsetzungshinweis der Einschränkung eingesehen und editiert werden. Vorhandene Informationen aus dem Standard werden auf der rechten Seite abgebildet. Über die abgebildete Tabelle lässt sich die Einschränkung einer Nachricht zuweisen. Die Tabelle verfügt über eine eigene Such- und Filterfunktion, welche das finden von Einträgen erleichtern soll. In den aufgelisteten Einträgen der Tabelle sind sowohl der Elementname als auch der Sytaxpfad klickbar. Sie dienen als Sprungmarke in den entsprechenden Bereich der Anwendung.

4.5. Elemente in der Baumnavigation finden

Über die Baumnavigation im linken Bildschirmbereich lässt sich durch die Elemente des Datentypprofils navigieren. Die Suche im oberen Bereich erleichtert das Finden von Elementen. Im unteren Bereich der Navigation lassen sich Filter für den Navigationsbaum definieren. Der Toggle "Profilierte Elemente anzeigen" filtert den Navigationsbaum nach Elementen, die profiliert wurden. Alle nicht profilierten Elemente werden ausgeblendet. Per Klick auf die Elemente im Baum, öffnet sich der Bearbeitungsbereich im rechten Bildschirmbereich.

4.6. Datentypprofile einschränken

Neben dem Elementnamen ganz oben, wird der Datentyp in blau angezeigt. Per Klick kann hier direkt in den Datentypen gesprungen werden. Wurde eine Profilierung eines Standarddatentyps vorgenommen, so kann dieser hier entsprechend über das Stift-Icon neben dem Datentypen ausgewählt werden. Es öffnet sich ein entsprechnder Dropdown zur Auswahl.

Wurde ein profilierter Datentyp ausgewählt, sind alle Kindknoten nicht mehr editierbar. Dies wird auch in der Navigation durch ein Schloss-Icon, sowie ein ausgrauen des Teilbaums kenntlich gemacht.

Im Bearbeitungsbereich, auf der rechten Bildschirmseite der Anwendung, lassen sich die Attribute der Datentypprofile entsprechend befüllen. Die Angaben aus dem Standard sind am rechten Bildschirmrand dargestellt.

Folgende Informationen können über die Eingabefelder "Beschreibung" und "Umsetzungshinweis" abgebildet werden:

  • Konkretisierung der semantischen Bedeutung: Die Konkretisierung einzelner Begrifflichkeiten oder semantischer Konzepte eines Standards. Dies ist beispielsweise mittels Konkretisierung einer Elementbeschreibung des Standards möglich.

  • Ergänzung um Synonyme: Nutzung von Synonymen zu den Begrifflichkeiten des zugrundeliegenden Standards. Beispiele für Synonyme sind die Zuordnung der länder- oder fachbereichsspezifischen Terminologie zu der im zu profilierenden Standard verwendeten Terminologie.

  • Ergänzung um erläuternde Informationen: Hinzufügen eines erläuternden Textes, der beispielsweise erklärt, wie ein Informationselement in einem bestimmten Anwendungsfall zu verwenden ist. Ein solcher Text darf die ursprüngliche semantische Definition des Elements nicht verändern.

4.6.1. Kardinalität:

Über die Kardinalität kann angegeben werden ob das Datentyprofil Teil der Profilierung sein soll und/oder wie oft es eingebunden wird.

Folgende Informationen können über die Kardinalität abgebildet werden:

  • Nutzung optionaler Informationselemente ausschließen (0..n zu 0..0): Mit der Einschränkung der Multiplizität von 0..n zu 0..0 wird die Nutzung eines optionalen Informationselements verboten.

  • Nutzung optionaler Informationselemente fordern (0..n zu 1..n): Wenn ein optionales Informationselement obligatorisch wird, wird damit eine Option seiner ursprünglich vorgesehenen Verwendung vorgegeben.

  • Anzahl möglicher Wiederholungen einschränken (x..n zu x..1, mit x gleich 0 oder 1): Die Anzahl möglicher Wiederholungen wird beispielsweise von 1..n auf 1..1 verringert.

4.6.2. Einschränkung der Werte

Hier können Defaultwert und Beispiel-Wert für das Element profiliert werden.

Ist der Fixed-Wert gesetzt, sollte kein Defaultwert, Beispiel-Wert oder Wert für Beispielnachrichten vergeben werden sein.

4.7. Datentypprofile zurücksetzen

Zurücksetzen-Button
Figure 7. Zurücksetzen-Button

Im Bereich Datentypen befindet sich unterhalb des Speichern-Buttons Ein Zurücksetzen-Icon. Ist ein Datentypprofil ausgewählt und wurden Profilierungen vorgenommen, so können alle vorgenommenen Änderungen am Element durch Klick auf diesen Button gleichzeitig zurückgesetzt werden.

Falls ein Datentypprofil eingebunden ist, wird auch dieses aus dem geöffneten Datentypprofil entfernt und durch die Angabe aus dem Standard ersetzt.

4.8. Eigene Eigenschaften

Die im Bereich "Projekt" der Anwendung definierten eigenen Eigenschaften können hier eingebunden werden. Sie dienen als Ergänzug zu den bereits vorhandenen Attributen aus dem Standard. Nach dem befüllen der Eingabefelder, kann die Eigenschaft über das + Icon hinzugefügt werden. Über das Stift-Icon kann die Eigenschaft editiert werden. Durch betätigen des Mülleimer-Icons wird die Eigenschaft entfernt.

4.9. Datentypprofile vom Typ CodeType

Codeliste-Icon
Figure 8. Codeliste-Icon

Datentypprofile vom Typ CodeType lassen sich ähnlich wie andere Datentypen in der Anwendung profilieren. Sie sind durch ein graues Icon in der Navigation gekennzeichnet. Zusätzlich bieten sie weitere Profilierungsmöglichkeiten.

Folgende Informationen können über die Eingaben zu den Metadaten einer Codeliste angegeben werden:

  • zu verwendende Codeliste konkretisieren: Wird durch den Standard nur eine Codeliste und nicht deren konkrete Version vorgegeben, so kann die Vorgabe einer Version erfolgen (Nutzungstyp 3 zu 2). Wird durch den Standard nur die Verwendung einer Codeliste vorgegeben, aber keine konkrete Codeliste vorgegeben, so kann eine konkrete Codeliste und eine konkrete Version zur verbindlichen Nutzung in der Profilierung benannt werden (Nutzungstyp 4 zu 3 oder 2).

  • Codes ausschließen: Einschränkung der zur Übermittlung vorgesehenen Codes einer Codeliste.

  • Codes konkretisieren: Die semantische Konkretisierung eines Codelisteneintrags ist als semantische Einschränkung der ursprünglichen Bedeutung zu verstehen.

4.9.1. Metadaten der Codeliste

Je nach Nutzungsart der Codeliste können die Attribute Codelistenversion, Codelistenkennung und Nutzungsart editiert werden. Die Nutzungsart ergibt sich aus der Angabe des Standards. Da die Anwendung an das XRepository angeschlossen ist, sind auf der rechten Bildschirmseite nicht nur die Angaben aus dem Standard angegeben, sondern auch der Verweis zum XRepository, mit Link zur entsprechend eingebundenen Codeliste. Aufgrund dieser Verbindung ist, je nach Nutzungsart, bereits die aktuelle Codelistenversion und Kennung in den Metadaten der Codeliste vorausgefüllt.

Folgende Profilierungsmöglichkeiten bestehen, je nach Nutzungsart:

  • Nutzungsart 1: Die Codelistenversion und Codelistenkennung sind nicht editierbar.

  • Nutzungsart 2: Die Codelistenversion und Codelistenkennung sind nicht editierbar.

  • Nutzungsart 3: Die Codelistenversion ist editierbar, die Codelistenkennung ist nicht editierbar.

  • Nutzungsart 4: Die Codelistenversion und Codelistenkennung sind editierbar.

4.9.2. Einschränkung der Codelistenwerte

In diesem Bereich können Codelistenwerte eingeschränkt werden. Über die Art der Einschränkung wird bestimmt ob:

  • Zulässige Codelistenwerte: nur angegebe Codelistenwerte sind erlaubt.

  • Ausgeschlossene Codelistenwerte: Alle Codelistenwerte sind erlaubt, bis auf die angegebenen.

Sollten bereits Codelistenwerte auf Nachrichtenebene profiliert sein und das profilierte Datentypprofil wird der Nachricht zugewiesen, so überschreibt die Eingabe aus dem Datentypprofil immer die Eingabe aus dem Nachrichtenelement.

4.10. Rekursive Datentypprofile

Rekursion-Icon
Figure 9. Rekursion-Icon

Rekursive Datentypprofile sind durch ein Unendlich-Icon in der Baumnavigation gekennzeichnet.

Rekursive Elemente lassen sich zusätzlich in ihrer Rekursionstiefe einschränken. Durch die Eingabe einer Zahl, kann die Rekursionstiefe festgelegt werden. Darüber hinaus ist es möglich eine Beschreibung der Rekursionstiefe anzugeben.

4.11. simple Datentypen

Simple Datentypprofile haben keine aufklappbare Navigation auf der linken Bildschirmseite. Die Profilierungsmöglichkeiten sind deutlich eingeschränkter als bei komplexen Datentypen oder Datentypen vom Typ Codeliste.

4.12. komplexe Datentypen

Alle Datentypen, die weder simple, noch Codelisten, noch rekursive Datentypen sind, werden auch als komplexe Datentypen bezeichnet. Dies gilt für die überwiegende Mehrheit der Datentypen.

5. Nachrichtenstrukturen

5.1. Nachrichtenelemente aufrufen und filtern

Über die Navigation auf der linken Bildschirmseite lässt sich durch die Nachrichtenelemente navigieren. Die Suche im oberen Bereich erleichtert das Finden von Elementen. Im unteren Bereich der Navigation lassen sich Filter für den Navigationsbaum definieren. Der Toggle "Profilierte Elemente anzeigen" Filtert den Navigationsbaum nach Elementen, die profiliert wurden. Alle nicht profilierten Elemente werden ausgeblendet. Per Klick auf die Elemente im Baum, öffnet sich der Bearbeitungsbereich im rechten Bildschirmbereich.

5.2. Nachrichtenelementen Datentypprofile zuweisen

Neben dem Elementnamen ganz oben, wird der Datentyp in blau angezeigt. Per Klick kann hier direkt in den Datentypen gesprungen werden. Ist für ein Nachrichtenelement ein Datentypprofil angelegt, so ist dies über das Stift-Icon über der Beschreibung zu erkennen. Bei Klick auf das Stift-Icon öffnet sich ein Dropdown und vorhandene Datentypprofilierungen können zugewiesen werden.

Wurde ein profilierter Datentyp ausgewählt, sind alle Kindknoten nicht mehr editierbar. Dies wird auch in der Navigation durch ein Schloss-Icon kenntlich gemacht. .Gesperrt-Icon image::gesperrt-icon.svg[Gesperrt-Icon, 70, 50]

Dies wird in der Navigation durch ein ausgrauen des Teilbaums und ein kleines Schloss-Icon visualisiert. Die Kindknoten sind jedoch in der Leseansicht einsehbar.

Weisen Sie einem Elternelement ein profiliertes Datentypprofil zu, so öffnet sich eine Warnung. Bei der Profilierung von Elternelementen werden die Änderungen an Kindknoten zurückgesetzt.

5.3. Nachrichtenelemente zurücksetzen

Im Bereich Nachrichtenstrukturen befindet sich unterhalb des Speichern-Buttons ein Zurücksetzen-Icon. Ist ein Nachrichtenelement ausgewählt und wurden Profilierungen vorgenommen, so können alle vorgenommenen Änderungen am Element durch Klick auf dieses Icon gleichzeitig zurückgesetzt werden.

Falls ein Datentypprofil eingebunden ist, wird auch dieses aus dem geöffneten Nachrichtenelement entfernt und durch die Angabe aus dem Standard ersetzt.

5.4. Nachrichtenelemente einschränken

Im Bearbeitungsbereich, auf der rechten Bildschirmseite der Anwendung, lassen sich die Attribute der Nachrichtenelemente entsprechend befüllen. Die Angaben aus dem Standard sind am rechten Bildschirmrand dargestellt. Über die Kardinalität kann angegeben werden ob das Nachrichtenelement Teil der Profilierung sein soll und/oder wie oft es eingebunden werden soll. Je nach Angabe aus dem Standard kann hier entsprechend profiliert werden

Folgende Informationen können über die Eingabefelder "Beschreibung" und "Umsetzungshinweis" abgebildet werden:

  • Konkretisierung der semantischen Bedeutung: Die Konkretisierung einzelner Begrifflichkeiten oder semantischer Konzepte eines Standards. Dies ist beispielsweise mittels Konkretisierung einer Elementbeschreibung des Standards möglich.

  • Ergänzung um Synonyme: Nutzung von Synonymen zu den Begrifflichkeiten des zugrundeliegenden Standards. Beispiele für Synonyme sind die Zuordnung der länder- oder fachbereichsspezifischen Terminologie zu der im zu profilierenden Standard verwendeten Terminologie.

  • Ergänzung um erläuternde Informationen: Hinzufügen eines erläuternden Textes, der beispielsweise erklärt, wie ein Informationselement in einem bestimmten Anwendungsfall zu verwenden ist. Ein solcher Text darf die ursprüngliche semantische Definition des Elements nicht verändern.

5.4.1. Kardinalität:

Über die Kardinalität kann angegeben werden ob das Element Teil der Profilierung sein soll und/oder wie oft es eingebunden wird.

Folgende Informationen können über die Kardinalität abgebildet werden:

  • Nutzung optionaler Informationselemente ausschließen (0..n zu 0..0): Mit der Einschränkung der Multiplizität von 0..n zu 0..0 wird die Nutzung eines optionalen Informationselements verboten.

  • Nutzung optionaler Informationselemente fordern (0..n zu 1..n): Wenn ein optionales Informationselement obligatorisch wird, wird damit eine Option seiner ursprünglich vorgesehenen Verwendung vorgegeben.

  • Anzahl möglicher Wiederholungen einschränken (x..n zu x..1, mit x gleich 0 oder 1): Die Anzahl möglicher Wiederholungen wird beispielsweise von 1..n auf 1..1 verringert.

5.4.2. Einschränkung der Werte

Hier können Defaultwert und Beispiel-Wert für das Element profiliert werden.

Ist der Fixed-Wert gesetzt, sollte kein Defaultwert, Beispiel-Wert oder Wert für Beispielnachrichten vergeben werden sein.

5.5. Nachrichtenelemente vom Typ Codeliste

Codeliste-Icon
Figure 10. Codeliste-Icon

Nachrichtenelemente vom Typ CodeType lassen sich ähnlich wie andere Elemente in der Anwendung profilieren. Sie sind durch ein graues quadratisches Icon in der Navigation gekennzeichnet. Zusätzlich bieten sie weitere Profilierungsmöglichkeiten.

Folgende Informationen können über die Eingaben zu den Metadaten einer Codeliste angegeben werden:

  • zu verwendende Codeliste konkretisieren: Wird durch den Standard nur eine Codeliste und nicht deren konkrete Version vorgegeben, so kann die Vorgabe einer Version erfolgen (Nutzungstyp 3 zu 2). Wird durch den Standard nur die Verwendung einer Codeliste vorgegeben, aber keine konkrete Codeliste vorgegeben, so kann eine konkrete Codeliste und eine konkrete Version zur verbindlichen Nutzung in der Profilierung benannt werden (Nutzungstyp 4 zu 3 oder 2).

  • Codes ausschließen: Einschränkung der zur Übermittlung vorgesehenen Codes einer Codeliste.

  • Codes konkretisieren: Die semantische Konkretisierung eines Codelisteneintrags ist als semantische Einschränkung der ursprünglichen Bedeutung zu verstehen.

5.5.1. Metadaten der Codeliste

Je nach Nutzungsart der Codeliste können die Attribute Codelistenversion, Codelistenkennung und Nutzungsart editiert werden. Die Nutzungsart ergibt sich aus der Angabe des Standards. Da die Anwendung an das XRepository angeschlossen ist, sind auf der rechten Bildschirmseite nicht nur die Angaben aus dem Standard angegeben, sondern auch der Verweis zum XRepository, mit Link zur entsprechend eingebundenen Codeliste. Aufgrund dieser Verbindung ist, je nach Nutzungsart, bereits die aktuelle Codelistenversion und Kennung in den Metadaten der Codeliste vorausgefüllt.

Folgende Profilierungsmöglichkeiten bestehen, je nach Nutzungsart:

  • Nutzungsart 1: Die Codelistenversion und Codelistenkennung sind nicht editierbar.

  • Nutzungsart 2: Die Codelistenversion und Codelistenkennung sind nicht editierbar.

  • Nutzungsart 3: Die Codelistenversion ist editierbar, die Codelistenkennung ist nicht editierbar.

  • Nutzungsart 4: Die Codelistenversion und Codelistenkennung sind editierbar.

5.5.2. Einschränkung der Codelistenwerte

In diesem Bereich können Codelistenwerte eingeschränkt werden. Über die Art der Einschränkung wird bestimmt ob: - Zulässige Codelistenwerte: nur angegebe Codelistenwerte sind erlaubt. - Ausgeschlossene Codelistenwerte: Alle Codelistenwerte sind erlaubt, bis auf die angegebenen.

Wird in das Nachrichtenelement ein Datentypprofil mit eingeschränkten Codelistenwerten eingebunden, so werden die eingeschränkten Werte des Nachrichtenelements durch die des Datentypprofils überschrieben.

5.6. Rekursive Nachrichtenelemente

Rekursion-Icon
Figure 11. Rekursion-Icon

Rekursive Nachrichtenelemente sind durch ein Unendlich-Icon in der Baumnavigation gekennzeichnet.

Rekursive Elemente lassen sich zusätzlich in ihrer Rekursionstiefe einschränken. Durch die Eingabe einer Zahl, kann die Rekursionstiefe festgelegt werden. Darüber hinaus ist es möglich eine Beschreibung der Rekursionstiefe anzugeben.

5.7. simple Datentypen

Simple Datentypprofile lassen sich in den Basisattributen ähnlich wie Codelisten oder komplexe Datentypprofile in Nachrichtenelemente einbinden und auch profilieren.

5.8. Nachrichtenelemente vom Typ Choice

Choice-Icon
Figure 12. Choice-Icon

Diese Nachrichtenelemente sind in der Navigation durch ein graues Verzweigungs-Icon gekennzeichnet. Die Profilierung erfolgt adequat zur Profilierung komplexer Datentypen

5.9. komplexe Nachrichtenelemente

Alle Nachrichtenelemente, die weder simple, noch Codelisten, noch rekursive Nachrichtenelemente sind, werden auch als komplexe Nachrichtenelemente bezeichnet.

5.10. Eigene Eigenschaften

Die im Bereich "Projekt" der Anwendung definierten eigenen Eigenschaften können hier eingebunden werden. Sie dienen als Ergänzung zu den bereits vorhandenen Attributen aus dem Standard. Nach dem befüllen der Eingabefelder, kann die Eigenschaft über das + Icon hinzugefügt werden. Über das Stift-Icon kann die Eigenschaft editiert werden. Durch betätigen des Mülleimer-Icons wird die Eigenschaft entfernt.

6. Dokumentation

Die Profilierungsdokumentation ist auf Basis von asciidoctor geschrieben. Einen Einstieg in dieses Dokumentationsformat ist hier zu finden: Asciidoctor

6.1. Struktur der Dokumentation anzeigen, durchsuchen, sortieren und bearbeiten

Im linken Bildschirmbereich wird die Struktur der Dokumentation angezeigt. Über das Suchfeld kann diese durchsucht werden. Per drag&drop lässt sich die Reihenfolge der Sortierung anpassen. In der Navigation der Dokumentation sind manche Punkte als "(generiert)" gekennzeichnet. Das sind Kapitel die auf Basis der Profilierung, während der Arbeit in der Anwendung automatisch generiert werden. Sie sind nicht editierbar.

6.1.1. Plus-Icon

Über das Plus-Icon lassen sich neue Kapitel in der Dokumentation anlegen.

6.1.2. Mülleimer-Icon

Durch das betätigen des Mülleimer-Icons lässt sich das ausgewählte Kaptiel aus der Dokumentation entfernen.

6.1.3. Zanhrad-Icon

Über das Zahnrad-Icon lässt sich die Dokumentation konfigurieren. per Default sind alle Nachrichten Teil der Dokumentation. Über die Konfigurationsansicht können Anpassungen vorgenommen werden.

6.1.4. Versteckte Kapitel

Das Toggle "Versteckte Kapitel" blendet in der Navigation die Konfigurationsdatei sowie die Dokumentattribute ein.

6.2. Bearbeitbare Inhalte der Dokumentation anzeigen und bearbeiten

Die Profilierungsdokumentation ist auf Basis von asciidoctor geschrieben. Einen Einstieg in dieses Dokumentationsformat ist hier zu finden: Asciidoctor

Im rechten Bildschirmbereich kann die Bearbeitung der Dokumentation vorgenommen werden. Über die Schaltflächen Bearbeitung und Preview kann zwischen dem Bearbeitungsmodus und der Vorschau des fertigen Dokuments gewechselt werden. Eingaben im Bearbeitungsmodus werden beim Umschalten in den Previewmodus direkt übernommen und visualisiert. Inhalte, die von der Dokumentation des Standards abweichen, werden gelb hervorgehoben.

6.3. PDF-Download der Dokumentation

Im Bearbeitungsbereich, unter dem Speichern-Button befindet sich ein Downloadsymbol. Per Klick lässt sich darüber die Dokumentation als PDF generieren und herunterladen.

Je nach profiliertem Standard kann dies auf Grund der umfangreichen Seitenzahl einige Augenblicke dauern.

6.4. Gesamtvorschau-Toggle

Mit diesem Schalter wählen Sie aus, ob die Vorschau der gesamten Dokumentation angezeigt wird, oder nur die Vorschau des jeweils ausgewählten Abschnitts.

7. Beispielnachricht

7.1. Beispielnachricht öffnen

Um eine vorhandene Beispielnachricht mit Hilfe der XÖV-Suite zu verwenden, kann über den Button oben Links "Nachricht öffnen" ein Upload-Dialog geöffnet werden. Es erscheint ein Fenster. In dieses Fenster kann per drag&drop eine entsprechende Beispielnachricht gezogen werden. Alternativ kann per klick in den grauen Kasten der Dateiexplorer des eigenen PCs aufgerufen werden. Nachdem eine Datei erfolgreich ausgewählt werden konnte, kann über die blaue Schalfläche rechts unten im Dialog, "Hochladen", die ausgewählte Nachricht in die Anwendung geladen werden.

7.2. Beispielnachricht generieren

Auf Basis der Profilierung in der XÖV-Suite kann eine Beispielnachricht erzeugt werden. Über den Button oben Links "Nachricht generieren" wird ein Dialogfenster zur "Konfiguration der Nachrichtenerzeugung" geöffnet. In dieser Ansicht kann konfiguriert werden, welche Nachrichten Teil der Beispielnachricht sein sollen. Die Suchfunktion erleichtert die Auswahl aus der Liste an möglichen Einträgen. Über den Toggle "Nur eingeschränkte Nachrichten anzeigen" kann das Ergebnis der Auflistung auf die in der XÖV-Suite profilierten Einträge reduziert werden.

7.3. Nachrichtenübersicht

In der Nachrichtenübersicht werden alle hochgeladenen oder generierten Nachrichten abgebildet.

7.4. Validierungsbericht

Auf der rechten Bildschirmseite finden Sie in der tabellarischen Auflistung der Nachrichtenübersicht, die Spalte "Validierungsbericht". Hier haben Sie die Möglichkeit per Klick auf das Icon den Validierungsreport der jeweiligen Nachrichten zu öffnen. Sollten die Nachricht Validierungsfehler oder -warnungen enthalten, so werden diese hier angezeigt. Neben dem Icon für den Validierungsreport gibt es noch das Dreipunktmenü mit weiterführenden Optionen.

7.5. Dreipunktmenü

Auf der rechten Bildschirmseite finden Sie in der tabellarischen Auflistung der Nachrichtenübersicht, die Spalte "Validierungsbericht". Per Klick auf das Icon mit den drei Punkten (Dreipunktmenü) haben Sie weitere Optionen:

  • Den Validierungsbericht herunterzuladen.

  • Die Nachricht herunterladen.

  • Die Nachricht aus de XÖV-Suite löschen.

7.6. Einzelansicht Beispielnachricht

Sobald eine Beispielnachricht in der Nachrichtenübersicht geöffnet ist, kann sie per Klick auf den blau hinterlegten "Dateinamen", in der tabellarischen Auflistung, geöffnet werden. Ist die Beispielnachricht geöffnet, erscheint Sie als Tab in der Leiste über der tabellarischen Auflistung.

Die geöffneten Tabs können über den Button ganz rechts in der Leiste alle gleichzeitig geschlossen werden.

Per Klick auf das Tab einer Beispielnachricht gelangen Sie in die Einzelansicht einer Beispielnachricht. Hier können Sie auf der linken Bildschirmseite die Nachrichtenstruktur der Nachricht einsehen. Auf der rechten Seite können Sie die Angaben aus der Profilierung einsehen und entsprechend kopieren.

Eine Bearbeitung der Beispielnachricht ist an dieser Stelle nicht möglich.