Plug-in inovatgtm. Betriebshandbuch Diagnosehandbuch

Transkript

1 Seite: 1 von 18 Betriebshandbuch Diagnosehandbuch Version 2.0 Stand Produktzustand Datei akzeptiert BetrInf_BuV-PlugIn-_FREI_V2.0_D docx Projektkoordinator Projektleiter Projektträger Herr Issleb Herr Franz Niedersächsische Straßenbau und Verkehr Göttinger Chaussee 76 A Hannover Ansprechpartner Herr Franz

2 Seite: 2 von 18 0 Allgemeines 0.1 Verteiler Organisationseinheit Name Anzahl Kopien Vermerk PG NI-DAUZ inovat Herr Franz Herr Issleb Herr Schmädecke Herr Kniß 0.2 Änderungsübersicht Version Datum Kapitel Bemerkungen Bearbeiter alle Erstellung L. G. Givorgizova (inovat) alle Schlussredaktion H. C. Kniß (HCK), inovat Anpassung Namenskonvention NERZ H. C. Kniß (HCK), inovat

3 Seite: 3 von Inhaltsverzeichnis 0 Allgemeines Verteiler Änderungsübersicht Inhaltsverzeichnis Abkürzungsverzeichnis Definitionen Referenzierte Dokumente Abbildungsverzeichnis Tabellenverzeichnis Zweck des Dokuments Betriebshandbuch Installation der Software Erstinstallation Voraussetzungen Durchführung Kontrolle der Installation Deinstallation Voraussetzung Durchführung Kontrolle der Deinstallation Aktualisierung Konfiguration und Aufnahme des Betriebs Konfiguration des Features Konfiguration für dynamische Objekte Parametrierung Startparameter Einbindung in das Rahmenwerk Vorgehensweise Verfügbare Aktionen Berechtigungen Überwachung des Betriebs Unterbrechung oder Beendigung des Betriebs Diagnosehandbuch Diagnose über das interne Fehleransicht des Rahmenwerks Ausgabe in Log-Dateien OSGI-Console... 18

4 Seite: 4 von Abkürzungsverzeichnis Siehe [AbkV]. Darüber hinaus werden folgende Abkürzungen verwendet: BSVRZ DaV-DaV-Kopplung App-DaV-Kopplung Basis-System Verkehrsrechnerzentralen Datenverteiler-Datenverteiler-Kopplung Applikations- Datenverteiler -Kopplung 0.5 Definitionen keine 0.6 Referenzierte Dokumente AbkV AFoBLAK SysArcBLAK TAnfGlobalBLAK DatKat AFoNiDAUZ BetrHbKSW BetrHbStartStopp Abkürzungsverzeichnis zum Projekt VIZ Anwenderforderungen zum VRZ-Basissystem gemäß BLAK-VRZ, aktueller Stand SE AFo Systemarchitektur zum VRZ-Basissystem gemäß BLAK-VRZ, aktueller Stand SE SysArc Technische Anforderungen zum VRZ-Basissystem gemäß BLAK- VRZ, aktueller Stand SE TAnf-x.0 Datenkatalog des BSVRZ, aktueller Stand, verfügbar als navigierbare HTML-Version Anwenderforderungen zur DAUZ Niedersachsen, aktueller Stand AFo_NI-DAUZ.doc Betriebshandbuch zur Installation der Kernsoftware Betriebshandbuch zur SWE StartStopp, aktueller Stand Betr- Inf_SWE10.1_LosC3_VRZ3.doc 0.7 Abbildungsverzeichnis Abbildung 2-1: Installationsdialog des Rahmenwerks... 8 Abbildung 2-2: Liste der Updatesiten verwalten... 9 Abbildung 2-3: Hinzufügen einer Installationsquelle... 9 Abbildung 2-4: Präsentation der installierbaren Module Abbildung 2-5: Über-Dialog Abbildung 2-6: About-Dialog Abbildung 2-7: Dialog Installation Details Abbildung 2-8: Dialog Installation Details Abbildung 2-9: Oberflächenelemente des Features für den Menüeditor... 15

