Kernmodul Oberfläche

Die Oberfläche von SuperX kann angepaßt werden bzgl.

• Startseite
• Kopf- und Fußzeilen
• Generelle Layoutmerkmale

Startseite konfigurieren

Login Seite konfigurieren

Beim Aufruf von SuperX wird eine Login-Seite angezeigt, die vordefiniert ist und die Felder Benutzername und Kennwort sowie Links auf Hilfetexte und Impressum anbietet:

 

Sie können diese Seite durch eine eigene "Kachel" ersetzen, um z.B.

• Ein eigenes Startlogo oder andere Corporate Designs der Hochschule umzusetzen
• spezielle Links zu Kontakt- oder Hilfeseiten anzubieten
• Einen oder mehrere Gastzgänge ermöglichen
• bei serverweitem Login mit LDAP eine spezielle Login-Seite für Kennungen ohne LDAP anzubieten

Außerdem können Sie weitere Kacheln daneben anzeigen. Hier ein Beispiel vom SuperX-Demosystem:

 

Erläuterungen zur Konfiguration von Login-Kacheln finden Sie unten.

Startseite Menü

Angemeldeten Benutzer_innen wird oben ein Menü angezeigt, über das z.B. in die verschiedenen Auswertungswerkzeuge geleitet werden kann:

Die Startseite besteht aus

• dem Seitenkopf, Hochschulname und Logo
• einer horizontalen Menüleiste mit Buttons zu den jew. Auswertungswerkzeugen
• einem Gitter aus Kacheln
• einem Seitenfuß

Im Folgenden wird erläutert wie Sie diese anpassen.

Kopf-und Fusszeile

Der Inhalt derKopfzeile ist statisch bis auf das Logo, den Link dahinter und den Hochschulnamen. Diese Angaben ändern Sie in dem Menü Administration -> Beschriftungen suchen.

 

Die Kopfzeile ist ein XSL-Template "nd_navi_top". Sie können dieses Template aber auch komplett überlagern.

Analog lautet das Template für die Fußzeile "nd_navi_bottom".

Horizontale Menüleiste

Nach der Installation/dem Upgrade wird erst einmal nur der Link „Standardberichte“. Mitgeliefert werden aber auch die Einträge für Management und z.B.xCube, im folgenden Screenshot grün umrandet:

 

Die Elemente können erzeugt, geändert und deaktiviert werden. Über das Feld „aktiv“ können diese aber auf „1“=aktiv gesetzt werden („0“ steht für inaktiv). Die Daten für das Menü kommen aus der Tabelle sx_repository, erreichbar im Browser über die Maske Administration -> Hochschul-Repository. Folgende Felder werden hier verwendet:

• id: Dieses Feld muss in dieser Tabelle eindeutig sein. Mit dem Präfix:“WELCOME_“ wird der Eintrag zu einem Link für die Menüleiste. verwenden und danach mit einen sinnvollen Namen in Großbuchstaben ergänzen.
• content: Hier den Link eintragen, zu dem der Menüeintrag verweisen soll.
• caption: Hier den Text eintragen, der im Menü stehen soll.
• comment: In die Kachel wurde ein icon-Font integriert. Diese Icons werden dann neben dem Menü-Eintrag angezeigt. Welche Icons zur Verfügung stehen und welcher Code dafür eingegeben werden muss erfahren Sie auf Ihrem SuperX Server unter <>/superx/xml/fonts.html bzw. hier online.

• art: Hier muss „WELCOME_LINK“ eingetragen werden, damit dieser Eintrag als Menü-Punkt erkannt wird.
• art2: Hintergrundfarbe Variablenname in Bulma, z.b. "has-background-link-light". Eine Aufstellung aller möglichen Variablen finden Sie auf der Bulma-Homepage.
• sort1: Über diese Nummer wird die Sortierung festgelegt. Das Menü fängt mit dem Eintrag an, der die niedrigste Nummer hat und geht dann immer höher.
• gueltig_von, gueltig_bis: Hier kann angegeben werden in welchem Zeitraum der Menü-Punkt angezeigt wird. Wenn es immer gelten soll für gueltig_von „01.01.1900“ und für gueltig_bis „01.01.3000“ eintragen. Dies sind auch die Standard-Einträge, falls das Feld leer gelassen wird.

Kacheln

Es gibt drei mögliche Orte für Kacheln:

• Spezielle Login-Kacheln
• Kacheln auf der Startseite vor Login
• Kacheln auf der Startseite nach Login

Sie können Inhalt, Funktion und Layout der Kacheln anpassen. Es können auch zeitlich begrenzte Informationen ausgegeben werden, wie z.B. wenn Wartungsarbeiten anstehen oder eine Mitarbeiter-Schulung angeboten wird.

Bearbeitung der Kacheln

Die Portlets werden in der Tabelle sx_portlet gepflegt, im Browser erreichbar über das Menü Administration -> Tabelle suchen -> Stichwort "portlet".

 

Im Listenformular können Sie Portlets anlegen, löschen und bearbeiten:

 

Für die Bearbeitung stehen folgende Felder zur Verfügung:

• Name des Portlets: Der Name des Portlets wird als Überschrift ausgegeben.
• Typ: Hier wird der Ausgabe-Typ eingetragen. Bisher wird nur „HTML“ unterstützt.
• CSS-class: Hier kann eine CSS Klasse für das Portlet eingetragen werden. Bisher gibt es die Klassen „green“ und „red“. Damit kann die Hintergrundfarbe gewählt werden. Mit eigenen CSS Klassen kann hier noch wesentlich mehr gemacht werden.
• Icon: Sie können einen Fontello Icon Font nutzen. Diese Icons werden dann neben dem Portlet angezeigt. Welche Icons zur Verfügung stehen und welcher Code dafür eingegeben werden muss erfahren Sie auf Ihrem SuperX Server unter <>/superx/xml/fonts.html bzw. hier online.

