Modul Visualisierung Konfigurationshandbuch

Installation

Voraussetzungen

Sie benötigen
- in SuperX das Kernmodul 5.2 oder höher
- in HISinOne-BI die Version 2022.06 oder höher
- in beiden Fällen ist nur die Zeichencodierung UTF-8 mit DBMS Postgres nutzbar (also kein ISO, und somit kein Informix)
- Das SuperX-RPTA Modul (Berichtsasssistent) Version 0.4 oder höher
- Fürs Deployment aus dem git Repository die Software ANT, Anleitung zur Installation siehe hier.
  - Nutzer_innen von Eclipse haben ANT bereits integriert unter "Run" -> "External tools".

Vorgehen bei Neuinstallation - kurz und knapp

Download

Sie können das Modul aus dem SuperX-Downloadbereich herunterladen, oder direkt das git-Repository laden (s.u.).

Zum Download eines fertigen Pakets:
- Laden Sie das zu Ihrer Platform (SuperX / HISinOne-BI) und DBMS (Postgres / Informix) passende Modul herunter und speichern Sie es
  - Bei SuperX in $SUPERX_DIR
  - Bei HISinOne-BI in dem Ordner .../webapps/superx
- Entpacken Sie das Modul mit

tar  -xzvf  Dateiname

Zur Installation direkt aus dem git Repository:

git  clone  https://git.campussource.de/git/SuperX/viz.git
cd  viz
ant    -DMODULE_PATH=$VIZ_PFAD  -DBASE_DIR=.  -DWEBAPP=$WEBAPP  -DMODULE=viz  all

wobei VIZ_PFAD den Zielordner unter ...db/module/viz enthält, und WEBAPP den Ordner .../webapps/superx

Installation unter SuperX

Laden Sie zunächst das Environment von SuperX, so dass die Umgebungsvariables $SUPERX_DIR und $WEBAPP gesetzt sind. Führen Sie dann folgende Shell-Befehle aus:

cat  $SUPERX_DIR/db/bin/SQL_ENV_viz.sam  >>  $SUPERX_DIR/db/bin/SQL_ENV
.  $SUPERX_DIR/db/bin/SQL_ENV
cd  $VIZ_PFAD
module_install  viz  .

Danach bitte Tomcat neu starten, und dann ist das Modul einsatzbereit.

Eine Hauptladeroutine für VIZ wird derzeit noch nicht genutzt, Sie müssen aber die Hauptladeroutine RPTA ausführen.

Installation unter HISinOne-BI

Installieren Sie das Modul wie gewohnt über die Komponentenverwaltung. Eine Hauptladeroutine wird derzeit noch nicht genutzt.

Danach bitte Tomcat neu starten, und dann ist das Modul einsatzbereit.

Sie müssen aber die Hauptladeroutine RPTA ausführen.

Weitere Installationsschritte

Repository und XML-Ordner

Für das Dashboard kann der Kurzname der Hochschule in der Variablen VIZ_HS_KUERZEL angepaßt werden. Dieses Kürzel wird dann in der Kopfzeile angezeigt.

Nur für SuperX Kern 4.9 bzw. HISinOne-BI bis Version 2023.06:

Damit das Visualisierungs-Icon in der Buttonleiste über der Ergebnistabelle erscheint, müssen Sie den Inhalt des Template

.../webapps/superx/xml/pageComponents_html_final_viz.xsl.sam

in Ihre Datei

.../webapps/superx/git/viz/superx/xml/pageComponents_html_final.xsl

einfügen.

Danach muss man im Webanwendung Manager den Cache leeren. Ein Tomcat Neustart ist nicht nötig.

Konfiguration

Visualisierungen mit Masken verbinden

Wenn Sie eine Visualisierung erstellt haben, können Sie diese mit der jew. Maske verknüpfen und so abrufbar machen:

Speichern Sie die Visualisierung in der Maske : Abfragen -> Visualisierungen -> Administration Visualisierungen -> Visualisierungen verwalten, indem Sie einen vorhandenen Eintrag duplizieren
Im Feld Maskennummer geben Sie jew. Maskennummer an, in der die Grafik aufgerufen wird
Weisen Sie der Maske das Stylesheet "viz_html_chart_viewer.xsl" zu
Erzeugen Sie ein neues Feld "Grafik" mit der Relation aus viz_chart
- Sie können das Feld auch mit einem Defaultwert versehen und verstecken, es muss lediglich vorhanden sein.
Wenn Sie für die Maske das generische Standardlayout erlauben wollen, erzeugen Sie ein weiteres Feld
- tablestylesheet mit der Relation zu sx_mask_style, analog zu normalen Datenblatt Berichten.
- Wenn Ihre Maske ein Datenblatt ist, können Sie auch die Zuweisung von Stylesheets zu Spalten verwenden ("stylesheet_field").

Beispiel-Dashboard

Im VIZ Modul wird ein Beispiel-Dashboard auf der Basis vom Studierenden-Datenblatt mitgeliefert.

Dies ist nur nutzbar wenn Sie auch das Studierenden-Modul 1.3 oder höher sowie das RPTA-Modul 0.4 oder höher installiert haben. Wenn nicht, sollten Sie die beiden Masken

Studierende und Absolvierende Dashboard
Campus-Dashboard Übersicht

im Themenbaum unsichtbar machen.

Upgrade

Upgrade unter SuperX

Wenn Sie die Komponente bereits installiert haben, müssen Sie wie folgt vorgehen:

Führen Sie den Patch in der Shell im Verzeichnis $SUPERX_DIR/db/module/viz/upgrade mit

viz_upgrade.x

aus. Danach bitte Tomcat neu starten.

Upgrade unter HISinOne-BI

Upgraden Sie das Modul wie gewohnt über die Komponentenverwaltung.

Danach bitte Tomcat neu starten.