Erweiterte Maskenprogrammierung: Freemarker Templates

Die OpenSource-Bibliothek FreeMarker (www.freemarker.org) wird als Template-Engine eingesetzt. Damit Sie in einer Abfrage die Freemarker Funktionalität benutzen können, muss im Kopf des Select-Statements eine Hinweiszeile (--freemarker template) enthalten sein.

Klassische Verarbeitung ohne Freemarker

Die einzelnen Abfragen (auch synonym Masken genannt) enthalten Platzhalter, wie beispielsweise:

select monat,sum(betrag) from cob_busa
where   monat=<<Monat>>; 

Auf der Maske gibt es ein Feld Monat. Vorm Abschicken des SQL wird <<Monat>> durch den gewählten Wert ersetzt. Falls eine Maske Felder enthält, welche optional gefüllt werden können, so wird der Ausdruck zwischen /* und */ gesetzt. Das hat zur Folge, dass dieser entfernt wird, falls kein Wert ausgewählt wurde. Aus beispielsweise

select monat,sum(betrag) from cob_busa
where   monat=<<Monat>>
/* and gege=<<Geldgeber>> */;

wird, falls kein Geldgeber ausgewählt wurde z. B.

select monat,sum(betrag) from cob_busa
where   monat=1;

, aber falls ein Geldgeber ausgewählt wurde z. B.

select monat,sum(betrag) from cob_busa
where   monat=1
and gege=3; 

Achtung: Der Ausdruck in <<XXX>> darf nur einmal in dem optionalen Block vorkommen. Falls er zweimal benötigt wird, müssen diese auf zwei Blöcke aufgeteilt werden. Z. B.:

/* and (dr in (<<Deckungsring>>) */
/* or dr2 in (<<Deckungsring>>))*/

FreeMarker-Transformation

Übersicht

Nach der klassischen Transformation mit generateSql folgt ggfs. die FreeMarker Transformation. FreeMarker transformiert eine Vorlage (template) mit Hilfe eines Datenmodells (mit Java Objekten) zu einem Ausgabetext.

Sehr oft wird es zur Erzeugung von HTML benutzt, wir produzieren stattdessen SQL. Die Java-Objekte im Datenmodell sind die Felder, die auf der Maske zur Auswahl stehen.

Als einfachsten Anwendungsfall könnten wir also für eine Maske mit einem Monatsfeld statt des klassischen SuperX-Tags

select monat,sum(betrag) from tmp_busa where monat=<<Monat>> 

auch die FreeMarker Notation nehmen.

select monat,sum(betrag) from tmp_busa where monat=${Monat} 

Innerhalb von Freemarker kann ${} entfallen:

<#if Monat=1> ... </#if>

Ein komplexes Beispiel:

Interaktion Freemarker mit Maskenfeldern

Zweistufige Verarbeitung

Das Servlet verarbeitet bei der Maskenausführung zuerst die Maskenfelder, die mit den Steuerungszeichen "<<" und ">>" in das select_stmt eingefügt werden. So wird z.B. bei der Anweisung

 <#if (einFach.strukturStr = "Fach (intern)" && <<Aggregierung Fach>>=10 )>

im Servlet zunächst die Variable "Aggregierung Fach " aufgelöst und dann erst startet der Freemarker-Parser. Für das o.g. Statement würde also zunächst:

 <#if (einFach.strukturStr = "Fach (intern)" && 10=10 )>

ersetzt und dann die Freemarker-IF-Bedingung ausgewertet. So können Sie z.B. auch Checkboxen auswerten, wenn sie nicht angekreuzt sind: nehmen wir an das Feld heißt "nur aktuelle Stg." und hat den Typ "char" und die art=10, dann wäre der Code:

 <#if "<<nur aktuelle Stg.>>" =""> 
      select 'Beispiel: nur aktuelle Stg. nicht angekreuzt' from xdummy; 
 </#if>

Wenn das Feld nicht angekreuzt ist, macht der SuperX-Parser daraus zunächst

 <#if "" ="">

und Freemarker würde diese if-Bedingung mit "wahr" beantworten und den SQL "select 'Beispiel: nur aktuelle Stg. nicht angekreuzt' from xdummy;" ausführen. Wenn das Feld angekreuzt wird, macht der SuperX-Parser daraus zunächst

 <#if "'true'" ="">

und Freemarker würde diese if-Bedingung mit "falsch" beantworten und den SQL "select 'Beispiel: nur aktuelle Stg. nicht angekreuzt' from xdummy;" nicht ausführen.

Einstufige Verarbeitung mit Freemarker

Sie können ausgefüllte Maskenfelder im select_stmt der Maske auf zweierlei Arten verarbeiten:

• Zweistufige Verarbeitung, wo zuerst die Platzhalter mit den Feldinhalten ersetzt werden, und dann mit Freemarker
• Einstufige Verarbeitung mit Freemarker

Hier ein einfaches Beispiel für zweistufige Verarbeitung:

• Im select_stmt der Maske steht

select tid,name from userinfo where position(<<Suchwort>> in name) > 0;

Wenn in dem Maskenfeld "Suchwort" der Begriff "Schmidt" eingegeben wird, wird zur Laufzeit daraus der SQL

select tid,name from userinfo where position('Schmidt' in name) > 0;

Dieser Code kann bei der einstufigen Verarbeitung durch diesen ersetzt werden:

--freemarker template
<#assign suchwort=.vars["Suchwort"] />
select tid,name from userinfo where position('${suchwort}' in name) > 0;

Dies hat den Vorteil dass man vor dem Abschicken des SQLs noch weitere Freemarker Funktionen voranstellen kann, z.B.

--freemarker template
<#assign suchwort=.vars["Suchwort"]?replace("?","") />
select tid,name from userinfo where position('${suchwort}' in name) > 0;

Man muss allerdings aufpassen / abfangen ob überhaupt etwas im Maskenfeld eingegeben wurde.Daher nutzt man diese Technik eher bei Pflichtfeldern.

Beide Beispiele mögen anfällig für SQL-Injection aussehen, es wird aber bereits beim Abschicken der Maske, vor der tatsächlichen Ausführung der SQLs vom Servlet geprüft, ob das Suchwort Sonderzeichen wie Anführungszeichen oder Semikolon enthält, und dann ggf. zurückgewiesen mit der Meldung -Ungültige Eingabe-.

Programmieren mit FreeMarker

FreeMarker unterstützt praktisch alle Konzepte klassischer Programmiersprachen. Die Tags sind HTML-ähnlich.

if-Abfragen

Mit Freemarker können Sie z.B. if-then-Abfragen in normales SQL einbauen, z.B. um je nach gewünschter Aggregierungsstufe einen unterschiedlichen insert zu benutzen:

<#if "<<Aggregierung>>"="stark">
     insert into .. select ...
<#elseif "<<Aggregierung>>="mittel">
     insert into .. select ...
<#else>
     insert into .. select ...
</#if> 

Der klassische SuperX-Tag <<Aggregierung>> wird vor der FreeMarker Transformation ersetzt, sodass FreeMarker effektiv zwei Strings vergleicht ( if "stark"="stark" ). Alternativ könnte den ausgewählten Wert des Felds Aggregierung im Java-Objekt direkt ansprechen.

<#if Aggregierung="stark"> 

Hier braucht kein ${} um Aggregierung, da wir ja schon innerhalb einer FreeMarker-Anweisung sind.

Variablen: assign

Mit assign kann man eigene Variabeln definieren. Z. B.

 <#assign sortnr=0> 
 <#assign sortnr=sortnr+1>

oder

 <#if "<<Stichtagsbezogen>>"="NEIN"> 
        <#assign quelltabelle = "sos_statistik"> 
 <#else> 
        <#assign quelltabelle = "sos_statistik"> 
 </#if>

<<Stichtagsbezogen>> wird von der SuperX-Transformation ersetzt, sodass Freemarker vergleicht:

<#if "JA"="NEIN">

oder 

<#if "NEIN"="NEIN">

Die Variablen werden wie folgt abgerufen:

 insert into ... values (${sortnr},...)

oder

 select .... from ${quelltabelle} where ...