• content: Hier steht der Inhalt, der in dem Portlet ausgegeben wird. Bei type=“HTML“ bitte auch HTML Syntax verwenden.
• Sichtbarkeit: Hier sind folgende Werte auswählbar:
  • wird nicht angezeigt, inaktiv
  • wird als spezielle Login-Kachel angezeigt (und ersetzt damit den ausgelieferten Dialog)
  • wird nur angemeldeten Benutzern angezeigt.
  • wird auch nicht angemeldeten Besuchern angezeigt
  • immer sichtbar
  • wird nur angemeldeten Benutzern angezeigt.
• gültig von, gültig_bis: Hier kann angegeben werden in welchem Zeitraum das Portlet angezeigt wird. Wenn es immer gelten soll für gueltig_von „01.01.1900“ und für gueltig_bis „01.01.3000“ eintragen. Dies sind auch die Standard-Einträge, falls das Feld leer gelassen wird.

Der Inhalt wird im Detail-Formular bearbeitet:

 

Das das Portlet im Beispiel nur nach Login angezeigt wird, können hier auch "Deep Links" zu Menüelementen eingerichtet werden.

Im Ergebnis sieht die Kachel dann so aus:

 

Spezielle Login-Kacheln

Wenn Sie einen eigenen Login Dialog anbieten wollen, können Sie eine Kachel mit Sichtbarkeit="Spezielles Login-Portlet" anlegen. Hier ein Beispiel:

 

Der HTML-Code im Inhalt muss dafür spezielle Anforderungen erfüllen:

• Ein "FORM"-Element mit den Attributen und Unter-Elementen wie im Screenshot

 

• Speziell für einen oder mehrere Gastzugänge können Sie spezielle Links hinterlegen, wie im folgenden Screenshot

 

Zum Kopieren hier der komplette Beispielcode:

Und hier die Kachel wie sie im Browser aussieht:

 

• Wenn Sie bei der Installation auf LDAP-Login umgestellt haben, können Sie trotzdem einen Login für Kennungen ohne LDAP anbieten, mit dem Link

.../superx/index.jsp?login=superx

Impressum und Datenschutz

Auf der Startseite und allen Unter-Seiten muss ab 25.5.2018 gem. DSVGO ein Impressum und eine Datenschutzerklärung verlinkt werden. Diese sind server- und hochschulspezifisch und werden daher im Hochschul-Repository mit Beispielinhalten ausgeliefert.

Diese sollten angepasst werden:

• Öffnen Sie Abfragen → Administration → Hochschul-Repository
• Klicken Sie auf Abschicken. Sie erhalten je einen Datensatz für "IMPRINT" (Impressum) oder "PRIVACY" (Datenschutzerklärung), hier z.B. Impressum.
• Klicken Sie beim jew. Eintrag auf Bearbeiten:
• Sie erhalten ein Datenbankformular. Bearbeiten Sie den Inhalt im Feld " Inhalt der Variable " .

Der Editor ist ein "WYSIWYG"-Editor, Sie können hier HTML Code verwenden und auch Styles mit angeben.

Details zu den Inhalten siehe z.B. Wikipedia

CSS-Stylesheets und Icons

Mit Kernmodul 5.2 können Sie eigene CSS-Styles verwenden, und die ausgelieferte CSS-Datei bulma.css anpassen.

Auch eigene Icons lassen sich einbinden, zwecks besserer Layoutmöglichkeiten sind diese ebenfalls mit der CSS-Anpassung verbunden.

Eigener CSS

Über die Repository Variable CUSTOM_CSS kann eigener CSS Code in der Startseite verwendet werden. Das CSS wird nach den CSS Dateien von SuperX geladen und wird daher auch höher priorisiert behandelt. Dadurch können vorhandene Styles über die Repository-Variable verändert oder neue ergänzt werden, falls das Aussehen verändert werden soll.

Z.B. kann die Schriftart in der Menüleiste verändert werden. Zunächst ermitteln Sie den Klassennamen mit der "Element-untersuchen" Funktion im Browser. Hier heißt die Klasse "icon-text". Der folgende Code überlagert das Standardlayout:

Das würde dann folgendermaßen aussehen:

 

Anpassung der bulma.css

Sie können die Layouts von unserem CSS-Framework bulma anpassen und eine "eigene" bulma.css erstellen. Eine umfassende Doku befindet sich hier: http://bulma.io/documentation/

Hier nur ganz kurz eine Anleitung.

Zur Anpassung von bulma wird der CSS-Compiler "sass" genutzt. Diesen kann man über Node.js nutzen (eine Laufzeitumgebung für Javascript), oder als ausführbare Datei fürs jew. Betriebssystem. Obwohl ersteres empfohlen wird, ist dir zweite Option leichter nutzbar für unsere Zwecke.

Installation von sass

Installation mit sass-dart

Die Kommandozeilen-Anwendung sass-dart können Sie hier für Ihre jew. Betriebssystem herunterladen.

Nach dem Download müssen Sie das Paket nur entpacken und in Ihren PATH mit aufnehmen.

Nehmen wir an Sie haben es in Ihrem Homeverzeichnis in tools/sass/sass-dart installiert.

Unter Windows:

• Gehen Sie in die Systemsteuerung, dort zu System-> Erweitert -> Umgebungsvariablen
• Dort erweitern Sie PATH um den Pfad zu sass-dart. Wenn es mehrere Variablen gibt, müssen Sie diese mit ";" trennen.

Unter Linux:

PATH=$PATH:~/tools/sass/sass-dart
export  PATH

Danach können Sie in der Kommandozeile "sass" eingeben, es müsste ein Hilfetext zur Nutzung erscheinen

Installation mit NPM

1. in einem leeren Verzeichnis eingeben:

npm init

Bei der Frage nach "name" gibt man an: "superxbulma"

Bei der Frage nach "entry point" gibt man an: "sass/mystyles.scss"

2. Dann installation von sass und bulma:

npm install node-sass --save-dev

npm install bulma --save-dev

Kompilieren der bulma.css

Zum "Kompilieren" der bulma.css benötigen Sie lokal am Arbeitsplatz eine Bulma-Installation. Sie können die zu SuperX 5.2 passende Version von bulma hier herunterladen.

Nach dem Entpacken gehen Sie in der Kommandozeile in den jew. Ordner, und geben zum Testen ein:

sass  bulma.scss  meinbulma.css

Es müssten zwei Dateien erzeugt werden:

• meinbulma.css
• meinbulma.css.map

Dann können Sie das Layout mit folgender Testseite testen:

https://www.superx-projekt.de/doku/kern_modul/ui/bulma_testseite.html

Hier eine Vorschau:

Wenn das klappt können Sie Ihre eigene SCSS-Datei anlegen, z.B. mit dem Namen "meinbulma.scss" und dem Inhalt:

Hier werden ein paar Layouts (Fonts, Farben) umdefiniert.

Dann können Sie das Layout mit obiger Testseite testen:

sass  meinbulma.scss  meinbulma.css

Hier wieder eine Vorschau:

Icons

Ausschalten der Icons

Sie können generell die Anzeige von Icons in der Oberfläche steuern. Dazu können Sie in die Datei webapps/superx/xml/pageComponents_html_final.xsl (siehe Leitfaden Masken- und Tabellengestaltung) die Icons im Breadcrumb:

sowie im linken Navigationspanel:

ein- und ausschalten. Beim Ausschalten wählen Sie "false". Danach sollten Sie im Webanwendung Manager den Cache leeren.

Icons im Themenbaum

Sie können im linken Navigationsmenü (wir nennen das "Themenbaum") eigene "Kapitel" und Unterkapitel anlegen und jeden Eintrag mit einem Icon versehen. In der Beispielauslieferung gibt es bereits einige Icons für die jeweils ausgelieferten Module. Wenn kein Icon definiert ist, erscheint ein "Platzhalter"-Icon. Im folgenden Screenshot ist das Plarthalter Icon rot umrandet:

Ein Icon besteht aus zwei Teilen:

• Eine Grafikdatei, z.B. eine PNG- oder SVG-Datei
• Zwei CSS-Anweisungen, die Formatattribute des Icons jeweils für normale Icon Größe sowie für ein Mini-Icon definieren.

Nehmen wir z.B. den folgenden Themenbaum-Eintrag, der von der Hochschule angelegt wurde:

Links ist die Miniatur, und rechts das größere Icon. Wir wollen das "Standard-Icon" mit dem Kreis durch ein eigenes ersetzen.

Neues Icon star-empty.svg

Zunächst kopieren wir z.B. die Datei "star-empty.svg" auf den Applikationsserver in den neuen Ordner:

.../superx/images/icons/meine_hochschule/

Danach erweitern wir die Repository Variable CUSTOM_CSS um die Zeilen:

Hier ein Screenshot:

Damit ist das Icon im System bekannt.

Danach referenzieren wir darauf im Themenbaum-Eintrag, über die Maske "Themenbaumeintrag suchen":

Nach Speichern, Leeren des Webanwendung Manager Cache und Neu-Anmeldung ist das Icon sichtbar:

Dokumentation von Abfragen: Glossare

Die Statistiken in SuperX ist nicht immer für Außenstehende "selbsterklärend", und insbesondere bei Kennzahlen und kondensierten Werten sollten die Konzepte mit einem Glossar versehen sein.

Die Oberfläche des Systems bietet drei Möglichkeiten der Dokumentation:

• Dialogelemente auf den Masken können mit einem "Tool-Tip" versehen werden, d.h. bei Mausbewegung über den Button wird eine Erläuterung angezeigt.
• Ergebnistabellen können mit einem Glossar versehen werden, das die in der Tabelle benutzten Begriffe auf einer zweiten Seite erläutert.
• Umfangreichere Hilfetexte sind über die kontextabhängigen Hilfetexte zu einem Themenbereich, z.B. "Studierende" verlinkt.

Für alle Dokumentationsarten wird dies im Menü Administration -> Masken -> Beschriftungen suchen ( Tabelle sx_captions) gepflegt, die Felderläuterungen und allgemeine Schlüssel dokumentieren. Die Dokumentation ist sogar mehrsprachig möglich. Es werden immer Standardtexte ausgeliefert, die die Hochschule aber beliebig ändern kann.

Generell gilt: wenn eine Hochschule Beschriftungen ändert, werden diese nicht durch das System (z.B. beim Upgrade) überschrieben. Nur bei Deinstallation eines Moduls werden die zugehörigen Beschriftungen gelöscht.

Allgemeine Schlüsselwörter

Allgemeine Schlüsselwörter sind im Menü Administration -> Masken -> Beschriftungen suchen ( Tabelle sx_captions)definiert, man erkennt sie, daran dass die Spalte id gefüllt ist (table_name, field_name und record_no hingegen leer)

Im Beispiel wird der Tag 'studiengang' definiert.

Dieser Tag wird, wenn darum die Sonderzeichen @@@ aufgeführt sind (also hier z.B. @@@studiengang@@@) an beliebiger Stelle (Maskennamen, Überschriften, select_stmt, XIL-Proplist, XSL-Dateien, etc) durch den Eintrag contents_short der aktuellen Locale ersetzt.

Der Spezialfall Maskenfelder

