3.5.4. Module

Module sind technische Pakete, die eine Standardlösung für eine fachliche Fragestellung zur Verfügung stellen. Ein Modul besteht aus beliebig vielen Content-Elementen, die technisch gesehen SQL-Skripte sind.

Anhand der Modulverwaltung in der Applikation ist es möglich, …

… Module und Datenbankobjekte bzw. Content-Elemente direkt in der OCT-Weboberfläche zu bearbeiten, zu speichern sowie einzuspielen.

… Versionen der Content-Elemente zu vergleichen und zu verwalten.

… eine Übersicht aller heruntergeladenen und eingespielten Module mit den zugehörigen Content-Elementen zu erhalten.

3.5.4.1. Menüleiste (A)

Die Menüleiste mit ihren Funktionen ist für den gesamten Bereich “Module” anwendbar.

Icon “Hinzufügen”	Bei Auswahl des Icons kann man zwei unterschiedliche Elemente hinzufügen: ein neues Modul ein neues Content-Element - nur aktiviert, wenn zuvor ein Modul ausgewählt wurde Eine detaillierte Beschreibung dazu finden Sie hier: 3.5.4. Module \| 3.5.4.1.1.-Hinzufügen
Icon “Speichern”	Speichert alle Änderungen in der OCT-Datenbank ab. Das Icon wird nur aktiviert, wenn ungespeicherte Änderungen vorhanden sind. Vor dem Speichern von Änderungen eines Content-Elements öffnet sich ein Dialog, in dem Sie einen Kommentar bzw. eine Commit-Nachricht zu den Änderungen eingeben können.
Icon “Neu laden”	Temporäre und nicht gespeicherte Änderungen können so verworfen werden.
Icon “Importieren”	Es können Module aus folgenden Quellen importiert werden: Von Content-Server = Sammlung von Modulen in der Saxess-Cloud (Internetzugriff erforderlich) Aus JSON Datei = Modul in Form einer JSON-Datei, die auf der Festplatte des Benutzers oder einem Netzlaufwerk gespeichert ist Eine detaillierte Beschreibung dazu finden Sie hier: 3.5.4. Module \| 3.5.4.1.2.-Importieren
Icon “Exportieren”	In der Modulübersicht kann man mit einem Linksklick ein Modul auswählen und exportieren. Es öffnet sich ein Dialog, in welchem ein Dateiname für das zu exportierende Modul eingetragen werden muss. Mit Auswahl des Buttons “Exportieren” wird der Export im JSON-Format gestartet.
Icon “Einspielen”	Wählen Sie mit einem Linksklick das Modul oder Content-Element aus, welches eingespielt bzw. installiert werden soll. Bei Auswahl des Icons wird das Modul mit den zugehörenden Content-Elementen in die Datenbank eingespielt. Nach erfolgreicher Einspielung des Moduls und den zugehörenden Content-Elementen wird rechts neben dem Modulnamen sowie neben den Content-Elementen ein grüner Haken angezeigt. Bitte beachten Sie, dass nach nicht vollständiger Einspielung des Moduls oder eines der zugehörigen Content-Elemente ein gelber Haken rechts neben dem Modulnamen angezeigt wird. Das nicht eingespielte Content-Element wird in hellgrauer Schriftfarbe angezeigt. Werden für das Einspielen eines Moduls SQL-Datenbank-Administratorrechte benötigt, öffnet sich ein Popup Fenster, in dem man alternative Zugangsdaten eingeben kann, welche nur für das Einspielen des Moduls verwendet werden.
Icon “Deinstallieren”	Wählen Sie mit einem Linksklick das Modul aus, welches deinstalliert werden soll. Bei Auswahl des Icons wird das Modul mit den zugehörenden Content-Elementen deinstalliert. Das bedeutet, dass alle Content-Elemente, die eine Tabelle oder eine View sind, aus der Datenbank gelöscht werden. Das deinstallierte Modul oder Content-Element ist weiterhin in der Übersicht in der Modulverwaltung verfügbar. Ein deinstalliertes Modul hat keinen Haken rechts neben dem Modulnamen und alle Content-Elemente werden in hellgrauer Schriftfarbe angezeigt.
Icon “Content-Element bearbeiten”	Um dieses Icon zu aktivieren, muss in der Modulübersicht ein Content-Element mit einem Linksklick ausgewählt werden. Eine detaillierte Beschreibung dazu finden Sie hier: 3.5.4. Module \| 3.5.4.1.3.-Content-Element-bearbeiten-(Details)
Icon “Kopieren”	Wählen Sie mit einem Linksklick das Modul oder Content-Element aus, welches kopiert werden soll. Bei Auswahl des Icons öffnet sich ein Dialog, in welchen das Quellmodul angezeigt wird und ein eindeutiger Zielmodulnamen vergeben werden muss. Das Modul mit den zugehörenden Content-Elementen wird kopiert und der Modulübersicht in der Modulverwaltung in alphabetischer Reihenfolge hinzugefügt. Das Modul wird durch das Kopieren nicht eingespielt!
Icon “Löschen”	Man kann über dieses Icon entweder ein einzelnes Content-Element oder das komplette Modul löschen. Löschen eines Content-Elements: Wählen Sie mit einem Linksklick ein Content-Element aus, das gelöscht werden soll. Bei Auswahl des Icons erscheint eine Meldung, in welcher der Vorgang bestätigt werden muss. Löschen eines Moduls: Wählen Sie mit einem Linksklick ein Modul aus, das mit all seinen Content-Elementen gelöscht werden soll. Bei Auswahl des Icons erscheint eine Meldung, in welcher der Vorgang bestätigt werden muss. Beim Löschen eines Moduls oder Content-Elements wird dieses zuerst aus der Datenbank deinstalliert und dann aus der Applikation gelöscht.
Icon “Vergleichsmodus”	Dieses Icon ist nur aktiviert, wenn beim ausgewählten Content-Element mehr als eine Version und Zeile verfügbar ist. Es können über dieses Icon verschiedene Versionen angezeigt werden, indem mit einem Linksklick ein Objekt bzw. Content-Element ausgewählt und dann der Vergleichsmodus aktiviert wird. Oben im Editor werden ggf. Kommentare bzw. vorher verfasste Commit-Nachrichten angezeigt, die beim Speichern der Versionen hinzugefügt wurden. Rechts neben dem Kommentar können über einen kleinen schwarzen Pfeil alle Versionen aufgeklappt und in einem Drop-down-Menü die gewünschte Version ausgewählt werden. Unterschiede und Änderungen in den Versionen werden farblich (grün/rot) hervorgehoben und können somit nachverfolgt werden. Schwebt man mit der Maus über der farblich (rot) markierten Zeile, erscheint am Zeilenanfang ein schwarzer Punkt, über welchen die Zeile gelöscht werden kann. Mit einem erneuten Linksklick auf das Icon wird der Vergleichsmodus wieder deaktiviert. Am rechten Rand des Editors wird in einer Miniaturansicht die Prozedur angezeigt. Über diesen Rand können die farblich hervorgehobenen Änderungen schneller gefunden werden.

