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.

1. Profilierung

1.1. Projekt neu anlegen

FunktionBeschreibung

Metadaten der Profilierung angeben

Über Dorppdown-Menüs und Freitext-Felder können Sie die Metadaten eines Profilierungsprojekts angeben.

Anlegen

Mit dem Button "Anlegen" wird ein Profilierungsprojekt erzeugt und der Bereich "Projekt" aufgerufen.

1.2. Projekt öffnen

FunktionBeschreibung

Profilierungsprojektdatei hochladen

Hier können Sie ein zuvor lokal abgespeichertes Profilierungsprojekt auswählen und mit der XÖV Suite öffnen.

1.3. Projekt

FunktionBeschreibung

Metadaten der Profilierung bearbeiten

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.

1.4. Datentypen

FunktionBeschreibung

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.

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.

Datentypprofile anzeigen und anlegen

Unter dem Punkt "Einschränkungen" lassen sich neue Datentypprofile 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.

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 können der Name, sowie die Beschreibung der Einschränkung eingesehen und editiert werden. Über die abgebildete Tabelle lässt sich die Einschränkung einer Nachricht zuweisen.

Elemente von Datentypprofilen einschränken

Über die Baumnavigation im linken Bildschirmbereich lässt sich durch die Elemente des Datentypprofils navigieren. Die Elemente sind editierbar.

Datentypprofile vom Typ CodeType

Datentypprofile vom Typ CodeType lassen sich ähnlich wie andere Datentypen in der Anwendung profilieren. Zusätzlich haben sie weitere Profilierungsmöglichkeiten.

Metadaten der Codeliste

Die Metadaten der Codeliste wie Codelistenkennung, Nutzungsart und Codelistenversion werden auf Basis der Informationen aus dem XRepository vorausgefüllt. Je nach Nutzungsart der Codeliste sind die Metainformationen Kennung und Version editierbar. Der Verweis zum XRepository auf der rechten Seite des Bearbeitungsbereichs, verweist per Link direkt auf die entsprechend eingebundene Codeliste aus dem XRepository.

Einschränkung der Codelistenwerte

In "Einschränkung der Codelistenwerte" können Codelistenwerte festgelegt werden, die von der Profilierung ausgeschlossen sind. Über die "Art der Einschränkung" wird festgelegt ob die ausgewählten Codelistenwerte zulässig sind oder von der Profilierung ausgeschlossen werden sollen.

1.5. Nachrichtenstrukturen

FunktionBeschreibung

Nachrichtenelemente aufrufen und filtern

Über die Navigation auf der linken Bildschirmseite lässt sich durch die Nachrichtenelemente navigieren.

Datentypprofile zuweisen und einschränken

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. Klickt man direkt auf das unterstrichene Datentypprofil öffnet sich die Einschränkung des entsprechenden Datentypprofils.

Nachrichtenelemente einschränken

Nachrichtenelemente können über die entsprechende Eingabemaske eingeschränkt werden.

Nachrichtenelemente als Codelisten

Codelisten lassen sich ähnlich wie andere Nachrichtenelemente in der Anwendung profilieren. Zusätzlich haben sie weitere Profilierungsmöglichkeiten.

Metadaten der Codeliste

Die Metadaten der Codeliste wie Codelistenkennung, Nutzungsart und Codelistenversion werden auf Basis der Informationen aus dem XRepository vorausgefüllt. Je nach Nutzungsart der Codeliste sind die Metainformationen Kennung und Version editierbar. Der Verweis zum XRepository auf der rechten Seite des Bearbeitungsbereichs, verweist per Link direkt auf die entsprechend eingebundene Codeliste aus dem XRepository.

Einschränkung der Codelistenwerte

In "Einschränkung der Codelistenwerte" können Codelistenwerte festgelegt werden, die von der Profilierung ausgeschlossen sind. Über die "Art der Einschränkung" wird festgelegt ob die ausgewählten Codelistenwerte zulässig sind oder von der Profilierung ausgeschlossen werden sollen.