Für die Erläuterung von Maskenfeldern können kurze und längere Hilfetexte hinterlegt werden. Die kurzen Texte dienen als Beschriftung des Feldes (überschreiben als den "Feldnamen"), und die langen Texte erscheinen als Tool-Tip bei Mausbewegung auf den Button. Im Ausdruck werden die Maskenfelder wahlweise auf einer separaten Seite dokumentiert.

Damit nicht für jedes einzelne Maskenfeld ein Eintrag gemacht werden muss, kann ein Hilfetext über seinen Namen auch mehreren Maskenfeldern zugeordnet werden; in diesem Fall ist die Spalte record_no leer.

Für Felder aus der Tabelle felderinfo schaut SuperX nach, ob in der Tabelle sx_captions ein Eintrag für die Tabelle felderinfo, field_name studiengang und record_no = 10050 oder null vorhanden ist

Im folgenden Beispiel ist ein Maskenbutton "Studiengang" erläutert, der in dieser Weise und bei dem Feld Nummer 10050 dokumentiert sein soll.

Wenn Sie den Erläuterungstext bei allen Feldern mit dem Namen "studiengang" erscheinen lassen wollen, dann müssen Sie das Feld record_no leer lassen.

Nutzungshandbücher verlinken

Ein allgemeines Nutzungshandbuch ist in der Beschriftung REPORT_DOCUMENTATION_URL konfigurierbar. Dies wird über den Masken und Tabellen in einen "Handbuch-Icon" angezeigt, hier z.B. bei Masken:

Über den Ergebnistabellen ist der gleiche Link sichtbar:

Auch bei jedem Themenbereich (z.B. "Studierende") ist ein Nutzungshandbuch verlinkt.

Die Voreinstellung, das ausgelieferte Nutzungshandbuch, kann man anpassen. Gehen Sie dazu in das Menü Administration -> Masken -> Beschriftungen suchen, und suchen Sie dort nach "Benutzerhandbuch". Sie finden z.B. das Element für die Studierendenverwaltung, mit der ID studierende_doku_benutzer_url. Im Feld "Beschriftung (lang)" steht der voreingestellte HTML-Code mit der URL, z.B.

Den Inhalt können Sie auf eine beliebige Webadresse ändern.

Individuelle Kopf- und Fusszeilen

Hochschulname und URL

Bei der HTML-Darstellung und dem PDF-Export ist auf der ersten Seite im Kopf vorgesehen den Hochschulnamen und die Internetadresse der Hochschule auszugeben. Dies geschieht allerdings nur, wenn diese im System hinterlegt sind. Um die Daten einzugeben oder zu ändern, gehen Sie in der Oberfläche in die Maske "Administration -> Masken -> Beschriftungen suchen". Dort geben Sie bei Stichwort "REPORT" ein.

Feld Sprache muss leer sein.

In der Ergebnistabelle sollte nun in der Spalte id jeweils ein Eintrag für "REPORT_HEADING_INSTITUTION" und für "REPORT_HEADING_URL" erscheinen.

Bei "REPORT_HEADING_INSTITUTION" sollte in der Spalte Inhalt (kurz) der Hochschulname stehen und bei "REPORT_HEADING_URL" die Internetadresse der Hochschule.

Dies kann über den Button Bearbeiten geändert werden.

Hier kann bei Beschriftung (kurz) der Inhalt geändert werden. Danach einfach auf Speichern (oben rechts) klicken.Der Hochschulname ist schon voreingestellt.

Dann leeren Sie den SuperX Manager Cache

URL der Hochschule

Soll im HTML/PDF-Kopf auch die URL der Hochschule angezeigt werden, ändern Sie die Variable

REPORT_HEADING_URL

mit der gleichen Vorgehensweise.

Derzeit noch nicht in der Kopfzeile ausgewertet werden

• REPORT_HEADING_ADRESS=Adressdaten der Hochschule, oder der Name der Abteilung, die die Berichte rausgibt
• REPORT_EMAIL=Kontaktadresse für Berichte
• REPORT_DOCUMENTATION_URL=URL für hochschulinterne Doku-Seiten

Eigenes Logo

Für das Logo wird als Voreinstellung in der Beschriftung REPORT_LOGO_FILE der Wert bei HISinOne-BI der Wert ../xml/his1/images/logos/hisinone_logo_reports.png, und bei SuperX der Wert ../images/SymbolU.gif ausgeliefert, d.h. in dem Feld "Beschriftung (kurz)" steht der Pfad zur Bilddatei relativ zum Verzeichnis webapps/superx/servlet. Um ein eigenes Logo zu nutzen, können Sie die Grafikdatei z.B. in

webapps/superx/images/mein_logo.png

speichern, und in der Beschriftung (kurz) speichern Sie

../images/mein_logo.png

Wenn Sie keinen direkten Zugang zum Tomcat Rechner haben, spielen Sie die Datei zunächst mit dem Uploadtool hoch (s.u.)

Dann wie gehabt:

Rufen Sie Adminstration -> Masken-> Beschriftungen suchen auf ,

wählen Sie bei ID REPORT_LOGO_FILE aus und bei Sprache das Feld leeren.

Klicken Sie auf Abschicken und dann bearbeiten.

Machen Sie im Feld "Beschriftung (kurz)" Ihre Änderung und klicken Sie speichern.

Wichtig, die Pfadangabe muss relativ sein, also starten mit

../MANDANTENID/custom/dateiname

Statt MANDANTENID muss Ihre konkrete MandantenID angegeben werden, die im Upload-Tool angezeigt wird. Hier ein Beispiel:

Dann leeren Sie den SuperX Manager Cache

Damit wird der Hochschulname ggfs. URL und Logo schon in Standard-HTML und PDF-Berichten angezeigt.

