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):