3.5.4.1.1. Hinzufügen

Zusätzlich zu den bereits vorgefertigten Modulen können individuelle Module und Content-Elemente über diese Option erstellt werden.

3.5.4.1.1.1. Neues Modul hinzufügen

Bei Auswahl der Option öffnet sich ein Dialog, in welchem Eigenschaften für das neue Modul eingetragen werden müssen.

Modul	Eingabefeld für einen eindeutigen Modulnamen Erlaubte Zeichen: a-z, A-Z, 0-9, _ (kein Leerzeichen erlaubt)
Modultyp	In einem Drop-down-Menü kann einer von vier Modultypen ausgewählt werden: Integration = Modul, das mit Hilfe eines Konnektors befüllt werden kann. Planung = Modul, das hauptsächlich Objekte für die Datenerfassung zur Verfügung stellt. Visualisierung = Modul, das hauptsächlich grafische Auswertungen zur Verfügung stellt. Staging = Modul, das Daten aus einer anderen Datenbank oder einer anderen Software 1:1 in die OCT-Datenbank übernimmt. Jeder Modultyp wird zur Übersichtlichkeit mit einem eigenem Icon gekennzeichnet. Der Modultyp hat aktuell keine technischen Auswirkungen.
Beschreibung	Eingabefeld für eine optionale Beschreibung des Moduls Das Beschreibungsfeld kann in der rechten, unteren Ecke größer gezogen werden.
Button “Anwenden”	Bei Auswahl des Buttons wird ein neues Modul erstellt und in alphabetischer Reihenfolge der Modulübersicht in der Applikation hinzugefügt. Nachdem das Modul fertig bearbeitet und dazugehörende Content-Elemente erstellt wurden, muss es zusätzlich in die Datenbank eingespielt werden.