Für Kopfzeilen in Excel gehen Sie nach dem Abschnitt unten vor.

Kopfzeilen in Excel

Um beim Excelexport eine individuelle Kopf/Fußzeile zu nutzen, erzeugen Sie eine Exceldatei mit individueller Kopf/Fußzeile und speichern diese als ExcelVersion bis 2003 ab.

Dateiname  vorlage.xls

Laden Sie diese Datei mit dem Uploadtool hoch.

Alternative via XSL:

Schauen Sie in die für das Seitenformat in die Datei $SUPERX_DIR/webserver/tomcat/webapps/superx/xml/pageComponents.xsl; dort wird im Abschnitt definiert, welche Einträge wie gefüllt werden sollen.

Das folgende Beispiel zeigt die Vorgabewerte des Seitenformats einer Excel-Datei. Die Knoten und Attributnamen sollten selbsterklärend sein.

Sie können den gesamten Knoten kopieren in die hochschulspezifische pageComponents_final.xsl-Datei (siehe Leitfaden Masken- und Tabellengestaltung), sie überlagert automatisch die "normale" pageComponents.xsl und ist sofort in allen Berichten aktiv. So können Sie z.B. im Berichtskopf den Hochschulnamen und die Abteilung eintragen.

Ganz individuelle HTML-Kopf/Fußzeilen

Einfach nur den Hochschulnamen/URL und Logo anzeigen, geht am einfachsten wie im ersten Abschnitt beschrieben.

Um eine ganz individuelle Kopfzeile für die Berichte im Browser anzulegen, erzeugen Sie testweise lokale auf Ihrem Computer eine Datei htmlheader.htm, die Sie in Ihrem Browser testen können.

(Die Datei braucht nicht auf den Server gespielt zu werden, nur für Sie lokal zum Ausprobieren)

Sie können diese Datei mit HTML gestalten.

Ein einfaches Beispiel

Sie wollen einfach nur den Namen Ihrer Hochschule zentriert über der Tabelle stehen haben,

der Inhalt der Datei kann dann so aussehen.

Hochschule XY

Wollen Sie zusätzlich ein Logo einbinden, laden Sie das Logo mit dem Upload-Tool hoch und definieren htmlheader.htm z.B. so:

Hochschule XY

Statt MANDANTENID nehmen Sie Ihre konkrete MandantenId, die Ihnen im Upload-Tool angezeigt wird.

Wenn die Datei gut aussieht, kopieren Sie den Inhalt in die Zwischenablage.

Allerdings ohne die

Tags.

Dann wird der Inhalt ins Repository als Variable HTML_HEADER eingespielt. In der Zeile mit HTML_HEADER klicken Sie auf Details.

(Falls die Variable HTML_HEADER nicht gefunden wird, leeren Sie einmal den SuperXManager-Cache und versuchen es erneut.)

Tragen Sie Ihre Vorlage bei Inhalt der Variable ein, speichern Sie und leeren Sie den SuperX-Manager-Cache.

Für eine individuelle Fußzeile legen Sie nach dem gleichen Prinzip eine Datei htmlfooter.htm an und testen Sie sie lokal.

Sie könnten Sie z.B. füllen mit

Dann steht der Hinweis "Datenschutzbestimmungen beachten" unter den Ergebnistabellen im Browser.

Spielen Sie diese als Variable "HTML FOOTER" im Repository ein.

PDF

Einfach nur den Hochschulnamen/URL und Logo anzeigen, geht am einfachsten wie im ersten Abschnitt beschrieben.

Wenn Sie ganz eigene Kop/Fußzeilen entwerfen wollen:

Für die ganz freie Erstellung individueller Kopf-/Fußzeilen muss man eine XSL-Vorlage erstellen und unter der Variablen CUSTOM_PDF ins repository einspielen.

Dazu gehen Sie unter Administration auf Hochschul-Repository.

In der Zeile mit CUSTOM_PDF klicken Sie auf Details.

(Falls die Variable CUSTOM_PDF nicht gefunden wird, leeren Sie einmal den SuperXManager-Cache und versuchen es erneut.)

Tragen Sie Ihre Vorlage bei Inhalt der Variable ein, speichern Sie und leeren Sie den SuperX-Manager-Cache.

Bei PDF kann man separat steuern, wie die Kopf-/Fußzeile der ersten Seite und die der weiteren Seite aussehen soll.

Will man die Höhe einer Kopf/Fußzeile ändern, muss man das an der Stelle machen, wo ein entsprechender Kommentar steht.

z.B.

Hier kann man statt 40mm z.B. 60mm eintragen, wenn man ein großes Logo verwendet. (Der unten im Beispiel angegebene XLM-Header darf nicht fehlen)

Die Gestaltung der Zeilen erfolgt mittels fo bzw. xsl.

Will man z.B. in der Kopfzeile nur den Namen der Hochschule haben, ändert man nach dem entsprechenden Kommentar

Hochschule  XY

Wichtig ist, dass der auch mit einem geschlossen wird.

Möchte man zusätzlich ein Logo einbinden, kann man es mit dem Upload-Tool hochladen und dann z.B. nehmen

Hochschule  XY

Statt MANDANTENID tragen Sie Ihre konkrete MandantenID ein, die vom Upload-Tool angezeigt wird.

Möchten Sie beispielweise in einer Fußzeile das Erstellungsdatum, die aktuelle Seitenzahl sowie die Gesamtzahl der Seiten haben, könnte der Eintrag für die Fußzeilen so ausshen:

Erzeugungsdatum:  

/

Es folgt nun eine komplette Beispieldatei mit den Standardeinstellungen, die Sie als Vorlage nutzen und anpassen können.

<xsl:stylesheet  version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:string="java.lang.String"
xmlns:fo="http://www.w3.org/1999/XSL/Format">

