Konventionen

Folgende Typographie wird verwendet:

kursiv

Namen von Dateien, Ordnern und Benutzern

Maschinenschrift

Befehle und Texte die in der Kommandozeile oder einem graphischem Dialog eingeben werden

Maschinenschrift im Fettdruck

Teil eines Befehls oder Eingabetextes, der individuell angepasst werden muss

Folgende Konventionen werden festgelegt:

$PLUGIN

Das Verzeichnis, in dem die Plug-Ins des BuV-Rahmenwerks installiert sind.

Betriebshandbuch

Installation der Software

Dieser Abschnitt beschreibt die Neuinstallation, die Aktualisierung und die Deinstallierung des Plug-Ins DatKat2HTML. Das Plug-In wird als ZIP-Archiv ausgeliefert, dessen Dateiname dem Muster de.inovat.pat.datkat2html_X.Y.Z.zip entspricht. Wobei X der Hauptversionsnummer (major release), Y der Nebenversionsnummer (minor release) und Z der Revisionsnummer (patch level) entspricht.

Erstinstallation

Voraussetzungen

Das BuV-Rahmenwerk muss installiert und funktionstüchtig eingerichtet sein (siehe [BetrInfBuVRahmenWerk].

Durchführung

Der Inhalt des ZIP-Archivs des Plug-Ins muss in ein beliebiges Verzeichnis kopiert und entpackt werden.

Unter Unix-Systemen das ZIP-Archiv mit

unzip de.inovat.pat.datkat2html_X.Y.Z.zip

entpacken und bei Bedarf mit

cp -r plugin $PLUGIN

den Plug-In-Ordner in das gewünschte Zielverzeichnis kopieren.

Unter Windows kann ab Windows XP der Windows-Explorer sowohl für das Entpacken, als auch für das Kopieren verwendet werden. Für ältere Windows-Systeme muss ein zusätzliches Tool zum Entpacken des ZIP-Archivs verwendet werden (z. B. das kostenlose 7-Zip http://7-zip.org).

Kontrolle der Installation

Nach erfolgreicher Installation befindet sich im lokalen Dateisystem im Verzeichnis $PLUGIN die jar-Datei des Plug-Ins.

Deinstallation

Voraussetzung

Die Aktualisierung einer SWE ist ein guter Zeitpunkt, um das Backup des Projekts zu aktualisieren. Das Backup ist unbedingt erforderlich, um bei Problemen mit der neuen SWE den Zustand vor der Aktualisierung wiederherstellen zu können.

Weiterhin müssen die Voraussetzungen aus 2.1.1.1 erfüllt sein.

Durchführung

Zuerst muss kontrolliert werden, ob das Backup des Projekts erfolgreich erstellt wurde und ein Wiederherstellen möglich ist.

Anschließend wird der Ordner der alten SWE gelöscht. Unter Unix-Systemen kann der folgende Befehl verwendet werden:

rm –r $PLUGIN/de.inovat.pat.datkat2html_1.0.0.jar

Unter Windows wird der Windows-Explorer verwendet.

Kontrolle der Deinstallation

Die JAR-Datei $PLUGIN/de.inovat.pat.datkat2html_1.0.0.jar  wurde erfolgreich entfernt.

Aktualisierung

Die Aktualisierung des Plug-Ins DatKat2HTML entspricht der Deinstallation und der anschließenden Neuinstallation des Plug-Ins, siehe 2.1.2 und 2.1.1., die während des Betriebs angelegten Verzeichnisse „workspace“ und „debug“ müssen aus der Datensicherung bei Bedarf wiederhergestellt werden oder beim Entfernen nicht beseitigt werden !

Das Verzeichnis „debug“ enthält die Dateien mit den Logausgaben der Bedienoberfläche. Das Verzeichnis „workspace“ enthält nutzerspezifische lokale Einstellungen, die während des Betriebs der Visualisierung gemacht wurden.

Konfiguration und Aufnahme des Betriebs

Konfiguration

Das Plug-In DatKat2HTML kann ohne Konfiguration verwendet werden.

Das Plug-In kann ohne laufendes Kernsystem (Datenverteilerverbindung) verwendet werden.

Startparameter

Das Plug-In wertet keine Startparameter aus.

Parametrierung

Das Plug-In wertet keine Parameter (aus dem Datenverteilersystem) aus.

Aufnahme des Betriebs

Beim erstmaligen Start des BuV-Rahmenwerk nach der Installation des Plug-Ins muss zum Aufruf ein Menüeintrag und / oder ein Eintrag in die Symbolleiste erfolgen.

Die grundsätzliche Vorgehensweise dazu ist in [BetrInfBuVRahmenWerk] beschrieben.

Folgende „Action“ ist einzubinden (aus „Actions – Registrierte Oberflächenelemente):

Nach dem Eintrag in das Menü erscheint folgender Eintrag (Menüstruktur kann abweichen):

 

 

Nach dem Eintrag in eine Symbolleiste ist folgendes ICON vorhanden:      

„Error Log“ View

Zusätzlich sollte beim Betrieb des Plug-Ins der View „Error Log“ angezeigt werden, da die laufenden Meldungen in diesem View ausgegeben werden. Der „Error Log“ View ist Bestandteil des Rahmenwerks und kann über einen

·         eingerichteten Menüpunkt

·         die Tastenkombination ALT+SHIFT+Q, L

aufgerufen werden. Damit alle Meldungen des Plug-In vollständig angezeigt werden können, sollte die Begrenzung der darzustellenden Ausgaben ausgeschaltet werden. Dazu wird über das Menü des „Error Log“ View der Befehl „Filters…“ aufgerufen…

…und anschließend der Punkt „Limit visible events to:“ deaktiviert (wie nachfolgend dargestellt).

 

Überwachung des Betriebs

Entfällt.

Unterbrechung oder Beendigung des Betriebs

Voraussetzungen

Das Plug-In kann jederzeit beendet werden.

Unterbrechung des Betriebs

Eine vorübergehende Unterbrechung des Betriebs des Plug-Ins ist nicht vorgesehen.

Beenden des Betriebs

Das Plug-In wird über die entsprechenden Bedienelemente der Oberfläche beendet (Schließbutton auf dem Reiter des Views):

Anwendungshandbuch

Die nachfolgende Beschreibung der Bedienoberfläche steht in wesentlichen Teilen auch als Online-Hilfe innerhalb der Bedienoberfläche zum Plug-In zur Verfügung und ist dort über die Hilfe-Schaltflächen des Plug-In und über das Hilfe-Menü aufrufbar.

 

Gesamtfunktion

Das Werkzeug DatKat2HTML dient zur Umwandlung der Inhalte des BSVRZ-Datenkatalogs vom XML-Format in eine für den Anwender einfach lesbare und einfach navigierbare HTML-Darstellung. Die Zusammenstellung des zu konvertierenden Datenkatalogs aus einzelnen Konfigurationsbereichen erfolgt dabei über eine grafische Oberfläche. Unterschiedliche Zusammenstellung lassen sich speichern, so dass für eine erneute Konvertierung auf bestehende Zusammenstellungen zurückgegriffen werden kann.

Überblick

Nach dem Aufruf des Plug-Ins „DatKat2HTML“ öffnet sich folgender View (hier dargestellt mit dem bereits geöffneten „Error Log“ View):

 

Legende mit Linie (2) (Markierungsleiste): Navigations-
Bereich
Legende mit Linie (2) (Markierungsleiste): Dialog-
Bereich

Allgemeiner Aufbau                                         

o        Teildialog zur Verwaltung der Konvertierungsvorgaben (Verwaltung)

o        Teildialog zur Steuerung der Konvertierung (Konvertierung)

o        Teildialog zur Darstellung des erzeugten Datenkatalogs (Ansicht)

 

Navigations-/Auswahlbereich für Konvertierungsvorgaben

o        Sofern die Liste Einträge enthält, ist genau ein Eintag angewählt.           

o        Enthält die Liste mehr Einträge als gleichzeitig darstellbar sind, wird ein vertikaler Scrollbalken zur Navigation eingeblendet.   

o        Sofern die Länge der Listeneinträge breiter als die Liste ist, wird ein horizontaler Scrollbalken zur Navigation eingeblendet.

o        Die Einträge sind alphabetisch aufsteigend sortiert dargestellt.          

Dialogbereich/Verwaltung                        

Nach Auswahl des Reiters „Verwaltung“ wird für die im Navigationsbereich ausgewählte Konvertierungsvorgabe der Konvertierungsdialog entsprechend Abbildung 32 geöffnet.

Ist keine Konvertierungsvorgabe ausgewählt (es ist noch keine Vorgabe definiert), ist der Reiter automatisch ausgewählt.

 

 

Der Dialog besteht aus den drei Bereichen:

 

Bei den Allgemeinen Konvertierungseigenschaften können im Verwaltungsdialog die allgemeinen Eigenschaften der Konvertierungsvorgabe eingeben werden. Folgende Felder sind vorhanden:

 

Bei den Konfigurationsbereichen lassen sich die Konfigurationsbereiche für die Konvertierung angeben sowie die Optionen zur Konvertierung der Bereiche Modelle und/oder Objekte.

Für das Entfernen von Konfigurationsbereichen lassen die Zeilen einzeln und mehrfach anwählen.

 

Eine Zeile im Bereich "Konfigurationsbereiche" kann wie folgt bearbeitet werden:.

 

Die Schaltflächen im Abschnitt Konfigurationsbereiche haben dazu folgende Funktionen:

 

Die Schaltflächen haben folgende Funktionen:

Dialogbereich/Konvertierung

Nach Auswahl des Reiters „Konvertierung“ wird für die im Navigationsbereich ausgewählte Konvertierungsvorgabe der Konvertierungsdialog entsprechend Abbildung 33 geöffnet.

Ist keine Konvertierungsvorgabe ausgewählt (es ist noch keine Vorgabe definiert), lässt sich der Reiter nicht anwählen.

 

 

Über diesen Dialog lässt sich die Konvertierung eines Datenkatalogs auf Basis der ausgewählten Konvertierungsvorgabe ausführen und der Konvertierungsablauf verfolgen.

Der Dialog besteht aus den Bereichen:

Bei den Allgemeinen Konvertierungseigenschaften sind die im Verwaltungsdialog erstellten Eigenschaften dargestellt. Die Felder sind im Konvertierungsdialog nicht änderbar und dienen lediglich der Information.

 

Bei den Konfigurationsbereichen werden die Konfigurationsbereiche der ausgewählten Konvertierungsvorgabe tabellarisch sowohl mit ihren Eigenschaften als auch der aktuelle Zustand der Konvertierung dargestellt.

Die drei Spalten „KV“ (Konfigurationsverantwortlicher), „Konfigurationsbereich“ und „Pfad“ enthalten die entsprechenden Informationen aus der Konvertierungsvorgabe und sind nicht editierbar.

Über die beiden Spalten „Modelle“ und „Objekte“ wird dynamisch zur Laufzeit der Zustand der Konvertierung angezeigt werden. Dazu werden die folgenden Symbole verwendet (siehe Bereich Legende):

 

*

Bereich wird nicht transformiert (entsprechend Vorgabe)

*

Bereich muss noch transformiert werden (entsprechend Vorgabe)

*

Bereich wird gerade transformiert

*

Bereich wurde erfolgreich (siehe Meldungen) transformiert

Bereich wurde mit Warnungen (siehe Meldungen) transformiert

*

Bereich wurde mit Fehlern (siehe Meldungen) transformiert

 

Bei der Fortschrittsanzeige wird der Fortschritt der aktuell laufenden Konvertierung jeweils für die gesamte Konvertierung als auch für die Konvertierung des aktuellen Konfigurationsbereichs dargestellt. Zusätzlich wird im Bereich "Konfigurationsbereiche" die Zeile mit dem aktuell in Bearbeitung befindlichen Konfigurationsbereich mittels Fettdruck hervorgehoben.

 

 

Die Schaltflächen haben folgende Funktionen:

Als Meldungen werden die bei der Konvertierung auftretenden Informationen, Warnungen und Fehlermeldungen in der Standardsicht „Error-Log“ ausgegeben.

Dialogbereich/Ansicht

Nach Auswahl des Reiters „Ansicht“ wird für die im Navigationsbereich ausgewählte Konvertierungsvorgabe der Konvertierungsdialog entsprechend Abbildung 34 geöffnet.

Die Darstellung erfolgt in einem Browser mit plattformspezifischem Funktionsumfang. Dabei werden die Folgenden Elemente unterstützt:

Die Schaltflächen haben folgende Funktionen:

 

Das erzeugte Dokument hat folgenden grundsätzlichen Aufbau:

 

 

Kopfbereich     

Übersicht 

                Konfigurationsverantwortliche/Konfigurationsbereiche

                Abhängigkeitsmatrix der Konfigurationsbereiche

 

                Konfigurationsverantwortlicher

                Konfigurationsbereich

                         Modell

                                  Dokumentation

                                  Änderungsübersicht

                                  Übersicht

                                           Typ-Definitionen

                                           Mengen-Definitionen

                                           Attributgruppen-Definitionen

                                           Attributlisten-Definitionen

                                           Attributtyp-Definitionen

                                  Einzelbeschreibung

                                           Typ-Definitionen

                                           Mengen-Definitionen

                                           Attributgruppen-Definitionen

                                           Attributlisten-Definitionen

                                           Attributtyp-Definitionen

                         Objekte              

                                  Übersicht  

                                           Konfigurationsobjekte

                                  Einzelbeschreibung

                                           Konfigurationsobjekte

                                                    Datensatz

                                                    Objektmenge

                                                    Default-Parameter

 

Technische Randbedingungen

Für die Konvertierung werden die Konfigurationsbereiche aus der Voreinstellung eingelesen. Diese Konfigurationsbereiche liegen im XML-Format vor, welches der [K2SDTD] genügen muss. Die Auflösbarkeit aller Referenzen wird nicht vorausgesetzt, die Konvertierung erfolgt auch bei fehlenden Referenzen. Diese Fehler / Warnungen werden im Error Log ausgegeben und in der konvertierten HTML-Darstellung gesondert vermerkt.

Die [K2SDTD] enthält nicht nur die Definitionen zur Erstellung von Datenkatalogen des BSVRZ (Konfigurationsbereiche mit Modell- und Objektbereichen), sondern darüber hinaus aus historischen Gründen eine Vielzahl weiterer Definitionen zur Erstellung von Spezifikationsdokumenten in XML. Für die Umsetzung des Datenkatalogs in HTML werden deshalb hier nur die in der Abbildung 35 grün markierten Elemente umgesetzt, d. h. XML-Dateien die formal mit

 

<!DOCTYPE konfigurationsBereich PUBLIC "-//K2S//DTD Dokument//DE" "K2S.dtd">

 

spezifiziert sind.

 

 

 

 

Diagnosehandbuch

Benötigte Werkzeuge

Keine.

Diagnosemöglichkeiten

Analyse der Logfiles

Das Plug-In selbst erzeugt keine Meldungen im Logfile.

Online-Meldungen

Fehlermeldungen werden während des Betriebs der Visualisierung als Meldungsfenster angezeigt oder im View „Error Log“ als Multi-Meldungen angezeigt.

Die Meldungen sind ausführlich und selbsterklärend, gegebenenfalls mit entsprechenden Handlungsanweisungen.

 

Anhang

Verzeichnisstruktur

Das Plug-In besteht lediglich aus einer JAR-Datei, die sich nach der Installation im Verzeichnis $PLUGIN befindet.