3.5.4.1.1.2. Neues Content-Element hinzufügen

Es können nur Content-Elemente bzw. SQL-Skripte hinzugefügt werden, wenn ein Modul ausgewählt ist.

Bei Auswahl der Option öffnet sich ein Dialog, in welchem Eigenschaften für das neue Content-Element eingetragen werden müssen.

Modul	Es wird der Name des Moduls angezeigt. Der Name ist hier nicht veränderbar.
Content-Element	Eingabefeld für einen Content-Element-Namen. Es wird empfohlen, als Namen des Content-Elements den Namen des Datenbankobjekts zu wählen, welches dieses Content-Element erzeugt.
OCT-Objekttyp	In einem Drop-down-Menü kann ein Objekttyp aus folgender Liste ausgewählt werden: Fabrik, Produktlinie, Produkt, Tab, Tabellendaten, Modul, Abfrage, Pipeline, Liste, Format. Jeder Objekttyp wird zur Übersichtlichkeit mit einem eigenem Icon gekennzeichnet. Der Objekttyp ist derzeit technisch nicht relevant und dient nur als zusätzliche Information.
Technischer Typ	In einem Drop-down-Menü kann einer von vier technischen Typen ausgewählt werden: Tabelle Ansicht Gespeicherte Prozedur Abfrage Jeder technische Typ wird zur Übersichtlichkeit mit einem eigenem Icon gekennzeichnet. Der technische Typ hat Auswirkungen in der Deinstallation. Wird z.B. ein technischer Typ “Tabelle” deinstalliert, wird automatisch ein “DROP TABLE”-Befehl generiert und ausgeführt.
Beschreibung	Eingabefeld für eine optionale Beschreibung des Content-Elements Das Beschreibungsfeld kann in der rechten, unteren Ecke größer gezogen werden.
Button “Anwenden”	Bei Auswahl des Buttons wird automatisch ein neues Content-Element erstellt und dem vorausgewählten Modul hinzugefügt. Nachdem das Content-Element fertig bearbeitet und erstellt wurde, muss es zusätzlich in die Datenbank eingespielt werden.

Nach Auswahl eines Content-Elements kann auf der rechten Seite des Fensters ein SQL-Skript geschrieben werden.
Vor einem Wechsel zu einem anderen Content-Element oder vor dem Hinzufügen eines neuen Content-Elements muss das geöffnete Element zuerst gespeichert werden.
Nach Auswahl des Icons “Speichern” öffnet sich ein Dialog, in dem Sie einen Kommentar zum Element oder den vorgenommenen Änderungen hinzufügen können.

Der Kommentar wird sichtbar, wenn verschiedene Versionen eines Content-Elements über das Icon “Vergleichsmodus” verglichen werden.

Wenn die Schriftfarbe des Elements hellgrau ist und kein grüner Haken neben dem Element angezeigt wird, bedeutet dies, dass diese Version des Elements noch nicht in die Datenbank eingespielt wurde.

Nicht vollständig eingespielte Module sind durch einen gelben Haken neben dem Modulnamen gekennzeichnet.

3.5.4.1.2. Importieren

Es können komplette Module aus den Bereichen “Integration”, “Planung”, “Staging” und “Visualisierung” vom Content-Server aus der Saxess-Cloud sowie Module als JSON-Datei importiert bzw. heruntergeladen werden.

3.5.4.1.2.1. Von Content-Server

Es kann nur ein Modul und nicht mehrere Module oder ein einzelnes Content-Element importiert werden.