servlet/

Erzeugungsdatum:  

/

Erzeugungsdatum:  

/

Falls beim Aufruf einer PDF-Datei folgender Fehler kommt:

de.superx.common.DBServletException:  Konnte  XSL-Datei  file:////home/superx/tomcat_sx/webapps/superx/xml/tabelle_fo_pdf.xsl  nicht  kompilieren

bedeutet dies, dass Ihre CUSTOM_PDF vorlage nicht der XSL-Syntax entspricht. Korrigieren Sie dies ggfs. anhand des Beispiels schrittweise

Upload von Dateien per Browser

Für die Gestaltung eigener Kopf/Fußzeilen oder bei der Entwicklung eigener Maskenstylesheets kann es nötig sein, eigene Dateiein auf dem Server zu hinterlegen.

Wenn man Zugriff auf das Dateisystem des Webservers hat, kann man dies natürlich manuell machen, neu ist jetzt aber die Möglichkeit auch Dateien per Browser hochzuladen.

Eigene Dateien werden u.a. aus Sicherheitsgründen in ein eigenes Verzeichnis gelegt

webapps/superx/MANDANTENID/custom

ohne Mandantenbetrieb

webapps/superx/default/custom

(falls noch nicht existiert wird das Verzeichnis vom Servlet angelegt)

Um das Upload-Servlet nutzen zu können, muss zunächst die web.xml angepasst werden.

Anpassung der web.xml

Für das Upload-Servlet sind Ergänzungen in der web.xml nötig (falls noch nicht vorhanden).

Unter servlets

SuperXUpload

de.superx.servlet.SuperXUpload

default

vorlage.xls,*.gif

Für jeden Mandanten,der das Upload-Servlet nutzen soll, muss es einen Parameter geben.

Wenn es für einen Mandanten keinen param-Eintrag gibt, kann er das Upload-Servlet nicht benutzen.

Ohne Mandantenbetrieb ist es der param-name einfach nur default wie oben, bei zwei Mandanten FH_TEST1 und FH_TEST2

FH_TEST1

vorlage.xls,*.gif,*.png,*.jpg,*.htm

FH_TEST2

vorlage.xls,*.gif,*.png,*.jpg,*.htm

Als Parameter-Value wird eingetragen, welche Dateien/Dateiarten, die Hochschulen hochladen können sollen.

Weiterhin in der web.xml

Unter servlet-mapping

SuperXUpload

/servlet/SuperXUpload

Nutzen des Upload-Servlets

Rufen Sie unter Administration / Upload auf.

Wenn Sie Abschicken anklicken, sehen Sie ein Protokoll über Uploads und ganz oben ist ein Link zum UploadServlet.

Das Upload-Servlet gibt viele Infos aus, wie Ihre MandantenID oder erlaubte Dateien.

Sie können maximal vier Dateien gleichzeitig hochladen.

Jeder Upload wird einschließlich Dateiname,Username,Zeitpunkt und IP-Nummer protokolliert!

Nach dem Upload erhalten Sie eine Bestätigung.

Eigene XSL-Stylesheets mittels Upload-Funktion

Wenn eine Hochschule eigene XSL-Stylesheets mittels upload-Funktion nutzen möchte, ist zu beachten:

• Freigabe für *.xsl-Dateien muss in der web.xml eingetragen sein (s.o.)
• Die Stylesheets werden in das Verzeichnis tomcat/webapps/superx/MANDANTENID/custom geladen, daher müssen in dem Stylesheets Links relativ sein.

z.B. statt standardmäßig

• filename-Eintrag in SuperX-Tabelle sx_stylesheets muss auch relativ sein,z.B.

../custom/MANDANTENID/maske_html_M1.xsl

Embedding SuperX: Eigene Oberflächen für SuperX gestalten

Es ist in SuperX ab dem Kernmodul 3.5 möglich, einzelne SuperX Masken und Ergebnistabellen in eigene Web-Präsenzeen einzubetten. Es werden dabei direkte Hyperlinks auf das SuperX-Servlet genutzt, d.h. unter Umgehung der normalen Menüstruktur in SuperX. Da bei jedem Zugriff die Authentifizierung und die jew. Rechte überprüft werden, ist dies auch sicherheitstechnisch kein Problem.

Allgemeines Vorgehen

Wir erzeugen einen HTML-Hyperlink nach dem Muster

http://<
Beim  Pfad  zum  SuperX-Servlet  gibt  es  drei  Möglichkeiten:

Pfad  zum  Menü  (Themenbaum)
http://<:<>/superx/servlet/SuperXmlAnmeldung

Pfad  zur  Maske
http://<:<>/superx/servlet/SuperXmlMaske

Pfad  zur  Tabelle
http://<:<>/superx/servlet/SuperXmlTabelle


Der  Pfad  zum  Menü  liefert  ein  HTML-Menü  zurück,  der  Pfad  zur  Maske  eine  Maske.  Der  Pfad  zur  Tabelle  liefert  direkt  die  gewünschte  Tabelle.  Als  erster  Parameter  sollte  bei  Masken  und  Tabellen  der  Parameter  "tid=...."  übergeben  werden,  dies  ist  die  Maskennummer.
Diese  Hyperlinks  können  wir  in  eine  vorhandene  Webpräsenz  einbauen,  Anwender,  die  (noch)  nicht  authentifiziert  sind,  müssen  sich  beim  ersten  Aufruf  der  URL  anmelden,  und  werden  dann  zur  gewünschten  Seite  weitergeleitet.  Wenn  mehrere  Seiten  aufgerufen  werden  sollen,  müssen  die  Anwender  allerdings  für  den  Applikations-Server  Cookies  erlauben.
Das  allgemeine  Vorgehen  ist  sehr  einfach,  das  Problem  liegt  nur  im  Detail:  wir  müssen  für  die  Konstruktion  des  Hyperlinks  die  Schlüssel  der  zu  übergebenden  Felder  kennen,  und  wir  müssen  alle  Sonder-  und  Leerzeichen  in  Feldnamen  oder  Werten  entfernen  /  abfangen.  Wir  können  aber  zur  Erleichterung  der  Arbeit  die  Lesezeichen-Funktion  oder  Schlüsselanzeige  von  der  Webanwendung  nutzen.



