SuperX - Benutzerbeiträge [de]

Masken- und Tabellengestaltung

2026-09-14T19:27:17Z

Danielq: /* Eigene Navigationsspalten zum Anklicken */

=Vorbemerkung SuperX/HISinOne-BI=
;Vorbemerkung:Die im folgenden vorgestellten Techniken funktionieren in SuperX und in der HISinOne-BI in der Oberfläche "Business Intelligence"-> "Standardberichte" (ggf. mit dem Zusatz "konfigurieren" oder "klassisch"). Nicht alle der im Folgenden dargestellten Möglichkeiten funktionieren in der Angular Oberfläche von HISinOne-BI.

=Selektionsmasken anpassen=
==Checkboxen und Querabhängigkeiten==

Checkboxen können mit Feldart 10 definiert werden. Bei einfachen Masken, kann felderinfo.relation leer bleiben und in felderinfo.default auch ein fester Wert stehen wie true. Wenn es auf der Maske dynamische Felder gibt, in deren SQL z.B.
<source lang="sql">
<<UserID>>
</source>
steht, ist es wichtig, dass auch für Checkboxen in relation und default datenbanktypische Definitionen der auswählbaren Werte stehen, z.B.
<source lang="sql">
<<SQL>> select 'true','Ja' from xdummy union select 'false','Nein' from xdummy
</source>
und im Defaultwert:
<source lang="sql">
<<SQL>> select 'false','Nein' from xdummy;
</source>

==Felder auf der Maske verstecken==

Wenn Felder auf der Maske versteckt werden sollen, gibt es zwei Möglichkeiten:

*Feldart 13 -> das Feld ist versteckt und wird intern nicht aufgebaut, im Masken-XML ist es aber enthalten

* Feldart beliebig, Eintrag in Spalte attribut: hidden </br> Das Feld wird intern aufgebaut und kann auch im Masken-SQL per FreeMarker benutzt werden, es wird aber keine Auswahlmöglichkeit auf der Maske angezeigt (benutzt bisher für Feld Kostenstelle, das nicht angezeigt werden sollte, im Masken-SQL aber schon für Rechtekontrollen benutzt wird)

* Feldart 999 (ab SuperX3.5rc2): Feld wird gar nicht erst aus Datenbank eingelesen, also ob nicht existent

Bei Benutzung der erweiterten kameralen Rechte SxFinRechte:</br>
Auch wenn auf der Maske nicht alle kameralen Felder benötigt werden (z.B. Titel) müssen diese als versteckte Felder vorhanden sein, damit Querabhängigkeiten in Maskenbuttons z.B. FB SxFinRechte(..,"<<Titel>>",....) aufgelöst werden können!

Bei sehr vielen versteckten Feldern rutscht der Abschicken-Button nach unten, da auch versteckte Felder (noch) für die absolute Positionierung berücksichtigt werden. Trick: versteckte Felder in felderinfo auf y=-1 setzen, dann kommen sie nicht in Reihenzählung.
==Felder zum Verarbeiten von Eingaben per Javascript==
;Vorbemerkung:Diese Auswertung wird mit Release Kernmodul 5.1 bzw. HISinOne-BI 2024.06 ausgeliefert.

Ab können Sie vor dem Abschicken einer Maske benutzerdefiniterte Scripte ausführen, die z.B.
* bei Feldinhalt a von Feld x das Feld y mit dem Inhalt b befüllen
** Beispiel fürs Land Sachsen: wenn im Feld "Bericht" der Wert "Stellenbewirtschaftungsbericht (Excel)" ausgewählt wird, wird
*** das Feld "tablestylesheet" mit dem entsprechenden JasperReport befüllt
*** das Feld "Ausgabeformat" mit dem Wert für Excel befüllt.
* Es gibt noch viele andere Szenarien, z.B. können bestimmte Eingaben geprüft und, bei Warnungen, entsprechende Meldungen ausgegeben werden, und das Abschicken wird verhindert.

Technisch ist das wie folgt umgesetzt: Wenn eine Maske ein Feld mit dem Namen "_customValidation" hat, wird
* der defaultwert des Feldes ausgewertet, dieser enthält den Namene einer Javascript-Methode
* diese Methode wird ''vor'' dem Abschicken einer Maske ausgeführt und je nachdem ob "true" oder "false" zurückgeliefert wird, wird die Maske tatsächlich abgeschickt oder nicht.

Hier ein Beispiel:
* Die Maske "Maske kopieren" ermöglicht es, Maskenkopien anzulegen. Die Zielnummer sollte nach den Konventionen von SuperX in einem 10er oder 20er Nummernkreis bestehen. Wenn eine andere Zahl eingegeben wird, sollte eine Warnung erscheinen.
* das Maskenfeld sieht so aus:

[[Bild:masken_kopieren_custom_validation_feld.png|600px]]

* Im Maskenfeld befindet sich eine Referenz auf die Javascript-Funktion ''validiereNeueMaskennr''. Dieser Funktion wird vom Server immer der Parameter des Formulars und der Plattform (superx oder HISinOne-BI) übergeben. Hier der Quellcode:

<source lang="sql">
function validiereNeueMaskennr(frm,platform)
{
var neueNr=frm.elements["Neue tid"].value;
if(neueNr.indexOf("0", neueNr.length - 1) == -1)
{
var meldung="<p>Achtung: bitte wählen Sie eine Maskennummer, die mit 0 endet. Zu Nummernkreisen ";
if(platform=="his1")
meldung +="siehe <a href='https://wiki.his.de/mediawiki/index.php/Masken_entladen_und_einspielen_-_HISinOne-BI' target='_blank'>Leitfaden</a></p>";
else
meldung +="siehe <a href='http://www.superx-projekt.de/doku/entwicklung/masken/f_MaskenerstellenausKopien.htm' target='_blank'>Leitfaden</a></p>";

document.getElementById('validation').innerHTML = meldung;

return false;
}
else
{
return true;
}
}
</source>

* Im Ergebnis passiert nun folgendes, wenn man eine "ungerade" Maskennummer als "Neue Tid" eingibt und abschickt:

[[Bild:masken_kopieren_custom_validation.png|600px]]

Es erscheint eine Warnung, und die Maske wird nicht abgeschickt.

== Felder für Benutzergruppen verstecken ==
Es ist möglich, auf einzelnen Masken Felder für einzelne Gruppen zu verstecken. Dies dient z. B. dazu, das Feld "Hörerstatus" für die Gruppe "Externe Anwender" auszublenden, d.h. es würde immer "Alle" selektiert. Um dies zu realisieren geht man wie folgt vor:

# Ermitteln Sie zunächst die Feldnummer unter Administration->Masken -> Felder -> Feld suchen.
# Nutzen Sie die Selektionsparameter, um das gewünschte Feld zu suchen.
# Klicken Sie auf "Abschicken". Die Nummer steht in der Spalte "tid".
# Öffnen Sie Administration-> Tabelle suchen
#Geben Sie als Stichwort "pref" ein.
#Es erscheinen ein Listen- und ein Detailformular für die Tabelle.
#Klicken Sie auf "Bearbeiten". Es öffnet sich ein Detailformular.
# Wählen Sie die gewünschte "Gruppe" sowie das "Feld" aus.
#Wählen Sie unter Voreinstellung "Versteckt", damit wird das Feld für die jeweilige Gruppe ausgeblendet.
# Klicken Sie auf "Neuen Datensatz einfügen" bzw. "Speichern" .
# Nach dem Speichern können Sie diesen Datensatz "kopieren" oder einen "Neuen Datensatz anlegen" . Auch ein Blättern durch die angelegten Datensätze ist nun möglich.

== Anpassung von Feld-Vorbelegungen ==
Manche Masken haben Vorbelegungen, die bei der Hochschule nicht passen, z.B. Hörerstatus "Alle" im Bereich Studierende. Die in den jeweiligen Komponenten ausgelieferten Masken lassen sich zwar ändern, aber beim Einspielen eines neuen Releases würden diese überschrieben. Um dies zu vermeiden gibt es zwei Wege:

* Sie kopieren die Maske in einen eigenen Nummernkreis, dann ist sie vor Upgrades "geschützt".
* Sie ändern die Maske, und führen danach eine [Kernmodul_Komponentenverwaltung#Dateibasierte_hochschulspezifische_Anpassung| Customize]-Regel ein, die nach jedem Upgrade ausgeführt wird.

Beide Varianten haben Vor- und Nachteile. Die erste Variante ist besser, wenn Sie nur eine Maske ändern wollen, und ggf. auch noch andere Layouts (z.B. auch Spaltenlayouts der Ergebnistabelle) ändern wollen. Die zweite Variante ist besser, wenn Sie auf einen Schlag mehrere Masken bzgl. einer Kleinigkeit ändern wollen. Das obige Beispiel "Hörerstatus" wäre also besser mit der zweiten Variante lösbar, weil es das Feld in vielen Masken gibt. Hier ein Beispiel wie man das macht:

Ändern Sie die Feldvorbelegung über die Maske Administration-> Masken -> Felder -> "Feld suchen", z.B. beim Feld "Hörerstatus" in der Maske "Studierende und Studienanfänger (Zeitreihe)":

Bisheriger Wert in Spalte Defaultwert:

<source lang="sql">
<<SQL>> select apnr, eintrag from hoererstatus where eintrag='alle';
</source>
Neuer Wert:
<source lang="sql">
<<SQL>> select apnr, eintrag from hoererstatus where eintrag='Haupthörer';
</source>
Speichern Sie die Änderung, und testen Sie die Maske. Wenn das Ergebnis Sie zufrieden stellt, können Sie es wie folgt vor Änderungen durch Releases schützen:

Erzeugen Sie eine Datei $SOS_PFAD/conf/customize.sql

und schreiben Sie den Inhalt hinein:
<source lang="sql">
--Änderung xx.xx.xxxx Maskenvorbelegung von Hörerstatus "alle" auf Haupthörer ändern:
update felderinfo
set defaultwert=
'<<SQL>> select apnr, eintrag from hoererstatus where eintrag=''Haupthörer'''
where name='Hörerstatus' and tid=16004;
</source>
Damit wird diese Änderung nach jedem Upgrade ausgeführt. Sie können die Änderung auch direkt für alle Masken vornehmen, indem Sie die Where-Bedingung "and tid=16004" entfernen.

Hier noch ein Beispiel für das Feld "Status": wir ändern den Default von "Alle ohne Beurl." nach "Alle ohne Beurl., ohne Exmatr.":
<source lang="sql">
--Änderung xx.xx.xxxx: Standardwert für Feld Status im Bereich Studierende: alle ohne beurl., ohne exmatr.
update felderinfo
set defaultwert=
'<<SQL>> select apnr,eintrag from sos_status where eintrag=''Alle ohne Beurl., ohne Exmatr.'''
where name='Status'
and tid between 16000 and 16999;
</source>
=Ergebnistabellen anpassen=
==Vorschau: Erweiterte Ergebnistabellen==
Im [[Masken-Tutorial]] wird erläutert wie Quellcodes für Masken erstellt werden. Damit werden grundlegende Tabellenlayouts erzeugt. Darüber hinaus gibt es viele weitere Möglichkeiten, diese Layouts anzupassen.

Die folgende Abbildung zeigt, was jenseits von "normalen" Ergebnistabellen so möglich ist, am Beispiel einer Tabelle aus dem Managementmodul:

[[Bild:tabelle_html_treetable2.png|600px]]

Sie sehen
# Eine Baumdarstellung inkl. Autklappmöglichkeit für die Zeilen
# Dynamische Spalten z.B. bei Semesterzeitreihen
# Verschachtelte Spaltenüberschriften
# Einzelne Zellen werden mit CSS formatiert
Die folgende Abbildung zeigt den Quellcode, im letzten SELECT kann das Layout gesteuert werden.

[[Bild:tabelle_html_treetable3.png|600px]]

Dies wird unten näher erläutert. Aber dies ist nur ein Teil der Möglichkeiten, die es hier gibt. Sie können auch Hyperlinks in die Tabellenzellen legen, oder kleine Balkengrafiken einbauen.

==Baumdarstellung==

Um im XML-Frontend eine Baumstruktur (Treetable) zu erhalten die auf- und zugeklappt werden kann, muss nur in dem letzten select als erstes Feld die Spalte "ebene" angegeben werden. Dieses Feld soll Zahlen enthalten, welche die Ebene angeben (1= erste Ebene, 2= zweite Ebene …). Dabei ist darauf zu achten, dass es keine Sprünge zur übernächsten höheren Ebene gibt, z.B. nicht von Ebene 2 auf Ebene 4 gesprungen wird. Andersherum ist dies kein Problem, also z.B. von Ebene 4 auf Ebene 2. Wenn es nun zuerst eine Spalte mit Ebene 1 gibt und darauf mehrere mit der Ebene 2 sind diese alle unter der Spalte der Ebene 1. Die Reihenfolge der Auflistung entscheidet dabei den übergeordneten Knoten und nicht nur die Ebene.

Ein Beispiel:

[[Bild:tabelle_html_treetable1.png|650px]]

Zum Nachladen von Ergebniszeilen wird das Stylesheet tabelle_html_rows.xsl benutzt.

Wenn man ein spezielles Stylesheet hat, das auch die nachgeladenen Zeilen besonders darstellt, kann man eine eigene Variante von tabelle_html_rows.xsl erstellen und den Dateinamen in der Maske bei chartx eintragen.

Die Baumdarstellung lässt sich auch dynamisch mit Sichtenzugriff erstellen. Dazu kann mit .elements auf Sichten zugegriffen werden. Für Studiengangssichten also Studiengang.elements:

create table tmp_aggr (
Ebene integer,
strukturStr varchar(255),
name varchar (255),
key varchar(255),
anzahl integer,
nextsem integer,
anteil float,
inzweisem integer,
anteilzwei float,
abschlussarbeit integer
);

<#foreach einElement in Studiengang.elements>
insert into tmp_aggr(Ebene,strukturStr, name, key,anzahl,nextsem,anteil,inzweisem,anteilzwei,abschlussarbeit)
select
${einElement.level}::smallint,
'${einElement.strukturStr}'::char(50),
'${einElement.name}'::char(200),
'${einElement.key}'::char(10),
count(E.matrikel_nr),
sum(E.nextsem),
(sum(E.nextsem)*100/count(E.matrikel_nr))::integer,
sum(E.inzweisem),
(sum(E.inzweisem)*100/count(E.matrikel_nr))::integer,
sum(E.abschlussarbeit)
from tmp_ergebnis E
where E.tid in ${einElement.subkeys}
order by 1,2,3,4
;
</#foreach>

==Aufruf eines Stylesheets==

Wenn Sie ein Stylesheet (egal ob JasperReport oder XSLT) der Maske als alleiniges [[Masken_für_das_XML-Frontend_vorbereiten#Zuordnung_eines_Stylsheets_zu_einer_Maske|Tabellenstylesheet zuweisen]], wird dieses direkt im Ergebnis aufgerufen. Wenn Sie dann noch in der Maske ein Feld "Ausgabeformat" integrieren, können die Anwender zwischen HTML, Excel, PDF etc. wählen (s.u.).

Sie können auch eine Maske mit den Feldern "Bericht" und "Ausgabeformat" versehen, in dem die Anwender das entsprechende Layout (d.h. den JasperReport) auswählen kann. Ein funktionierendes Beispiel wäre z.B. die Maske "Studierende Datenblatt". Um so etwas zu erzeugen gehen Sie wie folgt vor:

Es muss auf der Maske ein Feld der Feldart 1 geben mit dem Namen tablestylesheet und der relation
<source lang="sql">
<<SQL>> select distinct filename,X.caption from sx_stylesheets X,sx_mask_style S where X.tid=S.stylesheet_id and S.maskeninfo_id=<<Maskennummer>>;
</source>
und zum Beispiel für Defaultwert:
<source lang="sql">
<<SQL>> select distinct filename,X.caption
from sx_stylesheets X,sx_mask_style S
where X.tid=S.stylesheet_id
and S.maskeninfo_id=<<Maskennummer>>
and S.ord=2
order by 2
</source>
Für das Feld tablestylesheet wird automatisch eine Beschriftung hinterlegt, damit auf der Maske als Anzeige "Bericht" erscheint.

Außerdem müssen Sie ein Feld "Ausgabeformat" in der Maske ergänzen, ebenfalls Feldart=1:</br>
relation:
<source lang="sql">
<<SQL>> select element_value,description from menu_element where element='Ausgabeformat' and nature::smallint<100 order by nature::smallint
</source>
Beispiel für Excel als defaultwert:
<source lang="sql">
<<SQL>> select element_value,description from menu_element where element='Ausgabeformat' and description='Excel'
</source>

==Navigationsspalten==
=== Eigene Navigationsspalten zum Anklicken ===

Wenn die Ergebnistabelle an das XML-Frontend übergeben wird, dann können spezielle Spalten für die Navigation eingesetzt werden.

[[Bild:Navigationsspalten beispiel bearbeiten.png|600px]]

Die Spaltennamen werden im letzten select des select_stmt einer Maske übergeben, dabei kann bei mehreren Spalten Nummern angehängt werden.

SQL für vorherigen Screenshot
select benutzer,name,email,nexttable, nextedit,nextedit2 from tmp_ergebnis;

*'''nexttable''': Link auf eine andere SuperX-Tabelle; der Inhalt des Feldes wird dann um den Pfad zum Servlet, (optional auch den String der Sessionid) und den Passus "SuperXmlTabelle?tid=" ergänzt, d.h. dem Servlet wird als erster Parameter die maskeninfo-tid übergeben.
** So wird z.B. aus dem Inhalt: 20010&id=2044 </br>der Link http://hostname/superx/servlet/SuperXmlTabelle?tid=20010&id=2044
** Die Ergebnisseite wird dann um einen Button ergänzt.
*'''nextwindowtable''': Das gleiche wie "nexttable", nur es wird ein neues Fenster geöffnet.
*'''nextpage''': Link auf eine andere SuperX-Tabelle wie '''nexttable''', es wird nur ein anderes Icon und ein anderer Target genutzt.
*'''nextmask''': Link auf eine andere SuperX-Maske; der Inhalt des Feldes wird dann um den Pfad zum Servlet, (optional auch den String der Sessionid) und den Passus "SuperXmlMaske?tid=" ergänzt. </br>So wird z.B. aus dem Inhalt: 20010&id=2044
** der Link http://hostname/superx/servlet/SuperXmlMaske?tid=20010&id=2044 </br>Die Ergebnisseite wird dann um einen Button ergänzt.
*'''nextdelete''': Link auf eine andere SuperX-Maske; Im Unterschied zu nextmask wird hier ein anderes Icon gewählt: Auf der Ergbnisseite erscheint ein Delete-Button.
*'''nextedit''': Link auf ein DBForms-Formular relativ zur URL des Servlets. Auf der Ergbnisseite erscheint ein Bearbeiten-Button.
*'''nextmail''': Feldinhalte werden um einen Mailto-Tag ergänzt.
** z.B. info@superx-projekt.de wird zu <a mailto:"info@superx-projekt.de"> info@superx-projekt.de</a>
*'''url''': Feldinhalte werden um einen href-Tag, sowie wenn nötig um ein "http" ergänzt.
** z.B. www.superx-projekt.de wird zu <a href="http://www.superx-projekt.de">www.superx-projekt.de</a>
*'''nextlink''': Link auf eine externe Seite oder eine andere SuperX-Tabelle; anders als bei nexttable wird ein frei wählbarer textueller Link angegeben, wobei der Volltext des Links und der eigentliche Link durch ein Trennzeichen "|" getrennt sind.
** So wird z.B. der Feldwert "SuperX-Projekt|http://www.superx-projekt.de" wie folgt ersetzt:
<source lang="xml">
<a href="http://www.superx-projekt.de">SuperX-Projekt</a>
</source>
** Wenn nach dem Trennzeichen keine externe Web-Adresse angeboten wird (erkennbar am vorangestellten "http:"), dann wird der Inhalt des Feldes um den Pfad zum Tabellen-Servlet ergänzt
*** So wird z.B. aus dem Inhalt: Details zur Hochschule|20010&id=2044 der Link <a href="../servlet/SuperXmlTabelle?tid=20010&id=2044">Details zur Hochschule</a>
*'''nextgenericlink''': für generische Links mit Link-Text und Link-URL jeweils mit "|" getrennt.
*'''nextwindowgenericlink ''':wie nextgenericlink nur mit Target "_blank", Zusatzfunktion (ab HisInOne 2023.06 bzw. Kernmodul 4.9) ein img am Anfang stellt eine Grafik für den Link dar
** So wird z.B. aus dem Inhalt:
<source lang="xml">
img:../images/pencil.svg|../edit/portal/portal_show.jsp?config=portal_config_gang_bearbeiten&layout=COLUMNS_2&idParam=1
</source>
der Link
<source lang="xml">
<a href="../edit/portal/portal_show.jsp?config=portal_config_gang_bearbeiten&layout=COLUMNS_2&idParam=1"><img src="../images/pencil.svg" /></a>
</source>
*'''nextserverlink''':Link auf eine andere Seite auf dem aktuellen Server
*'''nextdokulink''':Link auf eine integrierte Wiki-Seite (nur HISinOne-BI)

=== Ergebniszellen anklickbar machen ===
Statt eigener Navigationsspalten ist es auch möglich einzelne Zahlen bzw. Zellen in einem Bericht selbst anklickbar zu machen.

Dies kann z.B. genutzt werden, um per "DrillDown"
* von Kontoständen (wie 80.000 Euro) zu den zugehörigen Buchungen zu kommen,
* sich bei einer Summe von Studierenden die zugehörigen Matrikelnummern ausgeben zu lassen oder
* bei einem Flächenbericht mit Quadratmetern sich beim Anklicken der Quatdratmeterzahl die zugehörigen Räume anzeigen zu lassen.

;Beispiel: In einem einfachen Flächenbericht gibt es eine Ergebnisspalte "flaeche", die anklickbar gemacht werden soll und wenn eine Zahl angeklickt wird, soll ein Detailbericht mit den Räumen dazu (10250) aufgerufen werden.

Für die Ergebnisspalte wie
flaeche decimal(14,2)
muss es zusätzliches Feld in Ergebnistabelle geben
hidden_flaeche text
-> durch das hidden wird erkannt, dass die Spalte selbst nicht dargestellt werden sol und auch nicht nach Excel/PDF exportiert werden soll , _flaeche sorgt für die Zuordnung zu Ergebnisspalte.

Dann beim insert z.B.
insert into tmp_erg (kostenstelle,hidden_flaeche,flaeche)
select kostenstelle,'?tid=10250&Kostenstelle='||kostenstelle||'&cachingcontrol=clearmask',sum(flaeche)
from tmp_rohdaten group by 1,2;

Heißt: Für jede Ergebniszeile wird die Kostenstellennummer dargestellt und der Wert "flaeche" wird anklickbar gemacht (hidden_flaeche). Wenn die Flächenzahl in einer Ergebniszeile angeklickt wird, wird der Bericht 10250 mit dem Parameter z.B. Kostenstelle=1000 in einem neuen Tab aufgerufen.

Cachingcontrol=clearmask
sorgt dafür, dass die Maske neue geladen wird mit den Defaulteinstellungen und keine vorher auf anderen Masken getätigte Auswahl (z.B. Raumnutzungsart=500) eingetragen wird.

Aufpassen muss man noch, wenn man zusätzliche Felder auf der Maske hat.

z.B: Flächenart.

Wenn der User sich nicht die Gesamtfläche ausgeben lässt, sondern eine Einschränkung auf eine oder mehrere Flächenarten gemacht habt, muss diese Einschränkung ja auch an den Detailbericht mit übergeben werden.

Im einfachsten Fall bei obligatorischen numerischen Feld mit einfacher Auswahl - da ja immer etwas ausgewählt sein muss, wird der Tag <<Flächenart>> auf jeden Fall ersetzt.
insert into tmp_erg (kostenstelle,hidden_flaeche,flaeche)
select kostenstelle,'?tid=10250&Kostenstelle='||kostenstelle||'&Flächenart=<<Flächenart>>&cachingcontrol=clearmask',sum(flaeche)
from tmp_rohdaten group by 1,2;

Ist bei Flächenart eine Mehrfachauswahl oder ist nicht numerisch möglich, muss man evtl machen
insert into tmp_erg (kostenstelle,hidden_flaeche,flaeche)
select kostenstelle,'?tid=10250&Kostenstelle='||kostenstelle||'&Flächenart=${Flächenart?replace("|",",")}&cachingcontrol=clearmask',sum(flaeche)
from tmp_rohdaten group by 1,2;
Die Variable ${Flächenart} wird durch die Auswahl des Users gefüllt, dabei werden Pipezeichen bei Mehrfachauswahl durch das Replace mit Kommas ersetzt.

Wenn das Feld nicht obligatorisch ist oder für Gesamtsummenzeile nicht berücksichtigt werden soll, muss man etwas mit freemarker tricksen.
Man erstellt mit assign eine leere Freemarker-Variable für den Flächenartparameter (flart=""), wenn etwas ausgewählt ist, wird die Variable mit Inhalt gefüllt, z:B. &Flächenart=NF1,NF2 - für die zwei ausgewählten Flächenarten NF1 und NF2. In den Link wird dann der Inhalt der FreemarkerVariable mit ${flart} eingebaut.

<source lang="sql">
<#assign flart=""/>
-- Wenn der User eine oder mehrere Flächenarten auf der Maske ausgewählt hat,
-- muss dies auch im LInk übergeben werden mit Komma statt Pipezeichen
<#if "<<Flächenart>>"!=""><#assign flart="&Flächenart="+Flächenart?replace("|",",")/></#if>
insert into tmp_erg (kostenstelle,hidden_flaeche,flaeche)
select kostenstelle,'?tid=10250&Kostenstelle='||kostenstelle||'${flart}&cachingcontrol=clearmask',sum(flaeche) from tmp_rohdaten group by 1,2;
</source>

Eine Beispielmaske (mit noch mehr Freemarker Tricks) ist der Bericht 10320 "Flächen nach Kostenstellen-Flächenarten-Gebäuden (Zeitreihe)"

=== Rechteverwaltung für die Detailmaske ===
Wenn abgefragt werden soll, ob ein User Rechte für die Untermaske hat und nur in dem Fall die Navigationsspalte angezeigt werden soll oder die Zahl anklickbar gemacht werden soll, kann man dies mit einer Freemarkerfunktion machen

z.B. im letzten Select-Statement
select kostenstelle,name <#if UserHasMaskRight(23230)> , nextedit </#if> from tmp_erg
analog in der XIL-Proplist.

Oder bei einer "Hidden"-spalte, bleibt diese leer außer wenn der Anwender Rechte für den Unterbericht hat
<source lang="sql">
<#if UserHasMaskRight(23230)>
update tmp_erg set hidden_flaeche='.....';
</#if>
</source>

==Standardabfragen mit hochschulspezifischen Details versehen==
Bei Standardabfragen, bei denen nur Kleinigkeiten hochschulspezifisch angepasst werden sollen, wird ein Block eingebaut, z.B.
<#if K_hs_nr=6850> --HFT Stuttgart
update tmp_erg set fest=0 where jahr!=year(today()); --Festlegungen nur bei aktuellem Haushaltsjahr
</#if>
Freemarker greift mit K_hs_nr auf die Hochschulnr. aus der Tabelle hochschulinfo zu, der update wird in diesem Beispiel also nur an der HFT Stuttgart gemacht.

Dies ist erweiterbar, indem ein Repository-Objekt CUSTOM_xxxxxx (Maskennummer) angelegt wird. Beispiel: FIN-Abfrage zeigt standardmäßig Festlegungen immer an, aber einige Hochschulen wollen Festlegungen nur für aktuelles Haushaltsjahr. Es wird in CUSTOM_xxxxxx eine Variable definiert:
<#assign FestlegungenNurAktuellesJahr=true/>
Im masken-sql der Maske definiert man dann zunächst einen default-wert
<#assign FestlegungenNurAktuellesJahr=false/> -- default alle festelegungen
<#if CUSTOM_xxxxxx?exists> - falls custom_xxxxxx für die maske exisiert wird es aufgerufen
<#assign inlineTemplate=CUSTOM_xxxxxx?interpret>
<@inlineTemplate/>
-- ausführen der Definition überschreibt default-wert von FestlegungenNurAktuellesJahr mit <#assign FestlegungenNurAktuellesJahr=true/>
</#if>
<#if FestlegungenNurAktuellesJahr>
update tmp_erg set fest=0 where jahr!=year(today());
</#if>

you#re welcome!

==Spaltenlayout in Ergebnistabellen==
Wie im [[Masken-Tutorial#Abfragen_in_Maskendefinitionen|Tutorial]] gezeigt, wird das Spaltenlayout (Überschriften, Breite) in der sog. "xil_proplist" gesteuert (der Name stammt übrigens vom früher im SuperX-Windows-Client eingesetzten XVT-Compiler zur Layoutdarstellung). Das Format ist etwas eigenwillig und soll hier erläutert werden.

===Die Attribute in der xil_proplist===
Zunächst ein Beispiel: der Code für die Maske "Bewerbungsprozess nach Fach/Studiengang" im ZUL-Modul beginnt wie folgt:

XIL List
sizable_columns horizontal_scrolling
drop_and_delete movable_columns
white_space_color=COLOR_WHITE '''fixed_columns=2'''
min_heading_height=55
'''Column''' CID=0 '''heading_text="Ebene"''' center_heading
row_selectable heading_platform readonly
'''width=5''' text_size=20 '''explanation=""'''

Hier sehen Sie die Ausgabe:

{{ImagePara |imgsrc=Bewerbungsprozess_Ergebnistabelle_1.png|width=600|caption=Ergebnistabelle Spalte "Ebene"}}

Der Code stammt wie gesagt von einem alten Windows-Client und wurde nur aus Gründen der abwärtskompatibilität übernommen. Nur die fett hervorgehobenen Code-Teile werden überhaupt ausgewertet. Wichtig ist aber, daß die Absatzstruktur des vorhandenen Dokuments beibehalten wird (d.h. jede Spalte ist in einem Absatz definiert, der mit "Column" beginnt). Am Ende der gesamten Xil_proplist befindet sich die Endemarke "@@@" in einem neuen Absatz.</br>
Hier eine Erläuterung der Attribute:
*'''fixed_columns''': Das Attribut im Kopf steuert wie viele führende Spalten beim Scrollen nach rechts [[Masken-_und_Tabellengestaltung#Fixierte Spalten|fixiert]] bleiben.
*'''Column''': Definiert eine neue Spalte. Achtung: die Anzahl der "Column"-Anweisungen muss mit der Anzahl der Spalten übereinstimmen, die beim select_stmt geliefert werden.
*'''heading_text''': Die Spaltenüberschrift in der Ergebnistabelle. Hier sind noch spezielle Layoutanweisungen möglich (s.u.), außerdem können Sie [https://super-ics.de/superx/doku/entwicklerhandbuch/f_Glossare.htm Glossare] nutzen
*'''width''': Die Spaltenbreite in Zeichen. Diese Anweisung wird im HTML-Layout nicht ausgewertet. Im PDF-Layout wird sie relativ ausgewertet: Alle Spaltenbreiten werden addiert, und zum DIN-A-4-Querformat in Beziehung gesetzt, und dann werden alle Spalten prozentual auf cm heruntergerechnet. In Excel werden die Breiten in Zeichen umgesetzt.
*'''explanation''': Erläuterungstext, der zu der Ergebnistabelle in einem separation Fenster angezeigt werden kann. Achtung: Wenn Sie explanations einsetzen, müssen alle Spalten dieses Attribut haben. Bitte nicht nur einzelne Spalten dokumentieren. Im Notfall schreiben Sie nur die Spaltenüberschrift rein.

=== Fixierte Spalten ===
Bei breiten Tabellen ist es ggf. sinnvoll, die ersten X Spalten zu fixieren, damit sie beim Scrollen nach rechts stehen bleiben. Dies definieren Sie über
* eine [[Kern_Konfiguration#Konstanten|Konstante]] "fixed_columns_aktiv", mit der Sie das Fixieren generell einschalten
* im Kopf der [[Masken-_und_Tabellengestaltung#Die_Attribute_in_der_xil_proplist|Spaltenbeschreibung]] (xil_proplist) mit dem Attribut "fixed_columns".
Beispiel:

XIL List
sizable_columns horizontal_scrolling
drop_and_delete movable_columns
white_space_color=COLOR_WHITE '''fixed_columns=3'''
min_heading_height=40

Bei einer Ergebnistabelle in schmalem Viewport sieht die Originaltabelle so aus:

[[Bild:Bia_kern_fixed_columns2.png|400px]]

Bei einer Ergebnistabelle in schmalem Viewport und Scrollen nach rechts sieht es das dann so aus:

[[Bild:Bia_kern_fixed_columns3.png|400px]]

=== Mehrzeilige Spaltenüberschriften ===

Im Attribut "heading_text" können auch mehrzeilige Spaltenüberschriften definiert werden. Fügen Sie den Zeilenumbruch aber nicht direkt ein, sondern codieren Sie diesen als "\n". Bei der Ausgabe wird dies als Umbruch umgesetzt.

Beispiel: Der Code

Column CID=0 heading_text="Art'''\n'''d.Ebene" center_heading
row_selectable heading_platform readonly
width=10 text_size=20 explanation="@@@sos_ebene@@@"

sieht in der Ausgabe so aus:

[[Image:bsp_xil_proplist_2.png|300px]]

===Verknüpfte Spaltenüberschriften===
Um Spaltenüberschriften zu verknüpfen, muss man wie folgt vorgehen:</br>
Alle Zellen, die verknüpft werden sollen, müssen den gleichen Namen haben, und mit dem Steuerzeichen " \000 " sowie einem Zeilenumbruch " \n " enden.</br>
Beispiel: Der Code

Column CID=4 heading_text="Bewerbungen '''\000\n''' gesamt" center_heading
row_selectable col_selectable rightJust heading_platform readonly
width=10 explanation="Bewerberanzahl "
Column CID=4 heading_text="Bewerbungen '''\000\n''' weiblich" center_heading
row_selectable col_selectable rightJust heading_platform readonly
width=10 explanation=""
Column CID=5 heading_text="Bewerbungen '''\000\n''' weibl. in %" center_heading
row_selectable col_selectable rightJust heading_platform readonly
width=10 explanation=""

sieht in der Ausgabe so aus:

{{ImagePara |imgsrc=Bewerbungsprozess_Ergebnistabelle_2.png|width=600|caption=Verknüpfte Spaltenüberschriften}}

===Dynamische Spaltenanzahl===
Kann mit Freemarker realisiert werden, Einfaches Beispiel:</br>
Nur bei FIN_Quellsystem 1 (MBS) Soll Ansatz ausgegeben werden.
</br></br>
''Abschluss-Select im Masken-SQL:''
select name,<#if K_FIN_Quellsystem=1> hhans</#if>, einnahmen, ausgaben from fin;

''XIL:''
Column CID=4 heading_text="Name" center_heading
row_selectable col_selectable rightJust heading_platform readonly
width=10
<#if K_FIN_Quellsystem=1>
Column CID=4 heading_text="Ansatz" center_heading
row_selectable col_selectable rightJust heading_platform readonly
width=10
</#if>
Column CID=4 heading_text="Einnahmen" center_heading
row_selectable col_selectable rightJust heading_platform readonly
width=10
Column CID=4 heading_text="Einnahmen" center_heading
row_selectable col_selectable rightJust heading_platform readonly
width=10

Ein weiteres Beispiel:</br>
Spalte Bewilligung soll nur angezeigt werden, wenn werte größer 0
</br></br>
''Im Masken-SQL:''
...
<sqlvars>
<sqlvar bewilligungen>select sum(bewill) from fin where ins=<<Ins>> </sqlvar>
</sqlvars>
...
Die im Masken-SQL definierten sqlvars (in diesem Falle bewilligungen) sind auch in der XIL-Proplist zur verfügbar.

''Abschluss-Select im Masken-SQL:''
select name,ansatz<#if bewilligungen>0> , bewill, </#if> , ausgaben,verfuegbar from tmp_erg;

''XIL:''
Column CID=4 heading_text="Name" center_heading
row_selectable col_selectable rightJust heading_platform readonly
width=10
<#if bewilligungen&gt>0 >
Column CID=4 heading_text="bewill" center_heading
row_selectable col_selectable rightJust heading_platform readonly
width=10
</#if>
Column CID=4 heading_text="Ausgaben" center_heading
row_selectable col_selectable rightJust heading_platform readonly
width=10
Column CID=4 heading_text="verfügbar" center_heading
row_selectable col_selectable rightJust heading_platform readonly
width=10

===Hochschulspezifische Einstellmöglichkeit===
Ein Bericht sollte nur so viel Spalten haben wie maximal benötigt werden. In der Standardauslieferung werden alle Spalten gezeigt. Ein Beispiel für ein Standard-Schluss-select:
select name, akt_soll,einnahmen,aus,fest,verfuegbar from tmp_erg
Wenn eine Hochschule nicht alle Spalten oder die Spalten in einer anderen Reihenfolge sehen möchte, wird in x_repository eine Variable CUSTOM_XXXXXX (Maskennummer) angelegt, welche einen customize-Hash und in diesem die Felder, welche angezeigt werden sollen, definiert. field ist Feldname in der tmp_erg-tabelle, caption Spaltenüberschrift, width für xil-proplist und bei Bedarf kann auch explanation ergänzt werden:

<#assign customize={"resulttable":[
{"field":"name","caption":"Gliederung","width":14},
{"field":"akt_soll","caption":"Ansatz","width":15,"explanation":"Haushaltsansatz inkl.Einnahmen und Reste (Haushalterisch: Aktuelles Soll)"},
{"field":"einnahmen","caption":"Einnahmen","width":10},
{"field":"aus","caption":"Ausgaben","width":10},
{"field":"fest","caption":"Festgelegt","width":10},
{"field":"verfuegbar","caption":"verfügbar","width":12,"explanation":"@@@fin_verfuegbar@@@"}
]}/>

Dies wäre die gleich Ausgabe wie im Standard.

{{Achtung|Nach Eingabe/Änderung den Manager-Chache leeren}}

Möchte eine Hochschule beispielsweise verfügbar weiter vorne stehen haben und akt_soll gar nicht sehen, wird der Eintrag folgendermaßen geändert:

<#assign customize={"resulttable":[
{"field":"name","caption":"Gliederung","width":14},
{"field":"verfuegbar","caption":"verfügbar","width":12,"explanation":"@@@fin_verfuegbar@@@"},
{"field":"einnahmen","caption":"Einnahmen","width":10},
{"field":"aus","caption":"Ausgaben","width":10},
{"field":"fest","caption":"Festgelegt","width":10}
]}/>

Im Masken-sql gegen Ende baut man ein
<#if CUSTOM_xxxxxx?exists>
<#assign inlineTemplate=CUSTOM_xxxxxx?interpret>
<@inlineTemplate/>
</#if>

Falls eine Hochschule ein custom_xxxxxx angelegt hat, wird der Inhalt interpretiert und ein customize-Hash steht zur Verfügung.Das Abschluss-select prüft also

<#if customize?exists> --customize existiert, abschluss select daraus aufbauen
select
<#foreach f in customize.resulttable>
${f.field} <#if h_has_next>,</#if>
</#foreach>
from tmp_erg2 ;

<#else> -- kein customize objekt existiert, standard abschluss select
select name,akt_soll,einnahmen,ausgaben,fest,verfügbar from tmp_erg;
</#if>

Für die XIL-Proplist muss es genauso laufen:

XIL List
--freemarker template
<#if CUSTOM_xxxx?exists>
<#assign inlineTemplate=CUSTOM_xxxx?interpret>
<@inlineTemplate/>
</#if>
<#if customize?exists>--wenn Hochschul-customizeobjekt exixtiert, dann xil dynamisch aufbauen
<#foreach f in customize.resulttable>
Column CID=0 heading_text="${f.caption}" center_heading explanation="<#if f.explanation?exists>${f.explanation}</#if>"
row_selectable col_selectable heading_platform readonly width=${f.width}
</#foreach>
<#else> --standard xil list
Column CID=0 heading_text="Name explanation="" center_heading row_selectable col_selectable heading_platform readonly width=9 text_size=0
Column CID=0 heading_text="aktsoll explanation="" center_heading row_selectable col_selectable
..
</#if>

complex, but coool, </br>

for the super nerds,</br>

Technik kann man sogar mit eigenen Freemarker-Funktionen verbinden, z.B. dynamsiche Spalten nach customizing und Link-Spalten zur Einzelbuchung nur anzeigen, wenn Rechte für Einzelbuchungen da sind. Aus dem Kontext, XIL:

<#function isWanted field>
<#assign result=true>
<#if field?starts_with('linkbuch')&&Einzelbuchrecht?exists&&Einzelbuchrecht?is_number&&Einzelbuchrecht=0><#assign result=false/></#if>
<#if (field='einnahmen'||field?starts_with('linkbuchein')||field='offsoll_e'||field?starts_with('linkbuchoffsolle'))&&"<<Einnahmen anzeigen>>"="'nein'">
<#assign result=false/></#if>
<#return result>
<#if customize?exists>
<#foreach f in customize.resulttable>
<#if isWanted(f.field)>
Column CID=2 heading_text="${f.caption}" center_heading explanation="<#if f.explanation?exists>${f.explanation}</#if>"
row_selectable col_selectable heading_platform readonly width=${f.width}
</#if>
</#foreach>
<#else>
...

===Dezimalstellen variieren===
Normalerweise werden Werte mit Dezimalstellen immer zweistellig wiedergegeben. Im Ausnahmefall kann man dies ändern, indem man eine Spalte mit dem Namensschema "hidden"+Spaltenname+"dp" hinter die jeweilige Spalte setzt, und der Inhalt der Spalte enthält die Zahl der Nachkommastellen (0-6 möglich):

select ... plan_soll ,
1::integer as hiddenplan_solldp,...

bewirkt, dass die Spalte plan_soll einstellig dargestellt wird.
{{Achtung|Dies klappt nicht bei verschachtelten Spaltenlayouts}}
=== Einzelne Zellen oder Spalten formatieren (CSS) ===

Wenn im Masken-Resultset zum Beispiel eine Spalte "verfuegbar" existiert, kann über eine zusätzliche Spalte nach dem Muster
hidden - Spaltenname - css
Also hier z.B. eine versteckte Spalte '''hiddenverfuegbarcss''' mit dem Inhalt des css-Klassennamens, z.B. neu in kern44 ''td.boldnumber'':

Auszug
<source lang="sql">
create temp table tmp_erg
(
titel char(5),titelbez varchar(255),sort smallint,
hhans decimal (14,2),
sperre decimal (14,2),
reste decimal(14,2),
akts decimal(14,2),
einnahmen decimal(14,2),
ausgaben decimal (14,2),
fest decimal (14,2),
verfuegbar decimal (14,2),
hiddenverfuegbarcss varchar(200)
) <@informixnolog/>;
…

update tmp_erg set hiddenverfuegbarcss='boldnumber' where sort=0;
select titelbez, hhans,sperre ,reste,akts,einnahmen,ausgaben,fest,verfuegbar+fest,verfuegbar,
hiddenverfuegbarcss from tmp_erg order by sort,titel;
</source>

Eine entsprechende XIL_proplist-Definition der "column" muss es auch geben, hier ist der Name allerdings beliebig, sollte aber eindeutlig sein, d.h. eine Tabelle sollte nicht zwei gleiche Spaltenüberschriften haben.

===Detailansicht verlinken===

Es ist möglich die Werte einer bestimmten Spalte als Links auszugeben, sodass mit einem Klick auf diesen weitere Details in einer zweiten Ergebnistabelle gezeigt werden. Dabei wird über Klick auf diesen Link eine zweite Maske aufgerufen, die Maskenfelder dieser Maske mit den übergebenen Parametern gefüllt und die Ergebnistabelle dieser Maske ausgegeben.
</br>
Im Folgenden eine Erläuterung anhand eines Beispiels mit Prüfungsanmeldungen. Die Tabelle listet pro Modul die Anzahl der Anmeldung und in einer weiteren Spalte die Anzahl der Studierenden, welche zu ihrem dritten Prüfungsversuch antreten. Die Werte der letzten Spalte mit den Drittversuchen wird verlinkt:

{{ImagePara |imgsrc=Links_in_Ergebnistabelle.png|width=600|caption=Links in Ergebnistabelle}}

Nach Klick auf einen der Links erscheint eine weitere Tabelle, welche statt der Anzahl die einzelnen Matrikelnummern inklusive Studiengang ausgibt:

{{ImagePara |imgsrc=Detailansicht.png|width=600|caption=Detailansicht}}
</br>
In diesem Falle fungieren die Werte der Spalte drittversuch als Link. Um dies umzusetzen geben wir eine weitere Spalte hidden_drittversuch aus. Durch hidden wird diese nicht dargestellt und _drittversuch dient als Referenz auf die Spalte drittversuch. Die Spalte hidden_drittversuch enthält den Teil der URL, welcher die Parameter beim Maskenaufruf definiert. Das sieht beispielsweise so aus:

'?tid=30610360&Prüfungskurztext='||pktxt||'&&cachingcontrol=clearmask' as hidden_drittversuch

'||pktxt||' wird ersetzt durch den Wert des Feldes pktxt derselben Zeile:

select
pktxt,
pdtxt,
(case when pstatus='AN' then 1 else 0 end) as anmeldung,
(case when pversuch=3 then 1 else 0 end) as drittversuch,
'?tid=30610360&Prüfungskurztext='||pktxt||'&&cachingcontrol=clearmask' as hidden_drittversuch
into temp tmp_ergebnis

Werden beim Maskenaufruf der Detailansicht weitere Felder benötigt, wird für diese eine Variable angelegt:

#assign stg=""/>
<#if "<<Studiengang>>"!=""><#assign stg="&Studiengang=<<Studiengang>>"?replace("'","")?replace("|",",")/></#if>

So ist gewährleistet, dass der Parameter nicht in die URL übernommen wird, falls das Maskenfeld leer ist. Zudem werden einfache Hochkommata ' und Pipes | ersetzt, um zugewährleisten, dass die URL funktioniert. Einfache Hochkommata ' könnten beispielsweise bei Schlüsseln, welche als charakter definiert sind übergeben werden und Pipes | bei Aufzählungen. Die Variable wird in den select der Spalte hidden_drittversuch eingebunden:

'?tid=30610360&Prüfungskurztext='||pktxt||'${stg}&&cachingcontrol=clearmask' as hidden_drittversuch

Sonderfall: Falls eine Maske in einem Link auf sich selbst verweist wird empfohlen statt der Maskennummer die automatisch gefüllte Freemarker-Variable ${Maskennummer} zu benutzen:

'?tid=${Maskennummer}&Prüfungskurztext='||pktxt||'${stg}&&cachingcontrol=clearmask' as hidden_drittversuch

Hintergrund: Falls man eine Kopie des entsprechenden Berichtes angelegt hat, um diesen mit eingeschränkten Funktionen (bspw. für User mit eingeschränkten Rechten) bereitzustellen, bietet sich die [https://wiki.his.de/mediawiki/index.php/SXimport_zur_Maskengestaltung_verwerden-HISinOne-BI sximport-Funktion] an. Würde dann statt ${Maskennummer} die tid verwandt, so würde der Link in der Berichtskopie auf den Hauptbericht verweisen, was für User mit eingeschränkten Rechten nicht erwünscht ist.

===Datenbalken===
====Datenbalken in Standardberichten allgemein====
Es gibt die Möglichkeit, in der Ergebnistabelle horizontale Balken (In Excel nennt man dies "Datenbalken") anzeigen zu lassen. Dies kann z.B. dazu genutzt werden, ein Balkendiagramm darzustellen.

Hier ein Beispiel: Maske Administration -> Benutzer -> Gruppe suchen -> dort im Ergebnis die Spalte "Anteil Benutzer an Gesamtzahl (in %) "

{{ImagePara |imgsrc=datenbalken_1.png|width=500px|caption=Datenbalken Beispiel}}

Voreingestellt ist auch, dass beim MouseOver ein Tooltip mit der Zahl angezeigt wird.

Es gibt die Möglichkeit, die Datenbalken zu variiieren:
* Balken links- oder rechtsbündig
* Die Breite der Balken wird in Pixel angegeben, Sie können die Breite aber anpassen
** Der jew. Balken kann relativ zu einem Gesamtwert dargestellt werden
** Der gesamte Balken kann in der Breite angepaßt werden
* Auch Balken mit Serien sind möglich
=====Datenbalken linksbündig=====
Der Default des Datenbalkens ist linksbündig, wenn sie also "_graph" als Spaltenüberschrift nehmen, wird der Balken linksbündig gezeichnet.

{{ImagePara |imgsrc=datenbalken_2.png|width=500px|caption=Datenbalken linksbündig}}

=====Datenbalken rechtsbündig=====
Wenn sie "_graphbarright" als Spaltenüberschrift nehmen, wird der Balken rechtsbündig gezeichnet.

{{ImagePara |imgsrc=datenbalken_3.png|width=500px|caption=Datenbalken rechtsbündig}}

=====Datenbalken Breite=====
Die Gesamtbreite der Spalte mit dem Datenbalken (wie gewohnt anteilig zu allen Spalten) wird in der xil_proplist festgelegt. Im folgenden Beispiel wurde die Balkenbreite von 10 auf 20 erhöht:

{{ImagePara |imgsrc=datenbalken_4_breite.png|width=500px|caption=Datenbalken breiter}}

Wenn der Wert für den Datenbalken kein Prozentwert ist (also nicht die Skala 1-100 hat), können Sie den Gesamtwert mit "|" dahinter setzen. Dadurch wird die Breite anteilig berechnet. Beispiel:

Eine Spalte hat den Wert 44 von einem Gesamtwert von 50. Damit der Datenbalken nicht schmaler als die Häfte ist geben Sie die Gesamtsumme dahinter an:
select ..., '44|50' as _graph2 ...
Damit wird der Datenbalken mit der Hälfte der Gesamtbreite angezeigt.
{{ImagePara |imgsrc=datenbalken_5_relativ.png|width=500px|caption=Datenbalken relativ}}

=====Datenbalken mit Beschriftung=====
Sie können den Datenbalken auch mit einer Beschriftung versehen, indem Sie als Spaltenname "_graphbarwithlabel" nutzen:

{{ImagePara |imgsrc=datenbalken_6_label.png|width=500px|caption=Datenbalken mit Beschriftung}}

{{Achtung|Je nach Länge der Zahl und Breite des Balkens kann es zu unschönen Darstellungen kommen.}}
=====Datenbalken mit Serien=====
Wenn Sie den Spaltennamen beginnend mit "_graphbarxseries" liefern werden Datenbalken mit Serien ausgegeben. Dazu wird als Wert eine Liste mit Komma-getrennten Ganzzahlen erwartet, normiert auf die Breite der Spalte in der '''_xil_proplist'''. Hier ein Beispiel:

{{ImagePara |imgsrc=datenbalken 7 xseries.png|width=500px|caption=Datenbalken mit Serien}}

Die Farben der Serie können Sie im Template
<source lang="xml">
<xsl:template name="myBarColorFg" >...</xsl:template>
</source>
in der Datei /superx/xml/pageComponents_html_final.xsl überlagern. Die Auslieferung befindet sich in der Datei /superx/xml/graphtools.xsl.

====Datenbalken in xCube====
Da in xCube die Masken nicht änderbar sind, können Sie die Funktion über die Maske bzw. das Maskenfeld "Spaltenvisualisierung" direkt nutzen.
* Siehe in [[Modul_xCube_Nutzungshandbuch#Spaltenvisualisierung_als_Ansichtsoption|xCube]]

=Exporte anpassen=
== Exportformate ==
Im XML-Frontend können Abfragen direkt nach html (Druckversion), XML, PDF oder XLS (->Excel) exportiert werden. Die zugehörigen Stylesheets lauten:
* '''html (Druckversion)'''
** <code> $SUPERX_DIR/webserver/tomcat/webapps/superx/xml/tabelle_html_p.xls </code>
*'''PDF '''
** <code> $SUPERX_DIR/webserver/tomcat/webapps/superx/xml/tabelle_fo_pdf.xsl </code>
*'''XLS '''
** <code> $SUPERX_DIR/webserver/tomcat/webapps/superx/xml/tabelle_xls.xsl </code>
Der PDF-Konverter arbeitet mit der OpenSource-Bibliothek FOP, der Excel-Konverter mit POI. Die Vorlagen können als Grundlage für eigene Stylesheets verwendet werden.

Der PDF-Export funktioniert zwar technisch, aber leider sehen die Ergebnisse oft nicht "schön" aus, da die Berichte in SuperX generell über die Seitenbreite hinaus gehen. Wir empfehlen daher, die Exporte nur bei speziell geeigneten Berichten (mit weniger Spalten) zu verwenden. Außerdem gibt es für Volltexte keine Silbentrennung.

Der XLS-Export wurde mit MS Excel  und OpenOffice getestet. Da die Produkte automatisch auf Seitenbreite skalieren können, sieht der Export hier deutlich besser aus.

Außerdem können grundlegende Layoutelemente wie Kopf- und Fußzeilen und Seitenzahlen individuell angepasst werden, ohne zwingend XSLT-Kenntnisse zu haben.

== PDF-Export ==

Kurz ein paar Hinweise:

Am besten nimmt man zur Bearbeitung eine bestehende PDF-Vorlage.

Tabellen:

Für jede Spalte muss direkt unter fo:table fin table-column ein Knoten mit der Breite kommen (im mm)
<source lang="xml">
<fo:table>
<fo:table-column column-width=”30mm”>
<fo:block font-size=”10pt” text-align=”start/end” font-weight=”bold” font-family=”serif” line-height=”9pt”
space-before.optimum=”6pt” space-after.optimum=”6pt” language=”en” hyphente=”true”>
<xsl:value-if select=”format-number(/ergebnisse…,’#.###.##0,00,’German’)”/>
German groß ist wichtig!!!
</fo:block>
</fo:table-column>
<fo:table-header>
<fo:table-row>
<fo:table-cell border-width=”0.1mm” border-style=”solid” padding-left=”0.5mm” padding-right=”0.5mm”>..
<fo:table-body>
<fo:table-row><fo:table-cell>..

<fo:block text-align=”center” font-size=”9pt” font-weight=”bold” hyphenate=”false”>
</source>
Blöcke zusammenhalten
<source lang="xml">
<fo:block keep-together.within-page=”always”>
Block1
Block2
</fo:block>
</source>
Um lokal zu testen gibt es die Java-Klasse de.superx.bin.ExcelPdfCreator
Params

-in/home/superx/iaf-ausgaben.xml -xsl/home/superx/tabelle_fo_pdf_xxxx.xsl -out/home/superx/test.pdf

(Dateiendung legt fest, dass ein PDF erzeugt werden soll).

==Schriftgröße des PDF-Exportes anpassen==
Bei Bedarf kann man die Schriftgröße des PDF-Exportes anpassen. Dazu einfach beim letzten Select des "select_stmts" der Maske noch angeben

select ...... , '''6::smallint as hidden_pdf_fontsize''' from tmp_erg order by ...;

und in der XIL-Proplist als Spalte "hidden_pdf_fontsize" hinterlegen.
</br></br>
Oder falls die Spalten über eine CUSTOM_ Variable im Repository definiert werden, kann man einfach ergänzen:</br></br>
<#assign CUSTOM_1234={"resulttable":[</br>
{"field":"ivst_invnr","caption":"Inventarnr","width":8},</br>
{"field":"ivst_sernr","caption":"Seriennummer","width":9},</br>
{"field":"ivst_gerbez","caption":"Bezeichnung","width":14},</br>
{"field":"lieferant","caption":"Lieferant","width":10},</br>
{"field":"ivst_hh_j","caption":"Jahr","width":6},</br>
{"field":"ivst_betrdat","caption":"Inbetriebname","width":9},</br>
{"field":"ivst_nutzd","caption":"Nutzungs-\ndauer","width":8},</br>
{"field":"ivst_auftnr","caption":"Auftrags-\nnummer","width":8},</br>
{"field":"ivst_preis","caption":"Preis","width":8},</br>
{"field":"ivst_inst","caption":"Kosten-\nstelle","width":8},</br>
{"field":"splitktr","caption":"Kosten-\nträger","width":8},</br>
{"field":"ivst_nutzer","caption":"Nutzer","width":7},</br>
{"field":"ivst_raum","caption":"Raum","width":8},</br>
'''{"field":"8::smallint as hidden_pdf_fontsize","caption":"hidden_pdf_fontsize","width":1}'''</br>
]}/>
== Excelexport ==
{{Hinweis|Es wird nicht vorausgesetzt, dass Sie Microsoft Excel nutzen. Es wird zwar das Excel-Format erzeugt (*.xslx), aber in der Regel sind diese Dateien auch für andere Softwareprodukte, z.B. LibreOffice, nutzbar. }}
===Performance-optimiertes Excel===
Man kann einen Performance-optimierten Excelexport anstoßen, indem man im Berichtskopf den Kommentar "--ram excelexport" setzt.
Dies ist z.B. bei Datenblattberichten standardmäßig der Fall.

===Excel-Vorlagen===
{{Achtung|Diese Funktionalität wird derzeit überarbeitet, weil sie nur mit dem alten Excel Format (*.xls) funktioniert. }}
Am besten nimmt man zur Bearbeitung eine bestehende xsl-Vorlage.

Man kann eine bestehende Excel-Datei als Vorlage nehmen (attribut Vorlage des xls_workbook Knotens).

Dies ist praktisch, um nicht direkt erzeugbare Einstellungen zu hinterlegen, z. B.
* Skalierung auf 70%
* wiederholende Tabellenüberschrift (Seite einrichten/Tabelle)
* Extras/Schutz/Blattschutz (Poi kann man trotzdem reinschreiben!)

<xls_workbook vorlage="vorlage1.xls" removeAdditionalSheets="true">

Wenn man Tabellen auf Vorrat angelegt hat, kann man mit dem Tag removeAdditionalSheets=true überflüssige Tabellen entfernen.

Es werden alle Zellen neu erzeugt, man kann jedoch einzelne Zeilen oder Zellen überspringen, um in der Excel-Vorlage enthaltenes nicht zu überschreiben:
<xls_row jumpover="true">
<xls_cell jumpover="true"></xls_cell>
Tabellenblatt
<xsl_sheet>
Zelle kann Attribute haben ebene=summe
<xsl_row>

;Zellen
Für Zahlen
<xls_cell style="body_dec" numeric="true">

mögliche Attribute: width (gilt logischerweise für ganze Spalte)

Um lokal zu testen gibt es Java-Klasse de.superx.bin.ExcelPdfCreator
Params

-in/home/superx/iaf-ausgaben.xml -xsl/home/superx/tabelle_xls_xxxxxx.xsl -out/home/superx/test.xls

(Dateiendung legt fest, dass eine Excel-Datei erzeugt werden soll)

==Export als Mediawiki-Quellcode==
Wenn sie die Software Mediawiki nutzen, können Sie Tabellenexporte auch direkt als Quellcode exportieren:

[[Bild:tabelle_html_wiki1.png|600px]]

Der Quellcode wird im Browser in einem neuen Fenster ausgegeben:

[[Bild:tabelle_html_wiki2.png|600px]]

Diesen Quellcode können Sie per Copy-Paste in Ihre Mediawiki übernehmen, in der Variante [https://www.hallowelt.com Bluespice] sieht das dann so aus:

[[Bild:tabelle_html_wiki3.png|600px]]

=Masken- und Tabellenlayouts mit XSLT=
==Stylesheets verwalten==
Es ist möglich für Spezialfunktionen eigene Stylesheets für einzelne Masken zu hinterlegen. Zunächst muss für das Ergebnis ein neues Stylesheet erzeugt werden. Als Vorlage für Masken können Sie das Muster-Stylesheet
$WEBAPP/xml/maske_html.xsl
verwenden. Für Ergebnistabellen können Sie das Muster-Stylesheet
$WEBAPP/xml/tabelle_html.xsl
verwenden. Speichern Sie das Stylesheet unter einem anderen Namen im gleichen Verzeichnis ab, und ändern Sie das Stylesheet. Dann fügen Sie das Stylesheet in die Tabelle sx_stylesheets ein.

[[Bild:sx_stylesheets_access.png|400px]]

Das Beispiel zeigt einige Stylesheets, das erste ist bereits Teil des Kernmoduls, das fünfte befindet sich im COB-Modul. Zu den Feldern:
* ''filename'' kennzeichnet den Dateinamen relativ zum Verzeichnis $SUPERX_DIR/webserver/tomcat/webapps/superx/xml.
* ''caption'' dient als Kurzüberschrift, die im Ergebnisblatt als Button angezeigt wird.
* ''description'' stellt einen Erläuterungstext für den Button dar.
* ''relation'' bezieht sich auf die Beziehung des Stylesheets; mögliche Werte sind "mask" für eine Maske und "table" für Tabelle.
* '' useragent'' bietet die Möglichkeit, ein Stylesheet für spezielle Lesegeräte anzubieten, z.B. WAP-Hanys oder Braille-Zeilen.
* ''contenttype'' entspricht dem useragent und kennzeichnet den content-type, der dem Lesegerät im http-header übermittelt werden soll. Möglich sind derzeit die obigen Varianten (svg oder excel sind in Vorbereitung).
* ''is_generic''. Generisches Stylesheet für alle Ergebnistabellen (1=ja)
* ''usage_resultset_data''. Nutzung der Ergebnisdaten: Welche Ergebniszeilen soll das Stylesheet verarbeiten. S=Nur Schema, T=Aktuelle Baumstruktur,A=Alle Daten. Die Ausprägung T=aktuelle Baumstruktur wird nur ausgewertet, wenn die Ergebnistabelle in den Zeilen eine Aufklappfunktion bietet.
* ''stylesheet_type''. Art des Stylesheets (XSL,JRXML,XSL_JRXML,XSL_FO,XML,NATIVE,XLSX). Der Wert XSL_JRXML wird nur ausgewertet wenn das RPTA-Modul installiert ist (Berichtsassistent)
* ''jr_datasource''. Datenquelle (JasperReports). Wird nur bei JasperReports ausgewertet. Mögliche Werte: RS (Resultset vom Servlet) oder XMLSOURCE (XML vom Servlet). Ersteres ist schneller, zweites ist flexibler.
Im Browser können Sie die Daten mit dieser Maske bearbeiten:

[[Bild:stylesheets_suchen_bearbeiten.png|800px]]

==Zuordnung eines Stylesheets zu einer Maske==
Konkret arbeitet SuperX so: Wenn einer Abfrage ein oder mehrere Stylesheets zugeordnet sind, dann werden die in der Reihenfolge angezeigt, in der sie definiert sind. Wenn kein Stylesheet definiert ist, dann wird das Standard-Stylesheet von SuperX benutzt: maske_html.xsl für Masken sowie tabelle_html.xsl für Tabellen. </br>

<blockquote>
Die Zuordnung eines Stylesheets geschieht in der Tabelle sx_mask_style . Der Tupelidentifier des Stylesheets wird in der Tabelle sx_mask_style im Feld stylesheet_id eingetragen. Die Tabelle lässt sich über ein Bearbeitungsformular füllen. Dieses wird erreicht wenn die Maske gesucht wird, welcher ein Stylesheet zugeordnet wird:

{{ImagePara |imgsrc=Stylesheet_Zuordnung_2.png|width=400|caption=MaskenfeldSemester}}

Das Feld Sortiernummer (ord) kennzeichnet die Reihenfolge der anzubietenden Stylesheets. Wir sehen hier, dass zuerst das generische Standard-Stylesheet angezeigt wird und dann ein [https://superxhosting.de/superx/edit/kb/kb_media_ansehen.jsp?id=12 JasperReport als weiteres Stylesheet].
{{ImagePara |imgsrc=Stylesheet_Zuordnung.png|width=400|caption=MaskenfeldSemester}}

Defaultmäßig sind die Stylesheets für html (Druckversion in neuem Fenster), xml, Excel und PDF in jeder Ergebnistabelle enthalten. Andere Stylesheets werden in der obigen Tabelle zugeordnet.
</blockquote>
== Einzelne Templates anpassen ==
Mit eigenen XSL-Stylesheets kann man das Aussehen von Masken oder Ergebnistabellen sehr individuell anpassen. Oben beschrieben war das Vorgehen, dass man eine Kopie von '''maske_html/pdf/xls.xsl bzw tabelle_html/pdf/xls.xsl''' machte und darin Änderungen vornahm.

Da inzwischen immer wieder Erweiterungen an den Standardstylesheets vorgenommen werden, kommen diese Erweiterungen dann jedoch nicht in die kopierten Spezialstylesheets.

Daher sind die Stylesheets inzwischen etwas „objektorientierter" und kleine Änderungen kann man auch in der Datei
.../webapps/superx/xml/page_components_final.xsl
vornehmen.

Beispiel aus der Praxis, bei 2-3 Masken sollte unter dem Maskennamen noch ein Link zu PDF-Dateien erscheinen.

In der Standard maske_html.xsl ist nach dem Titel ein template-Aufruf definiert.
<source lang="xml">
<p class="maskentitel"><xsl:value-of select="maske/@name" /></p>
<xsl:call-template name="pccustomize"> <xsl:with-param name="position" select="'mask_post_title'">
</xsl:with-param> </xsl:call-template>
</source>

Das Template ist als leer in Page-Components.xsl definiert. Man kann es in <code>pageComponents_final.xsl</code> definieren, dann wird es überschrieben.
<source lang="xml">
<xsl:template name="pccustomize">
<xsl:param name="position"/>
<xsl:if test="$position='mask_post_title'">

</xsl:if>
</xsl:template>
</source>

Die Links werden nur bei den entsprechenden Masken eingebaut.

Außerdem wird standardmäßig das leere maskonload überschrieben, um den div der folgenden Maskenfelder etwas tiefer zu setzen, damit Platz für einen größeren Titel ist.

Um bei bestimmten Masken Export-Buttons auszublenden, kopieren Sie das entsprechende Template (hier: exportButtons) aus der Page-Components.xsl in die pageComponents_final.xsl und fügen dort eine if-Bedingung ein.

Beispiel für das Entfernen des PDF-Export-Buttons für die Masken mit der tid 16000 und 17000:
<source lang="xml">
<xsl:template name="exportButtons" >
...
<xsl:if test="/ergebnisse/ergebnis/maskenname/@id!='16000' and /ergebnisse/ergebnis/maskenname/@id!='17000'">

</xsl:if>
...
</xsl:template>
</source>
Will man ein spezielles Tabellenstylesheet erzeugen, braucht man tabelle_html.xsl nicht mehr kopieren, sondern erzeugt eine xsl-Datei mit den Standard-Importen und fügt dort den Import für tabelle_html.xsl hinzu.
<source lang="xml">
<xsl:import href="xsl_functions.xsl" />
<xsl:import href="resultset_html.xsl" />
<xsl:import href="interLinks_html.xsl" />
<xsl:import href="pageComponents_html.xsl" />
<xsl:import href="tabelle_html.xsl" />
<xsl:import href="pageComponents_html_final.xsl" />
</source>

als weiteres braucht man nur das Template von tabelle_html.xsl zu überlagern, was geändert werden soll.

Einfachstes Beispiel - keine Erläuterungslinks anzeigen:

Template explanation wird überlagert
<source lang="xml">
<xsl:template name="explanation"/>
</source>
Bei Bedarf kann man auch die standardmäßig leeren Funktionen wie
<source lang="xml">
<xsl:call-template name="tablecustomize"><xsl:with-param name="position"
select="'table_post_center'"></xsl:with-param></xsl:call-template>
</source>
überlagern.

Am Ende folgt dann, um die Tabelle aufzubauen.
<source lang="xml">
<xsl:template match="/">
<xsl:call-template name="table"/>
</xsl:template>
</source>
== Besonderes XML zu ALLEN Masken hinzufügen ==

Für das Management-Modul gibt es eine ganz besondere Erweiterung.

Anwendungsfall: ein Navigationsmenü soll in allen Masken bereitgestellt werden, es soll aber auch möglich sein, ganz normale SuperX-Masken einzubinden.

also Aufruf z.B.
http://localhost:8080/superx/servlet/SuperXmlTabelle?tid=xxy&param=1&stylesheet=tabelle_html_man.xsl

Legen Sie dazu in Repository ein Feld ID=CUSTOMXMLADD an. Da kann fester XML drin stehen, der wird zu allen Tabellen-xmls hinzugefügt.

zB..
<source lang="xml">
<navigation>
<item1 .../>
<item2 ../>
</navigation>
</source>

der wird dann in Tabellen XML unter ergebnisse/ergebniselement hinzufügt und kann ausgewertet werden.

z.B:
<source lang="xml">
<div id="Navigation">
<xsl:for-each select="/ergebnisse/ergebnis/ergebniselement/navigation/item">
<p class="ebene0">
<a class="ebene1" target="_self">
<xsl:attribute name="href">
<xsl:value-of select="concat(HtmlUtils:encodeURL('SuperXmlTabelle',/ergebnisse/@jsessionid ),'?tid=',href)" />
</xsl:attribute>
<![CDATA[]]><xsl:value-of select="caption" /><![CDATA[]]>
</a>
</p>
</xsl:for-each>
</source>

Der hinzuzufügende XML wird dynamisch mit Freemarker generiert, z.B.:
<source lang="xml">
<xupdate>
<text table="sx_repository" field="content" where="id='CUSTOMXMLADD'">
<![CDATA[<#include "MAN_MAKROS"/><sqlvars> <sqlvar name="entries" type="hash">
select R.catalogue_id,K.shortname,sqlchunk,calcratio,decimalplaces,linksub,linktimeline
from man_catalogue K,man_catalogue_rpt R
where
K.id=R.catalogue_id and R.active=1 order by R.sortnr, R.sortnr2 </sqlvar> </sqlvars>
<#if !Semester?exists><#assign Semester=""></#if>
<#if !Bezugssemester?exists><#assign Bezugssemester=""/></#if>
<#if !Jahr?exists><#assign Jahr=""></#if>
<#if !faecherkeys?exists><#assign faecherkeys=""></#if>
<#if !Fächer?exists><#assign Fächer={"selectedKey":""}></#if>
<#if !Kostenstelle?exists><#assign Kostenstelle={"selectedKey":""}></#if>
<#if !(.vars["Datum (Personal)"]?exists)><#assign "Datum (Personal)"=""></#if>
<#if !(.vars["Beschäftigungsstelle (Person)"]?exists)><#assign "Beschäftigungsstelle (Person)"="">
</#if><navigation><item><href>CDATASTART888880190&Jahr=${Jahr}&Semester=${Semester}&Datum%20(Personal)=${.vars["Datum (Personal)"]}
CDATAEND</href><caption>Start</caption></item>
<#if entries?is_sequence><#foreach e in entries> <#assign linktimeline=e.linktimeline?interpret/>
<#assign linkt><@linktimeline/></#assign> <#assign linksub=e.linksub?interpret/>
<#assign links><@linksub/></#assign> <doubleitem id="${e.id}"> <aktuell>CDATASTART${links?replace('Fakultäten|','')}CDATAEND</aktuell>
<zeitreihe>CDATASTART${linkt?replace('Zeitreihe|','')}CDATAEND</zeitreihe>
<caption>CDATASTART${e.shortname}
CDATAEND</caption> </doubleitem> </#foreach> </#if></navigation>]]>
</text>

</xupdate>

</source>

Masken- und Tabellengestaltung

2026-09-14T19:25:44Z

Danielq: /* Eigene Navigationsspalten zum Anklicken */

=Vorbemerkung SuperX/HISinOne-BI=
;Vorbemerkung:Die im folgenden vorgestellten Techniken funktionieren in SuperX und in der HISinOne-BI in der Oberfläche "Business Intelligence"-> "Standardberichte" (ggf. mit dem Zusatz "konfigurieren" oder "klassisch"). Nicht alle der im Folgenden dargestellten Möglichkeiten funktionieren in der Angular Oberfläche von HISinOne-BI.

=Selektionsmasken anpassen=
==Checkboxen und Querabhängigkeiten==

Checkboxen können mit Feldart 10 definiert werden. Bei einfachen Masken, kann felderinfo.relation leer bleiben und in felderinfo.default auch ein fester Wert stehen wie true. Wenn es auf der Maske dynamische Felder gibt, in deren SQL z.B.
<source lang="sql">
<<UserID>>
</source>
steht, ist es wichtig, dass auch für Checkboxen in relation und default datenbanktypische Definitionen der auswählbaren Werte stehen, z.B.
<source lang="sql">
<<SQL>> select 'true','Ja' from xdummy union select 'false','Nein' from xdummy
</source>
und im Defaultwert:
<source lang="sql">
<<SQL>> select 'false','Nein' from xdummy;
</source>

==Felder auf der Maske verstecken==

Wenn Felder auf der Maske versteckt werden sollen, gibt es zwei Möglichkeiten:

*Feldart 13 -> das Feld ist versteckt und wird intern nicht aufgebaut, im Masken-XML ist es aber enthalten

* Feldart beliebig, Eintrag in Spalte attribut: hidden </br> Das Feld wird intern aufgebaut und kann auch im Masken-SQL per FreeMarker benutzt werden, es wird aber keine Auswahlmöglichkeit auf der Maske angezeigt (benutzt bisher für Feld Kostenstelle, das nicht angezeigt werden sollte, im Masken-SQL aber schon für Rechtekontrollen benutzt wird)

* Feldart 999 (ab SuperX3.5rc2): Feld wird gar nicht erst aus Datenbank eingelesen, also ob nicht existent

Bei Benutzung der erweiterten kameralen Rechte SxFinRechte:</br>
Auch wenn auf der Maske nicht alle kameralen Felder benötigt werden (z.B. Titel) müssen diese als versteckte Felder vorhanden sein, damit Querabhängigkeiten in Maskenbuttons z.B. FB SxFinRechte(..,"<<Titel>>",....) aufgelöst werden können!

Bei sehr vielen versteckten Feldern rutscht der Abschicken-Button nach unten, da auch versteckte Felder (noch) für die absolute Positionierung berücksichtigt werden. Trick: versteckte Felder in felderinfo auf y=-1 setzen, dann kommen sie nicht in Reihenzählung.
==Felder zum Verarbeiten von Eingaben per Javascript==
;Vorbemerkung:Diese Auswertung wird mit Release Kernmodul 5.1 bzw. HISinOne-BI 2024.06 ausgeliefert.

Ab können Sie vor dem Abschicken einer Maske benutzerdefiniterte Scripte ausführen, die z.B.
* bei Feldinhalt a von Feld x das Feld y mit dem Inhalt b befüllen
** Beispiel fürs Land Sachsen: wenn im Feld "Bericht" der Wert "Stellenbewirtschaftungsbericht (Excel)" ausgewählt wird, wird
*** das Feld "tablestylesheet" mit dem entsprechenden JasperReport befüllt
*** das Feld "Ausgabeformat" mit dem Wert für Excel befüllt.
* Es gibt noch viele andere Szenarien, z.B. können bestimmte Eingaben geprüft und, bei Warnungen, entsprechende Meldungen ausgegeben werden, und das Abschicken wird verhindert.

Technisch ist das wie folgt umgesetzt: Wenn eine Maske ein Feld mit dem Namen "_customValidation" hat, wird
* der defaultwert des Feldes ausgewertet, dieser enthält den Namene einer Javascript-Methode
* diese Methode wird ''vor'' dem Abschicken einer Maske ausgeführt und je nachdem ob "true" oder "false" zurückgeliefert wird, wird die Maske tatsächlich abgeschickt oder nicht.

Hier ein Beispiel:
* Die Maske "Maske kopieren" ermöglicht es, Maskenkopien anzulegen. Die Zielnummer sollte nach den Konventionen von SuperX in einem 10er oder 20er Nummernkreis bestehen. Wenn eine andere Zahl eingegeben wird, sollte eine Warnung erscheinen.
* das Maskenfeld sieht so aus:

[[Bild:masken_kopieren_custom_validation_feld.png|600px]]

* Im Maskenfeld befindet sich eine Referenz auf die Javascript-Funktion ''validiereNeueMaskennr''. Dieser Funktion wird vom Server immer der Parameter des Formulars und der Plattform (superx oder HISinOne-BI) übergeben. Hier der Quellcode:

<source lang="sql">
function validiereNeueMaskennr(frm,platform)
{
var neueNr=frm.elements["Neue tid"].value;
if(neueNr.indexOf("0", neueNr.length - 1) == -1)
{
var meldung="<p>Achtung: bitte wählen Sie eine Maskennummer, die mit 0 endet. Zu Nummernkreisen ";
if(platform=="his1")
meldung +="siehe <a href='https://wiki.his.de/mediawiki/index.php/Masken_entladen_und_einspielen_-_HISinOne-BI' target='_blank'>Leitfaden</a></p>";
else
meldung +="siehe <a href='http://www.superx-projekt.de/doku/entwicklung/masken/f_MaskenerstellenausKopien.htm' target='_blank'>Leitfaden</a></p>";

document.getElementById('validation').innerHTML = meldung;

return false;
}
else
{
return true;
}
}
</source>

* Im Ergebnis passiert nun folgendes, wenn man eine "ungerade" Maskennummer als "Neue Tid" eingibt und abschickt:

[[Bild:masken_kopieren_custom_validation.png|600px]]

Es erscheint eine Warnung, und die Maske wird nicht abgeschickt.

== Felder für Benutzergruppen verstecken ==
Es ist möglich, auf einzelnen Masken Felder für einzelne Gruppen zu verstecken. Dies dient z. B. dazu, das Feld "Hörerstatus" für die Gruppe "Externe Anwender" auszublenden, d.h. es würde immer "Alle" selektiert. Um dies zu realisieren geht man wie folgt vor:

# Ermitteln Sie zunächst die Feldnummer unter Administration->Masken -> Felder -> Feld suchen.
# Nutzen Sie die Selektionsparameter, um das gewünschte Feld zu suchen.
# Klicken Sie auf "Abschicken". Die Nummer steht in der Spalte "tid".
# Öffnen Sie Administration-> Tabelle suchen
#Geben Sie als Stichwort "pref" ein.
#Es erscheinen ein Listen- und ein Detailformular für die Tabelle.
#Klicken Sie auf "Bearbeiten". Es öffnet sich ein Detailformular.
# Wählen Sie die gewünschte "Gruppe" sowie das "Feld" aus.
#Wählen Sie unter Voreinstellung "Versteckt", damit wird das Feld für die jeweilige Gruppe ausgeblendet.
# Klicken Sie auf "Neuen Datensatz einfügen" bzw. "Speichern" .
# Nach dem Speichern können Sie diesen Datensatz "kopieren" oder einen "Neuen Datensatz anlegen" . Auch ein Blättern durch die angelegten Datensätze ist nun möglich.

== Anpassung von Feld-Vorbelegungen ==
Manche Masken haben Vorbelegungen, die bei der Hochschule nicht passen, z.B. Hörerstatus "Alle" im Bereich Studierende. Die in den jeweiligen Komponenten ausgelieferten Masken lassen sich zwar ändern, aber beim Einspielen eines neuen Releases würden diese überschrieben. Um dies zu vermeiden gibt es zwei Wege:

* Sie kopieren die Maske in einen eigenen Nummernkreis, dann ist sie vor Upgrades "geschützt".
* Sie ändern die Maske, und führen danach eine [Kernmodul_Komponentenverwaltung#Dateibasierte_hochschulspezifische_Anpassung| Customize]-Regel ein, die nach jedem Upgrade ausgeführt wird.

Beide Varianten haben Vor- und Nachteile. Die erste Variante ist besser, wenn Sie nur eine Maske ändern wollen, und ggf. auch noch andere Layouts (z.B. auch Spaltenlayouts der Ergebnistabelle) ändern wollen. Die zweite Variante ist besser, wenn Sie auf einen Schlag mehrere Masken bzgl. einer Kleinigkeit ändern wollen. Das obige Beispiel "Hörerstatus" wäre also besser mit der zweiten Variante lösbar, weil es das Feld in vielen Masken gibt. Hier ein Beispiel wie man das macht:

Ändern Sie die Feldvorbelegung über die Maske Administration-> Masken -> Felder -> "Feld suchen", z.B. beim Feld "Hörerstatus" in der Maske "Studierende und Studienanfänger (Zeitreihe)":

Bisheriger Wert in Spalte Defaultwert:

<source lang="sql">
<<SQL>> select apnr, eintrag from hoererstatus where eintrag='alle';
</source>
Neuer Wert:
<source lang="sql">
<<SQL>> select apnr, eintrag from hoererstatus where eintrag='Haupthörer';
</source>
Speichern Sie die Änderung, und testen Sie die Maske. Wenn das Ergebnis Sie zufrieden stellt, können Sie es wie folgt vor Änderungen durch Releases schützen:

Erzeugen Sie eine Datei $SOS_PFAD/conf/customize.sql

und schreiben Sie den Inhalt hinein:
<source lang="sql">
--Änderung xx.xx.xxxx Maskenvorbelegung von Hörerstatus "alle" auf Haupthörer ändern:
update felderinfo
set defaultwert=
'<<SQL>> select apnr, eintrag from hoererstatus where eintrag=''Haupthörer'''
where name='Hörerstatus' and tid=16004;
</source>
Damit wird diese Änderung nach jedem Upgrade ausgeführt. Sie können die Änderung auch direkt für alle Masken vornehmen, indem Sie die Where-Bedingung "and tid=16004" entfernen.

Hier noch ein Beispiel für das Feld "Status": wir ändern den Default von "Alle ohne Beurl." nach "Alle ohne Beurl., ohne Exmatr.":
<source lang="sql">
--Änderung xx.xx.xxxx: Standardwert für Feld Status im Bereich Studierende: alle ohne beurl., ohne exmatr.
update felderinfo
set defaultwert=
'<<SQL>> select apnr,eintrag from sos_status where eintrag=''Alle ohne Beurl., ohne Exmatr.'''
where name='Status'
and tid between 16000 and 16999;
</source>
=Ergebnistabellen anpassen=
==Vorschau: Erweiterte Ergebnistabellen==
Im [[Masken-Tutorial]] wird erläutert wie Quellcodes für Masken erstellt werden. Damit werden grundlegende Tabellenlayouts erzeugt. Darüber hinaus gibt es viele weitere Möglichkeiten, diese Layouts anzupassen.

Die folgende Abbildung zeigt, was jenseits von "normalen" Ergebnistabellen so möglich ist, am Beispiel einer Tabelle aus dem Managementmodul:

[[Bild:tabelle_html_treetable2.png|600px]]

Sie sehen
# Eine Baumdarstellung inkl. Autklappmöglichkeit für die Zeilen
# Dynamische Spalten z.B. bei Semesterzeitreihen
# Verschachtelte Spaltenüberschriften
# Einzelne Zellen werden mit CSS formatiert
Die folgende Abbildung zeigt den Quellcode, im letzten SELECT kann das Layout gesteuert werden.

[[Bild:tabelle_html_treetable3.png|600px]]

Dies wird unten näher erläutert. Aber dies ist nur ein Teil der Möglichkeiten, die es hier gibt. Sie können auch Hyperlinks in die Tabellenzellen legen, oder kleine Balkengrafiken einbauen.

==Baumdarstellung==

Um im XML-Frontend eine Baumstruktur (Treetable) zu erhalten die auf- und zugeklappt werden kann, muss nur in dem letzten select als erstes Feld die Spalte "ebene" angegeben werden. Dieses Feld soll Zahlen enthalten, welche die Ebene angeben (1= erste Ebene, 2= zweite Ebene …). Dabei ist darauf zu achten, dass es keine Sprünge zur übernächsten höheren Ebene gibt, z.B. nicht von Ebene 2 auf Ebene 4 gesprungen wird. Andersherum ist dies kein Problem, also z.B. von Ebene 4 auf Ebene 2. Wenn es nun zuerst eine Spalte mit Ebene 1 gibt und darauf mehrere mit der Ebene 2 sind diese alle unter der Spalte der Ebene 1. Die Reihenfolge der Auflistung entscheidet dabei den übergeordneten Knoten und nicht nur die Ebene.

Ein Beispiel:

[[Bild:tabelle_html_treetable1.png|650px]]

Zum Nachladen von Ergebniszeilen wird das Stylesheet tabelle_html_rows.xsl benutzt.

Wenn man ein spezielles Stylesheet hat, das auch die nachgeladenen Zeilen besonders darstellt, kann man eine eigene Variante von tabelle_html_rows.xsl erstellen und den Dateinamen in der Maske bei chartx eintragen.

Die Baumdarstellung lässt sich auch dynamisch mit Sichtenzugriff erstellen. Dazu kann mit .elements auf Sichten zugegriffen werden. Für Studiengangssichten also Studiengang.elements:

create table tmp_aggr (
Ebene integer,
strukturStr varchar(255),
name varchar (255),
key varchar(255),
anzahl integer,
nextsem integer,
anteil float,
inzweisem integer,
anteilzwei float,
abschlussarbeit integer
);

<#foreach einElement in Studiengang.elements>
insert into tmp_aggr(Ebene,strukturStr, name, key,anzahl,nextsem,anteil,inzweisem,anteilzwei,abschlussarbeit)
select
${einElement.level}::smallint,
'${einElement.strukturStr}'::char(50),
'${einElement.name}'::char(200),
'${einElement.key}'::char(10),
count(E.matrikel_nr),
sum(E.nextsem),
(sum(E.nextsem)*100/count(E.matrikel_nr))::integer,
sum(E.inzweisem),
(sum(E.inzweisem)*100/count(E.matrikel_nr))::integer,
sum(E.abschlussarbeit)
from tmp_ergebnis E
where E.tid in ${einElement.subkeys}
order by 1,2,3,4
;
</#foreach>

==Aufruf eines Stylesheets==

Wenn Sie ein Stylesheet (egal ob JasperReport oder XSLT) der Maske als alleiniges [[Masken_für_das_XML-Frontend_vorbereiten#Zuordnung_eines_Stylsheets_zu_einer_Maske|Tabellenstylesheet zuweisen]], wird dieses direkt im Ergebnis aufgerufen. Wenn Sie dann noch in der Maske ein Feld "Ausgabeformat" integrieren, können die Anwender zwischen HTML, Excel, PDF etc. wählen (s.u.).

Sie können auch eine Maske mit den Feldern "Bericht" und "Ausgabeformat" versehen, in dem die Anwender das entsprechende Layout (d.h. den JasperReport) auswählen kann. Ein funktionierendes Beispiel wäre z.B. die Maske "Studierende Datenblatt". Um so etwas zu erzeugen gehen Sie wie folgt vor:

Es muss auf der Maske ein Feld der Feldart 1 geben mit dem Namen tablestylesheet und der relation
<source lang="sql">
<<SQL>> select distinct filename,X.caption from sx_stylesheets X,sx_mask_style S where X.tid=S.stylesheet_id and S.maskeninfo_id=<<Maskennummer>>;
</source>
und zum Beispiel für Defaultwert:
<source lang="sql">
<<SQL>> select distinct filename,X.caption
from sx_stylesheets X,sx_mask_style S
where X.tid=S.stylesheet_id
and S.maskeninfo_id=<<Maskennummer>>
and S.ord=2
order by 2
</source>
Für das Feld tablestylesheet wird automatisch eine Beschriftung hinterlegt, damit auf der Maske als Anzeige "Bericht" erscheint.

Außerdem müssen Sie ein Feld "Ausgabeformat" in der Maske ergänzen, ebenfalls Feldart=1:</br>
relation:
<source lang="sql">
<<SQL>> select element_value,description from menu_element where element='Ausgabeformat' and nature::smallint<100 order by nature::smallint
</source>
Beispiel für Excel als defaultwert:
<source lang="sql">
<<SQL>> select element_value,description from menu_element where element='Ausgabeformat' and description='Excel'
</source>

==Navigationsspalten==
=== Eigene Navigationsspalten zum Anklicken ===

Wenn die Ergebnistabelle an das XML-Frontend übergeben wird, dann können spezielle Spalten für die Navigation eingesetzt werden.

[[Bild:Navigationsspalten beispiel bearbeiten.png|800px]]

Die Spaltennamen werden im letzten select des select_stmt einer Maske übergeben, dabei kann bei mehreren Spalten Nummern angehängt werden.

SQL für vorherigen Screenshot
select benutzer,name,email,nexttable, nextedit,nextedit2 from tmp_ergebnis;

*'''nexttable''': Link auf eine andere SuperX-Tabelle; der Inhalt des Feldes wird dann um den Pfad zum Servlet, (optional auch den String der Sessionid) und den Passus "SuperXmlTabelle?tid=" ergänzt, d.h. dem Servlet wird als erster Parameter die maskeninfo-tid übergeben.
** So wird z.B. aus dem Inhalt: 20010&id=2044 </br>der Link http://hostname/superx/servlet/SuperXmlTabelle?tid=20010&id=2044
** Die Ergebnisseite wird dann um einen Button ergänzt.
*'''nextwindowtable''': Das gleiche wie "nexttable", nur es wird ein neues Fenster geöffnet.
*'''nextpage''': Link auf eine andere SuperX-Tabelle wie '''nexttable''', es wird nur ein anderes Icon und ein anderer Target genutzt.
*'''nextmask''': Link auf eine andere SuperX-Maske; der Inhalt des Feldes wird dann um den Pfad zum Servlet, (optional auch den String der Sessionid) und den Passus "SuperXmlMaske?tid=" ergänzt. </br>So wird z.B. aus dem Inhalt: 20010&id=2044
** der Link http://hostname/superx/servlet/SuperXmlMaske?tid=20010&id=2044 </br>Die Ergebnisseite wird dann um einen Button ergänzt.
*'''nextdelete''': Link auf eine andere SuperX-Maske; Im Unterschied zu nextmask wird hier ein anderes Icon gewählt: Auf der Ergbnisseite erscheint ein Delete-Button.
*'''nextedit''': Link auf ein DBForms-Formular relativ zur URL des Servlets. Auf der Ergbnisseite erscheint ein Bearbeiten-Button.
*'''nextmail''': Feldinhalte werden um einen Mailto-Tag ergänzt.
** z.B. info@superx-projekt.de wird zu <a mailto:"info@superx-projekt.de"> info@superx-projekt.de</a>
*'''url''': Feldinhalte werden um einen href-Tag, sowie wenn nötig um ein "http" ergänzt.
** z.B. www.superx-projekt.de wird zu <a href="http://www.superx-projekt.de">www.superx-projekt.de</a>
*'''nextlink''': Link auf eine externe Seite oder eine andere SuperX-Tabelle; anders als bei nexttable wird ein frei wählbarer textueller Link angegeben, wobei der Volltext des Links und der eigentliche Link durch ein Trennzeichen "|" getrennt sind.
** So wird z.B. der Feldwert "SuperX-Projekt|http://www.superx-projekt.de" wie folgt ersetzt:
<source lang="xml">
<a href="http://www.superx-projekt.de">SuperX-Projekt</a>
</source>
** Wenn nach dem Trennzeichen keine externe Web-Adresse angeboten wird (erkennbar am vorangestellten "http:"), dann wird der Inhalt des Feldes um den Pfad zum Tabellen-Servlet ergänzt
*** So wird z.B. aus dem Inhalt: Details zur Hochschule|20010&id=2044 der Link <a href="../servlet/SuperXmlTabelle?tid=20010&id=2044">Details zur Hochschule</a>
*'''nextgenericlink''': für generische Links mit Link-Text und Link-URL jeweils mit "|" getrennt.
*'''nextwindowgenericlink ''':wie nextgenericlink nur mit Target "_blank", Zusatzfunktion (ab HisInOne 2023.06 bzw. Kernmodul 4.9) ein img am Anfang stellt eine Grafik für den Link dar
** So wird z.B. aus dem Inhalt:
<source lang="xml">
img:../images/pencil.svg|
</source>
der Link
<source lang="xml">
<a href="../edit/portal/portal_show.jsp?config=portal_config_gang_bearbeiten&layout=COLUMNS_2&idParam=1"><img src="../images/pencil.svg" /></a>
</source>
*'''nextserverlink''':Link auf eine andere Seite auf dem aktuellen Server
*'''nextdokulink''':Link auf eine integrierte Wiki-Seite (nur HISinOne-BI)

=== Ergebniszellen anklickbar machen ===
Statt eigener Navigationsspalten ist es auch möglich einzelne Zahlen bzw. Zellen in einem Bericht selbst anklickbar zu machen.

Dies kann z.B. genutzt werden, um per "DrillDown"
* von Kontoständen (wie 80.000 Euro) zu den zugehörigen Buchungen zu kommen,
* sich bei einer Summe von Studierenden die zugehörigen Matrikelnummern ausgeben zu lassen oder
* bei einem Flächenbericht mit Quadratmetern sich beim Anklicken der Quatdratmeterzahl die zugehörigen Räume anzeigen zu lassen.

;Beispiel: In einem einfachen Flächenbericht gibt es eine Ergebnisspalte "flaeche", die anklickbar gemacht werden soll und wenn eine Zahl angeklickt wird, soll ein Detailbericht mit den Räumen dazu (10250) aufgerufen werden.

Für die Ergebnisspalte wie
flaeche decimal(14,2)
muss es zusätzliches Feld in Ergebnistabelle geben
hidden_flaeche text
-> durch das hidden wird erkannt, dass die Spalte selbst nicht dargestellt werden sol und auch nicht nach Excel/PDF exportiert werden soll , _flaeche sorgt für die Zuordnung zu Ergebnisspalte.

Dann beim insert z.B.
insert into tmp_erg (kostenstelle,hidden_flaeche,flaeche)
select kostenstelle,'?tid=10250&Kostenstelle='||kostenstelle||'&cachingcontrol=clearmask',sum(flaeche)
from tmp_rohdaten group by 1,2;

Heißt: Für jede Ergebniszeile wird die Kostenstellennummer dargestellt und der Wert "flaeche" wird anklickbar gemacht (hidden_flaeche). Wenn die Flächenzahl in einer Ergebniszeile angeklickt wird, wird der Bericht 10250 mit dem Parameter z.B. Kostenstelle=1000 in einem neuen Tab aufgerufen.

Cachingcontrol=clearmask
sorgt dafür, dass die Maske neue geladen wird mit den Defaulteinstellungen und keine vorher auf anderen Masken getätigte Auswahl (z.B. Raumnutzungsart=500) eingetragen wird.

Aufpassen muss man noch, wenn man zusätzliche Felder auf der Maske hat.

z.B: Flächenart.

Wenn der User sich nicht die Gesamtfläche ausgeben lässt, sondern eine Einschränkung auf eine oder mehrere Flächenarten gemacht habt, muss diese Einschränkung ja auch an den Detailbericht mit übergeben werden.

Im einfachsten Fall bei obligatorischen numerischen Feld mit einfacher Auswahl - da ja immer etwas ausgewählt sein muss, wird der Tag <<Flächenart>> auf jeden Fall ersetzt.
insert into tmp_erg (kostenstelle,hidden_flaeche,flaeche)
select kostenstelle,'?tid=10250&Kostenstelle='||kostenstelle||'&Flächenart=<<Flächenart>>&cachingcontrol=clearmask',sum(flaeche)
from tmp_rohdaten group by 1,2;

Ist bei Flächenart eine Mehrfachauswahl oder ist nicht numerisch möglich, muss man evtl machen
insert into tmp_erg (kostenstelle,hidden_flaeche,flaeche)
select kostenstelle,'?tid=10250&Kostenstelle='||kostenstelle||'&Flächenart=${Flächenart?replace("|",",")}&cachingcontrol=clearmask',sum(flaeche)
from tmp_rohdaten group by 1,2;
Die Variable ${Flächenart} wird durch die Auswahl des Users gefüllt, dabei werden Pipezeichen bei Mehrfachauswahl durch das Replace mit Kommas ersetzt.

Wenn das Feld nicht obligatorisch ist oder für Gesamtsummenzeile nicht berücksichtigt werden soll, muss man etwas mit freemarker tricksen.
Man erstellt mit assign eine leere Freemarker-Variable für den Flächenartparameter (flart=""), wenn etwas ausgewählt ist, wird die Variable mit Inhalt gefüllt, z:B. &Flächenart=NF1,NF2 - für die zwei ausgewählten Flächenarten NF1 und NF2. In den Link wird dann der Inhalt der FreemarkerVariable mit ${flart} eingebaut.

<source lang="sql">
<#assign flart=""/>
-- Wenn der User eine oder mehrere Flächenarten auf der Maske ausgewählt hat,
-- muss dies auch im LInk übergeben werden mit Komma statt Pipezeichen
<#if "<<Flächenart>>"!=""><#assign flart="&Flächenart="+Flächenart?replace("|",",")/></#if>
insert into tmp_erg (kostenstelle,hidden_flaeche,flaeche)
select kostenstelle,'?tid=10250&Kostenstelle='||kostenstelle||'${flart}&cachingcontrol=clearmask',sum(flaeche) from tmp_rohdaten group by 1,2;
</source>

Eine Beispielmaske (mit noch mehr Freemarker Tricks) ist der Bericht 10320 "Flächen nach Kostenstellen-Flächenarten-Gebäuden (Zeitreihe)"

=== Rechteverwaltung für die Detailmaske ===
Wenn abgefragt werden soll, ob ein User Rechte für die Untermaske hat und nur in dem Fall die Navigationsspalte angezeigt werden soll oder die Zahl anklickbar gemacht werden soll, kann man dies mit einer Freemarkerfunktion machen

z.B. im letzten Select-Statement
select kostenstelle,name <#if UserHasMaskRight(23230)> , nextedit </#if> from tmp_erg
analog in der XIL-Proplist.

Oder bei einer "Hidden"-spalte, bleibt diese leer außer wenn der Anwender Rechte für den Unterbericht hat
<source lang="sql">
<#if UserHasMaskRight(23230)>
update tmp_erg set hidden_flaeche='.....';
</#if>
</source>

==Standardabfragen mit hochschulspezifischen Details versehen==
Bei Standardabfragen, bei denen nur Kleinigkeiten hochschulspezifisch angepasst werden sollen, wird ein Block eingebaut, z.B.
<#if K_hs_nr=6850> --HFT Stuttgart
update tmp_erg set fest=0 where jahr!=year(today()); --Festlegungen nur bei aktuellem Haushaltsjahr
</#if>
Freemarker greift mit K_hs_nr auf die Hochschulnr. aus der Tabelle hochschulinfo zu, der update wird in diesem Beispiel also nur an der HFT Stuttgart gemacht.

Dies ist erweiterbar, indem ein Repository-Objekt CUSTOM_xxxxxx (Maskennummer) angelegt wird. Beispiel: FIN-Abfrage zeigt standardmäßig Festlegungen immer an, aber einige Hochschulen wollen Festlegungen nur für aktuelles Haushaltsjahr. Es wird in CUSTOM_xxxxxx eine Variable definiert:
<#assign FestlegungenNurAktuellesJahr=true/>
Im masken-sql der Maske definiert man dann zunächst einen default-wert
<#assign FestlegungenNurAktuellesJahr=false/> -- default alle festelegungen
<#if CUSTOM_xxxxxx?exists> - falls custom_xxxxxx für die maske exisiert wird es aufgerufen
<#assign inlineTemplate=CUSTOM_xxxxxx?interpret>
<@inlineTemplate/>
-- ausführen der Definition überschreibt default-wert von FestlegungenNurAktuellesJahr mit <#assign FestlegungenNurAktuellesJahr=true/>
</#if>
<#if FestlegungenNurAktuellesJahr>
update tmp_erg set fest=0 where jahr!=year(today());
</#if>

you#re welcome!

==Spaltenlayout in Ergebnistabellen==
Wie im [[Masken-Tutorial#Abfragen_in_Maskendefinitionen|Tutorial]] gezeigt, wird das Spaltenlayout (Überschriften, Breite) in der sog. "xil_proplist" gesteuert (der Name stammt übrigens vom früher im SuperX-Windows-Client eingesetzten XVT-Compiler zur Layoutdarstellung). Das Format ist etwas eigenwillig und soll hier erläutert werden.

===Die Attribute in der xil_proplist===
Zunächst ein Beispiel: der Code für die Maske "Bewerbungsprozess nach Fach/Studiengang" im ZUL-Modul beginnt wie folgt:

XIL List
sizable_columns horizontal_scrolling
drop_and_delete movable_columns
white_space_color=COLOR_WHITE '''fixed_columns=2'''
min_heading_height=55
'''Column''' CID=0 '''heading_text="Ebene"''' center_heading
row_selectable heading_platform readonly
'''width=5''' text_size=20 '''explanation=""'''

Hier sehen Sie die Ausgabe:

{{ImagePara |imgsrc=Bewerbungsprozess_Ergebnistabelle_1.png|width=600|caption=Ergebnistabelle Spalte "Ebene"}}

Der Code stammt wie gesagt von einem alten Windows-Client und wurde nur aus Gründen der abwärtskompatibilität übernommen. Nur die fett hervorgehobenen Code-Teile werden überhaupt ausgewertet. Wichtig ist aber, daß die Absatzstruktur des vorhandenen Dokuments beibehalten wird (d.h. jede Spalte ist in einem Absatz definiert, der mit "Column" beginnt). Am Ende der gesamten Xil_proplist befindet sich die Endemarke "@@@" in einem neuen Absatz.</br>
Hier eine Erläuterung der Attribute:
*'''fixed_columns''': Das Attribut im Kopf steuert wie viele führende Spalten beim Scrollen nach rechts [[Masken-_und_Tabellengestaltung#Fixierte Spalten|fixiert]] bleiben.
*'''Column''': Definiert eine neue Spalte. Achtung: die Anzahl der "Column"-Anweisungen muss mit der Anzahl der Spalten übereinstimmen, die beim select_stmt geliefert werden.
*'''heading_text''': Die Spaltenüberschrift in der Ergebnistabelle. Hier sind noch spezielle Layoutanweisungen möglich (s.u.), außerdem können Sie [https://super-ics.de/superx/doku/entwicklerhandbuch/f_Glossare.htm Glossare] nutzen
*'''width''': Die Spaltenbreite in Zeichen. Diese Anweisung wird im HTML-Layout nicht ausgewertet. Im PDF-Layout wird sie relativ ausgewertet: Alle Spaltenbreiten werden addiert, und zum DIN-A-4-Querformat in Beziehung gesetzt, und dann werden alle Spalten prozentual auf cm heruntergerechnet. In Excel werden die Breiten in Zeichen umgesetzt.
*'''explanation''': Erläuterungstext, der zu der Ergebnistabelle in einem separation Fenster angezeigt werden kann. Achtung: Wenn Sie explanations einsetzen, müssen alle Spalten dieses Attribut haben. Bitte nicht nur einzelne Spalten dokumentieren. Im Notfall schreiben Sie nur die Spaltenüberschrift rein.

=== Fixierte Spalten ===
Bei breiten Tabellen ist es ggf. sinnvoll, die ersten X Spalten zu fixieren, damit sie beim Scrollen nach rechts stehen bleiben. Dies definieren Sie über
* eine [[Kern_Konfiguration#Konstanten|Konstante]] "fixed_columns_aktiv", mit der Sie das Fixieren generell einschalten
* im Kopf der [[Masken-_und_Tabellengestaltung#Die_Attribute_in_der_xil_proplist|Spaltenbeschreibung]] (xil_proplist) mit dem Attribut "fixed_columns".
Beispiel:

XIL List
sizable_columns horizontal_scrolling
drop_and_delete movable_columns
white_space_color=COLOR_WHITE '''fixed_columns=3'''
min_heading_height=40

Bei einer Ergebnistabelle in schmalem Viewport sieht die Originaltabelle so aus:

[[Bild:Bia_kern_fixed_columns2.png|400px]]

Bei einer Ergebnistabelle in schmalem Viewport und Scrollen nach rechts sieht es das dann so aus:

[[Bild:Bia_kern_fixed_columns3.png|400px]]

=== Mehrzeilige Spaltenüberschriften ===

Im Attribut "heading_text" können auch mehrzeilige Spaltenüberschriften definiert werden. Fügen Sie den Zeilenumbruch aber nicht direkt ein, sondern codieren Sie diesen als "\n". Bei der Ausgabe wird dies als Umbruch umgesetzt.

Beispiel: Der Code

Column CID=0 heading_text="Art'''\n'''d.Ebene" center_heading
row_selectable heading_platform readonly
width=10 text_size=20 explanation="@@@sos_ebene@@@"

sieht in der Ausgabe so aus:

[[Image:bsp_xil_proplist_2.png|300px]]

===Verknüpfte Spaltenüberschriften===
Um Spaltenüberschriften zu verknüpfen, muss man wie folgt vorgehen:</br>
Alle Zellen, die verknüpft werden sollen, müssen den gleichen Namen haben, und mit dem Steuerzeichen " \000 " sowie einem Zeilenumbruch " \n " enden.</br>
Beispiel: Der Code

Column CID=4 heading_text="Bewerbungen '''\000\n''' gesamt" center_heading
row_selectable col_selectable rightJust heading_platform readonly
width=10 explanation="Bewerberanzahl "
Column CID=4 heading_text="Bewerbungen '''\000\n''' weiblich" center_heading
row_selectable col_selectable rightJust heading_platform readonly
width=10 explanation=""
Column CID=5 heading_text="Bewerbungen '''\000\n''' weibl. in %" center_heading
row_selectable col_selectable rightJust heading_platform readonly
width=10 explanation=""

sieht in der Ausgabe so aus:

{{ImagePara |imgsrc=Bewerbungsprozess_Ergebnistabelle_2.png|width=600|caption=Verknüpfte Spaltenüberschriften}}

===Dynamische Spaltenanzahl===
Kann mit Freemarker realisiert werden, Einfaches Beispiel:</br>
Nur bei FIN_Quellsystem 1 (MBS) Soll Ansatz ausgegeben werden.
</br></br>
''Abschluss-Select im Masken-SQL:''
select name,<#if K_FIN_Quellsystem=1> hhans</#if>, einnahmen, ausgaben from fin;

''XIL:''
Column CID=4 heading_text="Name" center_heading
row_selectable col_selectable rightJust heading_platform readonly
width=10
<#if K_FIN_Quellsystem=1>
Column CID=4 heading_text="Ansatz" center_heading
row_selectable col_selectable rightJust heading_platform readonly
width=10
</#if>
Column CID=4 heading_text="Einnahmen" center_heading
row_selectable col_selectable rightJust heading_platform readonly
width=10
Column CID=4 heading_text="Einnahmen" center_heading
row_selectable col_selectable rightJust heading_platform readonly
width=10

Ein weiteres Beispiel:</br>
Spalte Bewilligung soll nur angezeigt werden, wenn werte größer 0
</br></br>
''Im Masken-SQL:''
...
<sqlvars>
<sqlvar bewilligungen>select sum(bewill) from fin where ins=<<Ins>> </sqlvar>
</sqlvars>
...
Die im Masken-SQL definierten sqlvars (in diesem Falle bewilligungen) sind auch in der XIL-Proplist zur verfügbar.

''Abschluss-Select im Masken-SQL:''
select name,ansatz<#if bewilligungen>0> , bewill, </#if> , ausgaben,verfuegbar from tmp_erg;

''XIL:''
Column CID=4 heading_text="Name" center_heading
row_selectable col_selectable rightJust heading_platform readonly
width=10
<#if bewilligungen&gt>0 >
Column CID=4 heading_text="bewill" center_heading
row_selectable col_selectable rightJust heading_platform readonly
width=10
</#if>
Column CID=4 heading_text="Ausgaben" center_heading
row_selectable col_selectable rightJust heading_platform readonly
width=10
Column CID=4 heading_text="verfügbar" center_heading
row_selectable col_selectable rightJust heading_platform readonly
width=10

===Hochschulspezifische Einstellmöglichkeit===
Ein Bericht sollte nur so viel Spalten haben wie maximal benötigt werden. In der Standardauslieferung werden alle Spalten gezeigt. Ein Beispiel für ein Standard-Schluss-select:
select name, akt_soll,einnahmen,aus,fest,verfuegbar from tmp_erg
Wenn eine Hochschule nicht alle Spalten oder die Spalten in einer anderen Reihenfolge sehen möchte, wird in x_repository eine Variable CUSTOM_XXXXXX (Maskennummer) angelegt, welche einen customize-Hash und in diesem die Felder, welche angezeigt werden sollen, definiert. field ist Feldname in der tmp_erg-tabelle, caption Spaltenüberschrift, width für xil-proplist und bei Bedarf kann auch explanation ergänzt werden:

<#assign customize={"resulttable":[
{"field":"name","caption":"Gliederung","width":14},
{"field":"akt_soll","caption":"Ansatz","width":15,"explanation":"Haushaltsansatz inkl.Einnahmen und Reste (Haushalterisch: Aktuelles Soll)"},
{"field":"einnahmen","caption":"Einnahmen","width":10},
{"field":"aus","caption":"Ausgaben","width":10},
{"field":"fest","caption":"Festgelegt","width":10},
{"field":"verfuegbar","caption":"verfügbar","width":12,"explanation":"@@@fin_verfuegbar@@@"}
]}/>

Dies wäre die gleich Ausgabe wie im Standard.

{{Achtung|Nach Eingabe/Änderung den Manager-Chache leeren}}

Möchte eine Hochschule beispielsweise verfügbar weiter vorne stehen haben und akt_soll gar nicht sehen, wird der Eintrag folgendermaßen geändert:

<#assign customize={"resulttable":[
{"field":"name","caption":"Gliederung","width":14},
{"field":"verfuegbar","caption":"verfügbar","width":12,"explanation":"@@@fin_verfuegbar@@@"},
{"field":"einnahmen","caption":"Einnahmen","width":10},
{"field":"aus","caption":"Ausgaben","width":10},
{"field":"fest","caption":"Festgelegt","width":10}
]}/>

Im Masken-sql gegen Ende baut man ein
<#if CUSTOM_xxxxxx?exists>
<#assign inlineTemplate=CUSTOM_xxxxxx?interpret>
<@inlineTemplate/>
</#if>

Falls eine Hochschule ein custom_xxxxxx angelegt hat, wird der Inhalt interpretiert und ein customize-Hash steht zur Verfügung.Das Abschluss-select prüft also

<#if customize?exists> --customize existiert, abschluss select daraus aufbauen
select
<#foreach f in customize.resulttable>
${f.field} <#if h_has_next>,</#if>
</#foreach>
from tmp_erg2 ;

<#else> -- kein customize objekt existiert, standard abschluss select
select name,akt_soll,einnahmen,ausgaben,fest,verfügbar from tmp_erg;
</#if>

Für die XIL-Proplist muss es genauso laufen:

XIL List
--freemarker template
<#if CUSTOM_xxxx?exists>
<#assign inlineTemplate=CUSTOM_xxxx?interpret>
<@inlineTemplate/>
</#if>
<#if customize?exists>--wenn Hochschul-customizeobjekt exixtiert, dann xil dynamisch aufbauen
<#foreach f in customize.resulttable>
Column CID=0 heading_text="${f.caption}" center_heading explanation="<#if f.explanation?exists>${f.explanation}</#if>"
row_selectable col_selectable heading_platform readonly width=${f.width}
</#foreach>
<#else> --standard xil list
Column CID=0 heading_text="Name explanation="" center_heading row_selectable col_selectable heading_platform readonly width=9 text_size=0
Column CID=0 heading_text="aktsoll explanation="" center_heading row_selectable col_selectable
..
</#if>

complex, but coool, </br>

for the super nerds,</br>

Technik kann man sogar mit eigenen Freemarker-Funktionen verbinden, z.B. dynamsiche Spalten nach customizing und Link-Spalten zur Einzelbuchung nur anzeigen, wenn Rechte für Einzelbuchungen da sind. Aus dem Kontext, XIL:

<#function isWanted field>
<#assign result=true>
<#if field?starts_with('linkbuch')&&Einzelbuchrecht?exists&&Einzelbuchrecht?is_number&&Einzelbuchrecht=0><#assign result=false/></#if>
<#if (field='einnahmen'||field?starts_with('linkbuchein')||field='offsoll_e'||field?starts_with('linkbuchoffsolle'))&&"<<Einnahmen anzeigen>>"="'nein'">
<#assign result=false/></#if>
<#return result>
<#if customize?exists>
<#foreach f in customize.resulttable>
<#if isWanted(f.field)>
Column CID=2 heading_text="${f.caption}" center_heading explanation="<#if f.explanation?exists>${f.explanation}</#if>"
row_selectable col_selectable heading_platform readonly width=${f.width}
</#if>
</#foreach>
<#else>
...

===Dezimalstellen variieren===
Normalerweise werden Werte mit Dezimalstellen immer zweistellig wiedergegeben. Im Ausnahmefall kann man dies ändern, indem man eine Spalte mit dem Namensschema "hidden"+Spaltenname+"dp" hinter die jeweilige Spalte setzt, und der Inhalt der Spalte enthält die Zahl der Nachkommastellen (0-6 möglich):

select ... plan_soll ,
1::integer as hiddenplan_solldp,...

bewirkt, dass die Spalte plan_soll einstellig dargestellt wird.
{{Achtung|Dies klappt nicht bei verschachtelten Spaltenlayouts}}
=== Einzelne Zellen oder Spalten formatieren (CSS) ===

Wenn im Masken-Resultset zum Beispiel eine Spalte "verfuegbar" existiert, kann über eine zusätzliche Spalte nach dem Muster
hidden - Spaltenname - css
Also hier z.B. eine versteckte Spalte '''hiddenverfuegbarcss''' mit dem Inhalt des css-Klassennamens, z.B. neu in kern44 ''td.boldnumber'':

Auszug
<source lang="sql">
create temp table tmp_erg
(
titel char(5),titelbez varchar(255),sort smallint,
hhans decimal (14,2),
sperre decimal (14,2),
reste decimal(14,2),
akts decimal(14,2),
einnahmen decimal(14,2),
ausgaben decimal (14,2),
fest decimal (14,2),
verfuegbar decimal (14,2),
hiddenverfuegbarcss varchar(200)
) <@informixnolog/>;
…

update tmp_erg set hiddenverfuegbarcss='boldnumber' where sort=0;
select titelbez, hhans,sperre ,reste,akts,einnahmen,ausgaben,fest,verfuegbar+fest,verfuegbar,
hiddenverfuegbarcss from tmp_erg order by sort,titel;
</source>

Eine entsprechende XIL_proplist-Definition der "column" muss es auch geben, hier ist der Name allerdings beliebig, sollte aber eindeutlig sein, d.h. eine Tabelle sollte nicht zwei gleiche Spaltenüberschriften haben.

===Detailansicht verlinken===

Es ist möglich die Werte einer bestimmten Spalte als Links auszugeben, sodass mit einem Klick auf diesen weitere Details in einer zweiten Ergebnistabelle gezeigt werden. Dabei wird über Klick auf diesen Link eine zweite Maske aufgerufen, die Maskenfelder dieser Maske mit den übergebenen Parametern gefüllt und die Ergebnistabelle dieser Maske ausgegeben.
</br>
Im Folgenden eine Erläuterung anhand eines Beispiels mit Prüfungsanmeldungen. Die Tabelle listet pro Modul die Anzahl der Anmeldung und in einer weiteren Spalte die Anzahl der Studierenden, welche zu ihrem dritten Prüfungsversuch antreten. Die Werte der letzten Spalte mit den Drittversuchen wird verlinkt:

{{ImagePara |imgsrc=Links_in_Ergebnistabelle.png|width=600|caption=Links in Ergebnistabelle}}

Nach Klick auf einen der Links erscheint eine weitere Tabelle, welche statt der Anzahl die einzelnen Matrikelnummern inklusive Studiengang ausgibt:

{{ImagePara |imgsrc=Detailansicht.png|width=600|caption=Detailansicht}}
</br>
In diesem Falle fungieren die Werte der Spalte drittversuch als Link. Um dies umzusetzen geben wir eine weitere Spalte hidden_drittversuch aus. Durch hidden wird diese nicht dargestellt und _drittversuch dient als Referenz auf die Spalte drittversuch. Die Spalte hidden_drittversuch enthält den Teil der URL, welcher die Parameter beim Maskenaufruf definiert. Das sieht beispielsweise so aus:

'?tid=30610360&Prüfungskurztext='||pktxt||'&&cachingcontrol=clearmask' as hidden_drittversuch

'||pktxt||' wird ersetzt durch den Wert des Feldes pktxt derselben Zeile:

select
pktxt,
pdtxt,
(case when pstatus='AN' then 1 else 0 end) as anmeldung,
(case when pversuch=3 then 1 else 0 end) as drittversuch,
'?tid=30610360&Prüfungskurztext='||pktxt||'&&cachingcontrol=clearmask' as hidden_drittversuch
into temp tmp_ergebnis

Werden beim Maskenaufruf der Detailansicht weitere Felder benötigt, wird für diese eine Variable angelegt:

#assign stg=""/>
<#if "<<Studiengang>>"!=""><#assign stg="&Studiengang=<<Studiengang>>"?replace("'","")?replace("|",",")/></#if>

So ist gewährleistet, dass der Parameter nicht in die URL übernommen wird, falls das Maskenfeld leer ist. Zudem werden einfache Hochkommata ' und Pipes | ersetzt, um zugewährleisten, dass die URL funktioniert. Einfache Hochkommata ' könnten beispielsweise bei Schlüsseln, welche als charakter definiert sind übergeben werden und Pipes | bei Aufzählungen. Die Variable wird in den select der Spalte hidden_drittversuch eingebunden:

'?tid=30610360&Prüfungskurztext='||pktxt||'${stg}&&cachingcontrol=clearmask' as hidden_drittversuch

Sonderfall: Falls eine Maske in einem Link auf sich selbst verweist wird empfohlen statt der Maskennummer die automatisch gefüllte Freemarker-Variable ${Maskennummer} zu benutzen:

'?tid=${Maskennummer}&Prüfungskurztext='||pktxt||'${stg}&&cachingcontrol=clearmask' as hidden_drittversuch

Hintergrund: Falls man eine Kopie des entsprechenden Berichtes angelegt hat, um diesen mit eingeschränkten Funktionen (bspw. für User mit eingeschränkten Rechten) bereitzustellen, bietet sich die [https://wiki.his.de/mediawiki/index.php/SXimport_zur_Maskengestaltung_verwerden-HISinOne-BI sximport-Funktion] an. Würde dann statt ${Maskennummer} die tid verwandt, so würde der Link in der Berichtskopie auf den Hauptbericht verweisen, was für User mit eingeschränkten Rechten nicht erwünscht ist.

===Datenbalken===
====Datenbalken in Standardberichten allgemein====
Es gibt die Möglichkeit, in der Ergebnistabelle horizontale Balken (In Excel nennt man dies "Datenbalken") anzeigen zu lassen. Dies kann z.B. dazu genutzt werden, ein Balkendiagramm darzustellen.

Hier ein Beispiel: Maske Administration -> Benutzer -> Gruppe suchen -> dort im Ergebnis die Spalte "Anteil Benutzer an Gesamtzahl (in %) "

{{ImagePara |imgsrc=datenbalken_1.png|width=500px|caption=Datenbalken Beispiel}}

Voreingestellt ist auch, dass beim MouseOver ein Tooltip mit der Zahl angezeigt wird.

Es gibt die Möglichkeit, die Datenbalken zu variiieren:
* Balken links- oder rechtsbündig
* Die Breite der Balken wird in Pixel angegeben, Sie können die Breite aber anpassen
** Der jew. Balken kann relativ zu einem Gesamtwert dargestellt werden
** Der gesamte Balken kann in der Breite angepaßt werden
* Auch Balken mit Serien sind möglich
=====Datenbalken linksbündig=====
Der Default des Datenbalkens ist linksbündig, wenn sie also "_graph" als Spaltenüberschrift nehmen, wird der Balken linksbündig gezeichnet.

{{ImagePara |imgsrc=datenbalken_2.png|width=500px|caption=Datenbalken linksbündig}}

=====Datenbalken rechtsbündig=====
Wenn sie "_graphbarright" als Spaltenüberschrift nehmen, wird der Balken rechtsbündig gezeichnet.

{{ImagePara |imgsrc=datenbalken_3.png|width=500px|caption=Datenbalken rechtsbündig}}

=====Datenbalken Breite=====
Die Gesamtbreite der Spalte mit dem Datenbalken (wie gewohnt anteilig zu allen Spalten) wird in der xil_proplist festgelegt. Im folgenden Beispiel wurde die Balkenbreite von 10 auf 20 erhöht:

{{ImagePara |imgsrc=datenbalken_4_breite.png|width=500px|caption=Datenbalken breiter}}

Wenn der Wert für den Datenbalken kein Prozentwert ist (also nicht die Skala 1-100 hat), können Sie den Gesamtwert mit "|" dahinter setzen. Dadurch wird die Breite anteilig berechnet. Beispiel:

Eine Spalte hat den Wert 44 von einem Gesamtwert von 50. Damit der Datenbalken nicht schmaler als die Häfte ist geben Sie die Gesamtsumme dahinter an:
select ..., '44|50' as _graph2 ...
Damit wird der Datenbalken mit der Hälfte der Gesamtbreite angezeigt.
{{ImagePara |imgsrc=datenbalken_5_relativ.png|width=500px|caption=Datenbalken relativ}}

=====Datenbalken mit Beschriftung=====
Sie können den Datenbalken auch mit einer Beschriftung versehen, indem Sie als Spaltenname "_graphbarwithlabel" nutzen:

{{ImagePara |imgsrc=datenbalken_6_label.png|width=500px|caption=Datenbalken mit Beschriftung}}

{{Achtung|Je nach Länge der Zahl und Breite des Balkens kann es zu unschönen Darstellungen kommen.}}
=====Datenbalken mit Serien=====
Wenn Sie den Spaltennamen beginnend mit "_graphbarxseries" liefern werden Datenbalken mit Serien ausgegeben. Dazu wird als Wert eine Liste mit Komma-getrennten Ganzzahlen erwartet, normiert auf die Breite der Spalte in der '''_xil_proplist'''. Hier ein Beispiel:

{{ImagePara |imgsrc=datenbalken 7 xseries.png|width=500px|caption=Datenbalken mit Serien}}

Die Farben der Serie können Sie im Template
<source lang="xml">
<xsl:template name="myBarColorFg" >...</xsl:template>
</source>
in der Datei /superx/xml/pageComponents_html_final.xsl überlagern. Die Auslieferung befindet sich in der Datei /superx/xml/graphtools.xsl.

====Datenbalken in xCube====
Da in xCube die Masken nicht änderbar sind, können Sie die Funktion über die Maske bzw. das Maskenfeld "Spaltenvisualisierung" direkt nutzen.
* Siehe in [[Modul_xCube_Nutzungshandbuch#Spaltenvisualisierung_als_Ansichtsoption|xCube]]

=Exporte anpassen=
== Exportformate ==
Im XML-Frontend können Abfragen direkt nach html (Druckversion), XML, PDF oder XLS (->Excel) exportiert werden. Die zugehörigen Stylesheets lauten:
* '''html (Druckversion)'''
** <code> $SUPERX_DIR/webserver/tomcat/webapps/superx/xml/tabelle_html_p.xls </code>
*'''PDF '''
** <code> $SUPERX_DIR/webserver/tomcat/webapps/superx/xml/tabelle_fo_pdf.xsl </code>
*'''XLS '''
** <code> $SUPERX_DIR/webserver/tomcat/webapps/superx/xml/tabelle_xls.xsl </code>
Der PDF-Konverter arbeitet mit der OpenSource-Bibliothek FOP, der Excel-Konverter mit POI. Die Vorlagen können als Grundlage für eigene Stylesheets verwendet werden.

Der PDF-Export funktioniert zwar technisch, aber leider sehen die Ergebnisse oft nicht "schön" aus, da die Berichte in SuperX generell über die Seitenbreite hinaus gehen. Wir empfehlen daher, die Exporte nur bei speziell geeigneten Berichten (mit weniger Spalten) zu verwenden. Außerdem gibt es für Volltexte keine Silbentrennung.

Der XLS-Export wurde mit MS Excel  und OpenOffice getestet. Da die Produkte automatisch auf Seitenbreite skalieren können, sieht der Export hier deutlich besser aus.

Außerdem können grundlegende Layoutelemente wie Kopf- und Fußzeilen und Seitenzahlen individuell angepasst werden, ohne zwingend XSLT-Kenntnisse zu haben.

== PDF-Export ==

Kurz ein paar Hinweise:

Am besten nimmt man zur Bearbeitung eine bestehende PDF-Vorlage.

Tabellen:

Für jede Spalte muss direkt unter fo:table fin table-column ein Knoten mit der Breite kommen (im mm)
<source lang="xml">
<fo:table>
<fo:table-column column-width=”30mm”>
<fo:block font-size=”10pt” text-align=”start/end” font-weight=”bold” font-family=”serif” line-height=”9pt”
space-before.optimum=”6pt” space-after.optimum=”6pt” language=”en” hyphente=”true”>
<xsl:value-if select=”format-number(/ergebnisse…,’#.###.##0,00,’German’)”/>
German groß ist wichtig!!!
</fo:block>
</fo:table-column>
<fo:table-header>
<fo:table-row>
<fo:table-cell border-width=”0.1mm” border-style=”solid” padding-left=”0.5mm” padding-right=”0.5mm”>..
<fo:table-body>
<fo:table-row><fo:table-cell>..

<fo:block text-align=”center” font-size=”9pt” font-weight=”bold” hyphenate=”false”>
</source>
Blöcke zusammenhalten
<source lang="xml">
<fo:block keep-together.within-page=”always”>
Block1
Block2
</fo:block>
</source>
Um lokal zu testen gibt es die Java-Klasse de.superx.bin.ExcelPdfCreator
Params

-in/home/superx/iaf-ausgaben.xml -xsl/home/superx/tabelle_fo_pdf_xxxx.xsl -out/home/superx/test.pdf

(Dateiendung legt fest, dass ein PDF erzeugt werden soll).

==Schriftgröße des PDF-Exportes anpassen==
Bei Bedarf kann man die Schriftgröße des PDF-Exportes anpassen. Dazu einfach beim letzten Select des "select_stmts" der Maske noch angeben

select ...... , '''6::smallint as hidden_pdf_fontsize''' from tmp_erg order by ...;

und in der XIL-Proplist als Spalte "hidden_pdf_fontsize" hinterlegen.
</br></br>
Oder falls die Spalten über eine CUSTOM_ Variable im Repository definiert werden, kann man einfach ergänzen:</br></br>
<#assign CUSTOM_1234={"resulttable":[</br>
{"field":"ivst_invnr","caption":"Inventarnr","width":8},</br>
{"field":"ivst_sernr","caption":"Seriennummer","width":9},</br>
{"field":"ivst_gerbez","caption":"Bezeichnung","width":14},</br>
{"field":"lieferant","caption":"Lieferant","width":10},</br>
{"field":"ivst_hh_j","caption":"Jahr","width":6},</br>
{"field":"ivst_betrdat","caption":"Inbetriebname","width":9},</br>
{"field":"ivst_nutzd","caption":"Nutzungs-\ndauer","width":8},</br>
{"field":"ivst_auftnr","caption":"Auftrags-\nnummer","width":8},</br>
{"field":"ivst_preis","caption":"Preis","width":8},</br>
{"field":"ivst_inst","caption":"Kosten-\nstelle","width":8},</br>
{"field":"splitktr","caption":"Kosten-\nträger","width":8},</br>
{"field":"ivst_nutzer","caption":"Nutzer","width":7},</br>
{"field":"ivst_raum","caption":"Raum","width":8},</br>
'''{"field":"8::smallint as hidden_pdf_fontsize","caption":"hidden_pdf_fontsize","width":1}'''</br>
]}/>
== Excelexport ==
{{Hinweis|Es wird nicht vorausgesetzt, dass Sie Microsoft Excel nutzen. Es wird zwar das Excel-Format erzeugt (*.xslx), aber in der Regel sind diese Dateien auch für andere Softwareprodukte, z.B. LibreOffice, nutzbar. }}
===Performance-optimiertes Excel===
Man kann einen Performance-optimierten Excelexport anstoßen, indem man im Berichtskopf den Kommentar "--ram excelexport" setzt.
Dies ist z.B. bei Datenblattberichten standardmäßig der Fall.

===Excel-Vorlagen===
{{Achtung|Diese Funktionalität wird derzeit überarbeitet, weil sie nur mit dem alten Excel Format (*.xls) funktioniert. }}
Am besten nimmt man zur Bearbeitung eine bestehende xsl-Vorlage.

Man kann eine bestehende Excel-Datei als Vorlage nehmen (attribut Vorlage des xls_workbook Knotens).

Dies ist praktisch, um nicht direkt erzeugbare Einstellungen zu hinterlegen, z. B.
* Skalierung auf 70%
* wiederholende Tabellenüberschrift (Seite einrichten/Tabelle)
* Extras/Schutz/Blattschutz (Poi kann man trotzdem reinschreiben!)

<xls_workbook vorlage="vorlage1.xls" removeAdditionalSheets="true">

Wenn man Tabellen auf Vorrat angelegt hat, kann man mit dem Tag removeAdditionalSheets=true überflüssige Tabellen entfernen.

Es werden alle Zellen neu erzeugt, man kann jedoch einzelne Zeilen oder Zellen überspringen, um in der Excel-Vorlage enthaltenes nicht zu überschreiben:
<xls_row jumpover="true">
<xls_cell jumpover="true"></xls_cell>
Tabellenblatt
<xsl_sheet>
Zelle kann Attribute haben ebene=summe
<xsl_row>

;Zellen
Für Zahlen
<xls_cell style="body_dec" numeric="true">

mögliche Attribute: width (gilt logischerweise für ganze Spalte)

Um lokal zu testen gibt es Java-Klasse de.superx.bin.ExcelPdfCreator
Params

-in/home/superx/iaf-ausgaben.xml -xsl/home/superx/tabelle_xls_xxxxxx.xsl -out/home/superx/test.xls

(Dateiendung legt fest, dass eine Excel-Datei erzeugt werden soll)

==Export als Mediawiki-Quellcode==
Wenn sie die Software Mediawiki nutzen, können Sie Tabellenexporte auch direkt als Quellcode exportieren:

[[Bild:tabelle_html_wiki1.png|600px]]

Der Quellcode wird im Browser in einem neuen Fenster ausgegeben:

[[Bild:tabelle_html_wiki2.png|600px]]

Diesen Quellcode können Sie per Copy-Paste in Ihre Mediawiki übernehmen, in der Variante [https://www.hallowelt.com Bluespice] sieht das dann so aus:

[[Bild:tabelle_html_wiki3.png|600px]]

=Masken- und Tabellenlayouts mit XSLT=
==Stylesheets verwalten==
Es ist möglich für Spezialfunktionen eigene Stylesheets für einzelne Masken zu hinterlegen. Zunächst muss für das Ergebnis ein neues Stylesheet erzeugt werden. Als Vorlage für Masken können Sie das Muster-Stylesheet
$WEBAPP/xml/maske_html.xsl
verwenden. Für Ergebnistabellen können Sie das Muster-Stylesheet
$WEBAPP/xml/tabelle_html.xsl
verwenden. Speichern Sie das Stylesheet unter einem anderen Namen im gleichen Verzeichnis ab, und ändern Sie das Stylesheet. Dann fügen Sie das Stylesheet in die Tabelle sx_stylesheets ein.

[[Bild:sx_stylesheets_access.png|400px]]

Das Beispiel zeigt einige Stylesheets, das erste ist bereits Teil des Kernmoduls, das fünfte befindet sich im COB-Modul. Zu den Feldern:
* ''filename'' kennzeichnet den Dateinamen relativ zum Verzeichnis $SUPERX_DIR/webserver/tomcat/webapps/superx/xml.
* ''caption'' dient als Kurzüberschrift, die im Ergebnisblatt als Button angezeigt wird.
* ''description'' stellt einen Erläuterungstext für den Button dar.
* ''relation'' bezieht sich auf die Beziehung des Stylesheets; mögliche Werte sind "mask" für eine Maske und "table" für Tabelle.
* '' useragent'' bietet die Möglichkeit, ein Stylesheet für spezielle Lesegeräte anzubieten, z.B. WAP-Hanys oder Braille-Zeilen.
* ''contenttype'' entspricht dem useragent und kennzeichnet den content-type, der dem Lesegerät im http-header übermittelt werden soll. Möglich sind derzeit die obigen Varianten (svg oder excel sind in Vorbereitung).
* ''is_generic''. Generisches Stylesheet für alle Ergebnistabellen (1=ja)
* ''usage_resultset_data''. Nutzung der Ergebnisdaten: Welche Ergebniszeilen soll das Stylesheet verarbeiten. S=Nur Schema, T=Aktuelle Baumstruktur,A=Alle Daten. Die Ausprägung T=aktuelle Baumstruktur wird nur ausgewertet, wenn die Ergebnistabelle in den Zeilen eine Aufklappfunktion bietet.
* ''stylesheet_type''. Art des Stylesheets (XSL,JRXML,XSL_JRXML,XSL_FO,XML,NATIVE,XLSX). Der Wert XSL_JRXML wird nur ausgewertet wenn das RPTA-Modul installiert ist (Berichtsassistent)
* ''jr_datasource''. Datenquelle (JasperReports). Wird nur bei JasperReports ausgewertet. Mögliche Werte: RS (Resultset vom Servlet) oder XMLSOURCE (XML vom Servlet). Ersteres ist schneller, zweites ist flexibler.
Im Browser können Sie die Daten mit dieser Maske bearbeiten:

[[Bild:stylesheets_suchen_bearbeiten.png|800px]]

==Zuordnung eines Stylesheets zu einer Maske==
Konkret arbeitet SuperX so: Wenn einer Abfrage ein oder mehrere Stylesheets zugeordnet sind, dann werden die in der Reihenfolge angezeigt, in der sie definiert sind. Wenn kein Stylesheet definiert ist, dann wird das Standard-Stylesheet von SuperX benutzt: maske_html.xsl für Masken sowie tabelle_html.xsl für Tabellen. </br>

<blockquote>
Die Zuordnung eines Stylesheets geschieht in der Tabelle sx_mask_style . Der Tupelidentifier des Stylesheets wird in der Tabelle sx_mask_style im Feld stylesheet_id eingetragen. Die Tabelle lässt sich über ein Bearbeitungsformular füllen. Dieses wird erreicht wenn die Maske gesucht wird, welcher ein Stylesheet zugeordnet wird:

{{ImagePara |imgsrc=Stylesheet_Zuordnung_2.png|width=400|caption=MaskenfeldSemester}}

Das Feld Sortiernummer (ord) kennzeichnet die Reihenfolge der anzubietenden Stylesheets. Wir sehen hier, dass zuerst das generische Standard-Stylesheet angezeigt wird und dann ein [https://superxhosting.de/superx/edit/kb/kb_media_ansehen.jsp?id=12 JasperReport als weiteres Stylesheet].
{{ImagePara |imgsrc=Stylesheet_Zuordnung.png|width=400|caption=MaskenfeldSemester}}

Defaultmäßig sind die Stylesheets für html (Druckversion in neuem Fenster), xml, Excel und PDF in jeder Ergebnistabelle enthalten. Andere Stylesheets werden in der obigen Tabelle zugeordnet.
</blockquote>
== Einzelne Templates anpassen ==
Mit eigenen XSL-Stylesheets kann man das Aussehen von Masken oder Ergebnistabellen sehr individuell anpassen. Oben beschrieben war das Vorgehen, dass man eine Kopie von '''maske_html/pdf/xls.xsl bzw tabelle_html/pdf/xls.xsl''' machte und darin Änderungen vornahm.

Da inzwischen immer wieder Erweiterungen an den Standardstylesheets vorgenommen werden, kommen diese Erweiterungen dann jedoch nicht in die kopierten Spezialstylesheets.

Daher sind die Stylesheets inzwischen etwas „objektorientierter" und kleine Änderungen kann man auch in der Datei
.../webapps/superx/xml/page_components_final.xsl
vornehmen.

Beispiel aus der Praxis, bei 2-3 Masken sollte unter dem Maskennamen noch ein Link zu PDF-Dateien erscheinen.

In der Standard maske_html.xsl ist nach dem Titel ein template-Aufruf definiert.
<source lang="xml">
<p class="maskentitel"><xsl:value-of select="maske/@name" /></p>
<xsl:call-template name="pccustomize"> <xsl:with-param name="position" select="'mask_post_title'">
</xsl:with-param> </xsl:call-template>
</source>

Das Template ist als leer in Page-Components.xsl definiert. Man kann es in <code>pageComponents_final.xsl</code> definieren, dann wird es überschrieben.
<source lang="xml">
<xsl:template name="pccustomize">
<xsl:param name="position"/>
<xsl:if test="$position='mask_post_title'">

</xsl:if>
</xsl:template>
</source>

Die Links werden nur bei den entsprechenden Masken eingebaut.

Außerdem wird standardmäßig das leere maskonload überschrieben, um den div der folgenden Maskenfelder etwas tiefer zu setzen, damit Platz für einen größeren Titel ist.

Um bei bestimmten Masken Export-Buttons auszublenden, kopieren Sie das entsprechende Template (hier: exportButtons) aus der Page-Components.xsl in die pageComponents_final.xsl und fügen dort eine if-Bedingung ein.

Beispiel für das Entfernen des PDF-Export-Buttons für die Masken mit der tid 16000 und 17000:
<source lang="xml">
<xsl:template name="exportButtons" >
...
<xsl:if test="/ergebnisse/ergebnis/maskenname/@id!='16000' and /ergebnisse/ergebnis/maskenname/@id!='17000'">

</xsl:if>
...
</xsl:template>
</source>
Will man ein spezielles Tabellenstylesheet erzeugen, braucht man tabelle_html.xsl nicht mehr kopieren, sondern erzeugt eine xsl-Datei mit den Standard-Importen und fügt dort den Import für tabelle_html.xsl hinzu.
<source lang="xml">
<xsl:import href="xsl_functions.xsl" />
<xsl:import href="resultset_html.xsl" />
<xsl:import href="interLinks_html.xsl" />
<xsl:import href="pageComponents_html.xsl" />
<xsl:import href="tabelle_html.xsl" />
<xsl:import href="pageComponents_html_final.xsl" />
</source>

als weiteres braucht man nur das Template von tabelle_html.xsl zu überlagern, was geändert werden soll.

Einfachstes Beispiel - keine Erläuterungslinks anzeigen:

Template explanation wird überlagert
<source lang="xml">
<xsl:template name="explanation"/>
</source>
Bei Bedarf kann man auch die standardmäßig leeren Funktionen wie
<source lang="xml">
<xsl:call-template name="tablecustomize"><xsl:with-param name="position"
select="'table_post_center'"></xsl:with-param></xsl:call-template>
</source>
überlagern.

Am Ende folgt dann, um die Tabelle aufzubauen.
<source lang="xml">
<xsl:template match="/">
<xsl:call-template name="table"/>
</xsl:template>
</source>
== Besonderes XML zu ALLEN Masken hinzufügen ==

Für das Management-Modul gibt es eine ganz besondere Erweiterung.

Anwendungsfall: ein Navigationsmenü soll in allen Masken bereitgestellt werden, es soll aber auch möglich sein, ganz normale SuperX-Masken einzubinden.

also Aufruf z.B.
http://localhost:8080/superx/servlet/SuperXmlTabelle?tid=xxy&param=1&stylesheet=tabelle_html_man.xsl

Legen Sie dazu in Repository ein Feld ID=CUSTOMXMLADD an. Da kann fester XML drin stehen, der wird zu allen Tabellen-xmls hinzugefügt.

zB..
<source lang="xml">
<navigation>
<item1 .../>
<item2 ../>
</navigation>
</source>

der wird dann in Tabellen XML unter ergebnisse/ergebniselement hinzufügt und kann ausgewertet werden.

z.B:
<source lang="xml">
<div id="Navigation">
<xsl:for-each select="/ergebnisse/ergebnis/ergebniselement/navigation/item">
<p class="ebene0">
<a class="ebene1" target="_self">
<xsl:attribute name="href">
<xsl:value-of select="concat(HtmlUtils:encodeURL('SuperXmlTabelle',/ergebnisse/@jsessionid ),'?tid=',href)" />
</xsl:attribute>
<![CDATA[]]><xsl:value-of select="caption" /><![CDATA[]]>
</a>
</p>
</xsl:for-each>
</source>

Der hinzuzufügende XML wird dynamisch mit Freemarker generiert, z.B.:
<source lang="xml">
<xupdate>
<text table="sx_repository" field="content" where="id='CUSTOMXMLADD'">
<![CDATA[<#include "MAN_MAKROS"/><sqlvars> <sqlvar name="entries" type="hash">
select R.catalogue_id,K.shortname,sqlchunk,calcratio,decimalplaces,linksub,linktimeline
from man_catalogue K,man_catalogue_rpt R
where
K.id=R.catalogue_id and R.active=1 order by R.sortnr, R.sortnr2 </sqlvar> </sqlvars>
<#if !Semester?exists><#assign Semester=""></#if>
<#if !Bezugssemester?exists><#assign Bezugssemester=""/></#if>
<#if !Jahr?exists><#assign Jahr=""></#if>
<#if !faecherkeys?exists><#assign faecherkeys=""></#if>
<#if !Fächer?exists><#assign Fächer={"selectedKey":""}></#if>
<#if !Kostenstelle?exists><#assign Kostenstelle={"selectedKey":""}></#if>
<#if !(.vars["Datum (Personal)"]?exists)><#assign "Datum (Personal)"=""></#if>
<#if !(.vars["Beschäftigungsstelle (Person)"]?exists)><#assign "Beschäftigungsstelle (Person)"="">
</#if><navigation><item><href>CDATASTART888880190&Jahr=${Jahr}&Semester=${Semester}&Datum%20(Personal)=${.vars["Datum (Personal)"]}
CDATAEND</href><caption>Start</caption></item>
<#if entries?is_sequence><#foreach e in entries> <#assign linktimeline=e.linktimeline?interpret/>
<#assign linkt><@linktimeline/></#assign> <#assign linksub=e.linksub?interpret/>
<#assign links><@linksub/></#assign> <doubleitem id="${e.id}"> <aktuell>CDATASTART${links?replace('Fakultäten|','')}CDATAEND</aktuell>
<zeitreihe>CDATASTART${linkt?replace('Zeitreihe|','')}CDATAEND</zeitreihe>
<caption>CDATASTART${e.shortname}
CDATAEND</caption> </doubleitem> </#foreach> </#if></navigation>]]>
</text>

</xupdate>

</source>

Moduldokumentation

2026-09-03T19:30:44Z

Danielq: /* SuperX.Technologie und Qualitätssicherung */

=SuperX.Nummernkreise=
* [[Nummernkreise|Nummernkreise Masken]]
* [[Nummernkreise Sachgebiete und Komponenten]]

=SuperX.Kern=
* [[Moduldokumentation Kernmodul|Kernmodul]]
* [[Kern_Installation_Upgrade|Installation / Upgrade]]
* [[Kernmodul_Tomcat-Einrichtung|Tomcat-Einrichtung]]
* [[Kernmodul_LDAP-Einrichtung|LDAP-Einrichtung (obsolet?)]]
* [[Kern_Konfiguration|Konfiguration]]
* [[Kern_Oberflaeche|Anpassung der Oberfläche]]
* [[Kernmodul_Komponentenverwaltung|Komponentenverwaltung]]
* [[Kernmodul_Regelbetrieb|BI Regelbetrieb]]
* [[Kernmodul_Shellscripte|Shellscripte]]
* [[Kern_Bestandteile|Bestandteile]]
* [[Kern_Clientwerkzeuge|Client-Werkzeuge]]
* [https://wiki.his.de/mediawiki/index.php/Administration_-_HISinOne-BI Administrationsmasken (HISWIKI)]
* [[Kern_Benutzerverwaltung|Benutzerverwaltung]]

=SuperX-Entwicklung=
* [[SuperX-Entwicklung|Übersicht]]
* [[Masken-Tutorial]]
* [[Erweiterte Maskenprogrammierung: Freemarker Templates]]
* [[Masken- und Tabellengestaltung]]
* [[Masken für das XML-Frontend vorbereiten]] (obsolet)
* [[Masken für externe Datenbanken (operatives Berichtswesen)]]
* [[Hochschuleigene Laderoutinen]]
* [[Abfragemakros (einschl. Schleifen u. Grafiken)]]
* [https://wiki.his.de/mediawiki/index.php/SXimport_zur_Maskengestaltung_verwerden-HISinOne-BI Teile aus anderen Masken oder externen Tabellen importieren]
* [[Neue Layouts in SuperX 5.1]] (obsolet)
* [[Neue Layouts in SuperX 5.2]]
* [[Entwicklerschulung]]
* HISWIKI
** [https://wiki.his.de/mediawiki/index.php/Entwicklerdokumentation_HISinOne Leitfäden für Entwickler]
** [https://wiki.his.de/mediawiki/index.php/Leitf%C3%A4den_f%C3%BCr_Entwickler_der_HISinOne-BI Leitfäden für Entwickler (BI)]
* [[Maschinenlesbare Schnittstellen für Ergebnistabellen]]
* [[Kettle-Grundlagen]]
* [[Kettle Kurs Teil 2]]
* [[Kettle Automat. Berichtsausführung und Mailversand]]
* [[LM-Modul validieren (Abgleich mit EXA)]]
* [[Dashboards erstellen]]
* [[Entwicklerhandbuch_xcube]]
* [[Gxstage-Standalone]]
* [[SuperX REST Schnittstelle]]
* [[Berichtsdesign mit JasperReports]]

=SuperX.Campus-Management=

* [[Moduldokumentation Bewerbung_Zulassung|Bewerbungen, Zulassungen]]
** [[Leitfaden Bewerberstammdaten]]
** [[Auswertungsuebersicht_Bereich_Bewerbung_Zulassung | Auswertungsübersicht]]
** [[Anwendungshandbuch Bewerbung, Zulassung]]
** [[Konfigurationshandbuch Bewerbung, Zulassung]]
* [[Moduldokumentation Studierende_Pruefungen|Studierende, Prüfungen]]
** [[Auswertungsuebersicht_Bereich_Studierende_Pruefungen | Auswertungsübersicht]]
** [[Anwendungshandbuch Studierende]]
** [[Anwendungshandbuch Pruefungen|Anwendungshandbuch Prüfungen]]
** [[Konfigurationshandbuch Studierenden-Komponente|Konfigurationshandbuch Studierende]]
** [[Konfiguration Studierende, Pruefungen|Konfiguration Studierende, Prüfungen]]
** [[Konfiguration Studierende_Pruefungen_Stichtage|Konfiguration Studierende, Prüfungen Stichtage]]
* [[Moduldokumentation Studienerfolg|Studienerfolg]]
** [[Studienerfolg_Akkreditierungsberichte|Akkreditierungsberichte]]
** [[Studienerfolg Bachelor-Master Übergang|Bachelor-Master Übergang]]
** [[Anwendungshandbuch_Studienverlauf|Anwendungshandbuch Studienverlauf]]
** [[Konfigurationshandbuch_Studienverlauf|Konfigurationshandbuch Studienverlauf]]
* [[Moduldokumentation Leistungsmonitoring|Leistungsmonitoring]]
** [[Konfigurationshanbuch Leistungsmonitoring|Konfigurationshandbuch]]
** [[Nutzungshandbuch Leistungsmonitoring|Nutzungshandbuch]]
* [[Moduldokumentation Studiengaenge|Studiengänge]]
** [[Konfigurationshandbuch Studiengaenge|Konfigurationshandbuch]]
** [[Anwendungshandbuch_Studiengaenge|Anwendungshandbuch Studiengänge]]
* [[Moduldokumentation COSTAGE| COStage (TU Graz CampusOnline)]]
** [[Modul_COSTAGE_Administrationshandbuch|Konfigurationshandbuch]]
** [[Modul_COSTAGE_Nutzungshandbuch|Nutzungshandbuch]]
** [[COSTAGE_in_Deutschland|COStage in Deutschland]]
* [[Moduldokumentation Mehrfachstudiengaenge| Mehrfachstudiengänge]]

=SuperX.Ressourcen-Management=
* [[Moduldokumentation Personal, Stellen|Personal, Stellen]]
** [[Konfigurationshandbuch Personal und Stellen|Konfigurationshandbuch]]

** Benutzungshandbücher
*** Personal im [http://www.superx-projekt.de/doku/sva_modul/benutzer/pers/main.htm html]/[http://www.superx-projekt.de/doku/sva_modul/benutzer/pers/main.pdf pdf]-Format.
*** Stellen im [http://www.superx-projekt.de/doku/sva_modul/benutzer/stell/main.htm html]/[http://www.superx-projekt.de/doku/sva_modul/benutzer/stell/main.pdf pdf]-Format.
*** Besetzung im [http://www.superx-projekt.de/doku/sva_modul/benutzer/bes/main.htm html]/[http://www.superx-projekt.de/doku/sva_modul/benutzer/bes/main.pdf pdf]-Format.
* [[Moduldokumentation Finanzrechnung|Finanzen]]
* [[Moduldokumentation Kostenrechnung|Kostenrechnung]]
* [[Moduldokumentation Inventar|Inventar]]
* [[Moduldokumentation Bau|Flächen, Räume]]
* [[Moduldokumentation GXStage|GXStage]]
** [[Modul_GXStage_Konfigurationshandbuch|Konfigurationshandbuch]]
** [[Modul_GXStage_Nutzungshandbuch|Nutzungshandbuch]]
** [[Modul_GXStage_Nutzungshandbuch_KI|Nutzungshandbuch von KI]]
* [[Moduldokumentation HRStage|HRStage]]

=SuperX.Campus-Ressourcen-Übergreifend=
* [[Moduldokumentation Managementkennzahlen|Managementkennzahlen (MAN)]]
**[[Modul_Managementkennzahlen_Administrationshandbuch|Konfigurationshandbuch]]
**[[Modul_Managementkennzahlen_Nutzungshandbuch|Nutzungshandbuch]]
* [[Moduldokumentation Grunddaten und Kennzahlen|Landeskennzahlen (KENN/KENNX)]]
** [[Modul_KENN_Nutzungshandbuch|Nutzungshandbuch]]
* [[SuperX-Connect|SuperX-Connect (SXC)]]
** [[Modul_SuperXConnect_Administrationshandbuch|Konfigurationshandbuch]]
** [[Modul_SuperXConnect_Nutzungshandbuch|Nutzungshandbuch]]
* [[Moduldokumentation Wissensbasis|Wissensbasis (KB)]]

=SuperX.Technologie und Qualitätssicherung=
* [[Heartbeat|Moduldokumentation Heartbeat]]
* [[Moduldokumentation Laderoutinen| Moduldokumentation Laderoutinen (ETL)]]
**[[Modul_ETL_Administrationshandbuch|Konfigurationshandbuch]]
**[[Modul_ETL_Nutzungshandbuch|Nutzungshandbuch]]
* [[Moduldokumentation Qualitätssicherung |Moduldokumentation Qualitätssicherung (QA)]]
** [[Modul_Qualitätssicherung Administrationshandbuch|Konfigurationshandbuch]]
** [[Modul_Qualitätssicherung Benutzerhandbuch|Nutzungshandbuch]]
*[[Modul_Visualisierung|Moduldokumentation Visualisierung (VIZ)]]
** [[Modul_Visualisierung_Konfigurationshandbuch| Konfigurationshandbuch]]
** [[Modul_Visualisierung_Nutzungshandbuch| Nutzungshandbuch]]
*[[Modul_xCube|Moduldokumentation Kreuztabellen (Xcube)]]
** [[Modul_xCube_Konfigurationshandbuch| Konfigurationshandbuch]]
** [[Modul_xCube_Nutzungshandbuch| Nutzungshandbuch]]
**[[Entwicklerhandbuch_xcube|Entwicklerhandbuch]]
*[[Modul_Berichtsassistent|Moduldokumentation Berichtsassistent (RPTA)]]
** [[Modul_Berichtsassistent_Konfigurationshandbuch| Konfigurationshandbuch]]
** [[Modul_Berichtsassistent_Nutzungshandbuch| Nutzungshandbuch]]
** [[RPTA_TODOs|TODOs (Intern)]]
*[[Modul_Nutzungsantraege|Moduldokumentation Nutzungsanträge (USERANTRAG)]]
**[[Modul_Nutzungsantraege_Nutzungshandbuch|Nutzungshandbuch]]
*[[Modul_Portalkonfiguration|Moduldokumentation Portalkonfiguration (PORTAL)]]
** [[Modul_Portalkonfiguration_Nutzungshandbuch| Nutzungshandbuch]]

=SuperX.Bedienung=
* [[SuperX-Benutzungshandbuch_Basics|SuperX-Benutzungshandbuch: Basics]]
* [[SuperX_barrierefrei | SuperX barrierefrei?]]

Aufbau eines SuperX-Moduls

2026-09-03T09:14:48Z

Danielq: /* Gestaltung der Formulare */

=Einleitung=
Dieser Artikel beschreibt den Aufbau eines Moduls in SuperX. Es wird erläutert welche Dateien ein Modul umfasst, wo sie abgelegt und wie sie aufgebaut sind.

== Begriffsklärung ==
* Installation: SuperX stellt eine Menge von Modulen zur Verfügung, die je nach Bedarf einzeln installiert werden können. Eine Installation ist einmal bei der Installation der HISinOne-BI notwendig.
* Upgrade: Ein Upgrade eines Moduls ist notwendig, wenn eine Neue Version oder ein Patch vorhanden ist und die BI-Komponente technisch auf den aktuellen Stand gebracht werden soll. Ein Upgrade ist bei jeder neuen Version, jedem Release, jedem ServicePack und jedem Patch notwendig.
* Update: Ein Update eines Moduls sorgt dafür, dass aktuelle Daten aus dem Quellsystem in die BI überführt werden. Ein Update wird jede Nacht automatisiert durchgeführt.
* Laderoutine: Eine Laderoutine führt ein Update durch.
* In HISinOne-BI wird ein Modul als "BI-Komponente" bezeichnet

= Modul-XML-Datei =
Es existiert zu jedem Modul eine zentrale Datei:
superx/WEB-INF/conf/edustore/db/module/<<modulname>>/conf/<<modulname>>.xml
Diese Datei enthält das Datenmodell. Aus ihr werden mit XSLT alle Skripte erzeugt, die für die Installation, Deinstallation, das Upgrade und die Laderoutine (Update) einer Komponente benötigt werden. Das XML-Format hat den Vorteil, dass die Skripte dynamisch für PostgreSQL und Informix erzeugt werden können, und dass die Skripte vereinheitlicht werden. Aus dieser Datei werden die Skripte erzeugt, die das Modul jeweils für Postgres und Informix installieren / updaten /aktualisieren / überprüfen und entfernen.

{{Hinweis| Die Modul-Dateien sind sehr groß und daher unübersichtlich. In Eclipse hilft die View ''Outline'' den Überblick zu behalten.}}
Grundsätzlich ist wichtig, dass zwischen Groß- und Kleinschreibung bei Tabellen- und Feldnamen unterschieden wird, d.h. "Gang" ist nicht gleich "gang". Außerdem sind zusätzliche Leerzeichen eine häufige Fehlerquelle.

== Aufbau ==
<source lang="xml">
<module>
<description></description>
<database></database>
<install></install>
<uninstall-step></uninstall-step>
<upgrade></upgrade>
<etl></etl>
<olap-system></olap-system>
<dbforms></dbforms>
</module>
</source>

Die Attribute des XML-tag <tt><modul></tt> sind wie folgt:
* name:
* version:
* sachgebiet_id:
* systeminfo_id:
* system:
* thema:
* thema_parent:

==Unterbereich database==
In diesem Unterbereich werden die Tabellen, Views, Themen und Masken integriert.
<source lang="xml">
<database>
<sachgebiet></sachgebiet>
<table></table>
...
<table></table>
<views></views>
<functions></functions>
<themen></themen>
<masken></masken>
<data-integrity></data-integrity>
</database>
</source>

Die Attribute des XML-tag <tt><database></tt> sind wie folgt:
* name:
* version:
* system:

===Tabellen===
Dies ist der Kernbereich.
<source lang="xml">
<table>
<description></description>
<columns>
<column></column>
...
<column></column>
</columns>
<primaryKeys></primaryKeys>
</table>
</source>

Die Attribute des XML-tag <tt><nowiki><table></nowiki></tt> sind wie folgt:
* name: Tabellenname
* caption: Beschreibung
* version: Version der Tabelle
* thema: Das Thema, dem die Tabelle zugeordnet werden kann.
* typ: Art der Tabelle
* datenquelle:

Art der Tabelle:
Per Konvention folgen die meisten Tabellen einem gewissen Schema, darin erfüllen sie eine bestimmte Funktion und sind an der Namensgebung zu erkennen. Beispielhafte Tabellen:
*Stagingtabelle: zum Sammeln von Daten, die ins Vorsystem geladen wurden
**Beispielname: tabelle_neu.sql
*Datentabelle: zur Datenhaltung
**Beispielname: tabelle.sql
*Aggregationstabelle: gehören zur Präsentationsschicht, für Berichte
**Beispielname: tabelle_aggr.sql
*Cubetabelle: bauen normalerweise auf Aggregationstabellen auf und überführen diese in eine numerische Verschlüsselung, für OLAP
**Beispielname: tabelle_cube.sql
*Dimensionstabelle: für Datenblätter, (OLAP)
**Beispielname: tabelle_cif.sql
:::tabelle_cifx.sql
:::dim_bp_tabelle_apnr

Das Element <tt><description></tt> bietet die Möglichkeit eine ausführlichere Beschreibung der Tabelle zu hinterlassen. <br>
In dem Element <tt><columns></tt> werden die Spalten der Tabelle definiert. Die Attribute des XML-tag <tt><column></tt> sind wie folgt:
* name: Name der Spalte
* type: Datentyp
* size: größe des Datentyps
* notnull: ob das Feld leergelassen werden darf
* description: Beschreibung der Spalte (wird in den jsp-Seiten der BI angezeigt)
* currentlyUsed: Wenn false, wird die Spalte in Datenblatt-Berichten nicht angezeigt.
* comment: Hier kann noch ein zusätzlicher Kommentar rein (erscheint in der Datenbankdokumentation)

Im Element "primaryKeys" werden die Primärschlüssel der Tabelle eingetragen. Hier gilt folgende Syntax:
<source lang="xml">
<rs>
<row>
<fld name="table_cat">superx</fld>
<fld name="table_schem">superx</fld>
<fld name="table_name">gang_stg_astat</fld>
<fld name="column_name">tid</fld>
<fld name="key_seq">1</fld>
<fld name="pk_name">gang_stg_stat_tid</fld>
</row>
</rs>
</source>
Die Elemente "fld name" müssen hier von "rs" und "row" umschlossen werden. Für einen Weiteren "primaryKey" wird ein neues Element "row" in dem selben "rs" geschrieben.
Zur Beschreibung:
* table_cat: Databasenamen
* table_schem: Databasename
* table_name: Tabellenname in dem der Primarykey steht
* column_name: Spaltenname vom Primarykey
* key_seq: Der wievielte Primarykey ist dies von der Tabelle?
* pk_name: Name vom Primarykey, üblicherweise <<Tabellenname>>_<<Spaltenname>>

=== Beispiel <nowiki><table></nowiki> ===
<source lang="xml">
<table name="gang_stg_astat" caption="Studienfächer (amtlich) zu Lehreinheiten" version="0.1" thema="Studiengänge" typ="Schlüsseltabelle" datenquelle="1">
<description>Zuordnung amtlicher Studienfächer einer Hochschule zu internen Lehreinheiten.</description>
<columns>
<column name="tid" type="SERIAL" size="4" default="" notnull="true" description="Laufnummer" isKey="true"/>
<column name="lehreinheit" type="CHAR" size="10" notnull="false" description="Lehreinheit"><comment>(hochschulinterner Schlüssel)</comment></column>
<column name="beschreibung" type="CHAR" size="150" notnull="false" description="Bezeichnung des Studienfachs"/>
<column name="astat" type="CHAR" size="3" notnull="false" description="Externer Schlüssel"/>
<column name="studienbereich" type="CHAR" size="10" notnull="false" description="Schlüssel Studienbereich"/>
<column name="aktiv" type="SMALLINT" notnull="false" description="Aktiv"><comment>Nur aktive Stati (1) werden im Studiengangsbaum angezeigt</comment></column>
<column name="bund_key" type="CHAR" size="10" notnull="false" description="Bundesschlüssel Lehreinheit"/>
<column name="datenquelle" type="INTEGER" size="4" default="1" notnull="false" description="Datenquelle für diesen Datensatz"/>
<column name="erzeugt_am" type="DATE" size="4" default="today()" notnull="false" description="Datum der Erzeugung des Datensatzes" currentlyUsed="false"/>
<column name="geaendert_am" type="DATE" size="4" default="" notnull="false" description="Datum der letzten Änderung des Datensatzes" currentlyUsed="false"/>
<column name="geaendert_von_id" type="INTEGER" size="4" default="" notnull="false" description="UserID des Ändernden" currentlyUsed="false"/>
<column name="erzeugt_von_id" type="INTEGER" size="4" default="" notnull="false" description="UserID des Erzeugers" currentlyUsed="false"/>
</columns>
<primaryKeys>
<rs>
<row>
<fld name="table_cat">superx</fld>
<fld name="table_schem">superx</fld>
<fld name="table_name">gang_stg_astat</fld>
<fld name="column_name">tid</fld>
<fld name="key_seq">1</fld>
<fld name="pk_name">gang_stg_stat_tid</fld>
</row>
</rs>
</primaryKeys>
</table>
</source>

===Views===
Für die Views wird wie bei den Tabellen eine bestimmte Syntax verfolgt. Diese erläutere ich an dem Beispiel der gang_k_sb:

<source lang="xml">
<view name="gang_k_sb" version="0.1">
<description>View Studienbereiche (Landesschlüssel)</description>
<columns>
<column name="apnr" type ="char" size ="2" default ="" notnull ="true" />
<column name="kurz" type ="VARCHAR" size ="150" default ="" notnull ="false" />
<column name="druck" type ="VARCHAR" size ="255" default ="" notnull ="false" />
<column name="lang_1" type ="VARCHAR" size ="255" default ="" notnull ="false" />
<column name="astat" type ="SMALLINT" size ="2" default ="" notnull ="false" />
</columns>
<sql dbsystem=""><![CDATA[SELECT apnr,kurz,druck ,lang_1,astat FROM gang_cifx where key=3 ]]></sql>
</view>
</source>

Die Vorgehensweise ähnelt hier der der Tabellen. In "view" wird der Name und die Version des Views eingetragen und in "description" die Beschreibung. In "columns" wird für jede Spalte ein "column" Element angelegt mit den entsprechenden Eigenschaften, wie "name", "type", "size" ... . In "sql" wird dann der select des Views eingetragen. Die Besonderheit hier ist das "CDATA". Durch diesen Befehl wird der eingeschlossene Text nicht von XSLT ausgewertet, sondern direkt übergeben.

===Themen===
Hier handelt es sich um die Überschriften im Themenbaum, z.B. "Auswertungen zu Studiengängen". Im Attribut Parent wird das übergeordnete Element definiert.
<source lang="xml">
<thema name="Auswertungen zu Studiengängen" parent="Studiengänge">Abfragen zur Akkreditierung</thema>
</source>

===Masken===
Hier werden die Masken bzw. Berichte des Moduls definiert. Diese Definitionen werden z.B. genutzt, um die Masken zu installieren oder zu entladen.
<source lang="xml">
<maske tid="25240" name="Zulassung" thema="Auswertungen zu Studiengängen">
<src><path>$GANG_PFAD/masken</path><author>D. Quathamer</author><lastChange>23.5.2007</lastChange><dbsystem>INFORMIX</dbsystem></src>
<src><path>$GANG_PFAD/masken</path><author>D. Quathamer</author><lastChange>23.5.2007</lastChange><dbsystem>POSTGRES</dbsystem></src>
</maske>
</source>

===Data-integrity===
In der Data-integrity werden die Verknüpfungen der Tabellen eingetragen. Dies ist einmal für die <<Modul>>.html wichtig, da dann die Verknüpfungen auch als Link zu der entsprechenden Tabelle erscheinen und damit in SuperX in den entsprechenden Tabellen nicht nur eine Nummer, sondern auch ein aussagekräftiger Text steht.
In meinem Beispiel verknüpfe ich die Tabellen gang_k_lehr_hs mit der gang_stg_astat. Auch die Reihenfolge spielt hier eine wichtige Rolle. Die erste Tabelle ist die, in der der entsprechende Inhalt und der Schlüssel in einer Spalte stehen. Die zweite Tabelle enthält nur den Schlüssel. Daher wird in der <<Modul>>.xml in der Zweiten Tabelle der entsprechende Fremdschlüssel eingetragen.
In visibleFields wird die entsprechende Spalte eingetragen, die ausgegeben werden soll. Mit zwei Pipes "||" können auch mehrere Spalten miteinander verbunden werden, wenn z.B. der Key und der Text ausgegeben werden soll.

Beispiel:
<source lang="xml">

<relation from="gang_k_lehr_hs" to="gang_stg_astat" delete="FALSE" displayType="select" visibleFields="key_apnr || trim(drucktext)" format="%s">
<relation-column from="key_apnr" to="lehreinheit" />
</relation>
</source>

Zur Beschreibung "relation":
*from: Tabelle mit Schlüssel und zugehörigen Text
*to: Tabelle nur mit Schlüssel
*delete:
*displayType:
*visibleFields: Welche Spalten angezeigt werden sollen (z.B. in dbforms FK-Bezizehungen)
*format: Format der Anzeige

Zur Beschreibung "relation-column":
*from: Key-Spalte der ersten Tabelle
*to: Key-Spalte der zweiten Tabelle

== Unterbereiche install, uninstall, ETL und upgrade==
Hier werden Aktionen und Ladeschritte bei der jeweiligen Aktion eines Moduls definiert. Das Hauptaugenmark liegt hier auf "nativeaction" und "loadtable". Eine "nativeaction wäre z.B.:
<source lang="xml">
<nativeaction sql="" scriptfile="$GANG_PFAD/conf/gang_tabellen_fuellen.sql"
database=""/>
</source>

Hier wird der Inhalt der SQL Datei genommen und ausgeführt. Es ist auch möglich einen SQL Befehl direkt in das Attribut "sql" zu schreiben. Falls erforderlich, kann auch noch als Bedingung die Datenbank angegeben werden (z.B. POSTGRES oder INFORMIX), für die diese "nativeaction" gedacht ist.
Für "loadtable" ist folgendes Beispiel:
<source lang="xml">
<loadtable refresh="false" delimiter="^" header="false" tabname="gang_cifx"><file path="$GANG_PFAD/schluesseltabellen/gang_cifx.unl"/></loadtable>
</source>
Hier wird der Inhalt einer Tabelle in eine Datei abgespeichert. "delimiter" steht für Feldtrenner, "header", ob die Spaltenüberschrift übernommen werden soll und "tabname" für den Tabellennamen. in "file" in dem Attribut "path" wird der Pfad mit Dateinamen angegeben, wo der Inhalt abgespeichert werden soll.
===Spezialität bei ETL===
In dem ETL Modul sind 6 Stufen eingebaut. Zu beachten ist hier auch, wenn eine Stufe nicht richtig verarbeitet wird, bricht das SKript komplett ab.
Zu den einzelnen Stufen:
;Unload: Hier werden die Daten aus dem Vorsystem entladen.
;Load: Hier werden die Daten in das Datawarehouse geladen.
;Trans: Hier wird die Transformation durchgeführt. D.h. es wird eine Schlüsselharmonisierung durchgeführt.
;Aggregation: Hier werden die Hilfstabellen gefüllt.
;System: Hier wird das Datum aktualisiert, welches die Aktualität angibt.
;Test: Hier findet die Prüfroutine statt.

==dbforms==
In der Modul-XML werden auch die Vorlagen für die DBforms gemacht. Dabei wird mit XSLT aus der abstrakten Beschreibung des Formulars eine funktionstüchtige JSP-Seite erzeugt. Hier werde ich nur auf die wichtigsten Felder eingehen.
===Erläuterung der XML-Elemente===
;Tabellenname:Als erstes sollte der Tabellenname eingetragen werden. Dieser wird hier an mehreren Stellen benötigt. (Bei: "table", "path", "customfield", ..)
;path:Zu beachten ist, dass der Tabellenname sowie das Modul in den Pfad ("path") Angaben auch richtig eingetragen wird.
;name , caption:Im ersten Block wird meist in den Feldern "name" und "caption" dasselbe eingetragen und zwar eine kurze aber aussagekräftige Bezeichnung der Tabelle. Diese kann auch in dem zweiten Block übernommen werden. Dort gibt es genau dieselben Felder.
;descpription: Eine ausführlichere Beschreibung der Tabelle wird in das Feld "description" geschrieben. Diese Beschreibung sollte aber auch nicht länger sein als ein normaler Satz.
; field-selection / customfield :Wenn man <nowiki><field-selection complete="true" /></nowiki> wählt, dann werden automatisch alle Felder der Tabelle im Formular angezeigt. Wenn Sie nur einige Felder anzeigen wollen, nutzen Sie das Element <nowiki><customfield></nowiki>. Außerdem kann man mit customfield spezielle Layoutanweisungen kombinieren, z.B. Feldgröße.

<source lang="xml">
<form name="Studienfächer (amtlich) zu Lehreinheiten (Liste)"
table="gang_stg_astat"
path="/edit/gang/gang_stg_astat_list.jsp"
followUp=""
caption="Studienfächer (amtlich) zu Lehreinheiten (Liste)"
orderBy="astat"
gotoHt=""
helpfile=""
maxRows="*"
mode="update_insert">
<description>Zuordnung amtlicher Studienfächer einer Hochschule zu internen Lehreinheiten.</description>
<filters>
</filters>
<field-selection complete="false" />
<customfield name="tid" nullFieldValue="" />
<customfield name="astat" type="label" nullFieldValue="" visibleSize="10"/>
<customfield type="link" name="Details" path="/superx/edit/gang/gang_stg_astat_edit.jsp" linkid="tid"/>
</form>

<form name="Studienfächer (amtlich) zu Lehreinheiten"
table="gang_stg_astat"
path="/edit/gang/gang_stg_astat_edit.jsp"
followUp=""
caption="Studienfächer (amtlich) zu Lehreinheiten bearbeiten"
orderBy="astat"
gotoHt="tid"
helpfile=""
maxRows="1"
mode="full">
<description>Zuordnung amtlicher Studienfächer einer Hochschule zu internen Lehreinheiten.</description>
<filters>

</filters>
<field-selection complete="false" />
<customfield name="tid" nullFieldValue="" />
<customfield name="lehreinheit" nullFieldValue="" visibleSize="10"/>
<customfield name="beschreibung" nullFieldValue="" visibleSize="30"/>
<customfield name="astat" nullFieldValue="" visibleSize="100"/>
<customfield name="studienbereich" nullFieldValue="" visibleSize="30"/>
<customfield name="aktiv" nullFieldValue="" visibleSize="10"/>
<customfield name="bund_key" nullFieldValue="" visibleSize="30"/>
<customfield name="Datensatzstatus" type="include" path="/edit/gang/datensatzstatus.inc"/>
</form>
</source>

; Optionen für die Merkmale:
#mode
#* full
#* update_insert
#* update
#* insert
#* ...
#type
#*include
#*link
#*lable (Nur Bezeichnung)
#* ...
#filters
#* Beispiel: in gang.xml: form name="zuordnung"
<source lang="xml"><filters>
<filter mandatory="true" type="equals">tid</filter>
</filters></source>

===Test der Formulare===
Die Formulare werden in der Modul-XML-Datei definiert (s.o.). Die JSP-Seiten werden dann generiert, indem man das [[Kernmodul_Shellscripte#module_scripts_create.x|Modulscripte generieren]] ausführt.
Danach muss man einen Modulupgrade ausführen, damit die Formulare in der Datenbank gespeichert werden. Und dann kann man die Formulare testen, indem man im Menü Administration-> "Tabelle suchen"-> Bearbeiten anklickt.

Wenn Sie die Bearbeitungsformulare auch im Themenbaum anzeigen wollen, müssen Sie eine Suchmaske vorschalten, in der
*die Datensätze gefiltert werden können
*über einen' ''Bearbeiten''' Button [[Bild:Pencil.gif]](Spaltenname "nextedit") zugänglich gemacht werden.

Sie z.B. die Maske "Tabelle suchen", diese ist ein gutes, einfaches Beispiel für eine Kombination aus Suchformular und Bearbeitungsformular.

=== Gestaltung der Formulare ===

; Auswahl aus Schlüsseltabelle
: Wenn Inhalte zur Auswahl aus einer verknüften Schlüsseltabelle angezeigt werden sollen, müssen folgende Bedingungen erfüllt sein:
:* Die Beziehung ist als data-integrity-relation eingetragen.
:* in der Relation ist unter '''visibleFields="..."''' das Feld eingetragen, dessen Inhalt an der Oberfläche erscheinen soll.

;Spaltenbeschriftung
:Wenn nicht der Spaltennahme aus der Tabelle angezeigt werden soll, sondern eine sprechendere Bezeichnung muss bei description:
<source lang="xml">
<database> <table> <columns> <column name="..." '''description= "..."''' >
</source>
die entsprechende Bezeichnung eingetragen werden.

;Formular in Maske einbinden
:Wenn durch eintragen von "nextedit" bereits ein Verweis auf das (funktionierende) Formular erstellt wurde, es aber nicht gefunden wird, muss:
:* zunächst die jsp Seite unter superx/edit/MODULE generiert werden

* [http://entwicklerhandbuch.superx-projekt.de/ Entwicklungshandbücher von SuperX]

Aufbau eines SuperX-Moduls

2026-09-03T09:12:51Z

Danielq: /* Test der Formulare */

=Einleitung=
Dieser Artikel beschreibt den Aufbau eines Moduls in SuperX. Es wird erläutert welche Dateien ein Modul umfasst, wo sie abgelegt und wie sie aufgebaut sind.

== Begriffsklärung ==
* Installation: SuperX stellt eine Menge von Modulen zur Verfügung, die je nach Bedarf einzeln installiert werden können. Eine Installation ist einmal bei der Installation der HISinOne-BI notwendig.
* Upgrade: Ein Upgrade eines Moduls ist notwendig, wenn eine Neue Version oder ein Patch vorhanden ist und die BI-Komponente technisch auf den aktuellen Stand gebracht werden soll. Ein Upgrade ist bei jeder neuen Version, jedem Release, jedem ServicePack und jedem Patch notwendig.
* Update: Ein Update eines Moduls sorgt dafür, dass aktuelle Daten aus dem Quellsystem in die BI überführt werden. Ein Update wird jede Nacht automatisiert durchgeführt.
* Laderoutine: Eine Laderoutine führt ein Update durch.
* In HISinOne-BI wird ein Modul als "BI-Komponente" bezeichnet

= Modul-XML-Datei =
Es existiert zu jedem Modul eine zentrale Datei:
superx/WEB-INF/conf/edustore/db/module/<<modulname>>/conf/<<modulname>>.xml
Diese Datei enthält das Datenmodell. Aus ihr werden mit XSLT alle Skripte erzeugt, die für die Installation, Deinstallation, das Upgrade und die Laderoutine (Update) einer Komponente benötigt werden. Das XML-Format hat den Vorteil, dass die Skripte dynamisch für PostgreSQL und Informix erzeugt werden können, und dass die Skripte vereinheitlicht werden. Aus dieser Datei werden die Skripte erzeugt, die das Modul jeweils für Postgres und Informix installieren / updaten /aktualisieren / überprüfen und entfernen.

{{Hinweis| Die Modul-Dateien sind sehr groß und daher unübersichtlich. In Eclipse hilft die View ''Outline'' den Überblick zu behalten.}}
Grundsätzlich ist wichtig, dass zwischen Groß- und Kleinschreibung bei Tabellen- und Feldnamen unterschieden wird, d.h. "Gang" ist nicht gleich "gang". Außerdem sind zusätzliche Leerzeichen eine häufige Fehlerquelle.

== Aufbau ==
<source lang="xml">
<module>
<description></description>
<database></database>
<install></install>
<uninstall-step></uninstall-step>
<upgrade></upgrade>
<etl></etl>
<olap-system></olap-system>
<dbforms></dbforms>
</module>
</source>

Die Attribute des XML-tag <tt><modul></tt> sind wie folgt:
* name:
* version:
* sachgebiet_id:
* systeminfo_id:
* system:
* thema:
* thema_parent:

==Unterbereich database==
In diesem Unterbereich werden die Tabellen, Views, Themen und Masken integriert.
<source lang="xml">
<database>
<sachgebiet></sachgebiet>
<table></table>
...
<table></table>
<views></views>
<functions></functions>
<themen></themen>
<masken></masken>
<data-integrity></data-integrity>
</database>
</source>

Die Attribute des XML-tag <tt><database></tt> sind wie folgt:
* name:
* version:
* system:

===Tabellen===
Dies ist der Kernbereich.
<source lang="xml">
<table>
<description></description>
<columns>
<column></column>
...
<column></column>
</columns>
<primaryKeys></primaryKeys>
</table>
</source>

Die Attribute des XML-tag <tt><nowiki><table></nowiki></tt> sind wie folgt:
* name: Tabellenname
* caption: Beschreibung
* version: Version der Tabelle
* thema: Das Thema, dem die Tabelle zugeordnet werden kann.
* typ: Art der Tabelle
* datenquelle:

Art der Tabelle:
Per Konvention folgen die meisten Tabellen einem gewissen Schema, darin erfüllen sie eine bestimmte Funktion und sind an der Namensgebung zu erkennen. Beispielhafte Tabellen:
*Stagingtabelle: zum Sammeln von Daten, die ins Vorsystem geladen wurden
**Beispielname: tabelle_neu.sql
*Datentabelle: zur Datenhaltung
**Beispielname: tabelle.sql
*Aggregationstabelle: gehören zur Präsentationsschicht, für Berichte
**Beispielname: tabelle_aggr.sql
*Cubetabelle: bauen normalerweise auf Aggregationstabellen auf und überführen diese in eine numerische Verschlüsselung, für OLAP
**Beispielname: tabelle_cube.sql
*Dimensionstabelle: für Datenblätter, (OLAP)
**Beispielname: tabelle_cif.sql
:::tabelle_cifx.sql
:::dim_bp_tabelle_apnr

Das Element <tt><description></tt> bietet die Möglichkeit eine ausführlichere Beschreibung der Tabelle zu hinterlassen. <br>
In dem Element <tt><columns></tt> werden die Spalten der Tabelle definiert. Die Attribute des XML-tag <tt><column></tt> sind wie folgt:
* name: Name der Spalte
* type: Datentyp
* size: größe des Datentyps
* notnull: ob das Feld leergelassen werden darf
* description: Beschreibung der Spalte (wird in den jsp-Seiten der BI angezeigt)
* currentlyUsed: Wenn false, wird die Spalte in Datenblatt-Berichten nicht angezeigt.
* comment: Hier kann noch ein zusätzlicher Kommentar rein (erscheint in der Datenbankdokumentation)

Im Element "primaryKeys" werden die Primärschlüssel der Tabelle eingetragen. Hier gilt folgende Syntax:
<source lang="xml">
<rs>
<row>
<fld name="table_cat">superx</fld>
<fld name="table_schem">superx</fld>
<fld name="table_name">gang_stg_astat</fld>
<fld name="column_name">tid</fld>
<fld name="key_seq">1</fld>
<fld name="pk_name">gang_stg_stat_tid</fld>
</row>
</rs>
</source>
Die Elemente "fld name" müssen hier von "rs" und "row" umschlossen werden. Für einen Weiteren "primaryKey" wird ein neues Element "row" in dem selben "rs" geschrieben.
Zur Beschreibung:
* table_cat: Databasenamen
* table_schem: Databasename
* table_name: Tabellenname in dem der Primarykey steht
* column_name: Spaltenname vom Primarykey
* key_seq: Der wievielte Primarykey ist dies von der Tabelle?
* pk_name: Name vom Primarykey, üblicherweise <<Tabellenname>>_<<Spaltenname>>

=== Beispiel <nowiki><table></nowiki> ===
<source lang="xml">
<table name="gang_stg_astat" caption="Studienfächer (amtlich) zu Lehreinheiten" version="0.1" thema="Studiengänge" typ="Schlüsseltabelle" datenquelle="1">
<description>Zuordnung amtlicher Studienfächer einer Hochschule zu internen Lehreinheiten.</description>
<columns>
<column name="tid" type="SERIAL" size="4" default="" notnull="true" description="Laufnummer" isKey="true"/>
<column name="lehreinheit" type="CHAR" size="10" notnull="false" description="Lehreinheit"><comment>(hochschulinterner Schlüssel)</comment></column>
<column name="beschreibung" type="CHAR" size="150" notnull="false" description="Bezeichnung des Studienfachs"/>
<column name="astat" type="CHAR" size="3" notnull="false" description="Externer Schlüssel"/>
<column name="studienbereich" type="CHAR" size="10" notnull="false" description="Schlüssel Studienbereich"/>
<column name="aktiv" type="SMALLINT" notnull="false" description="Aktiv"><comment>Nur aktive Stati (1) werden im Studiengangsbaum angezeigt</comment></column>
<column name="bund_key" type="CHAR" size="10" notnull="false" description="Bundesschlüssel Lehreinheit"/>
<column name="datenquelle" type="INTEGER" size="4" default="1" notnull="false" description="Datenquelle für diesen Datensatz"/>
<column name="erzeugt_am" type="DATE" size="4" default="today()" notnull="false" description="Datum der Erzeugung des Datensatzes" currentlyUsed="false"/>
<column name="geaendert_am" type="DATE" size="4" default="" notnull="false" description="Datum der letzten Änderung des Datensatzes" currentlyUsed="false"/>
<column name="geaendert_von_id" type="INTEGER" size="4" default="" notnull="false" description="UserID des Ändernden" currentlyUsed="false"/>
<column name="erzeugt_von_id" type="INTEGER" size="4" default="" notnull="false" description="UserID des Erzeugers" currentlyUsed="false"/>
</columns>
<primaryKeys>
<rs>
<row>
<fld name="table_cat">superx</fld>
<fld name="table_schem">superx</fld>
<fld name="table_name">gang_stg_astat</fld>
<fld name="column_name">tid</fld>
<fld name="key_seq">1</fld>
<fld name="pk_name">gang_stg_stat_tid</fld>
</row>
</rs>
</primaryKeys>
</table>
</source>

===Views===
Für die Views wird wie bei den Tabellen eine bestimmte Syntax verfolgt. Diese erläutere ich an dem Beispiel der gang_k_sb:

<source lang="xml">
<view name="gang_k_sb" version="0.1">
<description>View Studienbereiche (Landesschlüssel)</description>
<columns>
<column name="apnr" type ="char" size ="2" default ="" notnull ="true" />
<column name="kurz" type ="VARCHAR" size ="150" default ="" notnull ="false" />
<column name="druck" type ="VARCHAR" size ="255" default ="" notnull ="false" />
<column name="lang_1" type ="VARCHAR" size ="255" default ="" notnull ="false" />
<column name="astat" type ="SMALLINT" size ="2" default ="" notnull ="false" />
</columns>
<sql dbsystem=""><![CDATA[SELECT apnr,kurz,druck ,lang_1,astat FROM gang_cifx where key=3 ]]></sql>
</view>
</source>

Die Vorgehensweise ähnelt hier der der Tabellen. In "view" wird der Name und die Version des Views eingetragen und in "description" die Beschreibung. In "columns" wird für jede Spalte ein "column" Element angelegt mit den entsprechenden Eigenschaften, wie "name", "type", "size" ... . In "sql" wird dann der select des Views eingetragen. Die Besonderheit hier ist das "CDATA". Durch diesen Befehl wird der eingeschlossene Text nicht von XSLT ausgewertet, sondern direkt übergeben.

===Themen===
Hier handelt es sich um die Überschriften im Themenbaum, z.B. "Auswertungen zu Studiengängen". Im Attribut Parent wird das übergeordnete Element definiert.
<source lang="xml">
<thema name="Auswertungen zu Studiengängen" parent="Studiengänge">Abfragen zur Akkreditierung</thema>
</source>

===Masken===
Hier werden die Masken bzw. Berichte des Moduls definiert. Diese Definitionen werden z.B. genutzt, um die Masken zu installieren oder zu entladen.
<source lang="xml">
<maske tid="25240" name="Zulassung" thema="Auswertungen zu Studiengängen">
<src><path>$GANG_PFAD/masken</path><author>D. Quathamer</author><lastChange>23.5.2007</lastChange><dbsystem>INFORMIX</dbsystem></src>
<src><path>$GANG_PFAD/masken</path><author>D. Quathamer</author><lastChange>23.5.2007</lastChange><dbsystem>POSTGRES</dbsystem></src>
</maske>
</source>

===Data-integrity===
In der Data-integrity werden die Verknüpfungen der Tabellen eingetragen. Dies ist einmal für die <<Modul>>.html wichtig, da dann die Verknüpfungen auch als Link zu der entsprechenden Tabelle erscheinen und damit in SuperX in den entsprechenden Tabellen nicht nur eine Nummer, sondern auch ein aussagekräftiger Text steht.
In meinem Beispiel verknüpfe ich die Tabellen gang_k_lehr_hs mit der gang_stg_astat. Auch die Reihenfolge spielt hier eine wichtige Rolle. Die erste Tabelle ist die, in der der entsprechende Inhalt und der Schlüssel in einer Spalte stehen. Die zweite Tabelle enthält nur den Schlüssel. Daher wird in der <<Modul>>.xml in der Zweiten Tabelle der entsprechende Fremdschlüssel eingetragen.
In visibleFields wird die entsprechende Spalte eingetragen, die ausgegeben werden soll. Mit zwei Pipes "||" können auch mehrere Spalten miteinander verbunden werden, wenn z.B. der Key und der Text ausgegeben werden soll.

Beispiel:
<source lang="xml">

<relation from="gang_k_lehr_hs" to="gang_stg_astat" delete="FALSE" displayType="select" visibleFields="key_apnr || trim(drucktext)" format="%s">
<relation-column from="key_apnr" to="lehreinheit" />
</relation>
</source>

Zur Beschreibung "relation":
*from: Tabelle mit Schlüssel und zugehörigen Text
*to: Tabelle nur mit Schlüssel
*delete:
*displayType:
*visibleFields: Welche Spalten angezeigt werden sollen (z.B. in dbforms FK-Bezizehungen)
*format: Format der Anzeige

Zur Beschreibung "relation-column":
*from: Key-Spalte der ersten Tabelle
*to: Key-Spalte der zweiten Tabelle

== Unterbereiche install, uninstall, ETL und upgrade==
Hier werden Aktionen und Ladeschritte bei der jeweiligen Aktion eines Moduls definiert. Das Hauptaugenmark liegt hier auf "nativeaction" und "loadtable". Eine "nativeaction wäre z.B.:
<source lang="xml">
<nativeaction sql="" scriptfile="$GANG_PFAD/conf/gang_tabellen_fuellen.sql"
database=""/>
</source>

Hier wird der Inhalt der SQL Datei genommen und ausgeführt. Es ist auch möglich einen SQL Befehl direkt in das Attribut "sql" zu schreiben. Falls erforderlich, kann auch noch als Bedingung die Datenbank angegeben werden (z.B. POSTGRES oder INFORMIX), für die diese "nativeaction" gedacht ist.
Für "loadtable" ist folgendes Beispiel:
<source lang="xml">
<loadtable refresh="false" delimiter="^" header="false" tabname="gang_cifx"><file path="$GANG_PFAD/schluesseltabellen/gang_cifx.unl"/></loadtable>
</source>
Hier wird der Inhalt einer Tabelle in eine Datei abgespeichert. "delimiter" steht für Feldtrenner, "header", ob die Spaltenüberschrift übernommen werden soll und "tabname" für den Tabellennamen. in "file" in dem Attribut "path" wird der Pfad mit Dateinamen angegeben, wo der Inhalt abgespeichert werden soll.
===Spezialität bei ETL===
In dem ETL Modul sind 6 Stufen eingebaut. Zu beachten ist hier auch, wenn eine Stufe nicht richtig verarbeitet wird, bricht das SKript komplett ab.
Zu den einzelnen Stufen:
;Unload: Hier werden die Daten aus dem Vorsystem entladen.
;Load: Hier werden die Daten in das Datawarehouse geladen.
;Trans: Hier wird die Transformation durchgeführt. D.h. es wird eine Schlüsselharmonisierung durchgeführt.
;Aggregation: Hier werden die Hilfstabellen gefüllt.
;System: Hier wird das Datum aktualisiert, welches die Aktualität angibt.
;Test: Hier findet die Prüfroutine statt.

==dbforms==
In der Modul-XML werden auch die Vorlagen für die DBforms gemacht. Dabei wird mit XSLT aus der abstrakten Beschreibung des Formulars eine funktionstüchtige JSP-Seite erzeugt. Hier werde ich nur auf die wichtigsten Felder eingehen.
===Erläuterung der XML-Elemente===
;Tabellenname:Als erstes sollte der Tabellenname eingetragen werden. Dieser wird hier an mehreren Stellen benötigt. (Bei: "table", "path", "customfield", ..)
;path:Zu beachten ist, dass der Tabellenname sowie das Modul in den Pfad ("path") Angaben auch richtig eingetragen wird.
;name , caption:Im ersten Block wird meist in den Feldern "name" und "caption" dasselbe eingetragen und zwar eine kurze aber aussagekräftige Bezeichnung der Tabelle. Diese kann auch in dem zweiten Block übernommen werden. Dort gibt es genau dieselben Felder.
;descpription: Eine ausführlichere Beschreibung der Tabelle wird in das Feld "description" geschrieben. Diese Beschreibung sollte aber auch nicht länger sein als ein normaler Satz.
; field-selection / customfield :Wenn man <nowiki><field-selection complete="true" /></nowiki> wählt, dann werden automatisch alle Felder der Tabelle im Formular angezeigt. Wenn Sie nur einige Felder anzeigen wollen, nutzen Sie das Element <nowiki><customfield></nowiki>. Außerdem kann man mit customfield spezielle Layoutanweisungen kombinieren, z.B. Feldgröße.

<source lang="xml">
<form name="Studienfächer (amtlich) zu Lehreinheiten (Liste)"
table="gang_stg_astat"
path="/edit/gang/gang_stg_astat_list.jsp"
followUp=""
caption="Studienfächer (amtlich) zu Lehreinheiten (Liste)"
orderBy="astat"
gotoHt=""
helpfile=""
maxRows="*"
mode="update_insert">
<description>Zuordnung amtlicher Studienfächer einer Hochschule zu internen Lehreinheiten.</description>
<filters>
</filters>
<field-selection complete="false" />
<customfield name="tid" nullFieldValue="" />
<customfield name="astat" type="label" nullFieldValue="" visibleSize="10"/>
<customfield type="link" name="Details" path="/superx/edit/gang/gang_stg_astat_edit.jsp" linkid="tid"/>
</form>

<form name="Studienfächer (amtlich) zu Lehreinheiten"
table="gang_stg_astat"
path="/edit/gang/gang_stg_astat_edit.jsp"
followUp=""
caption="Studienfächer (amtlich) zu Lehreinheiten bearbeiten"
orderBy="astat"
gotoHt="tid"
helpfile=""
maxRows="1"
mode="full">
<description>Zuordnung amtlicher Studienfächer einer Hochschule zu internen Lehreinheiten.</description>
<filters>

</filters>
<field-selection complete="false" />
<customfield name="tid" nullFieldValue="" />
<customfield name="lehreinheit" nullFieldValue="" visibleSize="10"/>
<customfield name="beschreibung" nullFieldValue="" visibleSize="30"/>
<customfield name="astat" nullFieldValue="" visibleSize="100"/>
<customfield name="studienbereich" nullFieldValue="" visibleSize="30"/>
<customfield name="aktiv" nullFieldValue="" visibleSize="10"/>
<customfield name="bund_key" nullFieldValue="" visibleSize="30"/>
<customfield name="Datensatzstatus" type="include" path="/edit/gang/datensatzstatus.inc"/>
</form>
</source>

; Optionen für die Merkmale:
#mode
#* full
#* update_insert
#* update
#* insert
#* ...
#type
#*include
#*link
#*lable (Nur Bezeichnung)
#* ...
#filters
#* Beispiel: in gang.xml: form name="zuordnung"
<source lang="xml"><filters>
<filter mandatory="true" type="equals">tid</filter>
</filters></source>

===Test der Formulare===
Die Formulare werden in der Modul-XML-Datei definiert (s.o.). Die JSP-Seiten werden dann generiert, indem man das [[Kernmodul_Shellscripte#module_scripts_create.x|Modulscripte generieren]] ausführt.
Danach muss man einen Modulupgrade ausführen, damit die Formulare in der Datenbank gespeichert werden. Und dann kann man die Formulare testen, indem man im Menü Administration-> "Tabelle suchen"-> Bearbeiten anklickt.

Wenn Sie die Bearbeitungsformulare auch im Themenbaum anzeigen wollen, müssen Sie eine Suchmaske vorschalten, in der
*die Datensätze gefiltert werden können
*über einen' ''Bearbeiten''' Button [[Bild:Pencil.gif]](Spaltenname "nextedit") zugänglich gemacht werden.

Sie z.B. die Maske "Tabelle suchen", diese ist ein gutes, einfaches Beispiel für eine Kombination aus Suchformular und Bearbeitungsformular.

=== Gestaltung der Formulare ===

; Auswahl aus Schlüsseltabelle
: Wenn Inhalte zur Auswahl aus einer verknüften Schlüsseltabelle angezeigt werden sollen, müssen folgende Bedingungen erfüllt sein:
:* Die Beziehung ist als <data-integrity> <relation> eingetragen.
:* in der Relation ist unter '''visibleFields="..."''' das Feld eingetragen, dessen Inhalt an der Oberfläche erscheinen soll.

;Spaltenbeschriftung
:Wenn nicht der Spaltennahme aus der Tabelle angezeigt werden soll, sondern eine sprechendere Bezeichnung muss:
:* unter <nowiki> <database> <table> <columns> <column name="..." '''description= "..."''' ></nowiki> die entsprechende Bezeichnung eingetragen werden.

;Formular in Maske einbinden
:Wenn durch eintragen von "nextedit" bereits ein Verweis auf das (funktionierende) Formular erstellt wurde, es aber nicht gefunden wird, muss:
:* zunächst die jsp Seite unter superx\edit\MODULE generiert werden

* [http://entwicklerhandbuch.superx-projekt.de/ Entwicklungshandbücher von SuperX]

Aufbau eines SuperX-Moduls

2026-09-03T09:10:43Z

Danielq: Die Seite wurde neu angelegt: „ =Einleitung= Dieser Artikel beschreibt den Aufbau eines Moduls in SuperX. Es wird erläutert welche Dateien ein Modul umfasst, wo sie abgelegt und wie sie aufgebaut sind. == Begriffsklärung == * Installation: SuperX stellt eine Menge von Modulen zur Verfügung, die je nach Bedarf einzeln installiert werden können. Eine Installation ist einmal bei der Installation der HISinOne-BI notwendig. * Upgrade: Ein Upgrade eines Moduls ist notwendig, wenn eine…“

=Einleitung=
Dieser Artikel beschreibt den Aufbau eines Moduls in SuperX. Es wird erläutert welche Dateien ein Modul umfasst, wo sie abgelegt und wie sie aufgebaut sind.

== Begriffsklärung ==
* Installation: SuperX stellt eine Menge von Modulen zur Verfügung, die je nach Bedarf einzeln installiert werden können. Eine Installation ist einmal bei der Installation der HISinOne-BI notwendig.
* Upgrade: Ein Upgrade eines Moduls ist notwendig, wenn eine Neue Version oder ein Patch vorhanden ist und die BI-Komponente technisch auf den aktuellen Stand gebracht werden soll. Ein Upgrade ist bei jeder neuen Version, jedem Release, jedem ServicePack und jedem Patch notwendig.
* Update: Ein Update eines Moduls sorgt dafür, dass aktuelle Daten aus dem Quellsystem in die BI überführt werden. Ein Update wird jede Nacht automatisiert durchgeführt.
* Laderoutine: Eine Laderoutine führt ein Update durch.
* In HISinOne-BI wird ein Modul als "BI-Komponente" bezeichnet

= Modul-XML-Datei =
Es existiert zu jedem Modul eine zentrale Datei:
superx/WEB-INF/conf/edustore/db/module/<<modulname>>/conf/<<modulname>>.xml
Diese Datei enthält das Datenmodell. Aus ihr werden mit XSLT alle Skripte erzeugt, die für die Installation, Deinstallation, das Upgrade und die Laderoutine (Update) einer Komponente benötigt werden. Das XML-Format hat den Vorteil, dass die Skripte dynamisch für PostgreSQL und Informix erzeugt werden können, und dass die Skripte vereinheitlicht werden. Aus dieser Datei werden die Skripte erzeugt, die das Modul jeweils für Postgres und Informix installieren / updaten /aktualisieren / überprüfen und entfernen.

{{Hinweis| Die Modul-Dateien sind sehr groß und daher unübersichtlich. In Eclipse hilft die View ''Outline'' den Überblick zu behalten.}}
Grundsätzlich ist wichtig, dass zwischen Groß- und Kleinschreibung bei Tabellen- und Feldnamen unterschieden wird, d.h. "Gang" ist nicht gleich "gang". Außerdem sind zusätzliche Leerzeichen eine häufige Fehlerquelle.

== Aufbau ==
<source lang="xml">
<module>
<description></description>
<database></database>
<install></install>
<uninstall-step></uninstall-step>
<upgrade></upgrade>
<etl></etl>
<olap-system></olap-system>
<dbforms></dbforms>
</module>
</source>

Die Attribute des XML-tag <tt><modul></tt> sind wie folgt:
* name:
* version:
* sachgebiet_id:
* systeminfo_id:
* system:
* thema:
* thema_parent:

==Unterbereich database==
In diesem Unterbereich werden die Tabellen, Views, Themen und Masken integriert.
<source lang="xml">
<database>
<sachgebiet></sachgebiet>
<table></table>
...
<table></table>
<views></views>
<functions></functions>
<themen></themen>
<masken></masken>
<data-integrity></data-integrity>
</database>
</source>

Die Attribute des XML-tag <tt><database></tt> sind wie folgt:
* name:
* version:
* system:

===Tabellen===
Dies ist der Kernbereich.
<source lang="xml">
<table>
<description></description>
<columns>
<column></column>
...
<column></column>
</columns>
<primaryKeys></primaryKeys>
</table>
</source>

Die Attribute des XML-tag <tt><nowiki><table></nowiki></tt> sind wie folgt:
* name: Tabellenname
* caption: Beschreibung
* version: Version der Tabelle
* thema: Das Thema, dem die Tabelle zugeordnet werden kann.
* typ: Art der Tabelle
* datenquelle:

Art der Tabelle:
Per Konvention folgen die meisten Tabellen einem gewissen Schema, darin erfüllen sie eine bestimmte Funktion und sind an der Namensgebung zu erkennen. Beispielhafte Tabellen:
*Stagingtabelle: zum Sammeln von Daten, die ins Vorsystem geladen wurden
**Beispielname: tabelle_neu.sql
*Datentabelle: zur Datenhaltung
**Beispielname: tabelle.sql
*Aggregationstabelle: gehören zur Präsentationsschicht, für Berichte
**Beispielname: tabelle_aggr.sql
*Cubetabelle: bauen normalerweise auf Aggregationstabellen auf und überführen diese in eine numerische Verschlüsselung, für OLAP
**Beispielname: tabelle_cube.sql
*Dimensionstabelle: für Datenblätter, (OLAP)
**Beispielname: tabelle_cif.sql
:::tabelle_cifx.sql
:::dim_bp_tabelle_apnr

Das Element <tt><description></tt> bietet die Möglichkeit eine ausführlichere Beschreibung der Tabelle zu hinterlassen. <br>
In dem Element <tt><columns></tt> werden die Spalten der Tabelle definiert. Die Attribute des XML-tag <tt><column></tt> sind wie folgt:
* name: Name der Spalte
* type: Datentyp
* size: größe des Datentyps
* notnull: ob das Feld leergelassen werden darf
* description: Beschreibung der Spalte (wird in den jsp-Seiten der BI angezeigt)
* currentlyUsed: Wenn false, wird die Spalte in Datenblatt-Berichten nicht angezeigt.
* comment: Hier kann noch ein zusätzlicher Kommentar rein (erscheint in der Datenbankdokumentation)

Im Element "primaryKeys" werden die Primärschlüssel der Tabelle eingetragen. Hier gilt folgende Syntax:
<source lang="xml">
<rs>
<row>
<fld name="table_cat">superx</fld>
<fld name="table_schem">superx</fld>
<fld name="table_name">gang_stg_astat</fld>
<fld name="column_name">tid</fld>
<fld name="key_seq">1</fld>
<fld name="pk_name">gang_stg_stat_tid</fld>
</row>
</rs>
</source>
Die Elemente "fld name" müssen hier von "rs" und "row" umschlossen werden. Für einen Weiteren "primaryKey" wird ein neues Element "row" in dem selben "rs" geschrieben.
Zur Beschreibung:
* table_cat: Databasenamen
* table_schem: Databasename
* table_name: Tabellenname in dem der Primarykey steht
* column_name: Spaltenname vom Primarykey
* key_seq: Der wievielte Primarykey ist dies von der Tabelle?
* pk_name: Name vom Primarykey, üblicherweise <<Tabellenname>>_<<Spaltenname>>

=== Beispiel <nowiki><table></nowiki> ===
<source lang="xml">
<table name="gang_stg_astat" caption="Studienfächer (amtlich) zu Lehreinheiten" version="0.1" thema="Studiengänge" typ="Schlüsseltabelle" datenquelle="1">
<description>Zuordnung amtlicher Studienfächer einer Hochschule zu internen Lehreinheiten.</description>
<columns>
<column name="tid" type="SERIAL" size="4" default="" notnull="true" description="Laufnummer" isKey="true"/>
<column name="lehreinheit" type="CHAR" size="10" notnull="false" description="Lehreinheit"><comment>(hochschulinterner Schlüssel)</comment></column>
<column name="beschreibung" type="CHAR" size="150" notnull="false" description="Bezeichnung des Studienfachs"/>
<column name="astat" type="CHAR" size="3" notnull="false" description="Externer Schlüssel"/>
<column name="studienbereich" type="CHAR" size="10" notnull="false" description="Schlüssel Studienbereich"/>
<column name="aktiv" type="SMALLINT" notnull="false" description="Aktiv"><comment>Nur aktive Stati (1) werden im Studiengangsbaum angezeigt</comment></column>
<column name="bund_key" type="CHAR" size="10" notnull="false" description="Bundesschlüssel Lehreinheit"/>
<column name="datenquelle" type="INTEGER" size="4" default="1" notnull="false" description="Datenquelle für diesen Datensatz"/>
<column name="erzeugt_am" type="DATE" size="4" default="today()" notnull="false" description="Datum der Erzeugung des Datensatzes" currentlyUsed="false"/>
<column name="geaendert_am" type="DATE" size="4" default="" notnull="false" description="Datum der letzten Änderung des Datensatzes" currentlyUsed="false"/>
<column name="geaendert_von_id" type="INTEGER" size="4" default="" notnull="false" description="UserID des Ändernden" currentlyUsed="false"/>
<column name="erzeugt_von_id" type="INTEGER" size="4" default="" notnull="false" description="UserID des Erzeugers" currentlyUsed="false"/>
</columns>
<primaryKeys>
<rs>
<row>
<fld name="table_cat">superx</fld>
<fld name="table_schem">superx</fld>
<fld name="table_name">gang_stg_astat</fld>
<fld name="column_name">tid</fld>
<fld name="key_seq">1</fld>
<fld name="pk_name">gang_stg_stat_tid</fld>
</row>
</rs>
</primaryKeys>
</table>
</source>

===Views===
Für die Views wird wie bei den Tabellen eine bestimmte Syntax verfolgt. Diese erläutere ich an dem Beispiel der gang_k_sb:

<source lang="xml">
<view name="gang_k_sb" version="0.1">
<description>View Studienbereiche (Landesschlüssel)</description>
<columns>
<column name="apnr" type ="char" size ="2" default ="" notnull ="true" />
<column name="kurz" type ="VARCHAR" size ="150" default ="" notnull ="false" />
<column name="druck" type ="VARCHAR" size ="255" default ="" notnull ="false" />
<column name="lang_1" type ="VARCHAR" size ="255" default ="" notnull ="false" />
<column name="astat" type ="SMALLINT" size ="2" default ="" notnull ="false" />
</columns>
<sql dbsystem=""><![CDATA[SELECT apnr,kurz,druck ,lang_1,astat FROM gang_cifx where key=3 ]]></sql>
</view>
</source>

Die Vorgehensweise ähnelt hier der der Tabellen. In "view" wird der Name und die Version des Views eingetragen und in "description" die Beschreibung. In "columns" wird für jede Spalte ein "column" Element angelegt mit den entsprechenden Eigenschaften, wie "name", "type", "size" ... . In "sql" wird dann der select des Views eingetragen. Die Besonderheit hier ist das "CDATA". Durch diesen Befehl wird der eingeschlossene Text nicht von XSLT ausgewertet, sondern direkt übergeben.

===Themen===
Hier handelt es sich um die Überschriften im Themenbaum, z.B. "Auswertungen zu Studiengängen". Im Attribut Parent wird das übergeordnete Element definiert.
<source lang="xml">
<thema name="Auswertungen zu Studiengängen" parent="Studiengänge">Abfragen zur Akkreditierung</thema>
</source>

===Masken===
Hier werden die Masken bzw. Berichte des Moduls definiert. Diese Definitionen werden z.B. genutzt, um die Masken zu installieren oder zu entladen.
<source lang="xml">
<maske tid="25240" name="Zulassung" thema="Auswertungen zu Studiengängen">
<src><path>$GANG_PFAD/masken</path><author>D. Quathamer</author><lastChange>23.5.2007</lastChange><dbsystem>INFORMIX</dbsystem></src>
<src><path>$GANG_PFAD/masken</path><author>D. Quathamer</author><lastChange>23.5.2007</lastChange><dbsystem>POSTGRES</dbsystem></src>
</maske>
</source>

===Data-integrity===
In der Data-integrity werden die Verknüpfungen der Tabellen eingetragen. Dies ist einmal für die <<Modul>>.html wichtig, da dann die Verknüpfungen auch als Link zu der entsprechenden Tabelle erscheinen und damit in SuperX in den entsprechenden Tabellen nicht nur eine Nummer, sondern auch ein aussagekräftiger Text steht.
In meinem Beispiel verknüpfe ich die Tabellen gang_k_lehr_hs mit der gang_stg_astat. Auch die Reihenfolge spielt hier eine wichtige Rolle. Die erste Tabelle ist die, in der der entsprechende Inhalt und der Schlüssel in einer Spalte stehen. Die zweite Tabelle enthält nur den Schlüssel. Daher wird in der <<Modul>>.xml in der Zweiten Tabelle der entsprechende Fremdschlüssel eingetragen.
In visibleFields wird die entsprechende Spalte eingetragen, die ausgegeben werden soll. Mit zwei Pipes "||" können auch mehrere Spalten miteinander verbunden werden, wenn z.B. der Key und der Text ausgegeben werden soll.

Beispiel:
<source lang="xml">

<relation from="gang_k_lehr_hs" to="gang_stg_astat" delete="FALSE" displayType="select" visibleFields="key_apnr || trim(drucktext)" format="%s">
<relation-column from="key_apnr" to="lehreinheit" />
</relation>
</source>

Zur Beschreibung "relation":
*from: Tabelle mit Schlüssel und zugehörigen Text
*to: Tabelle nur mit Schlüssel
*delete:
*displayType:
*visibleFields: Welche Spalten angezeigt werden sollen (z.B. in dbforms FK-Bezizehungen)
*format: Format der Anzeige

Zur Beschreibung "relation-column":
*from: Key-Spalte der ersten Tabelle
*to: Key-Spalte der zweiten Tabelle

== Unterbereiche install, uninstall, ETL und upgrade==
Hier werden Aktionen und Ladeschritte bei der jeweiligen Aktion eines Moduls definiert. Das Hauptaugenmark liegt hier auf "nativeaction" und "loadtable". Eine "nativeaction wäre z.B.:
<source lang="xml">
<nativeaction sql="" scriptfile="$GANG_PFAD/conf/gang_tabellen_fuellen.sql"
database=""/>
</source>

Hier wird der Inhalt der SQL Datei genommen und ausgeführt. Es ist auch möglich einen SQL Befehl direkt in das Attribut "sql" zu schreiben. Falls erforderlich, kann auch noch als Bedingung die Datenbank angegeben werden (z.B. POSTGRES oder INFORMIX), für die diese "nativeaction" gedacht ist.
Für "loadtable" ist folgendes Beispiel:
<source lang="xml">
<loadtable refresh="false" delimiter="^" header="false" tabname="gang_cifx"><file path="$GANG_PFAD/schluesseltabellen/gang_cifx.unl"/></loadtable>
</source>
Hier wird der Inhalt einer Tabelle in eine Datei abgespeichert. "delimiter" steht für Feldtrenner, "header", ob die Spaltenüberschrift übernommen werden soll und "tabname" für den Tabellennamen. in "file" in dem Attribut "path" wird der Pfad mit Dateinamen angegeben, wo der Inhalt abgespeichert werden soll.
===Spezialität bei ETL===
In dem ETL Modul sind 6 Stufen eingebaut. Zu beachten ist hier auch, wenn eine Stufe nicht richtig verarbeitet wird, bricht das SKript komplett ab.
Zu den einzelnen Stufen:
;Unload: Hier werden die Daten aus dem Vorsystem entladen.
;Load: Hier werden die Daten in das Datawarehouse geladen.
;Trans: Hier wird die Transformation durchgeführt. D.h. es wird eine Schlüsselharmonisierung durchgeführt.
;Aggregation: Hier werden die Hilfstabellen gefüllt.
;System: Hier wird das Datum aktualisiert, welches die Aktualität angibt.
;Test: Hier findet die Prüfroutine statt.

==dbforms==
In der Modul-XML werden auch die Vorlagen für die DBforms gemacht. Dabei wird mit XSLT aus der abstrakten Beschreibung des Formulars eine funktionstüchtige JSP-Seite erzeugt. Hier werde ich nur auf die wichtigsten Felder eingehen.
===Erläuterung der XML-Elemente===
;Tabellenname:Als erstes sollte der Tabellenname eingetragen werden. Dieser wird hier an mehreren Stellen benötigt. (Bei: "table", "path", "customfield", ..)
;path:Zu beachten ist, dass der Tabellenname sowie das Modul in den Pfad ("path") Angaben auch richtig eingetragen wird.
;name , caption:Im ersten Block wird meist in den Feldern "name" und "caption" dasselbe eingetragen und zwar eine kurze aber aussagekräftige Bezeichnung der Tabelle. Diese kann auch in dem zweiten Block übernommen werden. Dort gibt es genau dieselben Felder.
;descpription: Eine ausführlichere Beschreibung der Tabelle wird in das Feld "description" geschrieben. Diese Beschreibung sollte aber auch nicht länger sein als ein normaler Satz.
; field-selection / customfield :Wenn man <nowiki><field-selection complete="true" /></nowiki> wählt, dann werden automatisch alle Felder der Tabelle im Formular angezeigt. Wenn Sie nur einige Felder anzeigen wollen, nutzen Sie das Element <nowiki><customfield></nowiki>. Außerdem kann man mit customfield spezielle Layoutanweisungen kombinieren, z.B. Feldgröße.

<source lang="xml">
<form name="Studienfächer (amtlich) zu Lehreinheiten (Liste)"
table="gang_stg_astat"
path="/edit/gang/gang_stg_astat_list.jsp"
followUp=""
caption="Studienfächer (amtlich) zu Lehreinheiten (Liste)"
orderBy="astat"
gotoHt=""
helpfile=""
maxRows="*"
mode="update_insert">
<description>Zuordnung amtlicher Studienfächer einer Hochschule zu internen Lehreinheiten.</description>
<filters>
</filters>
<field-selection complete="false" />
<customfield name="tid" nullFieldValue="" />
<customfield name="astat" type="label" nullFieldValue="" visibleSize="10"/>
<customfield type="link" name="Details" path="/superx/edit/gang/gang_stg_astat_edit.jsp" linkid="tid"/>
</form>

<form name="Studienfächer (amtlich) zu Lehreinheiten"
table="gang_stg_astat"
path="/edit/gang/gang_stg_astat_edit.jsp"
followUp=""
caption="Studienfächer (amtlich) zu Lehreinheiten bearbeiten"
orderBy="astat"
gotoHt="tid"
helpfile=""
maxRows="1"
mode="full">
<description>Zuordnung amtlicher Studienfächer einer Hochschule zu internen Lehreinheiten.</description>
<filters>

</filters>
<field-selection complete="false" />
<customfield name="tid" nullFieldValue="" />
<customfield name="lehreinheit" nullFieldValue="" visibleSize="10"/>
<customfield name="beschreibung" nullFieldValue="" visibleSize="30"/>
<customfield name="astat" nullFieldValue="" visibleSize="100"/>
<customfield name="studienbereich" nullFieldValue="" visibleSize="30"/>
<customfield name="aktiv" nullFieldValue="" visibleSize="10"/>
<customfield name="bund_key" nullFieldValue="" visibleSize="30"/>
<customfield name="Datensatzstatus" type="include" path="/edit/gang/datensatzstatus.inc"/>
</form>
</source>

; Optionen für die Merkmale:
#mode
#* full
#* update_insert
#* update
#* insert
#* ...
#type
#*include
#*link
#*lable (Nur Bezeichnung)
#* ...
#filters
#* Beispiel: in gang.xml: form name="zuordnung"
<source lang="xml"><filters>
<filter mandatory="true" type="equals">tid</filter>
</filters></source>

===Test der Formulare===
Die Formulare werden in der Modul-XML-Datei definiert (s.o.). Die JSP-Seiten werden dann generiert, indem man das [[Skriptbasierte Datenbank- und Modulinstallation - HISinOne-BI#Module-Scripts-Create mit Ant]] ausführt.
Danach muss man einen Modulupgrade ausführen, damit die Formulare in der Datenbank gespeichert werden. Und dann kann man die Formulare testen, indem man im Menü Administration-> "Tabelle suchen"-> Bearbeiten anklickt.

Wenn Sie die Bearbeitungsformulare auch im Themenbaum anzeigen wollen, müssen Sie eine Suchmaske vorschalten, in der
*die Datensätze gefiltert werden können
*über einen' ''Bearbeiten''' Button [[Bild:Pencil.gif]](Spaltenname "nextedit") zugänglich gemacht werden.

Sie z.B. die Maske "Tabelle suchen", diese ist ein gutes, einfaches Beispiel für eine Kombination aus Suchformular und Bearbeitungsformular.

=== Gestaltung der Formulare ===

; Auswahl aus Schlüsseltabelle
: Wenn Inhalte zur Auswahl aus einer verknüften Schlüsseltabelle angezeigt werden sollen, müssen folgende Bedingungen erfüllt sein:
:* Die Beziehung ist als <data-integrity> <relation> eingetragen.
:* in der Relation ist unter '''visibleFields="..."''' das Feld eingetragen, dessen Inhalt an der Oberfläche erscheinen soll.

;Spaltenbeschriftung
:Wenn nicht der Spaltennahme aus der Tabelle angezeigt werden soll, sondern eine sprechendere Bezeichnung muss:
:* unter <nowiki> <database> <table> <columns> <column name="..." '''description= "..."''' ></nowiki> die entsprechende Bezeichnung eingetragen werden.

;Formular in Maske einbinden
:Wenn durch eintragen von "nextedit" bereits ein Verweis auf das (funktionierende) Formular erstellt wurde, es aber nicht gefunden wird, muss:
:* zunächst die jsp Seite unter superx\edit\MODULE generiert werden

* [http://entwicklerhandbuch.superx-projekt.de/ Entwicklungshandbücher von SuperX]

Datei:portal verwalten layouts liste.png

2026-09-03T06:32:25Z

Danielq: