DOKUMENT: TYP: ERSTELLT VON: Manual nova ratio AG Universitätsstraße 3 56070 Koblenz Deutschland VERSION: STAND: 9.x 23. September 2015
Inhaltsverzeichnis 1 2 2.1 2.2 2.3 3 3.1 3.2 3.3 4 4.1 4.2 4.3 4.4 4.5 4.6 4.7 4.8 5 5.1 5.2 5.2.1 5.2.2 5.2.3 5.3 6 6.1 6.2 6.3 Einleitung...1 Allgemeines...2 Instanzfenster...2 Menü-Navigation...3 Funktionsfenster...3 Instanzübersicht...4 Status-Liste...4 Database-Liste...5 Customer-Attribute-Liste...5 Instanzfunktionen...6 Instanzfunktion "Instance"...7 Instanzfunktion "Viewer"...7 Instanzfunktion "Editor"...8 Instanzfunktion "Start instance"...8 Instanzfunktion "Stop Instance"...9 Instanzfunktion "Abort Instance"...9 Instanzfunktion "Delete Instance"...10 Instanzfunktion "Update Instance"...10 Das Menü...11 Menüpunkt "Instances"...11 Menüpunkt "Activities"...11 Funktion "Start all"...11 Funktion "Stop all"...12 Funktion "Create instances"...12 Menüpunkt "Settings"...13 Datenbankeinstellungen...14 Nutzung der lokalen MariaDB...15 Nutzung einer Mysql-Datenbank...16 Nutzung einer Oracle-Datenbank...17 Inhaltsverzeichnis
1 Einleitung Die nova ratio AG ist der Hersteller der IT Informationsplattform erunbook. erunbook ist ein eingetragenes Markenzeichen der nova ratio AG. Die Nutzung der erunbook Software, der darauf basierenden Lösungen und aller sich darauf beziehenden Dokumente ist durch eine Lizenzvereinbarung mit der nova ratio AG reglementiert. Das vorliegende Dokument beschreibt die Nutzung der eadmin Instanz, mit der die auf der Informationsplattform erunbook aufbauenden Produkte der nova ratio AG verwaltet werden. Dazu gehören unter anderem das Erstellen und Löschen von Instanzen sowie das Starten und Stoppen von Instanzen. Je nach ausgeliefertem Produkt können Teile der Bedienoberfläche und einzelne Funktionen der eadmin Instanz aktiviert oder deaktiviert sein. Diese Dokumentation beschreibt alle möglichen Funktionen der eadmin Instanz. nova ratio AG Universitätsstraße 3 D-56070 Koblenz Deutschland Telefon: Fax: Mail: Web: +49 261 20 16 58 1 0 +49 261 20 16 58 1 19 info@nova-ratio.de www.nova-ratio.de Seite 1
2 Allgemeines 2.1 Instanzfenster Das zentrale Element der Weboberfläche der eadmin Instanz ist das Instanzfenster, in dem eine Liste aller auf dem erunbook System vorhandenen erunbook Instanzen angezeigt wird. Das Instanzfenster zeigt in Listenform alle Instanzen, welche auf dem erunbook System eingerichtet sind. Zwischen den verschiedenen Listen lässt sich über den Menüpunkt "Instances" und mit Hilfe der Select-Box "Select List" wechseln. Es stehen drei verschiedene Listen in der Instanzübersicht zur Verfügung (siehe Kapitel Instanzübersicht). Für jede Instanz können eine Reihe von Funktionen aufgerufen werden. Dies geschieht mit dem Werkzeugsymbol am linken Rand jeder Zeile der Liste. Durch einen Klick auf dieses Symbol wird die Auswahl der Instanzfunktionen angezeigt (siehe Kapitel Instanzfunktionen). Klickt man auf den Namen einer Instanz, so wird die Startseite der jeweiligen Instanz aufgerufen. Dies kann auch durch die Instanzfunktion "Instance" erreicht werden. Bild: Instanzliste im Instanzfenster Seite 2
2.2 Menü-Navigation Über das Menü können weitere Funktionen genutzt werden (siehe Kapitel Menüpunkte). Bild: Menü der eadmin Instanz 2.3 Funktionsfenster Für einige Instanzfunktionen wird ein Funktionsfenster im Webbrowser geöffnet, in dem die ausgewählte Funktion bestätigt werden muss. Generell wird jede Aktion erst durch das Betätigen der "OK" Schaltfläche ausgeführt. Nach dem "OK" wird die jeweilige Funktion ausgeführt. Das Funktionsfenster kann jederzeit geschlossen werden, allerdings wird eine laufende Funktion dadurch nicht abgebrochen. Bild: Funktionsfenster Seite 3
3 Instanzübersicht 3.1 Status-Liste Die Statis-Liste in der Instanzübersicht gibt Informationen über den Status der jeweiligen Instanzen aus. Für die Nutzung einer Instanz muss sich diese im Status "Up" befinden. Weitere Information in der StatusListe sind: Name und Description: Name der Instanz und Informationen zur Generierung Status: momentaner Status der Instanz Parameterset und Option: Definition der Inhalte der Instanz Start, Finish und Duration: Start, Dauer und Ende des Master Process Laufes, mit dem die Instanz erzeugt wurde Build: Build-Informationen zum Produktstand Bild: State-Liste im Instanzfenster Seite 4
3.2 Database-Liste Die Database-Liste in der Instanzübersicht gibt Informationen zur Datenbank aus, in welcher die Daten der Instanz gespeichert und verwaltet werden. Name und Description: Name der Instanz und Informationen zur Generierung DB Connect: momentaner Status der Datenbankverbindung DB Size: momentane Größe der Datenbank Bild: State-Liste im Instanzfenster 3.3 Customer-Attribute-Liste Die Customer-Attribute-Liste in der Instanzübersicht gibt Informationen aus, welche vom Anwender für die jeweiligen Instanz eingetragen wurden. Es stehen fünf Attribute für kundenspezifische Angaben zur Verfügung, nach denen die Instanzliste sortiert und gefiltert werden kann. In Beispiel wird die Liste nach dem Begriff "High" gefiltert: Bild: State-Liste im Instanzfenster Seite 5
4 Instanzfunktionen Die eadmin Instanz stellt 8 Instanzfunktionen zur Verfügung. Diese können ausgewählt werden, nachdem das Werkzeugsymbol am linken Rand der Liste der Instanzübersicht angeklickt wurde: Bild: Aufruf der Instanzfunktionen Die Instanzfunktion "Instance" ruft die Starseite der jeweiligen Instanz auf. Die Instanzfunktionen "Viewer" und "Editor" öffnen einen neuen Browser-Tab und ermöglichen die Anzeige von Detailinformationen zur Instanz ("Viewer") und die Bearbeitung der Kundenattribute ("Editor"). Die weiteren Instanzfunktionen öffnen nach der Auswahl jeweils ein Funktionsfenster in einem neuen Browser-Tab und müssen dort vor der Ausführung bestätigt werden. Seite 6
4.1 Instanzfunktion "Instance" Die Instanzfunktion "Instance" ruft die Startseite der ausgewählten Instanz auf. 4.2 Instanzfunktion "Viewer" Die Instanzfunktion "Viewer" öffnet ein neuen Brower-Tab und zeigt dort Detailinformationen zur ausgewählten Instanz an. Dies sind neben den Informationen, die auch in den verschiedenen Listen der Instanzübersicht dargestellt werden, auch die letzten 100 Zeilen des Logfiles der ausgewählten Instanz. Bild: Logfile einer Instanz Seite 7
4.3 Instanzfunktion "Editor" Die Instanzfunktion "Editor" öffnet ein neuen Brower-Tab und erlaubt dort die Eingabe bzw. Änderung der Kundenattribute, welche in der Liste "Customer Attribute List" in der Instanzübersicht dargestellt werden. Der Kunde kann hier eigene Such/Sortiertexte für die Instanzen eingeben (Editor). Falls dies genutzt wird, werden diese Angaben in der Liste "Customer Attribute List" dargestellt. Bild: Bearbeitung der Kundenattribute einer Instanz 4.4 Instanzfunktion "Start instance" Die Instanzfunktion "Start Instance" öffnet ein Funktionsfenster in einem neuen Browser-Tab. Für den Start der jeweiligen Instanz muss im Funktionsfenster die Schaltfläche "Ok" angeklickt werden. Nach dem Start der Instanz kann das Funktionsfenster geschlossen werden. Ein Start einer Instanz kann nur erfolgen, wenn sich die Instanz im Status "Down" befindet. Bild: Funktionsfenster für die Funktion "Start Instance" Seite 8
4.5 Instanzfunktion "Stop Instance" Die Instanzfunktion "Stop Instance" öffnet ein Funktionsfenster in einem neuen Browser-Tab. Für den Stop der jeweiligen Instanz muss im Funktionsfenster die Schaltfläche "Ok" angeklickt werden. Nach dem Stop der Instanz kann das Funktionsfenster geschlossen werden. Ein Stop einer Instanz kann nur erfolgen, wenn sich die Instanz im Status "Up" befindet. Bild: Funktionsfenster für die Funktion "Stop Instance" 4.6 Instanzfunktion "Abort Instance" Die Instanzfunktion "Abort Instance" öffnet ein Funktionsfenster in einem neuen Browser-Tab und ermöglicht es, eine Instanz unabhängig von Ihrem aktuelle Status zu beenden. Für den Abbruch der jeweiligen Instanz muss im Funktionsfenster die Schaltfläche "Ok" angeklickt werden. Nach dem Abbruch der Instanz kann das Funktionsfenster geschlossen werden. Ein Abbruch einer Instanz erfolgt unabhängig von Ihrem aktuellen Status und kann zu einer korrupten Instanz führen! Bild: Funktionsfenster für die Funktion "Abort Instance" Seite 9
4.7 Instanzfunktion "Delete Instance" Die Instanzfunktion "Delete Instance" öffnet ein Funktionsfenster in einem neuen Browser-Tab und ermöglicht es, eine Instanz zu löschen. Für das Löschen der jeweiligen Instanz muss im Funktionsfenster die Schaltfläche "Ok" angeklickt werden. Nach dem Löschvorgang kann das Funktionsfenster geschlossen werden. Das Löschen einer Instanz ist nur möglich, wenn sich die Instanz im Status "Down" befindet. Die Funktion "Delete Instanz" löscht sowohl die Datenbank der Instanz, das zugehörige Logfile und den Instanz-Baum im Verzeichnis des erunbook Servers. Der Löschvorgang kann nicht rückgängig gemacht werden. Es werden alle Informationen inklusive der kompletten Datenbank gelöscht! Bild: Funktionsfenster für die Funktion "Delete Instance" 4.8 Instanzfunktion "Update Instance" Die Instanzfunktion "Update Instance" öffnet ein Funktionsfenster in einem neuen Browser-Tab und ermöglicht es, eine Instanz zu aktualisieren. Für das Aktualisierung der jeweiligen Instanz muss im Funktionsfenster die Schaltfläche "Ok" angeklickt werden. Nach dem Updatevorgang kann das Funktionsfenster geschlossen werden. Der Update einer Instanz ist nur möglich, wenn sich die Instanz im Status "Down" befindet. Bild: Funktionsfenster für die Funktion "Update Instance" Seite 10
5 Das Menü Das Menü der eadmin Instanz besteht aus den drei Hauptpunkten "Instances", "Activities" und "Settings", die im Folgenden beschrieben werden. 5.1 Menüpunkt "Instances" Der Menüpunkt "Instances" ermöglicht die direkte Auswahl der drei möglichen Listen der Instanzübersicht (siehe Kapitel Instanzübersicht). 5.2 Menüpunkt "Activities" Der Menüpunkt "Activities" ermöglicht den Aufruf von allgemeinen Funktionen. Diese drei Funktionen sind der Start aller vorhandenen Instanzen (Start all), das Anhalten aller vorhandenen Instanzen (Stop all) und das Anlegen einer neuen Instanz (Create instances). Alle drei Funktionen öffnen nach der Auswahl einen neuen Browser-Tab und zeigen dort ein Funktionsfenster an. 5.2.1 Funktion "Start all" Die Instanzfunktion "Start all" öffnet ein Funktionsfenster in einem neuen Browser-Tab und ermöglicht es, alle vorhandenen Instanzen zu starten. Für den Beginn des Startvorganges muss im Funktionsfenster die Schaltfläche "Ok" angeklickt werden. Nach dem Startvorgang kann das Funktionsfenster geschlossen werden. Bild: Funktionsfenster für die Funktion "Start all" Seite 11
5.2.2 Funktion "Stop all" Die Instanzfunktion "Stop all" öffnet ein Funktionsfenster in einem neuen Browser-Tab und ermöglicht es, alle vorhandenen Instanzen anzuhalten. Für den Beginn des Stopvorganges muss im Funktionsfenster die Schaltfläche "Ok" angeklickt werden. Nach dem Stopvorgang kann das Funktionsfenster geschlossen werden. Bild: Funktionsfenster für die Funktion "Stop all" 5.2.3 Funktion "Create instances" Die Instanzfunktion "Create instances" öffnet ein Funktionsfenster in einem neuen Browser-Tab und ermöglicht es, eine neue Instanz anzulegen. Für den Beginn des Vorganges müssen im Funktionsfenster die notwendigen Eingaben gemacht werden und danach die Schaltfläche "Ok" angeklickt werden. Nach dem Abschluss des Vorganges kann das Funktionsfenster geschlossen werden. Der Name der neuen Instanz muss eindeutig sein und darf nur aus Buchstaben, Ziffern und dem Unterstrich bestehen. Die Länge ist begrenzt. Der ausgewählte Parameterset bestimmt die Parametrisierung der neuen Instanz. Die Auswahl der Datenbankeinstellungen (Database Settings) ermöglicht die Auswahl unterschiedlicher Datenbankmanagementsysteme, in denen die Daten der neuen Instanz gespeichert und verwaltet werden. Ein nachträgliche Änderung der Datenbankeinstellungen ist in der eadmin Instanz nicht vorgesehen. Die Datenbankeinstellungen werden über den Menüpunkt "Settings" eingerichtet (siehe Kapitel Datenbankeinstellungen). Nach dem Abschluss dieser Funktion wird die neu erstellte Instanz in der Instanzübersicht dargestellt. Bild: Funktionsfenster für die Funktion "Create instances" Seite 12
5.3 Menüpunkt "Settings" Der Menüpunkt "Settings" ruft die Liste der Datenbankeinstellungen auf. Über das Anklicken des Werkzeugsymbols am linken Rand der Liste können entweder eine Ansichtsseite (Viewer) oder eine Bearbeitungsseite (Editor) für die Datenbankeinstellungen aufgerufen werden. Bild: Liste der Datenbankeinstellungen Bild: Viewer für die Datenbankeinstellungen Seite 13
6 Datenbankeinstellungen Die eadmin Instanz unterstützt 10 verschiedene Datenbankeinstellungen, die in der Liste dargestellt werden. Die Datenbankeinstellungen werden für das Anlegen einer neuen Instanz benötigt und müssen vor dem Anlegen einer neuen Instanz bearbeitet werden. Als Standard sind in der eadmin Instanz die Datenbankeinstellung 2 bis 10 leer und die Datenbankeinstellung 1 ist für die Nutzung der lokalen MariaDB auf dem erunbook System eingerichtet. Wenn alle neuen Instanzen die lokale MariaDB nutzen sollen, müssen die Datenbankeinstellungen nicht gepflegt werden! Die Pflege erfolgt durch die Auswahl der Funktion "Editor" in der Liste der Datenbankeinstellungen. In einem neuen Browser-Tab wird daraufhin das Eingabeformulare für die Datenbankeinstellungen angezeigt: Bild: Editor für die Datenbankeinstellungen Die Eingabefelder haben die folgende Bedeutung: Description: Beschreibender Text für die gewählten Einstellungen DB Type: mysql oder oracle (für MariaDB wird mysql ausgewählt) DB Host: Hostname des Datenbanksystem, ggf. localhost für die lokale MariaDB DB Port: Netzwerkport des Datenbanksystems bzw. $NOVAHOME/spool/mysql.sock für die Nutzung der lokalen MariaDB DB User: Datenbankbenutzer, über den erunbook mit der Datenbank kommuniziert DB Password: Kennwort für den Datenbanknutzer DB Name: $NOVAINSTNAME bzw. Name der Datenbankinstanz Seite 14
6.1 Nutzung der lokalen MariaDB Für die Nutzung der lokalen MariaDB werden die folgenden Werte für die Datenbank-Einstellungen benötigt: Description: Beschreibender Text für die gewählten Einstellungen DB Type: mysql DB Host: localhost DB Port: $NOVAHOME/spool/mysql.sock DB User: root DB Password: <password_of_db_user> DB Name: $NOVAINSTNAME Diese Datenbank-Einstellung kann für mehrere erunbook Instanzen benutzt werden. Der Datenbankname entspricht mit dieser Einstellung immer dem Instanznamen, der in der Funktion "Create new" vergeben wird. Seite 15
6.2 Nutzung einer Mysql-Datenbank Für die Nutzung einer Mysql- bzw. MariaDB-Datenbank, die vom Anwender bereitgestellt wird, werden die folgenden Werte für die Datenbank-Einstellungen genutzt. Description: Beschreibender Text für die gewählten Einstellungen DB Type: mysql DB Host: <hostname> DB Port: <portnumber> DB User: <db_user> DB Password: <password_of_db_user> DB Name: $NOVAINSTNAME Der Datenbankbenutzer muss auf dem Datenbanksystem eingerichtet sein, bevor in der eadmin Instanz die Funktion "Create new" genutzt werden kann. Der Datenbankadministrator muss die Angaben für die Felder DB Host, DB Port, DB User und DB Password liefern! Diese Datenbank-Einstellung kann für mehrere erunbook Instanzen benutzt werden, sofern als DB Name der Wert "$NOVAINSTNAME" eingetragen wird. Der Datenbankname entspricht mit dieser Einstellung immer dem Instanznamen, der in der Funktion "Create new" vergeben wird. Wenn als DB Name der "echte" Datenbankname eingetragen wird, darf diese Datenbank-Einstellung nur für eine einzige erunbook Instanz genutzt werden! Seite 16
6.3 Nutzung einer Oracle-Datenbank Für die Nutzung einer Oracle-Datenbank, die vom Anwender bereitgestellt wird, werden die folgenden Werte für die Datenbank-Einstellungen genutzt. Description: Beschreibender Text für die gewählten Einstellungen DB Type: oracle DB Host: <hostname> DB Port: <portnumber> DB User: <db_user> DB Password: <password_of_db_user> DB Name: <name_of_db_instance> Der Datenbankbenutzer und die Datenbankinstanz müssen auf dem Datenbanksystem eingerichtet sein, bevor in der eadmin Instanz die Funktion "Create new" genutzt werden kann. Der Datenbankadministrator muss die Angaben für die Felder DB Host, DB Port, DB User, DB Password sowie DB Name liefern! Eine Kombination von DB User und DB Name darf immer nur für eine einzige erunbook Instanz benutzt werden. Der Datenbankuser wird auf der Oracle-Datenbank in ein Schema der Datenbankinstanz umgelenkt. Wenn die Funktion "Create new" zweimal mit der gleichen Kombination von DB User und DB Name aufgerufen wird, dann wird die erste erunbook Instanz gelöscht und durch die zweite Instanz überschrieben! Seite 17
nova ratio AG Universitätsstraße 3 D-56070 Koblenz Deutschland Telefon: +49 261 20 16 58 1 0 Fax: +49 261 20 16 58 1 19 Mail: info@nova-ratio.de Web: www.nova-ratio.de Seite 18