Rekursion

Im Bereich der Nachrichtenelemente werden rekursive Strukturen durch den Einsatz eines Icons im Navigationsbaum auf der linken Bildschirmseite dargestellt. Bei allen Elementen die durch das Icon eines Pfeils im Kreis gekennzeichnet sind, besteht die Möglchkeit der Rekursion.

1.6. Dokumentation

FunktionBeschreibung

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. Über das Plus-Icon lassen sich neue Kapitel in der Dokumentation anlegen. Durch das betätigen des Mülleimer-Icons lassen sich Kaptiel der Dokumentation entfernen.

Bearbeitbare Inhalte der Dokumentation anzeigen und bearbeiten

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.

PDF-Download der Dokumentation

Im Bearbeitungsbereich, unter dem Speichern-Button befindet sich ein Dwnloadsymbol. Per Klick lässt sich darüber die Dokumentation als PDF generieren und herunterladen. Dies kann je nach Umfang der Profilierung einen Moment dauern.

Generierte Inhalte der Dokumentation anzeigen

In der Navigation der Dokumentation auf der linken Bildschirmseite, sind manche Punkte als "(generiert)" gekennzeichnet. Diese wurden vom Werkzeug automatisch erstellt.

1.7. Basisfunktionen

FunktionBeschreibung

Speichern

Im oberen rechten Bildschirmbereich ist der Speichern-Button zu finden. Dieser startet den Download der Profilierungsdatei.

Validierungsfehler

Über das Icon links neben dem Speichern-Button 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.

Aktionen rückgängig machen und widerholen

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.

Navigationszeile verwenden

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. Nachrichten

2.1. Nachricht öffnen

FunktionBeschreibung

Nachricht öffnen

Über den Button "Nachricht öffnen", in der hellblauen Leiste am oberen Bildschirmrand, lässt sich eine bereits vorhandene Beispielnachricht hochladen. Per Dialogfenster kann im Dateiexplorer entsprechend navigiert werden.

2.2. Nachrichten Generieren

FunktionBeschreibung

Nachrichten Generieren

Über den Button "Nachrichten Generieren", in der hellblauen Leiste am oberen Bildschirmrand, lässt sich eine neue Beispielnachricht generieren. Im sich öffnenden Dialogfenster können einzelne Nachrichten für die Generierung selektiert werden. Der Vorgang kann mit dem "Beispielnachricht generieren"-Button unten rechts bestätigt werden.

2.3. Nachrichtenübersicht

FunktionBeschreibung

Nachrichtenübersicht

In der Nachrichtenübersicht werden alle geöffneten und generierten Beispielnachrichten tabellarisch aufgelistet.

Validierungsbericht

In der Nachrichtenübersicht kann bei den aufgeführten Nachrichten, auf der rechten Seite per Klick auf das farbige Icon, der Validierungsbericht der Nachricht eingesehen werden.

Validierungsbericht herunterladen

In der Nachrichtenübersicht kann bei den aufgeführten Nachrichten, auf der rechten Seite per Klick auf die drei Punkte, ein Dropdown geöffnet werden. Dieser enthält weitere Funktionen, wie den Download von Validierungsberichten der Beispielnachrichten.

Dateiname

Per Klick auf den Dateinamen einer Beispielnachricht, wird diese in einem neuen Tab neben der Nachrichtenübersicht geöffnet. Hier finden sich weitere Betrachtungsperspektiven einer Nachricht. Da dieser Bereich noch nicht final umgesetzt ist, sind die Funktionen noch nicht vollständig verfügbar. Es soll jedoch ein Ausblick gegeben werden, welche Funktionalitäten hier noch zur Verfügung gestellt werden.

3. Kontakt

Für Fragen und Anregungen erreichen Sie uns unter kosit@finanzen.bremen.de