Die Module auf dem Content-Server werden vier Hauptbereichen zugeordnet:

Integration: Module, die mit Hilfe eines Konnektors befüllt werden können.
Planung: Module, die hauptsächlich Objekte für die Datenerfassung zur Verfügung stellen.
Staging: Module, die Daten aus einer anderen Datenbank oder einer anderen Software 1:1 in die OCT-Datenbank übernehmen.
Visualisierung: Module, die hauptsächlich grafische Auswertungen zur Verfügung stellen.

Bei Auswahl dieser Option öffnet sich ein Dialog, in welchem auf der linken Seite die Übersicht aller Module in einer Baumstruktur organisiert ist.

Über das Suchfeld kann gezielt nach Modulen gesucht bzw. gefiltert werden.
Die vier Hauptbereiche “Integration”, “Planung”, “Staging” und “Visualisierung” können über den kleinen schwarzen Pfeil aus- und eingeklappt werden. Es werden dann alle verfügbaren Module für den jeweiligen Hauptbereich angezeigt.

Mit einem Linksklick auf ein Modul werden auf der rechten Seite des Fensters die Details zum Modul angezeigt.

Modul	In diesem Feld wird der Modulname angezeigt.
Typ	In diesem Feld wird der Modultyp angezeigt.
Basismodul	In diesem Feld wird angezeigt, welchem Basismodul das Modul zugeordnet ist. Das Basismodul ist für die Installation des Moduls zwingend erforderlich. Die Module “FIN-CP” oder “FIN-ODATA” erfordern z.B. das Basismodul “FIN”.
Erfordert Administratorrechte	Eine Checkbox mit Haken zeigt an, ob SQL-Datenbank-Administratorrechte bzw. “db_owner”-Rechte auf der OCT SQL-Datenbank für das Einspielen des Moduls oder des Content-Elements notwendig sind. Standardmäßig nutzt OCT beim Einspielen die Zugangsdaten, die in den Applikationseinstellungen auf Serverebene hinterlegt sind. Mit diesen Zugangsdaten hat OCT aber (normalerweise) keine Administratorrechte bzw. “db_owner”-Rechte auf der OCT SQL-Datenbank und kann das Modul nicht einspielen. Falls der Haken in der Checkbox gesetzt ist, öffnet sich beim Einspielen des Moduls oder Content-Elements ein zusätzliches Popup Fenster, in dem man alternative Zugangsdaten eingeben kann, welche nur für das Einspielen des Moduls verwendet werden.
Beschreibung	Das Feld zeigt eine kurze Beschreibung des Moduls (Zweck, Inhalt, Details, usw.) an.
Details	Falls dieser Unterpunkt verfügbar ist, finden sich unter der verlinkten Webseite (Saxess Homepage oder OCT Help Center) zusätzliche Informationen. Nur manche Module (FIN, STAGING-GENERIC, DARL) haben diesen Unterpunkt.
Button “Herunterladen”	Das Modul mit den dazugehörenden Content-Elementen wird vom Content-Server aus der Saxess-Cloud in die OCT-Datenbank importiert, aber noch nicht in die Datenbank eingespielt. Das heruntergeladene Modul wird in der Modulübersicht ohne grünen Haken und die dazugehörenden Content-Elemente in hellgrauer Schriftfarbe angezeigt.
Button “Herunterladen & einspielen”	Das Modul mit den dazugehörenden Content-Elementen wird vom Content-Server aus der Saxess-Cloud in die OCT-Datenbank importiert und direkt in die Datenbank eingespielt. Falls SQL-Datenbank-Administratorrechte erforderlich sind, öffnet sich ein zusätzliches Popup Fenster, in dem man alternative Zugangsdaten eingeben kann, welche nur für das Einspielen des Moduls verwendet werden. Das heruntergeladene und eingespielte Modul wird in der Modulübersicht mit einem grünen Haken rechts neben dem Modulnamen visualisiert.

3.5.4.1.2.2. Aus JSON-Datei

Es kann nur ein Modul und nicht mehrere Module oder ein einzelnes Content-Element importiert werden.