Folgender Effekt ist schon mal aufgetreten: Wenn man ein einer Abfrage z.B. schreibt

 <#assign sortnr=sortnr+1> 
 insert into tmp_rs_base 
 (struktur,text, ...

dann klappt das nicht, man muss unter dem assign eine Leerzeile einfügen.

Variablen für Fortgeschrittene: sqlvars

Manchmal wünscht man sich mit FreeMarker auf Variablen zugreifen zu können, die aus der Datenbank gefüllt werden müssten, weil sie nicht als Felder auf der Maske vorkommen. Allerdings muss die Freemarker-Transformation ja schon laufen, bevor der fertige SQL an die Datenbank geschickt wird, weil Postgres/Informix ja mit FreeMarker-Befehlen nichts anfangen können. Man kann also nicht so etwas

<#assign gegename="select name from fin_geldgeber G where G.xyz=<<XYZ>>"> 

machen, weil die Variable gegename dann einfach nur select... als String enthält, Freemarker hat mit der Datenbank keinen direkten Kontakt. Dies lässt sich umgehen, indem man einen Block anlegt:

<sqlvars> 
     <!-- einfache Variable--> 
     <sqlvar name="fin_geldgeber_exists"> 
          select sp_table_exists('fin_geldgeber') from xdummy 
     </sqlvar> 
     <!-- Listenvariable -- 1. Spalte key (darf nicht null sein!), 2. Spalte name--> 
     <sqlvar name="geldgeber"> 
          select ggnr,ggname1 from fin_geldgeber 
     </sqlvar> 
</sqlvars>

Anschließend kann man in der Abfrage mit FreeMarker auf diese aus der Datenbank gefüllten Variablen zugreifen:

<#if fin_geldgeber_exists=1> 
     insert into .. select * from fin_geldgeber; 
<#else> 
     insert into .. select * from fin_geldgeber; 
</#if> 

Die Variable wird als einfacher Wert erkannt, weil nur eine Spalte im SQL selektiert wurde. Sofern der Select mehrere Zeilen liefert, wird nur der letzte gefundene Wert hinterlegt.

Die zweite Art von Variable (geldgeber) wird als Liste von Items geführt und kann in der Abfrage benutzt werden z.B. mit

where ggnr in ( 
<#foreach gg in geldgeber> 
     ${gg.key}, 
</#foreach> 

Die erste per SQL eingelesene Spalte ist das Attribut key, die zweite name. Optional kann auch noch dritte/vierte Spalte mit Strukturinfo eingelesen werden:

<sqlvar name="geldgeber"> 
     select ggnr,ggname1,klr_geldgeber,strukturint from fin_geldgeber 
</sqlvar> 

Auf die dritte Spalte kann man zugreifen über das Attribut ".strukturStr", und die vierte Spalte mit ".strukturInt", also für das orbige Beispiel mit:

<#foreach gg in geldgeber > 
     -- Hier steht der Inhalt der Spalte klr_geldgeber: ${gg.strukturStr} 
...

Analog für strukturInt.

In den sqlvars kann auch freemarker-syntax und repository/konstanten benutzt werden, obstruses Beispiel:

<sqlvar name="spezial_gege"> 
     <#if K_FIN_Quellsystem=1> 
            select ggnr,ggname1 from fin_geldgeber where ggnr in ${FIN_Drittmittel} 
     <#else> 
            select ggnr,ggname2 from fin_geldgeber where ggnr in ${FIN_Drittmittel} 
     </#if> 
</sqlvar> 

Achtung : bei den SQL-Statements innerhalb von SQLVAR-Abschnitten dürfen Sie keine "<" oder ">"-Zeichen nutzen, sondern mit der html-Notation &lt; und &gt; umschreiben, also statt:

<sqlvar name="Semester"> 
     select distinct tid, eintrag 
     from semester 
     where tid < =20101 
     order by 1;
</sqlvars>

schreiben Sie besser

<sqlvars name="Semester">
     select distinct tid, eintrag 
     from semester 
     where tid &lt; =20101 
     order by 1;
</sqlvars>

Bei Problemen mit sqlvars, deren SQL dynamisch generiert werden, ist es schwierig, sich den produzierten SQL anzusehen (insb. wenn nur Browserzugriff besteht). Beispiel:

<sqlvar name="hhanssum"><![CDATA[
     select sum(hhans) from fin_konto_aggr 
     where rechnungsjahr= <<Haushaltsjahr>>
     and ch110_institut in ${Kostenstelle.allNeededElements}]]>
</sqlvars>

Trick: Einen SQL-Syntaxfehler einbauen:

<sqlvar name="hhanssum"><![CDATA[
     select XXXXX sum(hhans) from fin_konto_aggr 
     where rechnungsjahr= <<Haushaltsjahr>>
     and ch110_institut in ${Kostenstelle.allNeededElements}]]>
</sqlvars>

Dadurch wird ein SQL-Fehler erzeugt, der im Browser angezeigt wird und man kann sehen, wie <<Haushaltsjahr>> ersetzt wurde und Freemarker arbeitet. Man kann auch Inhalt von Freemarker-Variablen bzw. vorhergehenden SQLVars anzeigen lassen. Beispiel Konstante FIN_Quellsystem und vorhergehende sqlvar instname:

<sqlvar name="instname">
     select drucktext from fin_inst where key_apnr=<<Kostenstelle>>
</sqlvar>
<sqlvar name="hhanssum"><![CDATA[
     select '${K_FIN_Quellsystem} - ${instname}' from xdummy;
     select XX sum(hhans) from fin_konto_aggr where
     rechnungsjahr= <<Haushaltsjahr>>
     and ch110_institut in ${Kostenstelle.allNeededElements}]]>
</sqlvar>

In sqlvars kann man auch auf die vorherigen sqlvars zugreifen:

<sqlvars>
     <sqlvar name="v1">
          select ..
     </sqlvar>
     <sqlvar name="v2"><![CDATA[ 
          select .. 
          where 
               <#if v1=1> 
                    feld=1
               <#else>
                    feld=2
               </#if>]]>
     </sqlvar>
</sqlvars>

geht bisher nur innerhalb von if-Anweisungen o.ä. CDATA ist wichtig für wohlgeformtes xml

<sqlvar name="COB_FIN_STARTJAHR">
     select apnr from konstanten where beschreibung=' COB_FIN_STARTJAHR '
</sqlvar>
<sqlvar name="vorhandene_fin_monate">
     <![CDATA[select distinct klrjahr*12+klrmonat,'monat' 
               from fin_buch_akt 
               where klrjahr>0 and klrjahr>=${COB_FIN_TO_BUSA_STARTJAHR}]]> 
</sqlvar>

hier kommt Fehlermeldung smallint Operator >= existiert nicht. Hintergrund: ${COB_FIN_TO_BUSA_STARTJAHR} wird als $-Kommentar vom klassischen general-sql gelöscht und

select distinct klrjahr*12+klrmonat,'monat' 
from fin_buch_akt 
where klrjahr>0 and klrjahr>= 

abgeschickt.

Sichten und Freemarker

Bei Sicht-Feldern (Feldart 12) gibt es besondere Möglichkeiten. Mittels Java-Reflection kann FreeMarker auf Methoden der Objekte im Datenmodell zugreifen. Bei Sichtfeldern wie "Institution" oder "Kostenart" sind folgende Methoden interessant.

allNeededKeys für temporäre Datentabellen

Diese Methode liefert alle benötigten Schlüssel.

Wenn bei dme Sichtenfeld nichts ausgewählt wurde, werden einfach alle im Baum vorhandenen Schlüssel geliefert.

Wenn z.B. Personalkosten ausgewählt wurde, wird nur der Schlüssel von Personalkosten ('1') und dessen Unterknoten (z.B. '11','12') geliefert.

Dafür wird noch das allgemeine Makro printkeys benutzt.

<@printkeys Kostenarten.allNeededKeys/>

Beispiel für Erstellung einer temporären Datentabelle

execute procedure sp_user_orga_child
        (<<UserID>>,<<Organigramm-Stand>>,0,<<Institution>>, <<erlaubt>>);
  Create temp table tmp_erg   (fikr varchar(200), betrag decimal (14,2)) with no log;
 select fikrkey,sum(betrag) as betrag into temp tmp_busa 
 from cob_busa B,tmp_ch110_institut T where
  B.ch110_institut=T.ch110_institut and
  B.jahr=<<Haushaltsjahr>> and fikrkey in
<@printkeys Kostenarten.allNeededKeys />
  group by fikrkey
  ;

(Statt Benutzung der Prozedur sp_user_orga_child könnte man analog verwenden:

where B.110_institut in <@printkeys Institition.allNeededKeys/>)

Ggfs. versteckte Knoten werden hier mit ausgegeben.

Bei Kostenstellen-Feldern werden nur erlaubte Einträge ausgegeben.

Neu ab kern4.5

Diese Methode kann man auch für Feldart 1-Felder benutzen, z.B. mit

${Haushaltsprogramm.allNeededKeys}.

ContainsElements

Neu ab Kern4.5

Für Sichten und auch Feldart 1 kann man ermitteln, ob eine Auswahl möglich ist.

z.B.

<#if Kostenstelle.containsElements> … </#if>

Oder bei Feldart 1 :

 <#if HaushaltsprogrammObject.containsElements> .. </#if>

keysToRoot

Bei dem Maskenfeld Verteilschritte wird die Sicht von unten nach oben durchlaufen. sind ein ungewöhnliches Konzept.

1
 2
   3

Schritt 3 ist die Summe aus 1-3.

In Abfragen wird

<@printkeys Verteilschritt.keysToRoot/>

benutzt

elements: Schleifen über ausgewählte Knoten

Die Methode elements liefert eine Collection, entweder über alle Knoten im Sichtbaum oder nur über einen ausgewählten Knoten und deren Kinder.

Beispiel:

<#foreach eineKostenart in Kostenarten.elements>
-- Auswertung für ${eineKostenart}
</#foreach>

elements liefert die Knoten genau in der Reihenfolge, in der sie auch im Baum sind. Alternativ kann man breadthFirstElements oder depthFirstElements angeben. Dann wird beim Baum zunächst in die Breite/Tiefe gegangen.

Wichtig:

Für eine foreach-Schleife werden auch bei Kostenstellen-Feldern bei eingeschränkten Usern immer alle Knoten ausgegeben, z.B. nur Rechte auf 11 und 13

root-Hochschule (Auswahl)
 fak-Fakultäten (Auswahl)
   1-fak1 (Auswahl)
       11-Institut 1

Es werden alle Knoten durchlaufen, weil (Teil)summenzeilen interessant sein können. Anders ist es bei Berechnung (Methode subkeys) da werden nur die tatsächlich erlaubten Schlüssel ausgegeben.

Zugriff auf einzelne Knoten im Baum

Im Rahmen einer forEach Schleife bekommt man Zugriff auf einzelne Elemente eines Sichtenbaums. Für die einzelnen Knoten kann FreeMarker wiederum mittels Java-Reflection auf bestimmte Methoden zugreifen.

Knotenelement id, name

Die Attribute id und name liefern Zugriff auf den Schlüssel und den Namen des Knotens, z.B.

Insert into tmp_erg (fikr , betrag )
SELECT   "${eineKostenart. id }" || " " || "${eineKostenart. name }", sum(betrag)
FROM tmp_busa
…

Knoten-Attribut subkeys

Die Methode 'subkeys' liefert eine Liste mit dem Schlüssel des aktuellen Knotens (z.B. Personalkosten '1') und aller seiner Unterkn* oten (z.B. '11','12') (auch von versteckten Knoten!)

Insert into tmp_erg (fikr , betrag )
SELECT   "${eineKostenart. id }" || " " || "${eineKostenart. name }", sum(betrag)
FROM tmp_busa
where fikrkey in <@printkeys eineKostenart.subkeys }
group by 1 ;

Bei Kostenstellen-Sichten werden nur die erlaubten Knoten ausgegeben, z.B.

root-Hochschule (Auswahl)
 fak-Fakultäten (Auswahl)
   1-fak1 (Auswahl)
       11-Institut 1
       13 – Institut 3

wenn nichts ausgewählt wurde, root, fak, oder fak1 wird trotzdem nur 11,13 als subkeys ausgegeben, weil nur die selbst erlaubt sind.

Bei der foreach-Methode elements ist es anders: root, fak, fak1 werden auch mit durchlaufen, weil (Teil)summenzeilen interessant sein können

Knoten-Strukturattribut mit strukturInt,strukturStr

Ein Element im Baum kann ein Strikturattribut haben, dies beschreibt Art oder Struktur des Knotens. Beispiel: Das Feld "orgstruktur" im Organigramm beschreibt, ob ein Knoten eine Lehreinheit oder ein Fachbereich ist (20 bzw. 30). Diese Strukturinformation ist im Knoten hinterlegt, sofern beim Einlesen der Sicht an Postition 4 und/oder 5 etwas angegeben wurde (z.B. select name,key_apnr,parent,orgstruktur from organigramm). Sie kann z.B. für if-Abfragen zur Aggregierung benutzt werden.

<#foreach eineInstitution in Institutionen>
    <#if Aggregierung="stark" and eineInstitution.strukturInt=30>
    ...
    <#else>
    ..
    </#if>
</#foreach>

nodeattrib - ein Knotenattribut

Das Attribut nodeattib steuert:

• wenn null oder 0: Knoten wird ganz normal angezeigt
• wenn 1, dann wird es in der Anzeige versteckt
• wenn 2, dann wird es angezeigt, ist aber nicht selektierbar im Baum
• wenn 3, dann ist es eingerückt bei Feldart 1

Beispiel für relations-SQL für Feldart 1

select key,name,0 as nodeattrib from tabelle where name  like '%LFB%'  -- 0 = normale Darstellung
union
select key,name,3 as nodeattrib from tabelle where name not like '%LFB%'  -- 3 = eingerueckt

getSubKeys

Eine besonderer Trick ist, wenn man einen bestimmten Knoten aus dem Baum braucht, der nicht ausgewählt sein muss: Man nimmt den Feldnamen der Sicht und schreibt z.B.

Kostenarten("getSubkeys","21")

Dann erhält man eine Schlüsselliste für alle Schlüssel 21 und untergeordnete.

Mehrfachauswahl bei Sicht-Feldern mit Schleifenfunktion

Ab Kern4.5 kann man eine Mehrfachauswahl bei Sichtfeldern aktivieren, die als Schleife für die Ergebnisdarstellung benutzt werden.

Angenommen wir haben folgenden Finanzstellenbaum

- Hochschule
 - A1
   - A11
   - A12
 -   B2
   - B21
   - B22

Bisher gab es ein Problem wenn ein User bei der Mehrfachauswahl A11 und B2 auswählte, weil dann die Ebenendarstellung durcheinander kam, die Ergebniszeile für A11 wurde gar nicht angezeigt, weil Ebene 2 kleiner als Ebene 1 der zweiten Selektion B2.

Dies kann man jetzt umgehen, in dem man das Feld Finanzstelle obligatorisch macht, es muss also immer eine Selektion geben und dann für jede Finanzstelle nicht level benutzt, sondern levelFromSelection+1

<#foreach eineFistl in Finanzstelle.elements>
<#assign sortnr=sortnr+1/>
insert into tmp_erg (sortnr,ebene,key,name,
  budgetsumme,einnahmen,mittelbindung,ausgaben,verfuegbar_of,verfuegbar)
select ${sortnr},${ eineFistl.levelFromSelection+1 },'${eineFistl.key}','${eineFistl.name[(eineFistl.name?index_of('-')+1)..(eineFistl.name?length-1)]}',
sum(budgetsumme),sum(einnahmen),sum(mittelbindung),sum(ausgaben),sum(verfuegbar_of),sum(verfuegbar)
from tmp_konto2
where kst_nr in <@printkeys eineFistl.subkeys/>
group by 1,2,3,4;
</#foreach>

Eine Summenberechnung bei mehr als einer Zeile geht dann so

 <#if Finanzstelle.selectionCount&gt;1>
 create table...
 insert into tmp_sum   (
 budgetsumme ,
 einnahmen   ,
 ausgaben   ,
 mittelbindung   ,
 verfuegbar ,
 verfuegbar_of )
  select
  sum(budgetsumme) ,
  sum(einnahmen)   ,
  sum(ausgaben)   ,
  sum(mittelbindung)   ,
  sum(verfuegbar) ,
  sum(verfuegbar_of)
  from tmp_konto2
  where kst_nr in (
  <#foreach eineFistl in Finanzstelle.elements>'${eineFistl.key}' <#if eineFistl_has_next>,</#if></#foreach>
  );
</#if>

Ein Beispiel ist die Maske GXSTAGE Budget nach Finanzstellen 33060.

Sichten aus Repo-Variablen

Man kann Eintragungen in sx_repository nutzen, um Sichten zu erstellen, meist über einen zwischengeschalteten View, da dieser leichter zu bearbeiten ist.

Beispiel: eine Sicht für das Studierende Datenblatt, bei der RSZ und individuelle RSZ ausgewählt werden können

Dazu werden zunächst die benötigten Eintragungen in sx_repository vorgenommen, alle mit der id SOS_UDE_%RSZ%

INSERT INTO sx_repository ( id, content, caption, COMMENT, version, art, art2, art3, sachgebiete_id, sort1, sort2, sort3, geaendert_am, aktiv, gueltig_seit, gueltig_bis) VALUES ( 'SOS_UDE_RSZ', 'fach_sem_zahl <= L.regel', 'innerhalb RSZ', 'Hier werden Studierende in der RSZ gefiltert', NULL, 'SOS_STUD_FILTER', ' ', NULL, 16, 1, 0, 0, NULL, 1, DATE '1900-01-01', DATE '3000-12-31');
...
INSERT INTO sx_repository ( id, content, caption, COMMENT, version, art, art2, art3, sachgebiete_id, sort1, sort2, sort3, geaendert_am, aktiv, gueltig_seit, gueltig_bis) VALUES ( 'SOS_UDE_iRSZ',
'(individual_number_of_semesters is not null and individual_number_of_semesters>L.regel and fach_sem_zahl <= individual_number_of_semesters)', 'innerhalb iRSZ', 'Hier werden Studierende in der individuellen RSZ gefiltert', NULL, 'SOS_STUD_FILTER', ' ', NULL, 16, 1, 0, 0, NULL, 1, DATE '1900-01-01', DATE '3000-12-31');

Anschließend wird mit diesen Repo-Variablen und nicht anwählbaren Überschriften ein View definiert

create view sos_iRSZ as
select 0 as ord, 'alle' as id, 'alle' as caption, null as parent, 2 as nodeattrib, '1=1' as content from xdummy
union
select 1 as ord, 'RSZ' as id, 'RSZ' as caption, 'alle' as parent, 2 as nodeattrib, null as content from xdummy
union
select 1 as ord, id, caption, 'RSZ' as parent, 0 as nodeattrib, content from sx_repository where id like 'SOS_UDE_RSZ%'
union
select 2 as ord , 'iRSZ', 'iRSZ (wenn iRSZ bekannt und iRSZ!=RSZ)', 'alle' as parent, 2 as nodeattrib, null as content from xdummy
union
select 2 as ord, id, caption, 'iRSZ' as parent, 0 as nodeattrib, content from sx_repository where id like 'SOS_UDE_iRSZ%'
union
select 3 as ord , 'bRSZ', 'innerhalb iRSZ, sonst RSZ', 'alle' as parent, 2 as nodeattrib, null as content from xdummy
union select 3 as ord, id, caption, 'bRSZ' as parent, 0 as nodeattrib, content from sx_repository where id like 'SOS_UDE_bRSZ%'

Auf diesen View wird dann zum Schluss die Sicht definiert mit quelle='<<SQL>> select caption as name, id as key , parent, ord, nodeattrib, content from sos_iRSZ order by ord,1;'

Durch diese Eintragungen in sx_repository kann man nicht nur elegant diesen View erzeugen, sondern hat auch die Möglichkeit in der Abfrage direkt auf die Bedingung in content zuzugreifen

Eintrag in felderinfo:

Durch den typ=sql und den Wert z.B. SOS_UDE_RSZ sucht das System in sx_repository genau diese id und ersetzt sie im SQL durch den Wert in content.

<#assign filter="
/* and <<Hörerstatus>> */
...
/* and ${<<Filterung RSZ>>} */
" />

has_content

Wenn man wissen möchte, ob eine Variable mit Inhalt gefüllt ist, kann man dies mit has_content Abfragen, z.B.

<#if lehr_abg?has_content >

ForEach

FreeMarker kann nicht nur primitive Datentypen wie Strings oder Zahlen verarbeiten, sondern auch Collections. Wenn im Datenmodell eine Collection hinterlegt ist, kann man forEach benutzten. Das sieht ungefähr so aus:

<#foreach eineKostenart in Kostenarten.elements>
-- Auswertung für ${eineKostenart}
</#foreach> 

Details siehe bei Sichtfeldern-Schleifen.

For-Next-Schleifen: List

FreeMarker kann auch eine For-Next-Schleife mit 1er-Schritten erzeugen:

create temp table tmp_aggre 
(struktur char(50),text char(200), ch30_fach char(3),sortnr int,
<#list 0..30 as i>
m_a${18+(i*2)} decimal(7,2),
w_a${18+(i*2)} decimal(7,2),
</#list>
gesamt decimal(7,2)); 

Nach der Freemarker-Transformation:

create temp table tmp_aggre
(struktur char(50),text char(200), ch30_fach char(3),sortnr int,
m_a18 decimal(7,2),
w_a18 decimal(7,2),
m_a20 decimal(7,2),
w_a20 decimal(7,2),
m_a22 decimal(7,2),
w_a22 decimal(7,2),
[…]
m_a78 decimal(7,2),
w_a78 decimal(7,2),
gesamt decimal(7,2));

Freemarker in dynamischen Felderrelationen

Damit ein Feld Freemarker Variablen auslesen kann wie Kostenstelle, muss es als dynamisch markiert sein. SuperX erkennt ein Feld als dynamisch wenn << darin vorkommt:

<<SQL>>
--Freemarker Template
<#include "SQL_lingua_franca"/>
<#include "SuperX_general"/>\
select distinct buchungsab_fb,trim(buchungsab_fb)||'-'||max(ba_name) from fin_used_inst\
where kostenstelle in <@printkeys Kostenstelle.allNeededKeysList />

klappt nicht, aber

<<SQL>>
--Freemarker Template
<#include "SQL_lingua_franca"/>
<#include "SuperX_general"/>\
select distinct buchungsab_fb,trim(buchungsab_fb)||'-'||max(ba_name) from fin_used_inst\
where kostenstelle in <@printkeys Kostenstelle.allNeededKeysList />  /*  --quatsch <<Kostenstelle>> */

Makros und Funktionen

Es könnten auch Makros und Funktionen (die Werte zurückliefern) definiert werden.

<#macro macroname param1 param2>
</#macro> 

Aufgerufen werden sie mit

<@makroname /> 

bzw.

<@makroname param1 param2 ../> 

oder

<@makroname param1=wert1 param2=wert2 ../>

Die Reihenfolge in der Makros definiert werden spielt keine Rolle.

Einige Makros für Datenunabhängigkeit (SQL Lingua franca) und allgemeine Makros sind in der Tabelle fm_templates hinterlegt. Diese können mit <#include "xx"/> eingebunden werden, wobei "xx" durch die jew. fm_templates.id ersetzt wird.

Exportdateinamen

Ab Kern5.2 /HISinOne-BI 2025.06 kann man per Freemarker sqlvar bestimmen, wie ein Exportdateiname beim Export nach Excel/PDF heißen soll, wenn es nicht der Maskenname bzw. der Reportname bei JasperReports sein soll.
Dazu muss man im select_stmt der maske eine sqlvar namens "exportfilename" definieren. Dieser kann mit allem arbeiten, was SQL zu bieten hat und bei Bedarf auch auf vorherige sqlvars zugreifen. Beispiel:

<sqlvars>
<sqlvar name="hochschulnummer">select hs_nr from hochschulinfo</sqlvar>
<sqlvar name="exportfilename">select 'Bilanz-'||year(today())||'-'||'${hochschulnummer}' from xdummy;</sqlvar>
</sqlvars>

Der resultierende Dateiname könnte damit z.B. sein "Bilanz-2024-1241.xlsx"