Beispiel  für  eine  eingebettete  Seite
Nehmen  wir  an  wir  wollen  direkt  auf  folgende  Seite  verlinken:



Es  wird  das  Servlet  SuperXmlTabelle  mit  den  Parametern  "Köpfe  oder  Fälle  =  Köpfe"  etc.  aufgerufen.  


Die  zugehörige  URL  können  wir  durch  den  Lesezeichen-Button      erfahren:





Mit  Klick  auf  den  blauen  Link  mit  der  Rechten  Maustaste  können  Sie  den  Link  in  die  Zwischenablage  kopieren:





Der  Text  in  der  Zwischenablage  ist  ein  Javascript-Aufruf,  der  den  Komfort  im  normalen  Lesezeichen  erhöht.  Wir  benötigen  aber  nur  das  Ergebnis  der  Anweisung,  das  in  der  Variablen  "url"  steht.
javascript:url="http:...encodeURIComponent(p[i].k);if(window.oeffne)oeffne(url);else%20self.location.href=url;


(Zeilenumbrüche  bitte  ignorieren,  der  Link  besteht  aus  nur  einer  Zeile)

Ersetzen  Sie  den  Passus  "if(window.oeffne)oeffne(url);else%20self.location.href=url;"  durch  "alert(url);".
javascript:url="http:...encodeURIComponent(p[i].k);alert(url)





Rufen  Sie  das  Lesezeichen  in  einem  leeren  Browserfenster  auf.  Es  erscheint  eine  Dialogbox  mit  einer  Adresse,  z.B.
http://localhost:8080/superx/servlet/SuperXmlTabelle?tid=16160&K%C3%B6pfe%20oder%20F%C3%A4lle%20%3F=1%3D1&Stichtag=1&Seit%20Semester=20072&F%C3%A4cher=230&F%C3%A4cher-Sicht=k_stg&Studiengang-Sicht=sos_lstgab&Staatsangeh%C3%B6rigkeit-Sicht=sos_staat_astat&Hochschulzugangsber.=hzbart%20in%20%281%2C2%2C5%2C6%29&H%C3%B6rerstatus=1%3D1