Bei Auswahl dieser Option öffnet sich ein Dialog, in welchem eine JSON-Datei von einem Speicherort (z.B. Festplatte des Benutzers, Netzlaufwerk) importiert werden kann.

Button “Datei öffnen”	Bei Auswahl des Buttons öffnet sich ein neuer Dialog, in welchem die zu importierende Datei mit der Dateierweiterung “.json” von einem Speicherort ausgewählt bzw. importiert werden kann.
Dateiname	Dieser wird automatisch, basierend auf der importierten Datei, eingetragen.
Quell-Datenbankversion	Dieses Feld beinhaltet aufgrund des Dateiformats (JSON) keine Informationen.
Quellwerk	Dieses Feld beinhaltet aufgrund des Dateiformats (JSON) keine Informationen.
Objekttyp	Dieser wird automatisch, basierend auf der importierten Datei, eingetragen.
Modul (links - Quellmodul)	Der Name des Quellmoduls wird automatisch, basierend auf der importierten Datei, eingetragen.
Modul (rechts - Zielmodul)	Standardmäßig wird das Eingabefeld für den Namen des Zielmoduls mit dem Wert der Quelle bzw. des Quellmoduls befüllt. Je nach Anwendungsfall (Überschreiben oder Hinzufügen) muss der Name des Zielmoduls angepasst werden.
Button “Importieren”	Über den Button wird das Objekt in die OCT-Datenbank importiert und in der Modulübersicht angezeigt.
Button “Importieren & einspielen”	Über den Button wird das Objekt in die OCT-Datenbank importiert, in der Modulübersicht angezeigt und direkt in die Datenbank eingespielt.

3.5.4.1.3. Content-Element bearbeiten (Details)

Die Details bzw. Eigenschaften des Datenbankobjektes können bearbeitet werden.

Nach Auswahl des Icons öffnet sich ein Dialog, in welchem die Details des Content-Elements angezeigt sowie bearbeitet werden können.

Content-Element	Eingabefeld für einen Namen des Content-Elements in diesem Modul.
Typ des Content-Elements	In einem Drop-down-Menü kann ein Objekttyp aus folgender Liste ausgewählt werden: Fabrik, Produktlinie, Produkt, Tab, Tabellendaten, Modul, Abfrage, Pipeline, Liste, Format. Jeder Objekttyp wird zur Übersichtlichkeit mit einem eigenem Icon gekennzeichnet. Der Objekttyp ist derzeit technisch nicht relevant und dient nur als zusätzliche Information.
Technischer Typ	In einem Drop-down-Menü kann einer von vier technischen Typen ausgewählt werden: Tabelle Ansicht Gespeicherte Prozedur Abfrage Jeder technische Typ wird zur Übersichtlichkeit mit einem eigenem Icon gekennzeichnet. Der technische Typ hat Auswirkungen in der Deinstallation. Wird z.B. ein technischer Typ “Tabelle” deinstalliert, wird automatisch ein “DROP TABLE”-Befehl generiert und ausgeführt.
Beschreibung	Eingabefeld für eine optionale Beschreibung des Content-Elements

3.5.4.2. Anzeigefeld für Module (B)

Im Anzeigefeld werden alle Module mit ihren Content-Elementen angezeigt und können an dieser Stelle auch bearbeitet oder angepasst werden.

3.5.4.2.1. Modulübersicht

In der Modulübersicht werden alle hinzugefügten, heruntergeladenen und ggf. in die Datenbank eingespielten Module angezeigt.

Die Module können über den kleinen schwarzen Pfeil links vom Modulnamen aus- oder eingeklappt werden, um alle zugehörigen Content-Elemente anzuzeigen.
Heruntergeladene und nicht eingespielte Module haben keinen Haken rechts neben dem Modulnamen.
Heruntergeladene, aber nicht vollständig in die Datenbank eingespielte Module, haben einen gelben Haken rechts neben dem Modulnamen. Dies ist der Fall, wenn z.B. ein Content-Element des Moduls noch nicht eingespielt wurde.
Heruntergeladene sowie vollständig in die Datenbank eingespielte Module haben einen grünen Haken rechts neben dem Modulnamen.
Der Modultyp wird durch ein eigenes Icon ( Integration, Planung, Visualisierung, Staging) visualisiert, dieser hat jedoch aktuell keine technischen Auswirkungen.

