Arbeiten in einem Modul
Allgemeiner Aufbau
Der Aufbau der Umgebung für ein Modul entspricht der Struktur des Redaktionssystems. Auf der linken Seite werden im Strukturbaum alle Objekte des Moduls dargestellt. Über dem Strukturbaum befindet sich das Menü zur Auswahl der Redaktionsumgebung. Der Wechsel in ein ChangeSet wird jedoch nur bei den Transformationen angewendet. Alle anderen Änderungen werden nicht im Kontext des ausgewählten ChangeSets ausgeführt.
Der Startknoten ist das Modul, welches die Meta-Informationen zum aktuellen Modul enthält. Unterhalb des Moduls werden verschiedene Bereiche eines Moduls verwaltet. Sollten Bereiche nicht vorhanden sein, so können sie über das Kontextmenü auf dem Modulknoten hinzugefügt werden.
Ein Modul wird dabei in folgende Bereiche unterteilt:
- Moduleinstellungen
- Konfiguration
- Schemaverwaltung
- Datenobjekte
- Benutzer / Gruppen
- Transformationen
- Objektstrukturfenster
- Schnittstellen
- Editorfunktionen
- Komponenten
Weiter können über das Kontextmenü des Modulknotens die Einstellungen für die Webserver und die LRU-Slots verwaltet werden.
Webserver-Einstellungen
Hier werden alle Webserver-Einstellungen aufgelistet, die in onion.net konfiguriert sind. Zu jedem Webserver können so die spezifischen Transformationen verwaltet werden.
LRU-Slots
In der Verwaltung für die LRU-Slots werden die systemweiten LRU-Slots angezeigt und können an dieser Stelle verwaltet werden.
Das Modul
Im Startknoten eines Moduls werden die Meta-Informationen zu einem Modul gepflegt. Dazu zählen folgende Punkte:
- Hersteller, Autoren
- Logo
- Version
- Features
- Dashboard-Hintergrundbilder
- Projektspezifische Dateien
- Lokalisierung
Version
Der Aufbau der Versionsnummer orientiert sich an der allgemeinen Verwendung von Versionsnummern. Die Bedeutung der einzelnen Positionen wird bei Wikipedia für Versionsnummern beschrieben.
Die Erstellung der Versionsnummer kann daher im onion.net Editor teilweise unterstützt werden.
Die Hauptversionsnummer wird vom Bearbeiter händisch gepflegt. Dazu gibt es im Modulknoten im Tab "Allgemein" den Punkt "Version". Dort kann die Nummer erhöht oder verringert werden. Wird diese Nummer verändert, so setzt sich gleichzeitig die Nebenversionsnummer auf null zurück. Die Hauptversionsnummer hat technisch keine Bedeutung. Diese sollte jedoch geändert werden, wenn das Modul eine Neuimplementierung ist oder grundlegende Änderungen enthält.
Die Nebenversionsnummer wird verändert, wenn funktionale Änderungen am Modul vorgenommen werden. Funktionale Änderungen in einem Modul sind Änderungen am Schema oder Schnittstellen. Da bei diesen Änderungen Inkompatibilitäten zu anderen Modulen auftreten können, muss diese Nummer verändert werden.
Die Revisionsnummer wird bei Änderungen an Transformationen erhöht. Änderungen an Transformationen können Auswirkungen auf das Verhalten haben, sollten jedoch keine Inkompatibilitäten zu anderen Modulen bewirken.
Die Buildnummer wird bei jedem Export des Moduls gesetzt. Wird ein Modul exportiert, so wird diese Stelle um eins erhöht. Im Normalfall wird dabei das Modul im Modus "develop" exportiert, das bedeutet das Modul ist beim Importieren in andere Systeme bearbeitbar. Wird das Modul jedoch im Modus "release" exportiert, so wird die Buildnummer auf null gesetzt. Der Modus wird beim Exportieren entschieden. Es gibt im Dialog eine Schaltfläche "Schützen", mit welcher das Modul in den Modus "release" versetzt wird. Dabei bleibt jedoch das Modul im Quellsystem unverändert auf "develop".
Features
Features werden für ein Modul definiert, um den Umfang einer Installation zu definieren. Für alle Elemente eines Moduls muss der Modulentwickler mindestens ein Feature auswählen, damit das Element für das gewählte Feature mit installiert oder aktualisiert wird.
Damit der Modulentwickler nicht jedes Feature auswählen muss, können Features andere Features inkludieren. Das bedeuetet, dass die Elemente, welche für das inkludierte Feature definiert sind, auch für das eigene Feature mit zur Verfügung stehen.
Weiterhin besteht, aufgrund der Modulfunktion "Schnittstellen", die Möglichkeit, für ein Feature Abhängigkeiten zu anderen Modulen zu definieren. So kann ein Modul nur installiert werden, wenn die Abhängigkeiten bereits im Zielsystem vorhanden oder mit im zu installierenden Modulpaket enthalten sind. Damit eine Abhängigkeit erstellt weden kann, muss die GUID, installierte Mindestversion und installiertes Feature angegeben werden. Die GUID ist im Modulsystem die eindeutige Identifikation für ein Modul und wird beim Verweilen mit der Maus über dem Modulknoten als Tooltip angezeigt.
Hintergrundbilder
Jedes Modul kann eigene Hintergrundbilder für das Dashboard zur Verfügung stellen. Die Funktionsweise des Hintergrund-Konfigurators wird im Punkt Modulsystem beschrieben.
Projektspezifische Dateien
Unter diesem Tab können DLLs in dem Projekt eingebunden werden, die weitere projektspezifische Funktionen zur Verfügung stellen.
Lokalisierung
Im Modulknoten selbst werden sprachunabhängige Informationen gepflegt. Da es allerdings auch sprachabhängige Informationen zum Modul selbst gibt, werden diese im Strukturobjektfenster unterhalb des Moduls aufgelistet. In dieser Liste gibt es bereits mindestens eine Sprache, die bei der Erstellung des Moduls als Standardsprache mit erstellt worden ist.