Markieren  Sie  den  Text,  und  kopieren  Sie  den  Link  mit  STRG-c  in  die  Zwischenablage.  Testen  Sie  den  Link  in  einem  leeren  Browserfenster.  In  manchen  Browsern  kann  es  Probleme  wegen  Leerzeichen  im  Pfad  geben,  im  Zweifelsfall  ersetzen  Sie  Leerzeichen  durch  "%20".  Wenn  die  Anzeige  funktioniert,  können  Sie  die  URL  in  einen  "echten"  Hyperlink  ("<a  href='...'  ..."  einbauen.

Analog  können  Sie  auch  auf  Masken  verlinken,  die  jew.  Felder  sind  dann  entsprechend  vorbelegt,  ermöglichen  dem  User  aber  dann,  diese  oder  andere  Parameter  zu  ändern,  z.B.:
Dies  ist  ein  Test">http://mercury:8080/superx/servlet/SuperXmlMaske?tid=16340&K%C3%B6pfe%20oder%20F%C3%A4lle%20%3F=studiengang_nr%20%3D%201%20and%20fach_nr%20%3D%201&Stichtag=0&Seit%20Semester=20061&bis%20Semester=20061&F%C3%A4cher-Sicht=k_stg&Status=1%2C2%2C3%2C5%2C6&H%C3%B6rerstatus=1%3D1&Aggregierung%20Fach=10');">Test  einer  Maske

Hier  ist  der  Link  auf  das  Servlet  SuperXmlMaske  eingetragen.  




Aufruf  spezieller  Layouts  einer  Ergebnistabelle
Wenn  Sie  eine  Tabelle  direkt  in  einem  speziellen  Layout  anzeigen  wollen,  können  Sie  auch  Layoutparameter  übergeben;  wenn  Sie  ein  spezielles  Stylesheet  nutzen  wollen,  fügen  Sie  den  Parameter  "&stylesheet=<>"  an,  z.B.

http://localhost:8080/superx/servlet/SuperXmlTabelle?tid=16160&Köpfe  oder  Fälle  %3F=1%3D1&Stichtag=1&Seit  Semester=20072&Fächer=230&Fächer-Sicht=k_stg&Studiengang-Sicht=sos_lstgab&Staatsangehörigkeit-Sicht=sos_staat_astat&Hochschulzugangsber.=hzbart  in  (1%2C2%2C5%2C6)&Hörerstatus=1%3D1&stylesheet=tabelle_fo_pdf.xsl&contenttype=application/pdf


Folgende  Layoutparameter  sind  immer  möglich:

  Generisches  Standardlayout  HTML:  stylesheet=tabelle_html.xsl&contenttype=text/html
  Generisches  Standardlayout  HTML  Druckversion:  stylesheet=tabelle_html_p.xsl&contenttype=text/html
  Generisches  Standardlayout  PDF:  stylesheet=tabelle_fo_pdf.xsl&contenttype=application/pdf
  Generisches  Standardlayout  XML:  stylesheet=tabelle_xml.xsl&contenttype=text/xml
  Generisches  Standardlayout  Excel:  stylesheet=tabelle_xls.xsl&contenttype=application/vnd.ms-excel
  Wenn  Sie  eigene  XSL-Stylesheets  nutzen,  übergeben  Sie  analog  im  Parameter  den  Namen  bzw.  Pfad  zur  xsl-Datei
  Wenn  Sie  JasperReports  nutzen,  übergeben  Sie  analog  im  Parameter  den  Namen  bzw.  Pfad  zur  jrxml-Datei.

Achtung:  eigene  Stylesheets  werden  aus  Sicherheitsgründen  nur  akzeptiert,  wenn  Sie  in  der  outline|Stylesheetverwaltung  der  jew.  Maske  zugewiesen  wurden.  Sie  (oder  potentielle  Angreifer)  können  also  nicht  im  Parameter  stylesheet  beliebige  Stylesheets  einbinden.







Komplexeres  Beispiel  für  die  Einbettung  von  SuperX
Oben  wurde  gezeigt,  wie  man  mit  Hilfe  einer  URL  eine  Ergebnisseite  direkt  abrufen  kann.  Nun  ist  es  hier  und  da  sicher  sinnvoll,  eigene  Parameter  in  einer  benutzerdefinierten  Maske  anzugeben.  Das  folgende  Beispiel  zeigt  eine  Aufrufseite  der  Universität  Bonn.  Zunächst  wird  die  Oberfläche  gezeigt,  und  dann  die  zugehörige  Technik  dafür.


Oberfläche  der  Einbettung  von  SuperX  in  vorhandene  Websites



Die  Seite  bietet  eine  Studierenden-  eine  Personal-  und  eine  Stellenstatistik,  wobei  einzelne  Parameter  (Semester,  Datum)  vom  Anwender  variiert  werden  können.  Wenn  ein  Anwender  z.B:  bei  der  Voreinstellung  "SS  2008"  auf  den  Link  "Studierende  nach  Fach  und  Abschluss"  klicken,  gelangen  Sie  (beim  ersten  Mal)  zu  einem  Login-Dialog:


Nach  dem  Login  erscheint  direkt  die  Tabelle  für  das  SS  2008:



Man  könnte  nun  direkt  zurückgehen  und  ein  anderes  Semester  wählen.  Man  könnte  aber  auch  den  Button  "Zurück  zur  Maske"        anklicken,  dann  gelangt  man  zur  Abfragemaske:






Technik  der  Einbettung  von  SuperX  in  vorhandene  Websites
Die  obige  Oberfläche  wurde  durch  eine  HTML-Seite  erzeugt,  in  die  folgende  Komponenten  eingefügt  wurden:

Eine  Javascript-Methode,  die  den  Aufruf  einer  URL  realisiert  mit  Parameter  realisiert:
<script  language="Javascript"  type="text/javascript"><br  />
function  openWindow(fld_name,fld_val,url)<br  />
{<br  />
if(fld_val=='')<br  />
alert("Bitte  fuellen  Sie  das  Feld  "+fld_name+"  aus");<br  />
else<br  />
{<br  />
zs=url+"&"+fld_name+"="+fld_val;<br  />
window.open(zs,"_blank");<br  />
}<br  />
}<br  />
</script>



Der  folgende  Quellcode  zeigt,  wie  die  Tabelle  und  darunter  die  Maske  aufgerufen  wird:
<form  name="Studierende">  <b>Studierende  im  <SELECT  class="maskinputPflicht"  id="Sem"  NAME="Sem"  tabindex="1"  ><option  class="maskinput"  value="20082">WS  2008/2009</option><option  class="maskinput"  value="20081"  selected="true">SS  2008</option></SELECT></b>  <br  /><br  />
<a  href="javascript:openWindow('Semester',document.forms['Studierende'].elements[0].options[document.forms['Studierende'].elements[0].selectedIndex].value,'../../servlet/SuperXmlTabelle?tid=16280&'+escape('Köpfe  oder  Fälle  ?')+'=studiengang_nr%20%3D%201%20and%20fach_nr%20%3D%201&Stichtag=1&'+escape('Hörerstatus')+'='+escape('hrst  in  (select  apnr  from  sos_k_hrst  where  astat=\'1\')')+'&Status=1%2C2%2C3%2C5%2C6&'+escape('Studiengänge')+'=2');"><br  />
Studierende  nach  Fach  und  Abschluss</a><br><br  />
&nbsp;&nbsp;  <b><a  href="javascript:openWindow('Semester',document.forms['Studierende'].elements[0].options[document.forms['Studierende'].elements[0].selectedIndex].value,'../../servlet/SuperXmlMaske?tid=16280&'+escape('Köpfe  oder  Fälle  ?')+'=studiengang_nr%20%3D%201%20and%20fach_nr%20%3D%201&Stichtag=1&'+escape('Hörerstatus')+'='+escape('hrst  in  (select  apnr  from  sos_k_hrst  where  astat=\'1\')')+'&Status=1%2C2%2C3%2C5%2C6&'+escape('Studiengänge')+'=2');"><br  />
Abfragemaske...</a><br  />
</b><br  />
</form><br  />



Wie  Sie  sehen  werden  die  Felder  mit  Sonderzeichen,  Hochkommata  durch  die  Javascript-Funktion  "escape(...)"  umgewandelt,  damit  der  Aufruf  korrekt  übergeben  wird.  Das  Hochkomma  muss  darüber  hinaus  auch  durch  ein  "\"  maskiert  werden.
Das  obige  <form>-Element  wurde  mit  relativen  URLs  erzeugt,  d.h.  Sie  können  den  Code  z.B.  in  eine  Seite  http://Ihr-Server/superx/xml/public/index.htm  übernehmen,  und  der  Code  ist  direkt  lauffähig.