5 Seite: 5 von 18 Abbildung 3-1: Fehlermeldungen Abbildung 3-2: Detailinformationen zu Fehlermeldungen Tabellenverzeichnis Tabelle 1-1: Typographie... 6 Tabelle 1-2: Konventionen... 6 Tabelle 2-1: Aktionen für Ansichten... 16

6 Seite: 6 von 18 1 Zweck des Dokuments In diesem Dokument sind die zwei Bestandteile der Betriebsinformation aus Gründen der Übersichtlichkeit zusammengefasst: Betriebshandbuch Diagnosehandbuch Folgende Typographie wird verwendet: Maschinenschrift kursiv Maschinenschrift Namen von Dateien, Ordnern und Benutzern 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 Tabelle 1-1: Typographie Folgende Konventionen werden festgelegt: Rahmenwerkverzeichnis Das Verzeichnis, in dem das Rahmenwerk installiert ist Tabelle 1-2: Konventionen

7 Seite: 7 von 18 2 Betriebshandbuch 2.1 Installation der Software Dieser Abschnitt beschreibt die Neuinstallation, die Aktualisierung und die Deinstallation der SWE. Die SWE wird als ZIP-Archiv ausgeliefert, dessen Dateiname dem Muster de.inovat.buv.gtm.feature v1.0.0-r99.zip entspricht (Datum, Uhrzeit, Version und Revision des Builds entsprechen dem aktuellen Stand) Erstinstallation Voraussetzungen Die Erstinstallation der Software erfolgt über den Installationsmechanismus des Rahmenwerks. Das Rahmenwerk stellt eine Aktion Installation zur Verfügung, die in das Menü der Applikation einzubinden ist. Wie das erfolgt, ist im Handbuch des Rahmenwerks beschrieben. Die zu installierenden Softwarekomponenten werden als Archivdatei oder als Updateseite bereitgestellt Durchführung Die Installation wird über das Rahmenwerk durchgeführt. Wenn man das Rahmenwerk im Offline- Modus startet, wird das Standard-Menü geladen. Der Menüpunkt Hilfe -> Installation öffnet den Installationsdialog des Rahmenwerks:

8 Seite: 8 von 18 Abbildung 2-1: Installationsdialog des Rahmenwerks Um die abhängigen Plug-ins mitzuinstallieren muss man die Eclipse-Updatesite in der Liste der verfügbaren Updatesiten aktivieren und die Updatesite von Bitctrl hinzufügen. Das passiert im Dialog 'Preferences'. Den Dialog kann man über den Link 'Available Software Sites' oder den Menüpunkt Bearbeiten -> Präferenzen öffnen.

9 Seite: 9 von 18 Abbildung 2-2: Liste der Updatesiten verwalten Im Installation-Dialog muss jetzt die Installationsquelle für die Software in der Auswahlliste 'Work with' ausgewählt werden. Die Quelle ist entweder die oben beschriebene ZIP-Datei, auf die über das Dateisystem zugegriffen werden kann oder eine öffentliche oder vom Betreiber zur Verfügung gestellte zentrale Aktualisierungs-Seite. Wenn die Quelle in der Auswahlliste noch nicht zur Verfügung steht, kann diese über die Schaltfläche 'Add...' oder über den Link 'Available Software Sites' hinzugefügt werden. Abbildung 2-3: Hinzufügen einer Installationsquelle In dem jetzt angezeigten Dialog wird entweder die ZIP-Datei als 'Archive ' im Dateisystem ausgewählt oder die URL bzw. der Dateipfad für eine zentrale Aktualisierungsseite angegeben. Wenn eine Installationsquelle ausgewählt wurde, wird deren Inhalt präsentiert:

10 Seite: 10 von 18 Abbildung 2-4: Präsentation der installierbaren Module Nach der Auswahl der zu installierenden Komponenten und Betätigen der Schaltfläche 'Next' wird überprüft, ob eine Installation ausgeführt werden kann. Im folgenden Dialog werden alle installierbaren Komponenten angezeigt. Wenn eine Installation nicht möglich ist wird dies entsprechend visualisiert. Die Installation wird in der Regel abgelehnt, wenn die erforderlichen Komponenten nicht auf den bekannten Update-Seiten gefunden werden konnten. Eine entsprechende Erläuterung erscheint im Textfeld im unteren Bereich des Dialogs. Im Fehlerfall können nicht installierbare Komponenten abgewählt werden und die Installation für die anderen wird fortgesetzt. Anderenfalls müssen zusätzliche Installationsquellen wie oben beschrieben im System integriert werden. Wenn eine Installation möglich ist, erfolgt gegebenenfalls noch eine Abfrage zur Bestätigung der gültigen Lizenzbestimmungen. Dann erfolgt die Installation, nach der in der Regel ein Neustart der Anwendung erfolgen sollte.

11 Seite: 11 von Kontrolle der Installation Nach erfolgreicher Installation und dem Neustart des Rahmenwerks (im Offline-Modus) kann die Liste der installierten Softwaren über den Menüpunkt Hilfe -> Über überprüft werden. Die Aktion öffnet den folgenden Dialog: Abbildung 2-5: Über-Dialog Über die Schaltfläche 'inovat' wird About-Dialog mit der Information zur installierten Feature geöffnet:

12 Seite: 12 von 18 Abbildung 2-6: About-Dialog Alternativ kann man über die Schaltfläche 'Installation Details' im Reiter 'Installed Software' die Liste der installierten Softwaren anzeigen lassen, in der auch Feature erscheinen muss: Abbildung 2-7: Dialog Installation Details

13 2.1.2 Deinstallation Seite: 13 von Voraussetzung Die Deinstallation eine Softwarekomponente erfolgt über den 'Über'-Dialog des Rahmenwerks, d. h. die Aktion 'Über' muss im Rahmenwerksmenü eingebunden sein Durchführung Die Aktion 'Über' wird ausgeführt. Im Dialog wird über die Schaltfläche 'Installation Details' im Reiter 'Installed Software' die Liste der installierten Softwarekomponenten geöffnet. Die zu deinstallierende Komponente wird ausgewählt und über die Schaltfläche 'Uninstall' entfernt Kontrolle der Deinstallation Abbildung 2-8: Dialog Installation Details Die Kontrolle der Deinstallation entspricht der Kontrolle der Erstinstallation Aktualisierung Die Aktualisierung erfolgt auf die gleiche Weise wie die Erstinstallation. In der Liste der zu installierenden Softwarekomponenten wird gegebenenfalls darauf hingewiesen, dass keine Installation sondern eine Aktualisierung erfolgt. Alternativ kann die Rahmenwerks-Aktion 'Aktualisierung' eingebunden werden, die auf allen bekannten Installationsseiten nach Aktualisierungen für alle installierten Plug-ins sucht und das Ergebnis in einer Liste präsentiert, in der dann optional die tatsächlich zu aktualisierenden Komponenten ausgewählt werden können. Ansonsten entspricht die Vorgehensweise der Installation. 2.2 Konfiguration und Aufnahme des Betriebs Konfiguration des Features Eine Konfiguration des Features selbst ist nicht notwendig, das Feature wird beim Start des Rahmenwerks automatisch erkannt. Ordner ProjektResource Vor dem Start der Anwendung kann man im Root-Ordner des Rahmenwerks einen Ordner ProjektResource für die projektspezifischen Dateien erstellen. Der wird von manchen inovat-plugins (zum Beispiel Plugin Rechteverwaltung oder Feature LZZS) gebraucht. Für jedes Bundesland werden eigenen Unterordner mit dem Kürzelnamen erstellt. Das Bundesland wird über den Aufrufparameter bundesland bestimmt. Falls der Parameter nicht gesetzt wird, wird als bundesspezifischer Unterordner AA verwendet.

14 Seite: 14 von 18 Präferenzen Über die Präferenz inovat -> Datei Speicherstelle wird der Projektausgabeordner angegeben. In diesem Ordner wird der Ordner <Projektname>_Ausgabe mit Unterordnern für die Bundesländer erstellt, wo verschiede Ausgabedateien abgelegt werden können. Der Benutzer muss die Schreiberechte für den Projektausgabeordner haben Konfiguration für dynamische Objekte -entfällt Parametrierung -entfällt Startparameter Die SWE kennt folgende Startparameter (zusätzlich zu den Standardparametern für Applikationen mit DaV-Verbindung): berechtigungskonzept Der Rahmenwerk-Aufrufparameter legt fest, ob das Berechtigunskonzept eingeschaltet werden soll. Als Standardwert wird false verwendet. Parameterbeispiel: -berechtigungskonzept=true oberflaechenobjekt Der Rahmenwerk-Aufrufparameter definiert die PID des Oberflächenobjekts. Parameter muss definiert werden, falls das Berechtigunskonzepr eingeschaltet ist. Parameterbeispiel: -oberflaechenobjekt=kv.aoe.ni.dauz davsystemobjektevorladen Der Rahmenwerk-Aufrufparameter. Parameterbeispiel: -davsystemobjektevorladen=true bundesland Der Aufrufparameter definiert das Bundesland. Als Wert ist das Bundeslandkürzel zu verwenden. Der Standardwert ist unbekannt. Mit jedem Bundesland ist ein Unterordner im Ordner ProjektResource verknüpfet, wo bundesspezifische Dateien abgelegt sind. Dem unbekannten Bundesland entspricht der Ordner AA. Parameterbeispiel: -bundesland=ni bundeslandlogo Der Aufrufparameter definiert das Bundesland-Logo, das das Standardlogo des Bundeslandes ersetzt. Parameterbeispiel: -bundeslandlogo=d:\resource\logo.png resourceordner Der Aufrufparameter definiert den alternativen Pfad zum Ordner ProjektResource. Falls der Ordner ProjektResource im Rahmenwerkverzeichnis nicht gefunden wird, wird der weiter im angegeben Pfad gesucht. Parameterbeispiel: -resourceordner=d:\dateien defaultbenutzerordner Der Aufrufparameter definiert den Default-Ordner für Projektausgabedateien. Der Standardwert ist für Nordrheinwestfalen D:\, für Niedersachsen U:\ und für die anderen Bundesländer-Home-Verzeichnis des Benutzers. Der Projektausgabeordner wird in der Präferenz inovat -> Datei Speicherstelle festgelegt und für jeden Benutzer gespeichert. Falls der Ordner noch nicht gespeichert ist, wird der Default-Ordner aus dem Aufrufparameter verwendet. Parameterbeispiel: -defaultbenutzerordner =d:\dateien

15 Seite: 15 von 18 projektname Der Aufrufparameter definiert den Projektnamen. Der Standardwert ist inovatprojekt. Der in der Präferenz angegebene Projektausgabeordner wird mit dem Projektname ergänzt. Parameterbeispiel: -projektname=ni-dauz menuexmldatei Der Rahmenwerk-Aufrufparameter definiert die Datei mit dem Rahmenwerkmenü. Dieses Menü wird geladen, falls kein Menü über Rahmenwerkspeicherverwaltung ermittelbar ist. Parameterbeispiel: -menuexmldatei=.\projektresource\ni\menu\menunidauz.xml symbolxmldatei Der Rahmenwerk-Aufrufparameter definiert die Datei mit der Rahmenwerksymbolleiste. Diese Symbolleiste wird geladen, falls keine Symbolleiste über Rahmenwerkspeicherverwaltung ermittelbar ist. Parameterbeispiel: - symbolxmldatei=.\projektresource\ni\menu\symbolleistenidauz.xml Einbindung in das Rahmenwerk Vorgehensweise Alle wesentlichen Bedienelemente dieses Plug-ins sind mit dem Rahmenwerk über IDs verknüpft. Diese IDs ermöglichen die Einbindung der Bedienelemente (Ansichten, Aktionen aus Menüs) in neu gestaltete Menüs bzw. Taskleisten. Die Gestaltung erfolgt über die Perspektive 'Menüeditor' des Rahmenwerks. Die ID aller dem Rahmenwerk zur Verfügung stehenden Bedienelemente des Features beginnt stets mit de.inovat.buv.gtm... Abbildung 2-9: Oberflächenelemente des Features für den Menüeditor Verfügbare Aktionen Folgende Aktionen werden durch das Feature zur Verfügung gestellt. Die ID der Aktion hat jeweils den Präfix: mit de.inovat.buv.gtm. ID Bezeichnung Aktion de.inovat.buv.gtm.filter Filter Öffnet die Sicht für die Filterverwaltung de.inovat.buv.gtm.sortierung Sortieren Öffnet die Sicht für die Sortierverwaltung de.inovat.buv.gtm.tabellendarstellung de.inovat.buv.gtm.tabellenverwaltung de.inovat.buv.gtm.spaltenauswahl Spaltenauswahl Öffnet die Sicht Spaltenverwaltung Tabellendarstellung Tabellenverwaltung Öffnet die Sicht mit der Tabellendarstellung Öffnet die Sicht für die Tabellenverwaltung

16 Tabelle 2-1: Aktionen für Ansichten Seite: 16 von Berechtigungen Die Berechtigung für einzelne Funktionalitäten wird über das allgemeine Berechtigungskonzept des Rahmenwerkes realisiert. Die Funktionen werden innerhalb des Rahmenwerkes registriert und können über den Oberflächenberechtigungsparameter des verwendeten Oberflächenobjekts parametriert (freigegeben/gesperrt) werden. Die IDs für die Berechtigungsfunktionen sind identisch mit den IDs für die Rahmenwerkaktionen (s. Tabelle 2-1). 2.3 Überwachung des Betriebs Eine spezielle Überwachung ist für ein Feature nicht erforderlich. Die Funktionsfähigkeit ergibt sich aus der Anwendung in der Rahmenwerksapplikation. 2.4 Unterbrechung oder Beendigung des Betriebs Eine explizite Unterbrechung bzw. Beendigung der SWE ist nicht vorgesehen.

17 Seite: 17 von 18 3 Diagnosehandbuch 3.1 Diagnose über das interne Fehleransicht des Rahmenwerks Alle Fehler und Warnungen des Features werden an den internen Logger des Eclipse-Frameworks weitergeleitet. Die Ausgaben können mit dem integrierten 'Error Log', der im Rahmenwerk integriert ist, beobachtet werden. Abbildung 3-1: Fehlermeldungen Eine genauere Beschreibung ist im Handbuch des Rahmenwerks zu finden. Fehler im normalen Betrieb des Plug-ins werden dem Anwender in verständlichen Standarddialogen und Anzeigen innerhalb der Bedienoberfläche präsentiert. Die innerhalb der Fehlerliste auftretenden Probleme können verschiedenste Ursachen haben, bspw. Inkompatibilitäten von Versionen der im Rahmenwerk verknüpften Komponenten untereinander oder zum Rahmenwerk selbst. Eine genaue Auflistung potentieller Log-Meldungen ist daher hier nicht möglich. Detaillierte Informationen zu einer Fehlermeldung innerhalb der Ansicht erhält man durch Doppelklick auf den entsprechenden Eintrag. Abbildung 3-2: Detailinformationen zu Fehlermeldungen

18 Seite: 18 von 18 Der Dialog zeigt detaillierte Informationen, gegebenenfalls einen Stacktrace, der bei der Behebung des Problems hilfreich sein kann und bei Fehlermeldungen weitergegeben werden sollte. 3.2 Ausgabe in Log-Dateien Parallel zur Meldung im internen Logger des Rahmenwerks werden alle Meldungen auch in die zentrale Log-Datei des Rahmenwerkes ausgegeben: Rahmenwerkverzeichnis:\workspace\.metadata\.log. 3.3 OSGI-Console Um die generelle Funktion und Einbindung des Features zu prüfen, kann mit der zusätzlichen Startoption '-console' für das Rahmenwerk die OSGI-Konsole gestartet werden. Diese bietet die Möglichkeit, den Status des Plug-ins zu überprüfen und eventuelle Probleme zu ermitteln. Nähere Erläuterung finden sich im Benutzerhandbuch des Rahmenwerkes.