3.5.4.2.2. Detailansicht eines Moduls

Die Module können individuell in der Detailansicht bearbeitet bzw. angepasst werden.

Mit einem Linksklick auf ein Modul wird auf der rechten Seite eine Übersicht mit Moduldetails angezeigt.

Modul	Eingabefeld für einen eindeutigen Modulnamen Erlaubte Zeichen: a-z, A-Z, 0-9, _ (kein Leerzeichen erlaubt)
Modultyp	In einem Drop-down-Menü kann einer von vier Modultypen ausgewählt werden: Integration Planung Visualisierung Staging Jeder Modultyp wird zur Übersichtlichkeit mit einem eigenem Icon gekennzeichnet. Der Modultyp hat aktuell keine technischen Auswirkungen.
Beschreibung	Eingabefeld für eine optionale Beschreibung des Moduls Bei importierten Modulen (vom Content-Server) wird bereits eine Beschreibung des Moduls (Zweck, Inhalt, Details, usw.) mitgeliefert.
Version	Es wird automatisch die letzte Versionsnummer angezeigt, unter welcher das Modul auf dem Content-Server in der Saxess-Cloud abgespeichert ist. Die Versionsnummer kann an dieser Stelle nicht bearbeitet werden.
Erfordert Administratorenrechte	Eine Checkbox mit Haken zeigt an, ob SQL-Datenbank-Administratorrechte bzw. “db_owner”-Rechte auf der OCT SQL Datenbank für das Einspielen des Moduls oder des Content-Elements notwendig sind. Standardmäßig nutzt OCT beim Einspielen die Zugangsdaten, die in den Applikationseinstellungen auf Serverebene hinterlegt sind. Mit diesen Zugangsdaten hat OCT aber (normalerweise) keine Administratorrechte bzw. “db_owner”-Rechte auf der OCT SQL Datenbank und kann das Modul nicht einspielen. Falls der Haken in der Checkbox gesetzt ist, öffnet sich beim Einspielen des Moduls oder Content-Elements ein zusätzliches Popup Fenster, in dem man alternative Zugangsdaten eingeben kann, welche nur für das Einspielen des Moduls verwendet werden.
Details	Falls dieser Unterpunkt verfügbar ist, finden sich unter der verlinkten Webseite (Saxess Homepage oder OCT Help Center) zusätzliche Informationen. Nur manche Module (FIN, STAGING-GENERIC, DARL) haben diesen Unterpunkt.

3.5.4.2.3. Detailansicht eines Content-Elements - SQL-Editor

Content-Elemente sind SQL-Skripte, die Datenbankobjekte anlegen oder Inhalte in die Datenbank einfügen.

Die Position der Content-Elemente in der Übersichtsliste innerhalb des Moduls kann mittels Drag & Drop verändert werden. Die Position beeinflusst die Reihenfolge, in welcher die Content-Elemente eingespielt werden.
Mit einem Linksklick auf ein Content-Element wird auf der rechten Seite ein SQL-Editor für das Schreiben von Prozeduren angezeigt.

Das Content-Element kann direkt im Editor bearbeitet werden, indem das SQL-Skript geschrieben, geändert und gespeichert wird.
Verschiedene Versionen können über den Vergleichsmodus verglichen und nachverfolgt werden .
Die Details des Content-Elements können über das Icon “Content-Element bearbeiten” abgeändert werden.
Nachdem im SQL-Skript Änderungen vorgenommen wurden, müssen diese über das Icon “Speichern” gespeichert werden.
Bei Auswahl des Icons “Speichern” öffnet sich ein Dialog, in welchem ein Kommentar bzw. eine Commit-Nachricht hinzugefügt werden kann, um die Änderungen am Content-Element zu dokumentieren.

Erst nach Auswahl des Buttons “Anwenden” kann die Bearbeitung des Content-Elements abgeschlossen werden.

Der Kommentar wird nur im Vergleichsmodus angezeigt.